# go-zero-box **Repository Path**: hacker__007/go-zero-box ## Basic Information - **Project Name**: go-zero-box - **Description**: 📦开箱即用的go-zero示例，内置 api、scheduler、queue、script 服务。 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2025-03-26 - **Last Updated**: 2025-03-26 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ### 一、概述 开箱即用的 go-zero 示例，内置 api、scheduler、queue、script 服务。 框架初始版本基于 go-zero 框架的 1.5.5 版本，后续会参考 go-zero 的版本出相应的更新。 在熟悉 go-zero 框架过程中踩坑很多，衍生的 go-zero-box 框架也是相当于经验贴了，希望可以帮助开发者更快的度过熟悉期。 整理并且开源不易，后续还会持续编写 go-zero 框架和 go 语言新特性的使用心得，在使用过程中有任何问题，欢迎提 **issue**，如果您觉得项目对您有帮助，希望给个️ ⭐️ **star** ⭐️ ，十分感谢。 ### 二、特性 - 做了一些符合Web应用框架的目录划分，使开发者代码阅读更便捷，减少开发成本； - 提供了初始业务的 api 代码示例，包含登录、注册、鉴权等开箱即用的业务功能； - 提供了初始业务的 api 文档，使用 Apifox 工具，导入即可使用 [go-zero-box.apifox.json](https://github.com/prf16/go-zero-box/blob/main/go-zero-box.apifox.json)； - 增加了更多的 ORM API，支持复杂的数据操作业务； - 引入 asynq 库，实现了队列、调度、脚本等功能； - 引入 wire 库，实现了依赖注入功能； - 通过 ```app [command]``` 的方式，在多实例扩展的场景下可以更方便地部署 api 、scheduler、queue 服务； - go 语言新特性的优秀示例，比如通过范式实现的三元表达式 ```tools.Any(a == b, a, b)```； ··· 持续更新中，敬请期待。 ### 三、框架介绍 go-zreo 框架 + goctl 代码生成工具 + wire 依赖注入 + Makefile 实现自动化编译。 go-zero 是一个集成了各种工程实践的 web 和 rpc 框架，缩短从需求到上线的距离，通过弹性设计保障了大并发服务端的稳定性，经受了充分的实战检验。 goctl 是 go-zero 微服务框架下的代码生成工具。使用 goctl 可显著提升开发效率，让开发人员将时间重点放在业务开发上，其功能有：api服务生成、rpc服务生成、model代码生成、模板管理。 wire 是一个依赖注入工具，用于解决 Go 语言中依赖注入的问题。通过 wire，您可以轻松地管理应用程序的依赖关系，并确保它们在编译时进行注入。 Makefile 文件描述了 Linux 系统下项目工程的编译规则，只需要一个 `make bild` 命令，整个工程就开始自动构建项目环境，不再需要手动执行大量的 `go build` 命令，Makefile 文件定义了一系列规则，指明了源文件的编译顺序、依赖关系、是否需要重新编译等，可以输入 `make help` 查看命令集。 ### 四、代码结构 ```text . ├── app 包含应用程序的主要代码 │ ├── doc 项目主业务逻辑 │ ├── etc 静态配置文件目录 │ ├── internal 内部业务逻辑 │ ├── app.go 应用程序的入口文件，定义了 API 服务、队列服务和调度服务的启动命令。 │ ├── wire.go 依赖注入文件 │ └── wire_gin.go 依赖注入生成文件 ├── build 项目构建目录 │ ├── app 应用构建目录 │ │ ├── bin 应用二进制文件 │ │ └── deploy 应用部署文件 │ │ └── etc 配置文件 │ └── app.tar 应用构建打包文件（部署文件） ├── deploy 部署目录 │ ├── goctl 代码生成工具 │ ├── sql 数据库脚本 │ └── template 模板文件 ├── pkg 工具包 ├── runtime 项目运行时目录 ├── vendor 项目依赖包 ├── .gitignore git 忽略文件 ├── go.mod 项目依赖管理文件 ├── Makefile 项目构建文件 └── README.md 项目说明文件 ``` ### 五、环境要求 - Golang >= 1.20 - MySql >= 5.7 ### 六、项目部署 ```shell # 目录初始化，首次运行项目前请运行该命令 $ make new # 生成api代码文件 $ make api # 生成model代码文件 $ make model # 生成wire代码文件 $ make wire # 构建项目 $ make build env=dev|test|prod ``` ### 七、安装 #### 1. go-zero - 仓库地址：https://github.com/zeromicro/go-zero - 文档地址：https://go-zero.dev/cn/ ```shell $ go get -u github.com/zeromicro/go-zero ``` #### 2. goctl - 仓库地址：https://github.com/zeromicro/go-zero/tree/master/tools/goctl - 文档地址：https://go-zero.dev/cn/docs/goctl/goctl ```shell $ go get -u github.com/zeromicro/go-zero/tools/goctl ``` ### 八、常见问题 #### 1. go mod tidy 超时 i/o timeout ``` 1. 确认当前shell echo $SHELL 2. 编辑相应的 Shell 配置文件 a. 如果使用 zsh vim ~/.zshrc a. 如果使用 bash vim ~/.bash_profile 3. 添加配置信息 export GOPROXY=https://proxy.golang.org,https://mirrors.aliyun.com/goproxy/,direct 4. 重载配置 source ~/.zshrc source ~/.bash_profile 5. 查看更新结果 go env GOPROXY ``` ### 关于贡献 go-zero-box 是一个基于 [MIT](https://github.com/prf16/go-zero-box/blob/main/LICENSE) 的开源项目，大家在使用中发现bug，有新的特性等，均可以参与到go-zero-box的贡献中来，我们非常欢迎大家的积极参与，也会最快响应大家提出的各种问题，pr等。 ### go-zero-box 用户 如果贵公司也已使用 go-zero-box，欢迎在 [登记地址](https://github.com/prf16/go-zero-box/issues/1) 登记，仅仅为了推广，不做其它用途。