Golang微服务框架Kratos使用问题总结

Coding Alan 4个月前 (07-31) 630次浏览 0个评论 扫描二维码

最近准备使用微服务框架做一套系统,当然不用框架也能做(使用gRPC、API网关和权限校验创建Go微服务 Part 1/2),但人力有限的情况下用框架肯定是更好的选择。显然 go-micro时代已经过去了,那么我们更容易锁定到国内开源的两个框架,go-zeroKratos,各有千秋。本着没有深入使用就没有发言权的原则,我很可能会各实现一套来进行对比,就学习资源而言,当前Kratos处于劣势。

关于Kratos就不过多介绍了,是由Bilibili主导开源的一套微服务框架。本文是对Kratos使用中问题的一些总结,版本自然是v2,毕竟v1官方自己都说了有很多设计缺陷,更重要的是从Bilibili 的主账号里脱离出来了,发展就看社区参与度了。初用起来感觉就是深度绑定了protobuf,不同于go-zero同时在其基础上封装了一个.api文件,全部直接使用.proto文件进行定义。然后就是使用wire来处理依赖注入。

Golang微服务框架Kratos使用问题总结

官方对目录结构的说明如下:

根据自身业务可以在使用kratos new -r xxx(或是直接设置环境变量KRATOS_LAYOUT_REPO=xxx-layout.git)来指定采用自己的项目布局。

问题总结

  • 官方默认的 layout 目录已其实已经包含第三方包,但proto 文件仍然会出现红色波浪线,如import "google/api/annotations.proto";,以 VS Code 为例,只需要添加如下文件及配置:
    .vscode/settings.json
  • protoc-gen-validate: program not found or is not executable
  • 在 protobuf文件中添加的验证规则未生效
    首先要确保在 protoc 命令中添加参数:

    其次在grpc.gohttp.go文件(取决于你使用的服务)中应加入validate.Validator中间件
  • unsupported Scan, storing driver.Value type []uint8 into type *time.Time
    这个错误与 Kratos 无关,顺便记录在此,大概率你不会碰到这个问题,因为对 MySQL的配置一般都会怼上charset=utf8mb4&parseTime=True&loc=Local,万一出现这个报错,那就是缺少parseTime所致。
  • 成功及错误响应值格式可通过http.ResponseEncoderhttp.ErrorEncode进行定制
  • Kratos 默认返回的错误消息同时反馈在 HTTP状态码中(在kratos/v2/error中还内置了多个方法,如BadRequestUnAuthorized等),设计者应该是觉得HTTP状态码的语义更为前端所熟悉,但目前大多使用axios库来发起 HTTP请求,这样默认service.interceptors.response.use的拦截会直接进入error部分,那返回的消息体岂不是毫无价值了?原因从axios源码可以找到:

    一种方式是修改Kratos中的错误处理或者一律返回200到300之间的状态码,但这便辜负了框架的精妙设计,另一种自然就是从前端下手,比如假定简单粗暴地将500以下的状态码都视为正常,错误消息在response由前端处理,可以使用如下配置:
  • Protobuf和OpenAPI关于变量的使用方式有点烦,如果使用camelCase,一切太平,但如果使用snake_case,就开始麻烦了,你会发现接口本身字段没有问题,但 OpenAPI 开始作妖,文档里会显示为camelCase,那如何让文档里也显示为snake_case呢?那就还要再加一个注解,比如:

    顺便说一下,如果字段定义与json_name不统一也会出问题。
    经过进一步的探索,在生成时可通过protoc-gen-openapi的参数naming=proto来配置生成使用Protobuf文件定义名称的文档字段。但如果使用Kratos 自家的swagger-api,则还需要配置generator.UseJSONNamesForFields(false)

    延展一下,你可能会看到网上推荐使用protojson并可通过UseProtoNames来进行序列化配置,在 Kratos 中只需将其加入到 main.go 文件的init()中即可:
  • GRPC 不似 HTTP 那样利于调试,可以考虑使用以下工具:
    • grpcui(这个工具我在安装时出现go:linkname must refer to declared function or variable,这是本地使用的版本是 go 1.18有关,解决方案是go get -u golang.org/x/sys,如果你也有这个问题,可能像我一样克隆代码在本地编译安装)
    • bloomrpc
    • Postman,是的,Postman 也有相关支持,但要求首先注册一个账号
  • make api时出现添加--experimental_allow_proto3_optional参数的提示是因为 在 proto中使用了optional,但在3.15.0中这个特性已经转正,所以可以直接升级解决问题,当然不愿意升级请直接对protoc命令添加该参数;那我们为什么要添加optional呢(你还会在网上看到官方不建议使用optional,并且在3.15.0之前它一直作为experimental,要额外添加参数运行)?其实这与 Go 语言对零值的处理有关,在 Go 语言中数值、字符串等类型会默认被置为零值,那么问题就来了,我们怎么会知道一个int类型的变量是未传参还是传参的值为0,这时就要使用引用类型*int,在 Protobuf 中对应的就是在定义字段时在前面添加optional
    补充一个知识点,使用 Vue 进行前端开发的同学很多人会使用element-ui,它也有一个坑,就是在添加clearable属性后清空字段会默认将v-model对应的变量(即使它是一个数值类型)设置为空字符串,那问题来了,传一个空字符串给后端明显类型不匹配呀!于是我们又需要再添加一个@clear="status = null"(假定变量名称为status)来进行处理。

单元测试

  1. m.ctrl.T undefined (type *gomock.Controller has no field or method T)

 

学习资源

喜欢 (0)
[]
分享 (0)
发表我的评论
取消评论

表情 贴图 加粗 删除线 居中 斜体 签到

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址