trainking / goechoton

基于echo+arpc的Golang项目骨架

Hi! I'm xiaoye 👋

• 🔭 I’m currently working on game company.
• ⚡ Golang/Python/C/C++/C#.
• 📫 How to reach me: [email protected]
• 🍻 Guangzhou,China

goechoton's Issues

每次rpc重连都会增加新的连接

rpc服务器重启，客户端都会增加新的连接，应该是原有的在重连，而又创建新的导致

增加一个将configs目录下的配置文件加载到etcd中的cmd

传入参数:

• etcd地址，地址组用,分割
• 上传的的服务名称，与配置文件名称同名
• etcd的key path

etcdx包增加分布式锁的实现

分布式锁应该保证以下：

• 独占性，排他锁的必然
• 公平性，多个申请者申请，减少非设定不公平
• 可以通过机制，让特定申请者优先获得锁

增加一个统一的Logger库

• 全局使用统一的日志插件
• 支持自定义模板输出
• 支持日志文件按策略分割

为arpcserver增加guide文档

增加IPv4过滤中间件

• 黑名单过滤中间件，支持网络号
• 白名单过滤中间件，支持网络号，支持*代表所有地址可通过，空代表不许任何ip通过
• ip解析地域限制，需要依赖地址解析库（非必做）

增加RequestID标识请求

RequestID需要实现以下功能：

• 全局唯一不重复
• 可以在log中输出
• 传递到rpc中，识别调用链路

codegen代码生成器

需要生成的部分：

• 错误码
• 错误码文档

上传文件控件

1. 可以上传多个文件
2. 上传文件到指定目录
3. 表单可以额外增加数据

增加redis缓存包实现

1. 增加redisx包
2. 使用go-redis
3. 使用SingleFlight控制缓存穿透

增加makefile管理项目

makefile需要管理以下操作:

• 代码生成，标志gen
• 自动化白盒测试
• Docker镜像打包
• 代码和配置文件检查

如何做到路由向下兼容

假设api存在v1和v2两套路由，则存在下列情况：

两套路由兼容

• 访问v2路由，则如果v2不可用，降级访问到v1
• 访问v1路由，如果v1不可用，是否升级访问v2路由？

两套路由不兼容

互相之间不做升降级操作

错误码包

错误码设计需求：

• 错误码使用int
• 通过错误码位数区分服务-业务-类型
• 错误码有对应的msg
• msg要能够实现多语言
• msg可以通过传入数据，生成
• 实现Error()接口

没有将data传入

GoEchoton/pkg/apiserver/context.go

Line 61 in d3d307c

return c.ctx.JSON(http.StatusOK, JsonResponse{Code: int32(ResponseOkCode), Msg: ResponseOkMsg})

apiserver的Context增加JWT的内容解析透传

echo jwt

在中间件解析好，透传之后，提供方法进行修改

优化解析Data的逻辑

此处Data字段已经json.Unmarsh成interface{}，是否有更优转换对象方法？

GoEchoton/pkg/arpcx/context.go

Line 56 in ad96d38

b, err := json.Marshal(c.req.Data)

定义一个pkg/arpcx包统一arpc的服务端和客户端

rpc的服务端和客户端实现，还是内聚紧密实现比较好

[mark] 记录技巧和片段

Echo中，使用middleware作为全局中间件时，需要注意，echo.Request().Body 是一个io.ReadCloser。

读出数据之后，要重新建立一个io.ReadCloser放回去，不然会导致下一个处理中，读取不到数据，报EOF错误。

bodyContens, err := ioutil.ReadAll(req.Body)
...

req.Body = ioutil.NopCloser(bytes.NewReader(bodyContens))

为arpcclient增加guide文档

批处理模块

该模块具有以下功能：

• 定时任务执行
• 每次执行需要满足幂等性
• 每次执行返回error，记录错误日志
• 提供执行失败，补充再次执行方案（可人工介入）
• 每次执行要有唯一标识id

arpcx包使用msgpack