解决Go中循环依赖的最佳做法

时间:2019-03-03 05:53:39

标签: go circular-dependency

我有一个包含两个软件包的Go项目:

  • logging
    导入config,因为我想将当前配置发送到我的错误报告系统
  • config
    导入logging,因为我想记录程序是否无法打开配置文件

解决此依赖性错误的最佳实践是什么?

1 个答案:

答案 0 :(得分:1)

您以什么格式将配置发送到错误报告系统?也许将其传递给日志记录?例如,如果它是json,则在将配置送给日志记录之前先将其封送,然后仅给日志记录[]byte结果。

但是,通常,如果两个包直接相互依赖,您可以做的就是让其中一个声明一个与另一个人的行为匹配的接口,然后让一个单独的包将具体实例作为接口传递。

例如:

/myapp/config

import "myapp/logging"

type Config struct {
     // ...
}

func NewConfig() *Config {
    // ...
    if err != nil {
        logging.LogError(err)
    }
}

/myapp/logging

import "myapp/config"

func LogConfig(c *config.Config) {
    // ...
}

func LogError(err error) {
    // ...
}

因此,在这种情况下,您可以在config包中声明一个接口,该接口与其从日志记录中需要的行为相匹配。

/myapp/config

type Logging interface {
    LogError(error)
}

var logging Logging

func SetLogging(l Logging) {
    logging = l
}

type Config struct {
     // ...
}

func NewConfig() *Config {
    // ...
    if err != nil {
        logging.LogError(err)
    }
}

然后在日志记录程序包中有一个类型,只需委托原始功能即可实现该接口。

/myapp/logging

import "myapp/config"

func LogConfig(c *config.Config) {
    // ...
}

func LogError(err error) {
    // ...
}

type Logging struct{}

func (Logging) LogError(err error) {
    LogError(err)
}

最后还有第三个程序包使它们一起工作。

/myapp

import "myapp/config"
import "myapp/logging"

func init() {
    config.SetLogging(logging.Logging{})
}