用Groovy解析JSON配置文件

抛开关于是否使用 JSON 作为配置格式的争论，只需学习如何用 Groovy 来解析它。

创新互联公司是一家专业提供永康企业网站建设,专注与网站制作、成都网站建设、html5、小程序制作等业务。10年已为永康众多企业、政府机构等服务。创新互联专业的建站公司优惠进行中。

应用程序通常包括某种类型的默认或“开箱即用”的状态或配置，以及某种让用户根据自己的需要定制配置的方式。

例如，LibreOffice Writer 通过其菜单栏上的工具 > 选项，可以访问诸如用户数据、字体、语言设置等（以及更多的）设置。一些应用程序（如 LibreOffice）提供了一个点选式的用户界面来管理这些设置。有些，像 Tracker（GNOME 的“任务”，用于索引文件）使用 XML 文件。还有一些，特别是基于 JavaScript 的应用，使用 JSON，尽管它有许多人抗议（例如，这位作者 和 这位其他作者）。

在这篇文章中，我将回避关于是否使用 JSON 作为配置文件格式的争论，并解释如何使用 Groovy 编程语言 来解析这类信息。Groovy 以 Java 为基础，但有一套不同的设计重点，使 Groovy 感觉更像 Python。

安装 Groovy

由于 Groovy 是基于 Java 的，它也需要安装 Java。你可能会在你的 Linux 发行版的软件库中找到最近的、合适的 Java 和 Groovy 版本。或者，你可以按照其网站上的 说明 安装 Groovy。 Linux 用户的一个不错的选择是 SDKMan，你可以使用它来获取 Java、Groovy 和许多其他相关工具的多个版本。 对于本文，我将使用我的发行版的 OpenJDK11 和 SDKMan 的 Groovy 3.0.7。

演示的 JSON 配置文件

在这个演示中，我从 Drupal 中截取了这个 JSON 文件，它是 Drupal CMS 使用的主要配置文件，并将其保存在文件 config.json 中：

  
 
 
    
   
  
  
  1. {
    2. 
   
  
  
  2.  "vm": {
    3. 
   
  
  
  3.  "ip": "192.168.44.44",
    4. 
   
  
  
  4.  "memory": "1024",
    5. 
   
  
  
  5.  "synced_folders": [
    6. 
   
  
  
  6.  {
    7. 
   
  
  
  7.  "host_path": "data/",
    8. 
   
  
  
  8.  "guest_path": "/var/www",
    9. 
   
  
  
  9.  "type": "default"
    10. 
   
  
  
  10.  }
    11. 
   
  
  
  11.  ],
    12. 
   
  
  
  12.  "forwarded_ports": []
    13. 
   
  
  
  13.  },
    14. 
   
  
  
  14.  "vdd": {
    15. 
   
  
  
  15.  "sites": {
    16. 
   
  
  
  16.  "drupal8": {
    17. 
   
  
  
  17.  "account_name": "root",
    18. 
   
  
  
  18.  "account_pass": "root",
    19. 
   
  
  
  19.  "account_mail": "box@cdxwcx.com",
    20. 
   
  
  
  20.  "site_name": "Drupal 8",
    21. 
   
  
  
  21.  "site_mail": "box@cdxwcx.com",
    22. 
   
  
  
  22.  "vhost": {
    23. 
   
  
  
  23.  "document_root": "drupal8",
    24. 
   
  
  
  24.  "url": "drupal8.dev",
    25. 
   
  
  
  25.  "alias": ["www.drupal8.dev"]
    26. 
   
  
  
  26.  }
    27. 
   
  
  
  27.  },
    28. 
   
  
  
  28.  "drupal7": {
    29. 
   
  
  
  29.  "account_name": "root",
    30. 
   
  
  
  30.  "account_pass": "root",
    31. 
   
  
  
  31.  "account_mail": "box@cdxwcx.com",
    32. 
   
  
  
  32.  "site_name": "Drupal 7",
    33. 
   
  
  
  33.  "site_mail": "box@cdxwcx.com",
    34. 
   
  
  
  34.  "vhost": {
    35. 
   
  
  
  35.  "document_root": "drupal7",
    36. 
   
  
  
  36.  "url": "drupal7.dev",
    37. 
   
  
  
  37.  "alias": ["www.drupal7.dev"]
    38. 
   
  
  
  38.  }
    39. 
   
  
  
  39.  }
    40. 
   
  
  
  40.  }
    41. 
   
  
  
  41.  }
    42. 
   
  
  
  42. }
    43.

这是一个漂亮的、复杂的 JSON 文件，有几层结构，如：

  
 
 
    
   
  
  
  1. <>.vdd.sites.drupal8.account_name
    2.

和一些列表，如：

  
 
 
    
   
  
  
  1. <>.vm.synced_folders
    2.

这里，<> 代表未命名的顶层。让我们看看 Groovy 是如何处理的。

用 Groovy 解析 JSON

Groovy 自带的 groovy.json 包，里面有各种很酷的东西。其中最好的部分是 JsonSlurper 类，它包括几个 parse() 方法，可以将 JSON 转换为 Groovy 的 Map，一种根据键值存储的数据结构。

下面是一个简短的 Groovy 程序，名为 config1.groovy，它创建了一个 JsonSlurper 实例，然后调用其中的 parse() 方法来解析文件中的 JSON，并将其转换名为 config 的 Map 实例，最后将该 map 输出：

  
 
 
    
   
  
  
  1. import groovy.json.JsonSlurper
    2. 
   
  
  
  2. 
   
  
  
  3. def jsonSlurper = new JsonSlurper()
    4. 
   
  
  
  4. 
   
  
  
  5. def config = jsonSlurper.parse(new File('config.json'))
    6. 
   
  
  
  6. 
   
  
  
  7. println "config = $config"
    8.

在终端的命令行上运行这个程序：

  
 
 
    
   
  
  
  1. $ groovy config1.groovy
    2. 
   
  
  
  2. 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@cdxwcx.com, site_name:Drupal 8, site_mail:box@cdxwcx.com, vhost:[document_root:drupal8, url:drupal8.dev, alias:[www.drupal8.dev]]], drupal7:[account_name:root, account_pass:root, account_mail:box@cdxwcx.com, site_name:Drupal 7, site_mail:box@cdxwcx.com, vhost:[document_root:drupal7, url:drupal7.dev, alias:[www.drupal7.dev]]]]]]
    3. 
   
  
  
  3. $
    4.

输出显示了一个有两个键的顶层映射：vm 和 vdd。每个键都引用了它自己的值的映射。注意 forwarded_ports 键所引用的空列表。

这很容易，但它所做的只是把东西打印出来。你是如何获得各种组件的呢？下面是另一个程序，显示如何访问存储在 config.vm.ip 的值：

  
 
 
    
   
  
  
  1. import groovy.json.JsonSlurper
    2. 
   
  
  
  2. 
   
  
  
  3. def jsonSlurper = new JsonSlurper()
    4. 
   
  
  
  4. 
   
  
  
  5. def config = jsonSlurper.parse(new File('config.json'))
    6. 
   
  
  
  6. 
   
  
  
  7. println "config.vm.ip = ${config.vm.ip}"
    8.

运行它：

  
 
 
    
   
  
  
  1. $ groovy config2.groovy
    2. 
   
  
  
  2. config.vm.ip = 192.168.44.44
    3. 
   
  
  
  3. $
    4.

是的，这也很容易。 这利用了 Groovy 速记，这意味着：

  
 
 
    
   
  
  
  1. config.vm.ip
    2.

在 Groovy 中等同于：

  
 
 
    
   
  
  
  1. config['vm']['ip']
    2.

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

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

仅仅是处理 JSON 就这么多了。如果你想有一个标准的配置并让用户覆盖它呢？在这种情况下，你可能想在程序中硬编码一个 JSON 配置，然后读取用户配置并覆盖任何标准配置的设置。

假设上面的配置是标准的，而用户只想覆盖其中的一点，只想覆盖 vm 结构中的 ip 和 memory 值，并把它放在 userConfig.json 文件中:

  
 
 
    
   
  
  
  1. {
    2. 
   
  
  
  2.  "vm": {
    3. 
   
  
  
  3.  "ip": "201.201.201.201",
    4. 
   
  
  
  4.  "memory": "4096",
    5. 
   
  
  
  5.  }
    6. 
   
  
  
  6. }
    7.

你可以用这个程序来做：

  
 
 
    
   
  
  
  1. import groovy.json.JsonSlurper
    2. 
   
  
  
  2. 
   
  
  
  3. def jsonSlurper = new JsonSlurper()
    4. 
   
  
  
  4. 
   
  
  
  5. // 使用 parseText() 来解析一个字符串，而不是从文件中读取。
    6. 
   
  
  
  6. // 这给了我们一个“标准配置”
    7. 
   
  
  
  7. def standardConfig = jsonSlurper.parseText("""
    8. 
   
  
  
  8. {
    9. 
   
  
  
  9.  "vm": {
    10. 
   
  
  
  10.  "ip": "192.168.44.44",
    11. 
   
  
  
  11.  "memory": "1024",
    12. 
   
  
  
  12.  "synced_folders": [
    13. 
   
  
  
  13.  {
    14. 
   
  
  
  14.  "host_path": "data/",
    15. 
   
  
  
  15.  "guest_path": "/var/www",
    16. 
   
  
  
  16.  "type": "default"
    17. 
   
  
  
  17.  }
    18. 
   
  
  
  18.  ],
    19. 
   
  
  
  19.  "forwarded_ports": []
    20. 
   
  
  
  20.  },
    21. 
   
  
  
  21.  "vdd": {
    22. 
   
  
  
  22.  "sites": {
    23. 
   
  
  
  23.  "drupal8": {
    24. 
   
  
  
  24.  "account_name": "root",
    25. 
   
  
  
  25.  "account_pass": "root",
    26. 
   
  
  
  26.  "account_mail": "box@cdxwcx.com",
    27. 
   
  
  
  27.  "site_name": "Drupal 8",
    28. 
   
  
  
  28.  "site_mail": "box@cdxwcx.com",
    29. 
   
  
  
  29.  "vhost": {
    30. 
   
  
  
  30.  "document_root": "drupal8",
    31. 
   
  
  
  31.  "url": "drupal8.dev",
    32. 
   
  
  
  32.  "alias": ["www.drupal8.dev"]
    33. 
   
  
  
  33.  }
    34. 
   
  
  
  34.  },
    35. 
   
  
  
  35.  "drupal7": {
    36. 
   
  
  
  36.  "account_name": "root",
    37. 
   
  
  
  37.  "account_pass": "root",
    38. 
   
  
  
  38.  "account_mail": "box@cdxwcx.com",
    39. 
   
  
  
  39.  "site_name": "Drupal 7",
    40. 
   
  
  
  40.  "site_mail": "box@cdxwcx.com",
    41. 
   
  
  
  41.  "vhost": {
    42. 
   
  
  
  42.  "document_root": "drupal7",
    43. 
   
  
  
  43.  "url": "drupal7.dev",
    44. 
   
  
  
  44.  "alias": ["www.drupal7.dev"]
    45. 
   
  
  
  45.  }
    46. 
   
  
  
  46.  }
    47. 
   
  
  
  47.  }
    48. 
   
  
  
  48.  }
    49. 
   
  
  
  49. }
    50. 
   
  
  
  50. """)
    51. 
   
  
  
  51. 
   
  
  
  52. // 打印标准配置
    53. 
   
  
  
  53. println "standardConfig = $standardConfig"
    54. 
   
  
  
  54. 
   
  
  
  55. //读入并解析用户配置信息
    56. 
   
  
  
  56. def userConfig = jsonSlurper.parse(new File('userConfig.json'))
    57. 
   
  
  
  57. 
   
  
  
  58. // 打印出用户配置信息
    59. 
   
  
  
  59. println "userConfig = $userConfig"
    60. 
   
  
  
  60. 
   
  
  
  61. // 一个将用户配置与标准配置合并的函数
    62. 
   
  
  
  62. def mergeMaps(Map input, Map merge) {
    63. 
   
  
  
  63.  merge.each { k, v ->
    64. 
   
  
  
  64.  if (v instanceof Map)
    65. 
   
  
  
  65.  mergeMaps(input[k], v)
    66. 
   
  
  
  66.  else
    67. 
   
  
  
  67.  input[k] = v
    68. 
   
  
  
  68.  }
    69. 
   
  
  
  69. }
    70. 
   
  
  
  70. 
   
  
  
  71. // 合并配置并打印出修改后的标准配置
    72. 
   
  
  
  72. mergeMaps(standardConfig, userConfig)
    73. 
   
  
  
  73. 
   
  
  
  74. println "modified standardConfig $standardConfig"
    75.

以下列方式运行：

  
 
 
    
   
  
  
  1. $ groovy config3.groovy
    2. 
   
  
  
  2. 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@cdxwcx.com, site_name:Drupal 8, site_mail:box@cdxwcx.com, vhost:[document_root:drupal8, url:drupal8.dev, alias:[www.drupal8.dev]]], drupal7:[account_name:root, account_pass:root, account_mail:box@cdxwcx.com, site_name:Drupal 7, site_mail:box@cdxwcx.com, vhost:[document_root:drupal7, url:drupal7.dev, alias:[www.drupal7.dev]]]]]]
    3. 
   
  
  
  3. userConfig = [vm:[ip:201.201.201.201, memory:4096]]
    4. 
   
  
  
  4. 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@cdxwcx.com, site_name:Drupal 8, site_mail:box@cdxwcx.com, vhost:[document_root:drupal8, url:drupal8.dev, alias:[www.drupal8.dev]]], drupal7:[account_name:root, account_pass:root, account_mail:box@cdxwcx.com, site_name:Drupal 7, site_mail:box@cdxwcx.com, vhost:[document_root:drupal7, url:drupal7.dev, alias:[www.drupal7.dev]]]]]]
    5. 
   
  
  
  5. $
    6.

以 modified standardConfig 开头的一行显示，vm.ip and vm.memory 的值被覆盖了。

眼尖的读者会注意到，我没有检查畸形的 JSON，也没有仔细确保用户的配置是有意义的（不创建新字段，提供合理的值，等等）。所以用这个递归方法来合并两个映射在现实中可能并不那么实用。

好吧，我必须为家庭作业留下 一些 东西，不是吗？

Groovy 资源

Apache Groovy 网站有很多很棒的 文档。另一个很棒的 Groovy 资源是 Mr. Haki。学习 Groovy 的一个非常好的理由是继续学习 Grails，它是一个非常高效的全栈 Web 框架，建立在 Hibernate、Spring Boot 和 Micronaut 等优秀组件之上。

新闻名称：用Groovy解析JSON配置文件
本文地址：http://www.gawzjz.com/qtweb2/news10/16310.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

商城网站知识

行业网站建设

成都定制网站　　 　成都网站建设　　 　虚拟主机　　 　免备案虚拟主机空间　　 　成都网站制作　　 　绵阳网站制作公司　　 　成都主机托管　　 　四川锦华橡塑　　 　蓬溪网站建设　　 　搜索引擎优化　　 　自动门　　 　网站SEO优化　　 　工业净化空调　　 　清舞人间　　 　力比特机械　　 　成都网站设计　　 　成都网站改版公司　　 　重庆网站建设　　 　企业营销型网站　　 　遂宁网站建设