  [nginx]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
worker_processes  1;

events {
    worker_connections  1024;
}

http {
    include       mime.types;
    default_type  application/octet-stream;

    sendfile        on;
    keepalive_timeout  65;

    server {
        listen       80;
        server_name  localhost;

        location / {
            root   html;
            index  index.html index.htm;
        }

        error_page   500 502 503 504  /50x.html;
        location = /50x.html {
            root   html;
        }
    }
}

在这个示例中，worker_processes、events、http 和 server 等都是块指令，而 listen、server_name、location 等是普通指令。

相比之下，HOCON（Human-Optimized Config Object Notation）是一种用于配置文件的格式，主要用于配置基于 JVM 的应用程序，如 Akka、Play Framework 等。

HOCON 具有更复杂和灵活的语法，支持嵌套结构、对象、数组等。

下面是一个 HOCON 配置示例：

  [hocon]
1
2
3
4
5
6
7
8
9
10
11
12
13
application {
  name = "MyApp"
  version = "1.0.0"
  http {
    host = "localhost"
    port = 8080
  }
  database {
    url = "jdbc:mysql://localhost:3306/mydb"
    user = "dbuser"
    password = "dbpassword"
  }
}

可以看到，HOCON 的语法和 Nginx 的配置语法有很大的不同。

因此，Nginx 的配置文件并不是 HOCON 格式的，它有自己专门的配置格式。

Q2: 可以把你给的 nginx 配置例子，改成 hocon 格式的吗

将 Nginx 配置文件转换为 HOCON 格式涉及到将 Nginx 的指令和块转换为 HOCON 支持的键值对和嵌套结构。

以下是如何将上面示例的 Nginx 配置文件转换为类似 HOCON 的格式，但请注意，这只是一个结构上的转换，实际上 Nginx 并不支持 HOCON 格式的配置文件。

  [hocon]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
nginx {
  worker_processes = 1

  events {
    worker_connections = 1024
  }

  http {
    include = "mime.types"
    default_type = "application/octet-stream"
    sendfile = "on"
    keepalive_timeout = 65

    server {
      listen = 80
      server_name = "localhost"

      location_root {
        root = "html"
        index = ["index.html", "index.htm"]
      }

      error_page {
        code = [500, 502, 503, 504]
        page = "/50x.html"
        location {
          root = "html"
        }
      }
    }
  }
}

在这个示例中：

使用嵌套结构来表示 Nginx 配置中的块，例如 events 和 http。
将指令转换为键值对，例如 worker_processes = 1。
将数组值表示为 HOCON 数组，例如 index = ["index.html", "index.htm"]。
为了示例的完整性，error_page 里面的 code 和 page 分开写，表示多个错误代码使用相同的错误页面。

请记住，这只是一个理论上的转换，实际使用中，Nginx 不支持 HOCON 格式的配置文件，因此这个 HOCON 配置文件不能直接用于配置 Nginx 服务器。

这个示例仅用于展示如何将配置内容结构化为 HOCON 格式。

Q3: 我们自己设计文件格式，应该使用什么格式

老马这里，首先对配置文件做了统一的 java 抽象：

  [java]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
/**
 * 用户配置
 *
 * @since 0.12.0
 * @author 老马啸西风
 */
public class NginxUserConfig {

    // 全局配置
    private String httpPid;


    /**
     * 全部的 server 配置列表
     *
     * @since 0.12.0
     */
    private List<NginxUserServerConfig> serverConfigList;

    /**
     * 服务器端口
     */
    private Set<Integer> serverPortSet;

    /**
     * 当前的服务端口
     */
    private Integer currentServerPort;

    /**
     * 当前的 server 配置 map
     */
    private Map<String, List<NginxUserServerConfig>> currentServerConfigMap;

    /**
     * 默认的服务配置
     * @since 0.14.0
     */
    private NginxUserServerConfig defaultUserServerConfig;

    // 示意图...

}

定义配置解析的接口：

  [java]
1
2
3
4
5
6
7
8
9
10
public interface INginxUserConfigLoader {

    /**
     * 加载
     * @return 结果
     *
     * */
    NginxUserConfig load();

}

然后默认实现了 nginx.conf 标准格式的解析处理类：

  [java]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
public  class NginxUserConfigLoaderConfigFile extends AbstractNginxUserConfigLoader {

    private final String filePath;

    public NginxUserConfigLoaderConfigFile(String filePath) {
        this.filePath = filePath;
    }

    // 其他省略实现...

    @Override
    protected NginxUserConfig doLoad() {
        NgxConfig conf = null;
        try {
            NginxUserConfigBs configBs = NginxUserConfigBs.newInstance();
            conf = NgxConfig.read(filePath);

            //1. basic
            fillBasicInfo(configBs, conf);

            //2. server 信息
            fillServerInfo(configBs, conf);

            // 返回
            return configBs.build();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

}

小结

这篇文章我们一起讨论了如何为 nginx 设计一套配置实现。

开始老马以为 nginx.conf 比较接近 hocon 的文件格式，后来发现并不是。

所以还是决定抽象为标准的 pojo，这样一者便于使用，再者后续用户可以根据自己的需要拓展为 yaml 等其他格式的配置。

我是老马，期待与你的下次重逢。

开源地址

为了便于大家学习，已经将 nginx 开源

https://github.com/houbb/nginx4j

参考资料

前言
- 手写 nginx 系列
- 配置相关
目标
Q1: nginx.conf 是 hocon 格式的吗？
Q2: 可以把你给的 nginx 配置例子，改成 hocon 格式的吗
Q3: 我们自己设计文件格式，应该使用什么格式
小结
开源地址
参考资料

从零手写实现 nginx-14-nginx.conf 是 HOCON 的格式吗？

前言

手写 nginx 系列

配置相关

目标

Q1: nginx.conf 是 hocon 格式的吗？

Q2: 可以把你给的 nginx 配置例子，改成 hocon 格式的吗

Q3: 我们自己设计文件格式，应该使用什么格式

小结

开源地址

参考资料

更多学习