以人为本之 hocon 配置

hocon 配置文件是什么？

HOCON（Human-Optimized Config Object Notation）是一种配置文件格式，它旨在提供一种人类可读和可编辑的配置数据表达方式。

HOCON是Typesafe（Lightbend）公司开发的，现在由Lightbend Config Library支持。它被设计为易于人类阅读和编写，同时也易于机器解析和生成。

HOCON配置文件的特点：

•简洁性：HOCON的语法简洁，避免了不必要的复杂性，使得配置文件更加清晰。•JSON兼容：HOCON与JSON兼容，这意味着任何有效的JSON文件也是有效的HOCON文件。•注释支持：HOCON支持单行和多行注释，使得配置文件的可读性和可维护性得到提升。•包含机制：HOCON允许包含其他配置文件，这有助于重用配置片段，提高配置的可维护性。•替换机制：HOCON支持变量替换，允许在配置文件中定义变量并在其他地方引用它们。•数据合并：HOCON允许合并来自不同源的配置数据，这在处理不同环境的配置时非常有用。•路径表达式：HOCON支持路径表达式，可以方便地引用和操作配置文件中的特定部分。•类型安全：HOCON提供了基本的类型安全，包括整数、浮点数、布尔值和字符串。

HOCON配置文件的语法元素：

•对象：由大括号{}包围，包含键值对。•数组：由方括号[]包围，包含一系列值。•键值对：由键和值组成，键和值之间用冒号:分隔。•注释：以#开始的单行注释，或以/*开始以*/结束的多行注释。

使用场景：

HOCON通常用于配置服务和应用程序，特别是在以下场景中：

•微服务架构：在微服务架构中，HOCON可以用于服务的配置管理。•分布式系统：在分布式系统中，HOCON可以用于不同节点的配置同步。•开发和生产环境：HOCON支持环境特定的配置，方便在不同环境之间切换。

hocon 常见例子

HOCON（Human-Optimized Config Object Notation）配置文件的使用非常灵活，它支持多种特性，如变量替换、文件包含、注释等。

以下是一些常见的示例：

基本语法

HOCON文件由键值对组成，键和值之间用冒号分隔，对象用大括号{}包围。

key: value

对象和嵌套

可以创建嵌套的对象来组织配置。

database { host: "localhost" port: 5432 user: "dbuser" password: "dbpassword"}

数组

HOCON支持数组，数组中的元素用逗号分隔。

servers: ["server1.example.com", "server2.example.com"]

变量替换

可以在配置文件中定义变量，并在其他部分引用这些变量。

{ dbHost: "localhost" db { host: ${dbHost} port: 5432 }}

包含其他文件

HOCON允许包含其他配置文件，这有助于重用配置片段。

include "db.conf" // 包含名为db.conf的文件

路径表达式

可以使用路径表达式来引用配置值。

{ db: ${database} database: "prod-db"}

默认值

可以为配置项设置默认值。

{ timeout: ${?TIMEOUT:30s}}

在上面的例子中，如果环境变量TIMEOUT没有被设置，timeout将默认为30s。

条件包含

HOCON支持根据条件包含配置。

{ profiles: ["dev", "prod"] ${profiles} { dev { db { connection-timeout: 5s } } prod { db { connection-timeout: 10s } } }}

复杂数据类型

HOCON支持更复杂的数据类型，如列表和嵌套对象。

features { enabled: ["feature1", "feature2"] disabled: ["feature3"]}

导入系统环境变量

HOCON可以导入系统环境变量。

{ import sys.env.HOME as homeDirectory}

使用示例

假设有一个应用程序需要连接到数据库，并且根据运行环境的不同（开发、测试、生产）使用不同的配置。

HOCON配置文件可以这样组织：

{ application { name: "MyApp" environment: dev // 默认环境，也可以通过系统属性或环境变量覆盖 } db { host: "localhost" port: 5432 user: "user" password: "pass" }}

include "${application.environment}.conf" // 根据环境变量包含不同的配置文件

对应的dev.conf可能包含开发环境特有的配置：

{ db { user: "devuser" password: "devpass" } application { port: 8080 }}

java 如何解析 hocon 配置？

在Java中解析和处理HOCON配置文件，通常可以通过以下几种方式实现：

使用Lightbend Config库

Lightbend Config（之前称为Typesafe Config）是一个强大且灵活的库，用于处理HOCON配置文件。

以下是使用Lightbend Config库的基本步骤：

1.

添加依赖：在你的项目中添加Lightbend Config库的依赖。如果你使用Maven，可以在pom.xml文件中添加如下依赖项：

<groupId>com.typesafe</groupId> <artifactId>config</artifactId> <version>1.4.1</version> <!-- 请使用最新版本 -->

2.

读取配置文件：使用ConfigFactory来加载配置文件，并使用Config对象来访问配置值。

import com.typesafe.config.Config;import com.typesafe.config.ConfigFactory;

public class HoconConfigExample { public static void main(String[] args) { // 加载默认的HOCON配置文件（通常是application.conf） Config config = ConfigFactory.load();

// 读取配置项 String dbUser = config.getString("productDatabase.user"); String dbPassword = config.getString("productDatabase.password"); // ... 其他配置项 }}

使用Jackson库结合HOCON模块

除了Lightbend Config库，还可以使用Jackson库结合HOCON模块来解析HOCON文件：

1.

添加依赖：在项目中添加Jackson核心库和HOCON模块的依赖。

<groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.13.0</version> <!-- 使用最新版本 --> <groupId>com.fasterxml.jackson.dataformat</groupId> <artifactId>jackson-dataformat-hocon</artifactId> <version>2.13.0</version> <!-- 使用最新版本 -->

2.

解析HOCON文件：使用ObjectMapper结合HoconFactory来读取和解析HOCON文件。

import com.fasterxml.jackson.databind.ObjectMapper;import com.fasterxml.jackson.dataformat.hocon.HoconFactory;import com.typesafe.config.Config;import java.io.File;import java.io.IOException;

public class HoconParserExample { public static void main(String[] args) { try { ObjectMapper mapper = new ObjectMapper(new HoconFactory()); Config config = mapper.readValue(new File("application.hcl"), Config.class);

// 读取配置项 String value = config.getString("key"); // ... 其他配置项 } catch (IOException e) { e.printStackTrace(); } }}

使用Hutool库

Hutool是一个小型工具类库，也提供了对HOCON格式的支持：

1.

添加依赖：在项目中添加Hutool库的依赖。

<groupId>cn.hutool</groupId> <artifactId>hutool-setting</artifactId> <version>5.7.16</version> <!-- 使用最新版本 -->

2.

读取配置文件：使用HoconSetting来加载和读取HOCON配置文件。

import cn.hutool.setting.dialect.HoconSetting;

public class HutoolHoconExample { public static void main(String[] args) { // 创建HoconSetting对象并加载配置文件 HoconSetting setting = new HoconSetting("config.hcl");

// 读取配置项 String value = setting.getByGroup("group").getStr("key"); // ... 其他配置项 }}

以上是几种在Java中解析和处理HOCON配置文件的方法。

开发者可以根据项目需求和个人偏好选择合适的库来实现配置文件的读取和管理。

hocon 为何如此设计？有何优缺点？

HOCON（Human-Optimized Config Object Notation）配置文件格式的设计初衷是为了提供一个易于人类读写的配置数据格式。

它被设计为一种面向对象风格的配置语言，旨在改善传统配置文件格式（如.properties文件）的一些限制。

以下是HOCON设计的一些原因和它的优缺点：

设计原因：

•易读性：HOCON被设计为易于阅读和编写，采用直观的语法，使得配置文件更加清晰易懂。•面向对象风格：HOCON支持面向对象的配置结构，可以定义嵌套对象和数组，使得配置更加结构化。•兼容性：HOCON与JSON兼容，这意味着任何有效的JSON文件也是有效的HOCON文件，这增加了它的通用性和灵活性。•包含和替换：HOCON支持包含其他配置文件和替换配置值，这有助于重用配置片段，提高配置的可维护性。•环境适应性：HOCON可以轻松地适应不同环境的配置需求，通过简单的语法来覆盖特定环境的配置项。•错误友好：HOCON设计了更友好的错误消息，帮助开发者快速定位配置错误。

优点：

•简洁性：HOCON的语法简洁，避免了不必要的复杂性，使得配置文件更加清晰。•表达能力强：支持复杂的数据结构，如列表、字典、嵌套结构等，能够满足各种类型的配置需求。•易于维护：通过模块化和引用机制，HOCON支持配置的重用和组合，简化了配置管理。•灵活的格式：支持注释、条件包含等，使得配置文件更加灵活和可配置。•与工具集成：HOCON被设计为与特定的工具和框架（如Lightbend Config和Akka）集成，提高了这些工具的可用性。

缺点：

•社区和生态系统：相比于更通用的配置文件格式如JSON或YAML，HOCON的社区和生态系统较小。•学习和迁移成本：对于已经习惯于其他配置文件格式的用户，学习和迁移到HOCON可能需要额外的时间和成本。•解析和处理：在某些编程环境中，可能缺乏直接支持HOCON的库，需要额外的工作来解析和处理HOCON文件。•复杂性：虽然HOCON旨在提高易读性，但其面向对象的风格和高级功能可能会增加配置文件的复杂性，特别是对于简单的用例。

小结

总的来说，HOCON的设计是为了提供一个更人性化、更灵活且功能丰富的配置文件格式，它特别适合需要高度可配置性和可维护性的现代应用程序。

个人比较喜欢这个配置文件，接触到的 apache seatunnel 就是使用的这个配置方式，非常的灵活。