go微服务框架Kratos简单使用总结

支持http &＃43; grpc两种调用方式&＃xff0c;通过编写proto文件来实现。

一般&＃xff0c;http开放给外部调用&＃xff0c;可以使用restful风格定义。grpc面向内部微服务之间进行调用。

​ 在项目中&＃xff0c;会以这样的结构出现&＃xff0c;并且可以对不同协议进来的请求进行处理&＃xff0c;添加处理的中间件&＃xff0c;如权限校验、熔断限流等等。

2. 日志

在kratos中&＃xff0c;可以自定义日志框架选型&＃xff0c;设置日志格式和输出内容&＃xff0c;然后将logger对象以依赖注入的方式&＃xff0c;分配给server中的grpc server和http server&＃xff0c;这样就可以实现每次收到请求后的日志打印。

将logger对象以依赖注入的方式&＃xff0c;注入到业务层&＃xff0c;就可以在业务层中统一使用logger进行输出。

3. 错误处理

在grpc中&＃xff0c;比较通用的一种错误处理方式就是直接通过 proto 预定义定义错误码&＃xff0c;然后通过 proto-gen-go 生成帮助代码&＃xff0c;直接返回 error。

{
// 错误码&＃xff0c;跟 http-status 一致&＃xff0c;并且在 grpc 中可以转换成 grpc-status
"code": 500,
// 错误原因&＃xff0c;定义为业务判定错误码
"reason": "USER_NOT_FOUND",
// 错误信息&＃xff0c;为用户可读的信息&＃xff0c;可作为用户提示内容
"message": "invalid argument error",
// 错误元信息&＃xff0c;为错误添加附加可扩展信息
"metadata": {
"foo": "bar"
}
}


结构是这样的。这里可以发现&＃xff0c;为了兼容grpc&＃xff0c;在http的返回结果中&＃xff0c;code也无法自定义&＃xff0c;只能跟随httpcode。所以这里客户端或者第三方去处理错误时&＃xff0c;需要判断reason字段。

4. 配置管理

使用proto文件定义配置和生成struct&＃xff0c;然后将yaml中的内容读取到对应struct 字段中进行使用。

在这里我们可以注意到&＃xff0c;在kratos中&＃xff0c;除了传输格式使用了proto进行定义之外&＃xff0c;错误处理和配置管理&＃xff0c;也使用了proto来进行。可以说&＃xff0c;一切皆proto。

5. wire

Wire 是一个灵活的依赖注入工具&＃xff08;需要安装&＃xff09;&＃xff0c;通过自动生成代码的方式在编译期完成依赖注入。通过 Wire 进行初始化代码&＃xff0c;可以很好地解决组件之间的耦合&＃xff0c;以及提高代码维护性。

打开Kratos的示例项目&＃xff0c;从main入口看&＃xff0c;有一处调用了wireApp方法&＃xff0c;这里就是一切的源头&＃xff08;万恶之源&＃xff09;。

这个方法调用的是main同目录的wire文件中的wireApp方法&＃xff0c;同目录的wire_gen.go实现了此方法。

wire_gen中去实例化不同service和组建的对象&＃xff0c;用于调用。关系图如下&＃xff1a;

在每个模块中&＃xff0c;只需要一个 ProviderSet 提供者集合&＃xff0c;就可以在 wire 中进行依赖注入。

简单的描述一下&＃xff1a;有一个数据库连接对象&＃xff0c;service需要操作数据库&＃xff0c;依赖数据库连接对象。这时候我们可以声明数据库连接对象在ProviderSet集合&＃xff0c;然后在service对象处声明&＃xff0c;我需要一个数据库连接对象。 然后我们使用wire工具&＃xff0c;就可以自动帮我们生成依赖注入的代码。

这个功能使用的时候&＃xff0c;我才真正明白了依赖注入。和使用java的依赖注入是完全不同的感觉。有了显式的依赖注入&＃xff0c;让代码间的依赖关系一目了然。当我们查看同事代码时&＃xff0c;只需要点开wire_gen.go 代码&＃xff0c;什么处理过程 需要依赖哪些组件&＃xff0c;清清楚楚&＃xff0c;大大提高了代码的维护性。