依赖注入与控制反转:优化Go语言REST API客户端

在这篇文章中,我将探讨依赖注入(DI)和控制反转(IoC)是什么,以及它们的重要性。作为示例,我将使用Monibot的REST API客户端。让我们开始吧:

一个简单的客户端实现

我们从一个简单的客户端实现开始,允许调用者访问Monibot的REST API,具体来说,是为了发送指标值。客户端的实现可能如下所示:

package monibottype Client struct {
}func NewClient() *Client {return &Client{}
}func (c *Client) PostMetricValue(value int) {body := fmt.Sprintf("value=%d", value)http.Post("https://monibot.io/api/metric", []byte(body))
}

这里有一个客户端,提供了PostMetricValue方法,该方法用于将指标值上传到Monibot。我们的库的用户可能像这样使用它:

import "monibot"func main() {// 初始化API客户端client := monibot.NewClient()// 发送指标值client.PostMetricValue(42)
}

依赖注入

现在假设我们想对客户端进行单元测试。当所有HTTP发送代码都是硬编码的时候,我们如何测试客户端呢?对于每次测试运行,我们都需要一个“真实”的HTTP服务器来回答我们发送给它的所有请求。不可取!我们可以做得更好:让我们将HTTP处理作为“依赖”;让我们发明一个 Transport 接口:

package monibot// Transport传输请求。
type Transport interface {Post(url string, body []byte)
}

让我们再发明一个具体的使用HTTP作为通信协议的Transport:

package monibot// HTTPTransport是一个使用HTTP协议传输请求的Transport。
type HTTPTransport struct {
}func (t HTTPTransport) Post(url string, data []byte) {http.Post(url, data)
}

然后让我们重写客户端,使其“依赖”于一个Transport 接口:

package monibottype Client struct {transport Transport
}func NewClient(transport Transport) *Client {return &Client{transport}
}func (c *Client) PostMetricValue(value int) {body := fmt.Sprintf("value=%d", value)c.transport.Post("https://monibot.io/api/metric", []byte(body))
}

现在,客户端将请求转发到它的Transport依赖。当创建客户端时,transport(客户端的依赖项)被“注入”到客户端中。调用者可以这样初始化一个客户端:

import "monibot"func main() {// 初始化API客户端var transport monibot.HTTPTransportclient := monibot.NewClient(transport)// 发送指标值client.PostMetricValue(42)
}

单元测试

现在我们可以编写一个使用“伪造”Transport的单元测试:

// TestPostMetricValue确保客户端向REST API发送正确的POST请求。
func TestPostMetricValue(t *testing.T) {transport := &fakeTransport{}client := NewClient(transport)client.PostMetricValue(42)if len(transport.calls) != 1 {t.Fatal("期望1次传输调用,但是是%d次", len(transport.calls))}if transport.calls[0] != "POST https://monibot.io/api/metric, body=\\"value=42\\"" {t.Fatal("错误的传输调用 %q", transport.calls[0])}
}// 伪造的Transport是单元测试中使用的Transport。
type fakeTransport struct {calls []string
}func (f *fakeTransport) Post(url string, body []byte) {f.calls = append(f.calls, fmt.Sprintf("POST %v, body=%q", url, string(body)))
}

添加更多的Transport函数

现在假设我们库的其他部分,也使用了Transport功能,需要比POST更多的HTTP方法。对于它们,我们必须扩展我们的Transport接口:

package monibot// Transport传输请求。
type Transport interface {Get(url string) []byte     // 添加,因为health-monitor需要Post(url string, body []byte)Delete(url string)         // 添加,因为resource-monitor需要
}

现在我们有一个问题。编译器抱怨我们的fakeTransport不再满足Transport接口。所以让我们通过添加缺失的函数来解决它:

// 伪造的Transport是单元测试中使用的Transport。
type fakeTransport struct {calls []string
}func (f *fakeTransport) Get(url string) []byte {panic("不使用")
}func (f *fakeTransport) Post(url string, body []byte) {f.calls = append(f.calls, fmt.Sprintf("POST %v, body=%q", url, string(body)))
}func (f *fakeTransport) Delete(url string) {panic("不使用")
}

我们做了什么?由于在单元测试中我们不需要新的Get()和Delete()函数,如果它们被调用,我们就抛出异常。这里有一个问题:每次在Transport中添加新函数时,我们都会破坏现有的fakeTransport实现。对于大型代码库来说,这将导致维护噩梦。我们能做得更好吗?

控制反转

问题在于我们的客户端(和相应的单元测试)依赖于一个它们不能控制的类型。在这种情况下,它是Transport接口。为了解决这个问题,让我们通过引入一个未导出的接口,该接口仅声明了我们的客户端所需的内容,来反转控制:

package monibot// clientTransport传输Client的请求。
type clientTransport interface {Post(url string, body []byte)
}type Client struct {transport clientTransport
}func NewClient(transport clientTransport) *Client {return &Client{transport}
}func (c *Client) PostMetricValue(value int) {body := fmt.Sprintf("value=%d", value)c.transport.Post("https://monibot.io/api/metric", []byte(body))
}

现在让我们将我们的单元测试更改为使用假的clientTransport:

// TestPostMetricValue确保客户端向REST API发送正确的POST请求。
func TestPostMetricValue(t *testing.T) {transport := &fakeTransport{}client := NewClient(transport)client.PostMetricValue(42)if len(f.calls) != 1 {t.Fatal("期望1次传输调用,但是是%d次", len(f.calls))}if f.calls[0] != "POST https://monibot.io/api/metric, body=\\"value=42\\"" {t.Fatal("错误的传输调用 %q", f.calls[0])}
}// 伪造的Transport是在单元测试中使用的clientTransport。
type fakeTransport struct {calls []string
}func (f *fakeTransport) Post(url string, body []byte) {f.calls = append(f.calls, fmt.Sprintf("POST %v, body=%q", url, string(body)))
}

由于Go的隐式接口实现(如果愿意,可以称之为’鸭子类型’),我们库的用户什么也不需要改变:

import "monibot"func main() {// 初始化API客户端var transport monibot.HTTPTransportclient := monibot.NewClient(transport)// 发送指标值client.PostMetricValue(42)
}

重新审视Transport

如果我们使IoC成为规范(正如我们应该做的那样),就不再需要导出Transport接口了。为什么呢?因为如果消费者需要一个接口,让他们在自己的作用域中定义它,就像我们对’clientTransport’做的那样。
不要导出接口。导出具体实现。如果消费者需要接口,让他们在自己的作用域中定义。

总结

在这篇文章中,我展示了如何以及为什么在Go中使用DI和IoC。正确使用DI/IoC可以导致更易于测试和维护的代码,特别是在代码库不断增长时。虽然代码示例是用Go编写的,但这里描述的原则同样适用于其他编程语言。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/735927.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

每日五道java面试题之springMVC篇(二)

目录: 第一题. 请描述Spring MVC的工作流程?描述一下 DispatcherServlet 的工作流程?第二题. MVC是什么?MVC设计模式的好处有哪些?第三题. 注解原理是什么?第四题. Spring MVC常用的注解有哪些?第五题. SpingMvc中的…

Python模块百科_操作系统接口_os【三】

Python模块百科_操作系统接口_os【三】 os --- 多种操作系统接口【第一部分】一、相关模块1.1 os.path 文件路径1.2 fileinput 文件读取1.3 tempfile 临时文件和目录1.4 shutil 高级文件和目录1.5 platform 操作系统底层模块 二、关于函数适用性的说明2.1 与操作系统相同的接口…

C++ 中的头文件和源文件

#include<>一般用于包含系统头文件&#xff0c;诸如stdlib.h、stdio.h、iostream等&#xff1b; 类库目录下查找失败&#xff0c;编译器会终止查找&#xff0c;直接报错&#xff1a;No such file or directory. #include""一般用于包含自定义头文件&#xff…

【JAVA】CSS3:3D、过渡、动画、布局、伸缩盒

1 3D变换 1.1 3D空间与景深 /* 开启3D空间,父元素必须开启 */transform-style: preserve-3d;/* 设置景深&#xff08;你与z0平面的距离 */perspective:50px; 1.2 透视点位置 透视点位置&#xff1a;观察者位置 /* 100px越大&#xff0c;越感觉自己边向右走并看&#xff0c;…

stega1

题目链接&#xff1a;ctf.show 下载附件打开是一张jpg照片 无密码型jphs隐写得到flag flag{3c87fb959e5910b40a04e0491bf230fb}

微信小程序开发系列(二十五)·wxml语法·条件渲染wx:if, wx:elif, wx:else 属性组以及hidden 属性的使用

目录 1. 使用 wx:if、wx:elif、wx:else 属性组 2. 使用 hidden 属性 条件渲染主要用来控制页面结构的展示和隐藏,在微信小程序中实现条件渲染有两种方式: 1. 使用 wx:if, wx:elif, wx:else 属性组 2. 使用 hidden 属性 wx:if 和 hidden 二者的区别&#xff1a; 1. wx…

操作系统笔记(进程)

注&#xff1a; 下面图片资源来源于 王道计算机考研 操作系统 1.进程概念 进程&#xff08;process&#xff09;&#xff1a;是动态的&#xff0c;是程序的一次执行过程&#xff08;同一程序多次执行&#xff0c;会产生多个进程&#xff09;程序&#xff1a;是静态的&…

synchronized 锁的升级

锁的状态 synchronized 在jdk1.6之前是重量级锁&#xff0c;每次都要去和操作系统打交道&#xff0c;而操作系统层面的操作是比较耗性能的&#xff0c;需要将用户态转换为内核态。所以在jdk1.6后就有了锁的升级过程&#xff0c;总共有四种状态&#xff1a;无锁、偏向锁、轻量级…

基于电鳗觅食优化算法(Electric eel foraging optimization,EEFO)的无人机三维路径规划(提供MATLAB代码)

一、无人机路径规划模型介绍 无人机三维路径规划是指在三维空间中为无人机规划一条合理的飞行路径&#xff0c;使其能够安全、高效地完成任务。路径规划是无人机自主飞行的关键技术之一&#xff0c;它可以通过算法和模型来确定无人机的航迹&#xff0c;以避开障碍物、优化飞行…

指针【理论知识速成】(5)

一.回调函数&#xff1a; 1.什么事回调函数&#xff1a;通过函数指针调用函数 2.应用例子&#xff1a; https://blog.csdn.net/hot_water_oh/article/details/136572650?spm1001.2014.3001.5501 &#xff08;此链接为提到转义表所在博客的链接&#xff09; 依然以转义表为例…

drone ci 是什么

Drone CI是一个开源的持续集成和持续部署&#xff08;CI/CD&#xff09;系统&#xff0c;它使用Docker容器技术自动化软件的构建、测试和部署过程。Drone的设计哲学是简单和易用&#xff0c;通过使用Docker容器&#xff0c;它可以很容易地创建隔离的环境来运行测试和部署任务&a…

STM32使用定时器驱动电机

STM32使用定时器驱动电机 1、对定时器进行初始化配置1.1、include "encoder.c"文件 主函数 1、对定时器进行初始化配置 1.1、include "encoder.c"文件 #include "encoder.h"void TIM4_Encoder_Init(u16 arr,u16 psc) { GPIO_InitTypeDef GPIO…

详细讲解Xilinx DDR3 的MIG IP生成步骤及参数含义

前几篇文章讲解了SDRAM到DDR3各自的变化&#xff0c;本文讲解如何使用DDR3&#xff0c;在Altera的Cyclone IV开发板上一般会使用SDRAM作为存储数据的芯片&#xff0c;而Xilinx的S6和7000系列一般使用DDR3作为存储数据的芯片。 从SDRAM芯片内部结构分析其原理&#xff0c;从内部…

策略模式(Strategy mode)

一、策略模式概述 策略模式是一种行为设计模式&#xff0c;它定义了一系列的算法&#xff0c;并将每一个算法封装起来&#xff0c;使它们可以互相替换。策略模式使得算法可以独立于使用它的客户端变化。在游戏开发中&#xff0c;这意味着我们可以根据不同的游戏状态、角色类型…

从空白镜像创建Docker hello world

文章目录 写在前面基础知识方法一&#xff1a;使用echo工具方法二&#xff0c;使用c语言程序方法三&#xff0c;使用汇编语言小结 写在前面 尝试搞了下docker&#xff0c;网上的教程大多是让下载一个ubuntu这种完整镜像&#xff0c;寥寥几篇从空白镜像开始创建的&#xff0c;也…

HSM 网络安全 信息安全

文章目录 HSMHSM信息安全功能汽车电子网络安全中HSM 的应用场景选择适合汽车电子网络安全的 HSM符合汽车安全标准和法规要求的HSMHSM 在汽车电子网络安全中的可靠性和安全性评估汽车电子网络的安全性汽车 HSM(Hardware Security Module)模块开发汽车 HSM(Hardware Security …

文件系统事件监听

文件系统事件和网络IO事件一样&#xff0c;也可以通过epoll或者IOCP 事件管理器统一调度&#xff0c;当所监控的文件或文件夹发生了增删改的事件时&#xff0c;就会触发事件回调&#xff0c;进行事件处理。很常见的应用&#xff0c;如配置文件立即生效功能&#xff0c;就可以通…

SpringBoot自定义banner,自定义logo

SpringBoot自定义banner&#xff0c;自定义logo 在线网站 http://www.network-science.de/ascii/?spma2c6h.12873639.article-detail.9.7acc2c9aSTnQdW https://www.bootschool.net/ascii?spma2c6h.12873639.article-detail.8.7acc2c9aSTnQdW https://patorjk.com/softwa…

官方安装配置要求服务器最低2核4G

官方安装配置要求服务器至少2核、4G。 如果服务器低于这个要求&#xff0c;就没有必要安装&#xff0c;因为用户体验超级差。 对于服务器CPU来说&#xff0c;建议2到4核就完全足够了&#xff0c;太多就浪费了&#xff0c;但是内存越大越好&#xff0c;最好是4G以上。 如果服务器…

创建Django项目,实现视图,路由

初识Django 1、创建Django项目 Django项目的创建的路径不要有中文和空格&#xff1b;【计算机名称不要是中文】 1、在cmd中命令进行创建Django项目打开存放项目的位置创建Django项目&#xff1a;django-admin startproject 项目名称(注意&#xff1a;项目名称不要是中文)启动…