[[410845]]

拋開關于是否使用 JSON 作為配置格式的爭論，只需學習如何用 Groovy 來解析它。

應用程序通常包括某種類型的默認或“開箱即用”的狀態(tài)或配置，以及某種讓用戶根據(jù)自己的需要定制配置的方式。

例如，LibreOffice Writer 通過其菜單欄上的工具 > 選項，可以訪問諸如用戶數(shù)據(jù)、字體、語言設置等（以及更多的）設置。一些應用程序（如 LibreOffice）提供了一個點選式的用戶界面來管理這些設置。有些，像 Tracker（GNOME 的“任務”，用于索引文件）使用 XML 文件。還有一些，特別是基于 JavaScript 的應用，使用 JSON，盡管它有許多人抗議（例如，這位作者 和 這位其他作者）。

在這篇文章中，我將回避關于是否使用 JSON 作為配置文件格式的爭論，并解釋如何使用 Groovy 編程語言 來解析這類信息。Groovy 以 Java 為基礎，但有一套不同的設計重點，使 Groovy 感覺更像 Python。

安裝 Groovy

由于 Groovy 是基于 Java 的，它也需要安裝 Java。你可能會在你的 Linux 發(fā)行版的軟件庫中找到最近的、合適的 Java 和 Groovy 版本?；蛘撸憧梢园凑掌渚W(wǎng)站上的 說明 安裝 Groovy。 Linux 用戶的一個不錯的選擇是 SDKMan，你可以使用它來獲取 Java、Groovy 和許多其他相關工具的多個版本。 對于本文，我將使用我的發(fā)行版的 OpenJDK11 和 SDKMan 的 Groovy 3.0.7。

演示的 JSON 配置文件

在這個演示中，我從 Drupal 中截取了這個 JSON 文件，它是 Drupal CMS 使用的主要配置文件，并將其保存在文件 config.json 中：

{
 "vm": {
  "ip": "192.168.44.44",
  "memory": "1024",
  "synced_folders": [
   {
    "host_path": "data/",
    "guest_path": "/var/www",
    "type": "default"
   }
  ],
  "forwarded_ports": []
 },
 "vdd": {
  "sites": {
   "drupal8": {
    "account_name": "root",
    "account_pass": "root",
    "account_mail": "box@example.com",
    "site_name": "Drupal 8",
    "site_mail": "box@example.com",
    "vhost": {
     "document_root": "drupal8",
     "url": "drupal8.dev",
     "alias": ["www.drupal8.dev"]
    }
   },
   "drupal7": {
    "account_name": "root",
    "account_pass": "root",
    "account_mail": "box@example.com",
    "site_name": "Drupal 7",
    "site_mail": "box@example.com",
    "vhost": {
     "document_root": "drupal7",
     "url": "drupal7.dev",
     "alias": ["www.drupal7.dev"]
    }
   }
  }
 }
}

這是一個漂亮的、復雜的 JSON 文件，有幾層結構，如：

<>.vdd.sites.drupal8.account_name

和一些列表，如：

<>.vm.synced_folders

這里，<> 代表未命名的頂層。讓我們看看 Groovy 是如何處理的。

用 Groovy 解析 JSON

Groovy 自帶的 groovy.json 包，里面有各種很酷的東西。其中最好的部分是 JsonSlurper 類，它包括幾個 parse() 方法，可以將 JSON 轉換為 Groovy 的 Map，一種根據(jù)鍵值存儲的數(shù)據(jù)結構。

下面是一個簡短的 Groovy 程序，名為 config1.groovy，它創(chuàng)建了一個 JsonSlurper 實例，然后調(diào)用其中的 parse() 方法來解析文件中的 JSON，并將其轉換名為 config 的 Map 實例，最后將該 map 輸出：

import groovy.json.JsonSlurper
 
def jsonSlurper = new JsonSlurper()
 
def config = jsonSlurper.parse(new File('config.json'))
 
println "config = $config"

在終端的命令行上運行這個程序：

$ groovy config1.groovy
config = [vm:[ip:192.168.44.44, memory:1024, synced_folders:[[host_path:data/, guest_path:/var/www, type:default]], forwarded_ports:[]], vdd:[sites:[drupal8:[account_name:root, account_pass:root, account_mail:box@example.com, site_name:Drupal 8, site_mail:box@example.com, vhost:[document_root:drupal8, url:drupal8.dev, alias:[www.drupal8.dev]]], drupal7:[account_name:root, account_pass:root, account_mail:box@example.com, site_name:Drupal 7, site_mail:box@example.com, vhost:[document_root:drupal7, url:drupal7.dev, alias:[www.drupal7.dev]]]]]]
$

輸出顯示了一個有兩個鍵的頂層映射：vm 和 vdd。每個鍵都引用了它自己的值的映射。注意 forwarded_ports 鍵所引用的空列表。

這很容易，但它所做的只是把東西打印出來。你是如何獲得各種組件的呢？下面是另一個程序，顯示如何訪問存儲在 config.vm.ip 的值：

import groovy.json.JsonSlurper
 
def jsonSlurper = new JsonSlurper()
 
def config = jsonSlurper.parse(new File('config.json'))
 
println "config.vm.ip = ${config.vm.ip}"

運行它：

$ groovy config2.groovy
config.vm.ip = 192.168.44.44
$

是的，這也很容易。 這利用了 Groovy 速記，這意味著：

config.vm.ip

在 Groovy 中等同于：

config['vm']['ip']

當 config 和 config.vm 都是 Map 的實例，并且都等同于在 Java 中的:

config.get("vm").get("ip")

僅僅是處理 JSON 就這么多了。如果你想有一個標準的配置并讓用戶覆蓋它呢？在這種情況下，你可能想在程序中硬編碼一個 JSON 配置，然后讀取用戶配置并覆蓋任何標準配置的設置。

假設上面的配置是標準的，而用戶只想覆蓋其中的一點，只想覆蓋 vm 結構中的 ip 和 memory 值，并把它放在 userConfig.json 文件中:

{
 "vm": {
  "ip": "201.201.201.201",
  "memory": "4096",
 }
}

你可以用這個程序來做：

import groovy.json.JsonSlurper
 
def jsonSlurper = new JsonSlurper()
 
// 使用 parseText() 來解析一個字符串，而不是從文件中讀取。
// 這給了我們一個“標準配置”
def standardConfig = jsonSlurper.parseText("""
{
 "vm": {
  "ip": "192.168.44.44",
  "memory": "1024",
  "synced_folders": [
   {
    "host_path": "data/",
    "guest_path": "/var/www",
    "type": "default"
   }
  ],
  "forwarded_ports": []
 },
 "vdd": {
  "sites": {
   "drupal8": {
    "account_name": "root",
    "account_pass": "root",
    "account_mail": "box@example.com",
    "site_name": "Drupal 8",
    "site_mail": "box@example.com",
    "vhost": {
     "document_root": "drupal8",
     "url": "drupal8.dev",
     "alias": ["www.drupal8.dev"]
    }
   },
   "drupal7": {
    "account_name": "root",
    "account_pass": "root",
    "account_mail": "box@example.com",
    "site_name": "Drupal 7",
    "site_mail": "box@example.com",
    "vhost": {
     "document_root": "drupal7",
     "url": "drupal7.dev",
     "alias": ["www.drupal7.dev"]
    }
   }
  }
 }
}
""")
 
// 打印標準配置
println "standardConfig = $standardConfig"
 
//讀入并解析用戶配置信息
def userConfig = jsonSlurper.parse(new File('userConfig.json'))
 
// 打印出用戶配置信息
println "userConfig = $userConfig"
 
// 一個將用戶配置與標準配置合并的函數(shù)
def mergeMaps(Map input, Map merge) {
  merge.each { k, v ->
    if (v instanceof Map)
      mergeMaps(input[k], v)
    else
      input[k] = v
  }
}
 
// 合并配置并打印出修改后的標準配置
mergeMaps(standardConfig, userConfig)
 
println "modified standardConfig $standardConfig"

以下列方式運行：

$ groovy config3.groovy
standardConfig = [vm:[ip:192.168.44.44, memory:1024, synced_folders:[[host_path:data/, guest_path:/var/www, type:default]], forwarded_ports:[]], vdd:[sites:[drupal8:[account_name:root, account_pass:root, account_mail:box@example.com, site_name:Drupal 8, site_mail:box@example.com, vhost:[document_root:drupal8, url:drupal8.dev, alias:[www.drupal8.dev]]], drupal7:[account_name:root, account_pass:root, account_mail:box@example.com, site_name:Drupal 7, site_mail:box@example.com, vhost:[document_root:drupal7, url:drupal7.dev, alias:[www.drupal7.dev]]]]]]
userConfig = [vm:[ip:201.201.201.201, memory:4096]]
modified standardConfig [vm:[ip:201.201.201.201, memory:4096, synced_folders:[[host_path:data/, guest_path:/var/www, type:default]], forwarded_ports:[]], vdd:[sites:[drupal8:[account_name:root, account_pass:root, account_mail:box@example.com, site_name:Drupal 8, site_mail:box@example.com, vhost:[document_root:drupal8, url:drupal8.dev, alias:[www.drupal8.dev]]], drupal7:[account_name:root, account_pass:root, account_mail:box@example.com, site_name:Drupal 7, site_mail:box@example.com, vhost:[document_root:drupal7, url:drupal7.dev, alias:[www.drupal7.dev]]]]]]
$

以 modified standardConfig 開頭的一行顯示，vm.ip and vm.memory 的值被覆蓋了。

眼尖的讀者會注意到，我沒有檢查畸形的 JSON，也沒有仔細確保用戶的配置是有意義的（不創(chuàng)建新字段，提供合理的值，等等）。所以用這個遞歸方法來合并兩個映射在現(xiàn)實中可能并不那么實用。

好吧，我必須為家庭作業(yè)留下 一些 東西，不是嗎？

Groovy 資源

Apache Groovy 網(wǎng)站有很多很棒的 文檔。另一個很棒的 Groovy 資源是 Mr. Haki。學習 Groovy 的一個非常好的理由是繼續(xù)學習 Grails，它是一個非常高效的全棧 Web 框架，建立在 Hibernate、Spring Boot 和 Micronaut 等優(yōu)秀組件之上。