golang整洁之道（一）

2024年4月13日 330次阅读 来源: Mandelbrot_Kobe

设计工整的go项目配置文件

问题背景

  • 项目经常会涉及到配置文件，而配置文件往往包含多方的配置信息，可能同时涉及到MySQL，kafka，hive，hdfs等等。

不加思索的yaml配置文件

  • 最快，最直接的方案自然是如下示例，直接写

  1. yaml部分

    hdfs_path: "/user/hive/warehouse/dm_user.db/user_vod_time/create_time="
hdfs_host: "hdfsNode9"
hdfs_port: "8020"
eth_host: "http://127.0.0.1"
eth_port: "8545"
coin_password: "password"

  2. golang部分

    package config

type config struct{
    HDFSPath string `yaml:"hdfs_path"`
    HDFSHost string `yaml:"hdfs_host"`
    HDFSPort string `yaml:"hdfs_port"`
    EthHost string `yaml:"eth_host"`
    EthPort string `yaml:"eth_port"`
    EthCoinPassword string `yaml:"coin_password"`
}

这个方案存在什么问题

  1. 没有条理，虽然在命名方面可以看出来对应的各个部分的配置，但是不够清晰。假如项目规模增大，配置文件内容看上去就是一大坨
  2. 每一个包，可能需要再额外定义一个类似的结构，保存相应的配置，造成代码的冗余。毕竟，以上边这个例子来说，HDFS的处理跟ETH的处理不可能放在一个package里，那对应的包要不要再定义一个数据结构，保存配置数据呢？

更加清晰的yaml配置文件

  • 利用golang struct的组合特性，就可以让结构更加清晰，减少代码冗余

  1. yaml文件

    hdfs: {
    path: "/user/hive/warehouse/dm_user.db/user_vod_time/create_time=",
    host: "hdfsNode9",
    port: "8020"
}
eth: {
    host: "http://127.0.0.1",
    port: "8545",
    coin_password: "password",
}

  2. golang 文件——config包

    type config struct {
    hdfs.HDFSConfig `yaml:"hdfs"`
    eth.EthConfig `yaml:"eth"`
}

  3. golang文件——eth包

    type EthConfig struct {
    EthHost string `yaml:"host"`
    EthPort string `yaml:"port"`
    EthCoinPassword string `yaml:"coin_password"`
}

  4. golang文件——hdfs包

    type HDFSConfig struct {
    HDFSPath string `yaml:"path"`
    HDFSHost string `yaml:"host"`
    HDFSPort string `yaml:"port"`
}

总结

  • 整个配置文件和代码结构，重构之后瞬间清晰了很多。用代码实现需求通常不难，大部分时候都有别人写好的接口，直接调用就可以。但是要想写好golang，让结构清晰，代码健壮，接下来还需要花很多功夫。（借助struct的组合，常常可以让代码结构更加清晰）
    原文作者：Mandelbrot_Kobe
    原文地址: https://segmentfault.com/a/1190000018404000
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞