首页 > 解决方案 > 第三方配置结构的封装

问题描述

我正在开发一个 Go 项目,我正在利用一些相当大的第三方客户端库与一些第三方 REST API 进行通信。我的意图是将我的内部代码 API 与这些特定的依赖项分离。

在我的代码中将特定方法与这些库解耦很简单,因为我只需要功能的一个子集,并且能够抽象出用例。因此,我在我的代码中引入了一种新类型,它实现了我的特定用例;然后,底层实现依赖于第三方依赖项。

我在哪里有问题要了解如何找到一个好的解耦configuration structs。通常,我使用的客户端库提供这种形式的一些功能

createResourceA(options *ResourceAOptions) (*ResourceA, error)
createResourceB(options *ResourceBOptions) (*ResourceB, error)

where*ResourceA*ResourceB是相应资源创建后的服务器端配置。

不同options的是具有大量字段、嵌套结构等的资源的相当大的配置结构。一般来说,这些配置包含比我的应用程序所需的更多选项,但总体重叠最终相当大。

因为我想避免我的内部代码必须导入特定的依赖项才能访问我想要封装这些的配置结构。

我目前的封装方法是定义我自己的配置结构,然后我用它来配置第三方依赖项。举一个简单的例子:

import a "github.com/client-a"

// MyClient implements my use case functions
type MyClient struct{}

// MyConfiguration wraps more or less the configuration options
// provided by the client-a dependency
type MyConfiguration struct{
  Strategy StrategyType
  StrategyAOptions *StrategyAOptions
  StrategyBOptions *StrategyBOptions
}

type StrategyType int
const (
  StrategyA StrategyType = iota
  StrategyB
)

type StrategyAOptions struct{}
type StrategyBOptions struct{}


func (c *MyClient) UseCaseA(options *MyConfiguration) error {
  cfg := &a.Config{}
  if (options.Strategy = StrategyA) {
    cfg.TypeStrategy = a.TypeStrategyXY
  }
  ...
  a.CreateResourceA(cfg)
}


如示例所示,使用此方法我可以封装第三方配置结构,但我认为此解决方案不能很好地扩展。我已经遇到了一些示例,其中我基本上是从代码中的依赖项中重新实现类型,只是为了抽象出依赖项。

如果我的方法通常是错误的,我在这里寻找可能更复杂的解决方案和/或一些见解。

我的进一步研究:

我调查了一下struct embedding,如果这可以帮助我。但是,由于配置包含非平凡的成员,我最终在调用代码中导入了依赖项以填充字段。

正如通常的指导方针一样,Accept interfaces return structs我试图用这种方法找到一个好的解决方案。但是在这里我也可以得到一个相当大的接口,并且在 go 标准库配置结构中似乎没有通过接口使用。如果在接口后面隐藏配置是 Go 中的一个好习惯,我无法找到明确的声明。

把它们加起来:

我想知道如何从第三方库中抽象出配置结构,而不会最终在我的代码中重新定义相同的数据类型。

标签: gostructinterfacedependenciesdecoupling

解决方案


一个非常简单的事情——重新定义你需要在你的包装器包中的结构类型怎么样?

我很新,所以这可能不是最好的方法。

package myConfig

import a "github.com/client-a"

type aConfig a.Config

那么你只需要导入你的 myConfig 包

import "myConfig"
// myConfig.aConfig is actually a.Config
myConfig.aConfig

不确定这是否有很大帮助,因为这不是真正的解耦,但至少您不需要在每个地方都导入“github.com/client-a”


推荐阅读