Typesafe加载HOCON为实体类详解

 

一.HOCON

---

简介

HOCON(Human-Optimized Config Object Notation)：人性化配置对象表示法，是一种人类可读（百度百科这样翻译的，名字的确挺怪的）的数据格式，由Lightbend公司（代表项目有scala、play framework）主导的项目，并是JSON和properties的一个超集，意思就是说完全兼容JSON和properties格式的文件，但是除此之外还提供了更加强大的功能。自我感觉在配置文件方面是非常完善的，特被是在大中型项目中优势非常明显。

---

特点

1. 完全兼容json和properties，是他们的超集
2. 可以写注释
3. 可以使用变量和引用
4. 可以继承

5. 自动类型转换等

// json写法
a: {
  b: {
    c: "value" # ":"或者"="都可以
  }
}
// properties写法
a.b.c="value"

test {a = "a", b = "b"}
# 直接引用test上面定义的test变量
test1: {a: ${test.a}, b: ${test.b}, c: ${test}}

// 继承
include "test.conf"

// key重复则覆盖默认值
test = "test"

---

语法

基本语法

HOCON的语法我们可以查看HOCON官方文档

---

常用数据格式举例

demo {
  name = "tom"
  age = 18
  men = true
  // list类型
  address = [
    "address1"
    "address2"
    "address3"
  ]
  // map类型
  family {
    mather = "mather"
    father = "father"
  }
}

---

二.Typesafe

---

1.简介

加载管理项目中的配置文件的jar包

• 它使文件配置模块化，易于管理
• 支持Java系统属性、JSON和HOCON
• 可以从不同的位置加载资源：文件，URL，类路径。它支持类型，加载约定，替换，属性合并等

---

2.Jar包

1.2.1版和更早版本是针对Java 6构建的，而较新的版本（1.3.0及更高版本）将针对Java 8构建

maven

<dependency>
    <groupId>com.typesafe</groupId>
    <artifactId>config</artifactId>
    <version>1.4.0</version>
</dependency>

gradle

implementation "com.typesafe:config:1.4.0"

 

---

3.使用

---

最简单的例子

使用ConfigFactory.load()将加载配置文件的优先顺序：

• system properties （例如：-Dconfig.file=path/to/config-file）
• application.conf （具有该名称的classpath上的所有资源）
• application.json （具有该名称的classpath上的所有资源）
• application.properties （具有该名称的classpath上的所有资源）
• reference.conf （具有该名称的classpath上的所有资源）

那么首先我们需要创建一个xxx.conf的文件放到classPath下，正常来说也就是放到我们java项目目录中的src.main.resources下（此次我们选用application.conf），conf的内容使用文章上面的“常用数据格式举例”

代码：

public void loadConf01() {
        Config conf = ConfigFactory.load();
        String name = conf.getString("demo.name");
        List<String> address = conf.getStringList("demo.address");
        ConfigObject family = conf.getObject("demo.family");

        System.out.println("The name is:" + name);
        address.forEach(v -> System.out.println("address:" + v));
        family.forEach((k,v) -> System.out.println("Key:" + k + ", Value:" + v));
    }

结果：

The name is:tom
address:address1
address:address2
address:address3
Key:father, Value:Quoted("father")
Key:mather, Value:Quoted("mather")

---

加载指定位置的配置文件

我们加载放在项目config文件夹下的app.conf

demo {
  name = "Jerry"
  age = 21
  men = false
  // list类型
  address = [
    "address4"
    "address5"
    "address6"
  ]
  // map类型
  family {
    mather = "sister"
    father = "brother"
  }
}

ConfigFactory.parseFile(new File("./config/app.conf"));

ConfigFactory.load和ConfFactory.parseFile有多种的加载方式，比如前者可以选择ClassLoader，后者可以选择ConfigParseOptions等

---

转换为实体类（bean）

// 总的实体类
public class AppConfig {
    private Demo demo;

    public Demo getDemo() {
        return demo;
    }

    public void setDemo(Demo demo) {
        this.demo = demo;
    }
}

// 上面配置文件的Demo
public class Demo {
    private String name;
    private int age;
    private boolean men;
    // list类型
    private List<String> address;
    // map类型
    private Map<String, Object> family;

    /*
     * 省略set and get
     */
}

// 加载放在Config下面的app.conf文件
public void loadConf02() {
        Config config = ConfigFactory.parseFile(new File("./config/app.conf"));

        AppConfig appConfig = ConfigBeanFactory.create(config, AppConfig.class);
        String name = appConfig.getDemo().getName();
        System.out.println("Name:" + name);
    }

结果：

Name:Jerry

BUILD SUCCESSFUL in 28s

---

完整代码

github中的typesafe-test