Bangumi Server 快速上手指南5 分钟搭建本地开发环境【免费下载链接】serverAPI server for bgm.tv项目地址: https://gitcode.com/gh_mirrors/server17/serverBangumi Server 是 bgm.tv番组计划官方新一代的 API 后端服务采用 Go 语言编写为动漫、游戏、书籍等 ACG 内容提供统一的数据接口。本文是一份面向新手的 Bangumi Server 快速上手指南带你用 5 分钟在本地搭建一套可运行、可调试的完整开发环境从环境准备、配置编写到服务启动一步到位。Bangumi Server 是什么Bangumi Server 是 bgm.tv 网站的后端 API 服务负责处理用户、条目Subject、角色Character、人物Person、收藏Collection等核心业务。它采用了清晰的分层架构模块说明代码位置Web 路由层定义所有 HTTP 接口web/routes.go业务控制层处理业务逻辑ctrl/数据访问层数据库读写GORMdal/dao/内部业务域用户、条目、搜索等internal/通用工具包可复用的公共组件pkg/技术栈上它使用 Echo 作为 Web 框架、GORM 操作 MySQL、Redis 做缓存并通过 Kafka 同步数据变更工程化程度非常高非常适合作为 Go 后端的学习范本。搭建前的环境准备 ✅在开始之前请确认你的电脑上已经安装了以下软件Go 1.26项目基于最新 Go 版本开发见 go.modMySQL 8.0主数据库Redis缓存服务go-task任务管理工具用于一键执行构建、测试等命令配置见 taskfile.yaml 推荐使用 Docker 启动 MySQL 和 Redis可以省去本地安装的麻烦几分钟内即可完成。第一步克隆项目代码 打开终端执行以下命令获取 Bangumi Server 源码git clone https://gitcode.com/gh_mirrors/server17/server bangumi-server cd bangumi-server克隆完成后用task命令可以查看项目支持的所有构建目标非常直观task第二步启动 MySQL 与 Redis Bangumi Server 本地开发环境依赖 MySQL 和 Redis两者缺一不可。你可以使用 Docker 快速拉起docker run -d --name bangumi-mysql \ -e MYSQL_ROOT_PASSWORDroot \ -e MYSQL_DATABASEbangumi \ -p 3306:3306 mysql:8 docker run -d --name bangumi-redis \ -p 6379:6379 redis创建好数据库后导入项目所需的表结构数据即可表结构由 dal/dao/ 中的 GORM 模型定义。第三步编写配置文件 ⚙️项目提供了开箱即用的配置模板 config.example.toml直接复制一份cp config.example.toml config.toml默认配置已经能覆盖大部分场景核心配置项如下http.host 127.0.0.1 http.port 3_000 redis-url redis://:redis-pass127.0.0.1:6379/0 [mysql] host 127.0.0.1 port 3306 user user password password db bangumi只需要把[mysql]段改成你本地数据库的实际账号密码即可。完整的配置结构定义在 config/config.go 中所有字段都有默认值无需全部填写。 除了 toml 文件你还可以通过环境变量或.env文件配置例如MYSQL_HOST、REDIS_URI、HTTP_PORT两种方式任选其一。第四步编译并启动服务 一切就绪后运行一条命令即可编译并启动 Web 服务task web该命令会先执行task build编译出dist/chii.exe二进制再以前台方式运行 HTTP 服务。看到类似下面的输出说明 Bangumi Server 已经成功启动reading app config file ... ... http server listening on 127.0.0.1:3000启动入口在 main.go通过 cmd/cmd.go 注册了web、canal、archive三个子命令其中web就是我们刚启动的 HTTP 服务。验证服务是否正常 打开浏览器访问http://127.0.0.1:3000或者用 curl 测试接口curl http://127.0.0.1:3000/v0/subjects/8如果返回 JSON 数据说明 Bangumi Server 本地开发环境已经搭建成功所有接口都定义在 web/routes.go 中你可以对照 openapi/v0.yaml 查看完整的接口文档。常用开发命令速查表 命令用途task web编译并启动 HTTP 服务task consumer启动 Kafka 消费者同步搜索索引task test运行单元测试无需外部依赖task test-db运行需要 MySQL/Redis 的测试task lint运行 golangci-lint 代码检查task gen重新生成 GORM 代码和 Mock常见问题排查 ️Q1启动时报数据库连接失败检查 MySQL 是否启动、config.toml中的账号密码是否正确并确认bangumi数据库已创建。Q2端口 3000 被占用在config.toml中修改http.port或设置环境变量HTTP_PORT3001。Q3需要搜索功能怎么办安装并配置 Meilisearch设置MEILISEARCH_URL环境变量即可启用搜索客户端参考 internal/search/。总结 ✨到这里你的 Bangumi Server 本地开发环境已经搭建完成从克隆代码到服务启动整个过程只需要 5 分钟。这套环境可以让你深入阅读源码学习大型 Go 项目的工程实践本地调试 API 接口快速验证功能为开源社区贡献代码参与 bgm.tv 的开发快去动手试试吧祝你编码愉快【免费下载链接】serverAPI server for bgm.tv项目地址: https://gitcode.com/gh_mirrors/server17/server创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考