Go Cinch Layout

Layout是ぜ一套轻量级微服务项目模版.

简介

起源きげん

你的单体服ふく务架构是否ひ遇ぐう到いた一いち些问题, 不能ふのう满足业务需求? 那な么微服ふく务会是ぜ好このみ的てき解かい决方案あん.
Cinch是ぜ一套轻量级微服务脚手架, 基もと于Kratos, 节省基もと础服务搭建けん时间, 快速かいそく投入とうにゅう业务开发.
我わが们参考さんこう了りょうGo的てき许多微ほろ服ふく务架构, 结合实际需求, 最さい终选择简洁的Kratos作さく为基石せき(B站架构), 从架构的设计思おもえ路ろ以及代だい码的书写格式かくしき和わ我わが们非常ひじょう匹ひき配はい.

cinch意い为简单的事ごと, 小しょう菜さい. 希望きぼう把わ复杂的てき事こと变得简单, 提つつみ升ます开发效率こうりつ.

若わか你想深入ふかいり学がく习微服ふく务每个组件けん, 建けん议直接ちょくせつ看みKratos官かん方かた文ぶん档. 本ほん项目整合せいごう一些业务常用组件, 开箱即そく用よう, 并不会かい把わ每ごと个组件けん都と介かい绍那么详细.

特性とくせい

Go - 当とう前まえGo版本はんぽん直接ちょくせつ上じょうv1.20
Proto - proto协议同どう时开启gRPC & HTTP支持しじ, 只ただ需开发一いち次じ接せっ口こう, 不用ふよう写うつし两套
Jwt - 认证, 用よう户登入にゅう登とう出で一いち键搞定じょう
Action - 权限, 基もと于行为的权限校こう验
Redis - 缓存, 内うち置おけ防ぼう缓存穿ほじ透とおる/缓存击穿/缓存雪崩なだれ示しめせ例れい
Gorm - 数かず据すえ库ORM管理かんり框かまち架か, 可か自じ行くだり扩展多た种数据すえ库类型がた, 目前もくぜん使用しようMySQL, 其他自じ行くだり扩展
Gorm Gen - Gorm实体自じ动生成せいせい, 无需再さい写うつし数すう据すえ库实体たい映うつ射い
Tenant - 基もと于Gorm的てきschema层面的てき多た租户(一个租户一个数据库schema)
SqlMigrate - 数かず据すえ库迁移うつり工具こうぐ, 每次まいじ更新こうしん平滑へいかつ迁移
Asynq - 分布ぶんぷ式しき定てい时任务(异步任にん务)
Log - 日にち志こころざし, 在ざいKratos基もと础上增加ぞうか一いち层包装ほうそう, 无需每ごと个方法ほう传入
Embed - go 1.16文ぶん件けん嵌入かんにゅう属性ぞくせい, 轻松将はた静しずか态文件けん打だ包つつめ到いた编译后きさき的てき二に进制应用中ちゅう
Opentelemetry - 链路追つい踪, 跨またが服ふく务调用よう可か快速かいそく追つい踪完整せい链路
Idempotent - 接せっ口こう幂等性せい(解かい决重复点击或提ひさげ交)
Pprof - 内うち置おけ性能せいのう分析ぶんせき开关, 对并发/性能せいのう测试友好ゆうこう
Wire - 依よ赖注入ちゅうにゅう, 编译时完成かんせい依よ赖注入ちゅうにゅう
Swagger - Api文ぶん档一键生成せいせい, 无需在ざい代だい码里写うつし注解ちゅうかい
I18n - 国くに际化支持しじ, 简单切きり换多语言

当とう前ぜん版本はんぽん

使用しようcinch工具こうぐ快速かいそく创建Game服ふく务

go install github.com/go-cinch/cinch/cmd/cinch@latest

cinch new game

在ざい线演示しめせ

Vue3入口いりくち
 React入口いりくち

项目结构

├── api                  // 各かく个微服ふく务的proto/go文ぶん件けん, proto文ぶん件けん通どおり过submodule管理かんり包含ほうがんproto后きさき缀
│   ├── auth             // auth服ふく务所需的go文ぶん件けん(通つう过命令めいれい生成せいせい)
│   ├── auth-proto       // auth服ふく务proto文ぶん件けん
│   ├── reason
│   ├── reason-proto     // 公共こうきょうreason(错误码建议统一いち管理かんり, 不要ふよう不同ふどう服ふく务搞不同ふどう的てき)
│   ├── xxx              // xxx服ふく务所需的go文ぶん件けん(通つう过命令めいれい生成せいせい)
│   ├── xxx-proto        // xxx服ふく务proto文ぶん件けん
│   └── ...
├── cmd                  
│   └── game             // 项目名めい
│       ├── main.go      // 程ほど序じょ主ぬし入口いりくち
│       ├── wire.go      // wire依よ赖注入ちゅうにゅう
│       └── wire_gen.go
├── configs              // 配置はいち文ぶん件けん目め录
│   ├── config.yml       // 主しゅ配置はいち文ぶん件けん
│   ├── client.yml       // 配置はいちgrpc服ふく务client, 如auth
│   ├── gen.yml          // gen gorm或あるmigrate会かい用よう到いた的てき配置はいち文ぶん件けん
│   └── ...              // 其他自じ定てい义配置はいち文ぶん件けん以yml/yaml结尾均ひとし可か
├── internal             // 内部ないぶ逻辑代だい码
│   ├── biz              // 业务逻辑的てき组装层, 类似 DDD 的てき domain 层, data 类似 DDD 的てき repo, 而 repo 接せっ口こう在ざい这里定てい义, 使用しよう依よ赖倒置とうち的てき原げん则. 
│   │   ├── biz.go
│   │   ├── reason.go    // 定てい义错误描述じゅつ
│   │   ├── game.go      // game业务
│   │   └── xxx.go       // 其他业务
│   ├── conf
│   │   ├── conf.pb.go
│   │   └── conf.proto   // 内部ないぶ使用しよう的てきconfig的てき结构定てい义, 使用しようproto格式かくしき生成せいせい
│   ├── data             // 业务数すう据すえ访问, 包含ほうがん cache、db 等とう封ふう装そう, 实现了りょう biz 的てき repo 接せっ口こう. 我わが们可能会のうかい把わ data 与あずか dao 混淆こんこう在ざい一起かずき, data 偏重へんちょう业务的てき含义, 它所要しょよう做的是ぜ将はた领域对象重おも新しん拿出来でき, 我わが们去掉了 DDD 的てき infra层. 
│   │   ├── model        // gorm gen生成せいせいmodel目め录
│   │   ├── query        // gorm gen生成せいせいquery目め录
│   │   ├── cache.go     // cache层, 防ぼう缓存击穿/缓存穿ほじ透とおる/缓存雪崩なだれ
│   │   ├── client.go    // 各かく个微服ふく务client初はつ始はじめ化か
│   │   ├── ctx.go
│   │   ├── data.go      // 数かず据すえ初はつ始はじめ化か, 如DB/Redis
│   │   ├── game.go
│   │   └── tracer.go    // 链路追つい踪tracer初はつ始はじめ化か
│   ├── db
│   │   ├── migrations   // sql迁移文ぶん件けん目め录, 每まい一次数据库变更都放在这里, 参考さんこうhttps://github.com/rubenv/sql-migrate
│   │   │   ├── xxx.sql  // sql文ぶん件けん
│   │   │   └── ...
│   │   └── migrate.go   // embed sql文ぶん件けん
│   ├── pkg              // 自じ定てい义扩展てん包つつみ
│   │   ├── idempotent   // 接せっ口こう幂等性せい
│   │   ├── task         // 异步任にん务, 内部ないぶ调用asynq
│   │   └── xxx          // 其他扩展
│   ├── server           // http和わgrpc实例的てき创建和わ配置はいち
│   │   ├── middleware   // 自じ定てい义中间件
│   │   │   ├── locales  // i18n多た语言map配置はいち文ぶん件けん
│   │   │   └── xxx.go   // 一いち些中间件
│   │   ├── grpc.go
│   │   ├── http.go
│   │   └── server.go
│   └── service          // 实现了りょう api 定てい义的服ふく务层, 类似 DDD 的てき application 层, 处理 DTO 到いた biz 领域实体的てき转换(DTO -> DO), 同どう时协同どう各かく类 biz 交互こうご, 但ただし是ぜ不ふ应处理り复杂逻辑
│       ├── service.go
│       ├── game.go      // game接せっ口こう入口いりくち
│       └── xxx.go       // 其他接せっ口こう入口いりくち
├── third_party          // api依よ赖的第だい三さん方ぽうproto, 编译proto文ぶん件けん需要じゅよう用よう到いた
│   ├── cinch            // cinch公共こうきょう依よ赖
│   ├── errors
│   ├── google
│   ├── openapi
│   │── validate
│   └── ...              //  其他自じ定てい义依赖
├─ .gitignore
├─ .gitmodules           // submodule配置はいち文ぶん件けん
├─ .golangci.yml         // golangci-lint
├─ Dockerfile
├─ go.mod
├─ go.sum
├─ LICENSE
├─ Makefile
└─ README.md

环境准じゅん备

启动项目前まえ, 我わが默だま认你已やめ准じゅん备好(部分ぶぶん软件按建议方式しき安あん装そう即そく可か):

go1.18+(建けん议使用しようg)

# sudo apt update
# sudo apt install -y curl
curl -sSL https://raw.githubusercontent.com/voidint/g/master/install.sh | bash
source "$HOME/.g/env"
# g --version
# g version 1.5.0

g install 1.20
# go version
# go version go1.20 linux/amd64

echo "export GOPATH=/home/ubuntu/go" >> ~/.bashrc 
# 设置go/bin目め录到PATH, 若わか不ふ设置, go安あん装そう的てき一些文件无法识别
echo "export PATH=$PATH:/home/ubuntu/.g/go/bin:/home/ubuntu/go/bin" >> ~/.bashrc
source ~/.bashrc

开启go modules
mysql(本地ほんじ测试建けん议使用しようdocker-compose搭建)

redis(本地ほんじ测试建けん议使用しようdocker-compose搭建)

# 安あん装そうdocker
sudo apt-get update
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo apt-key fingerprint 0EBFCD88
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update
sudo apt-get install -y docker-ce
# sudo docker -v
# Docker version 23.0.1, build a5ee5b1

# 国内こくない加速かそく安やす装そう
sudo apt-get update
sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common
curl -fsSL http://mirrors.aliyun.com/docker-ce/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] http://mirrors.aliyun.com/docker-ce/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update
sudo apt-get install -y docker-ce
# sudo docker -v
# Docker version 23.0.1, build a5ee5b1

# 去さ除じょdocker sudo
sudo groupadd docker
sudo gpasswd -a ${USER} docker
sudo systemctl restart docker
sudo chmod a+rw /var/run/docker.sock
# docker -v
# Docker version 23.0.1, build a5ee5b1

# docker-compose
sudo curl -L https://github.com/docker/compose/releases/download/v2.10.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
# docker-compose -v
# Docker Compose version v2.10.2


# 简单启动一いち个单机つくえ版ばんmysql和わredis
git clone https://github.com/go-cinch/compose
cd compose/single
# 修おさむ改あらため默だま认密码
source myenv
docker-compose -f docker-compose.db.yml up -d redis mysql
# docker ps
# CONTAINER ID  IMAGE         COMMAND                 CREATED            STATUS         PORTS                                                 NAMES
# 918328d0aae1  mysql:8.0.19  "docker-entrypoint.s…"  About an hour ago  Up 59 minutes  0.0.0.0:3306->3306/tcp, :::3306->3306/tcp, 33060/tcp  mysql
# 918b2cfcd72e  redis:7.0     "docker-entrypoint.s…"  About an hour ago  Up 59 minutes  0.0.0.0:6379->6379/tcp, :::6379->6379/tcp             redis

protoc

curl -LO https://github.com/protocolbuffers/protobuf/releases/download/v3.20.3/protoc-3.20.3-`uname -s`-`uname -m`.zip
# apt install -y unzip
sudo unzip protoc-3.20.3-`uname -s`-`uname -m`.zip -d /usr
# protoc --version
# libprotoc 3.20.3

protoc-gen-go

go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.30.0
# protoc-gen-go --version
# protoc-gen-go v1.30.0

git
```
sudo apt update
sudo apt install -y git
```

cinch cli工具こうぐ

go install github.com/go-cinch/cinch/cmd/cinch@latest
# cinch -v
cinch version v1.0.0

Auth服ふく务

权限认证服ふく务无需再开发, 下しも载开箱ばこ即そく用よう

git clone https://github.com/go-cinch/auth
# 可か以指定していtag
# git clone -b v1.0.3 https://github.com/go-cinch/auth

创建Game服ふく务

# 1.通つう过模板ばん创建项目
cinch new game
# -r 指定してい仓库 -b 指定してい分ぶん支ささえ
# cinch new game -r https://github.com/go-cinch/layout.git -b dev

# 2. 进入项目
cd game
# 创建个人开发分ぶん支ささえ
git init -b mark/dev
# 如果你的git版本はんぽん较低
# git init
# git checkout -b mark/dev

# 3. 初はつ始はじめ化かsubmodule(不ふ想そう使用しよう可か忽ゆるがせ略りゃく此步骤)
# -b指定してい分ぶん支ささえ --name指定していsubmodule名称めいしょう
git submodule add -b master --name api/auth-proto https://github.com/go-cinch/auth-proto.git ./api/auth-proto

# -b指定してい分ぶん支ささえ --name指定していsubmodule名称めいしょう
git submodule add -b master --name api/reason-proto https://github.com/go-cinch/reason-proto.git ./api/reason-proto

# 这里用ようgame作さく为示例れい, 按需修おさむ改あらため
# -b指定してい分ぶん支ささえ --name指定していsubmodule名称めいしょう
git submodule add -b master --name api/game-proto https://github.com/go-cinch/game-proto.git ./api/game-proto

# 删除一个已经存在的submodule
# git submodule deinit api/game-proto
# git rm --cached api/game-proto
# rm -rf .git/modules/api/game-proto
# rm -rf api/game-proto

# 4. 初はつ始はじめ化か依よ赖项(需确保ほ已やめ经安装そうmake)
# sudo apt install -y make
make init

# 5. 编译项目
make all

启动

配置はいち文ぶん件けん

# 修おさむ改あらためauth项目配置はいち
cd auth
# 将はたmysql/redis的てき配置はいち修おさむ改あらため成なり你本地ち配置はいち
vim configs/config.yml

# 修おさむ改あらためgame项目配置はいち
cd game
# 将はたmysql/redis的てき配置はいち修おさむ改あらため成なり你本地ち配置はいち
vim game/configs/config.yml
# 将はたauth服ふく务host和わ端はし口こう修おさむ改あらため成なり你本地ち配置はいち
vim game/configs/client.yml

# 启动auth
cd auth
cinch run

# 启动game
cd game
cinch run

环境变量

# 启动auth
# 如果你用的てき是ぜcompose/single
export AUTH_DATA_DATABASE_DSN='root:mysqlrootpwd@tcp(127.0.0.1:3306)/auth?parseTime=True'
export AUTH_DATA_REDIS_DSN='redis://:redispwd@127.0.0.1:6379/0'
# 其他按需修おさむ改あらため
export AUTH_DATA_DATABASE_DSN='root:root@tcp(127.0.0.1:3306)/auth?parseTime=True'
export AUTH_DATA_REDIS_DSN='redis://127.0.0.1:6379/0'
cd auth
cinch run

# 启动game
# 如果你用的てき是ぜcompose/single
export GAME_DATA_DATABASE_DSN='root:mysqlrootpwd@tcp(127.0.0.1:3306)/game?parseTime=True'
export GAME_DATA_REDIS_DSN='redis://:redispwd@127.0.0.1:6379/0'
# 其他按需修おさむ改あらため
export GAME_DATA_DATABASE_DSN='root:root@tcp(127.0.0.1:3306)/game?parseTime=True'
export GAME_DATA_REDIS_DSN='redis://127.0.0.1:6379/0'
# 设置auth服ふく务
export GAME_CLIENT_AUTH='127.0.0.1:6160'
cd game
cinch run

Tip: 环境变量前ぜん缀可在ざいcmd/xxx/main.go中ちゅう修おさむ改あらため, 参まいり见环境变量前ぜん缀

测试访问

auth服ふく务:

curl http://127.0.0.1:6060/idempotent
# 输出如下说明服ふく务通了りょう只ただ是ぜ没ぼつ有ゆう权限, 出で现其他た说明配置はいち有ゆう误
# {"code":401, "reason":"UNAUTHORIZED", "message":"token is missing", "metadata":{}}

game服ふく务:

curl http://127.0.0.1:8080/hello/world
# 输出如下说明服ふく务通了りょう只ただ是ぜ没ぼつ有ゆう权限, 出で现其他た说明配置はいち有ゆう误
# {"code":401, "reason":"UNAUTHORIZED", "message":"token is missing", "metadata":{}}

至いたり此, 微ほろ服ふく务已启动完かん毕, auth以及game, 接せっ下か来らい可か以自定てい义你的てきgame啦~

文ぶん档

以下いか几个较为常用じょうよう, 当然とうぜん你也可か以按顺序查看Docs

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Go Cinch Layout

简介

起源きげん

特性とくせい

当とう前ぜん版本はんぽん

在ざい线演示しめせ

项目结构

环境准じゅん备

Auth服ふく务

创建Game服ふく务

启动

配置はいち文ぶん件けん

环境变量

测试访问

文ぶん档

About

Releases

Packages

Languages

Name		Name	Last commit message	Last commit date
Latest commit History 239 Commits
api		api
cmd/server		cmd/server
configs		configs
internal		internal
third_party		third_party
.gitignore		.gitignore
.gitmodules		.gitmodules
.golangci.yml		.golangci.yml
Dockerfile		Dockerfile
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
go.mod		go.mod
go.sum		go.sum

License

go-cinch/layout

Folders and files

Latest commit

History

Repository files navigation

Go Cinch Layout

简介

起源きげん

特性とくせい

当とう前ぜん版本はんぽん

在ざい线演示しめせ

项目结构

环境准じゅん备

Auth服ふく务

创建Game服ふく务

启动

配置はいち文ぶん件けん

环境变量

测试访问

文ぶん档

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages