ssyg/hertz101

suyiiyii 9d82d63a64

docs(README): 更新项目文档- 添加项目简介部分

-修正部分功能描述
- 新增开发一个模块的流程说明
- 新增一次部署的流程说明

2025-01-22 11:31:09 +08:00

1.4 KiB

Raw Permalink Blame History

Hertz101

一个学习项目

简介

使用 kitex 框架，实现了

rpc 调用 (kitex)
hertz 作为 facade 层
服务注册与发现（consul）
配置动态加载（viper + consul）
docker 镜像
helm 模板 (manifest 分支)
k8s 部署
cicd 流水线
GitOps 部署（argocd）

开发一个模块的流程

编写 idl 文件
Makefile 中，从已有的模块复制一份，修改模块名
使用 cwgo 工具生成代码（运行刚刚写的 Makefile）
定义数据库 model
创建 cmd/migrate/migrate.go 文件，编写迁移代码（参见 gorm）
运行 cmd/migrate/migrate.go，创建数据库表
创建 cmd/gorm_gen/gen.go 文件，编写业务 sql（使用注释，参见 gorm gen）
运行 cmd/gorm_gen/gen.go，生成数据库操作代码
修改 config/config.go，改成自己的配置（viper+consul）
修改日志配置，改成自己的配置（直接打印到 std）
修改服务端口，改成一个未被占用的端口（便于在本地测试）
修改 biz/dal/mysql/mysql.go，改成自己的dsn，并初始化 gen 的 Q 对象
到 biz/service 下完善自己的业务逻辑
编写 dockerfile

一次部署的流程

代码推送到 main 分支
构建镜像并推送到镜像仓库（cicd，下同）
把镜像 tag 更新到 manifest 仓库中的 values.yaml
ArgoCD 自动同步
部署完成