依赖注入(Dependency injection)
依赖注入和控制反转恰恰相反,它是一种具体的编码技巧。我们不通过 new 的方式在类内部创建依赖类的对象,而是将依赖的类对象在外部创建好之后,通过构造函数、函数参数等方式传递(或注入)给类来使用。
DI
(依赖性注入)是一种技术,当你的模块间接地接受依赖性。他们不知道依赖的实现,只知道接口。
我们为什么需要它?
DI
可以帮助我们编写低耦合的代码。这意味着你将能够随时交换你的代码,并有助于重用它们的一些部分。
在写单元测试时,使用 mock 方式注入是一个非常好的实践。
参考代码
我们有一个小小的项目:main.go 和 两个服务--日志和缓存
├───cmd │ └───main.go └───services ├───logger │ └───logger.go └───cache └───cache.go
它们是如何工作的?我们有一个缓存服务,如果你想把一些东西存储在像Redis
这样的快速存储中,就可以使用它。
// cache.go import ( "fmt" "sync" ) // 将被注入的记录器服务的接口,用小写的方式来隐藏出口,是一个好的方式。 type logger interface { Error(error) Info(string) } type Cache struct { logger logger m *sync.Map } // NewCache 我们服务的构造函数,接收将被注入的服务的接口(我们可以注入几个服务),并返回结构(缓存的实例)。 func NewCache(logger logger) *Cache { return &Cache{ logger: logger, m: new(sync.Map), } } func (r *Cache) Get(key string) (string, error) { rawValue, ok := r.m.Load(key) if !ok { err := fmt.Errorf("not found: %s", key) r.logger.Error(err) return "", err } return rawValue.(string), nil } func (r *Cache) Set(key string, data []byte) { r.m.Store(key, data) r.logger.Info(fmt.Sprintf("store key: %s", key)) }
日志服务用来对日志的持久化存储以及分析
// logger.go import "fmt" type sentryClient interface { sendMessage(interface{}) } type NormalSentryClient struct{} func (s *NormalSentryClient) sendMessage(i interface{}) { fmt.Printf("send message %+v to sentry\n", i) } type Logger struct { sentry sentryClient } func NewLogger(sentryClient sentryClient) *Logger { return &Logger{ sentry: sentryClient, } } // 我们看到这里有四个方法,但是 cache 对象只能看到两个:Error 以及 Info func (l *Logger) Error(e error) { fmt.Printf("[ERROR] %+v\n", e) } func (l *Logger) Info(msg string) { fmt.Printf("[INFO] %s\n", msg) } func (l *Logger) Debug(msg string) { fmt.Printf("[DEBUG] %s\n", msg) } func (l *Logger) Log(msg string) { fmt.Printf("[LOG] %s\n", msg) }
// main.go func main() { // 注册服务 sentryService := new(logger.NormalSentryClient) loggerService := logger.NewLogger(sentryService) cacheService := cache.NewCache(loggerService) cacheService.Set("test", []byte("test")) cacheService.Get("test1") }
输出:
[INFO] store key: test [ERROR] not found: test1
golang DI 开源库
- inject:基于反射,运行时注入。但是已经不维护了。
- wire:AST,编译期注入。
- dig,Fx:基于反射,运行时注入。
附录: