可运行的骨架:四个页面能打开、数据库自动建表、给 Client 的三个接口
按契约响应。业务逻辑留 35 处 TODO(骨架),每处标明要点和文档章节。
结构(对应 docs/admin/02-architecture.md §2/§3)
- handler/web + handler/api 分开:页面要 CSRF、出错渲染错误页;
接口要认证、出错返回 JSON。混在一起迟早写错
- service 不认识 *gin.Context,方便不起服务器直接单测
- 只有 repository 能写 SQL
- 模板用 {{define "目录/名字"}},一次全部 ParseFS 进来不冲突
- 模板和静态资源用 //go:embed 打进二进制
已实测(Go 1.23.0,本机验证)
- go build / go vet / gofmt 全部通过
- 单文件产物 34MB,无需 cgo
- 四个页面 + 静态资源均 200,/ 正确 302 到 /shopee
- 建表 7 张 + 索引 10 个,user_version=1,二次启动不重复建表
- claim 带 X-Client-Id 返回 204(无任务可领),
缺 X-Client-Id 返回 400 + 契约格式的 JSON 错误体
依赖版本被 Go 1.23.0 卡死,已钉住并写进文档
- gin v1.11.0 (v1.12.0 起要求 Go >= 1.25.0)
- modernc.org/sqlite v1.38.0(v1.40.0 起要求 >= 1.24.0,v1.48.0 起 >= 1.25.0)
- excelize v2.9.1 (尚未入 go.mod,写导入功能时再加)
直接 go get 不带版本会拉到最新版并报 requires go >= 1.25.0,
所以文档里的命令一律带版本号。要升依赖就得先升 Go。
一处主动调整:迁移语句从「一个字符串装多条 SQL」改成 [][]string 逐条执行。
database/sql 的 Exec 对一次多条语句的支持因驱动而异,拆开最稳妥,
报错还能精确到第几条。
说明:Gitea 尚未配置,本次无对应工单号。
admin/testdata/ 只有 README,脱敏小样本需人工制作。
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
6.2 KiB
00 Admin 上手指南
- 文档状态:基线草案
- 读者:第一次接手 Admin 的开发者
- 目标:照着做完,能在自己电脑上把 Admin 跑起来,并知道下一步读哪份文档
这份文档只讲"怎么把环境搭好、怎么跑起来"。业务规则不在这里,见 文档索引。 遇到不认识的词(货运单、upsert、SKU 映射……),先查 术语表。
1. 准备电脑环境
| 需要什么 | 版本 | 怎么确认装好了 |
|---|---|---|
| Go | 1.23.0 | go version 输出 go version go1.23.0 windows/amd64 |
| Git | 任意较新版本 | git --version 有输出 |
| DB Browser for SQLite | 任意 | 用来看数据库,可选但强烈建议装 |
版本已定为 go1.23.0,写在 admin/go.mod 里。低于这个版本可能编译不过。
不需要装 gcc。 本项目的 SQLite 驱动是纯 Go 实现的
(modernc.org/sqlite),不依赖 cgo,这也是选它的原因——
go build 直接出单个 exe,不用配 C 编译器。
2. 拉依赖
先配国内代理,否则大概率拉不动:
go env -w GOPROXY=https://goproxy.cn,direct
正常情况下 go.mod 和 go.sum 已经在仓库里了,直接:
cd D:\chengma\cmautobuy\admin
go mod download
预期没有输出——Go 的惯例,成功时不打印东西。
万一需要重新拉依赖
[必须] 命令必须带版本号。 直接 go get github.com/gin-gonic/gin
会拉到最新版,然后报 requires go >= 1.25.0——因为这几个库的新版本
都已经不支持 Go 1.23.0 了。
go get github.com/gin-gonic/gin@v1.11.0
go get modernc.org/sqlite@v1.38.0
go mod tidy
写 Excel 导入功能时再把 excelize 加进来(现在没有代码 import 它,
go mod tidy 会把它去掉,这是 Go 的正常行为):
go get github.com/xuri/excelize/v2@v2.9.1
这三个是在 Go 1.23.0 下实测能编译通过的最高版本, 为什么不能更高见 admin/AGENTS.md 技术栈一节。
[必须] go.mod 和 go.sum 都要提交 Git,否则别人拉下来版本对不上。
SQLite 驱动不要换成
mattn/go-sqlite3,那个需要 cgo, 得装 gcc,还会让go build出不了单文件 exe。
3. 跑起来
cd D:\chengma\cmautobuy\admin
go run .
然后浏览器打开 http://localhost:8080。
这个命令是安全的:Admin 只管理数据,不会连手机、不会下单。放心随便跑。
改了代码要重启才生效(Go 不像 Python 那样改完就生效)。按 Ctrl+C 停掉再 go run .。
4. 你应该看到什么
左边(或顶部)是四个模块的导航:
| 模块 | 干什么的 |
|---|---|
| 蝦皮数据 | 导入蝦皮商品报表,填 PDD 链接,发起采集 |
| 顺运宝数据 | 同步货运单,匹配规格,生成采购任务 |
| 采购任务 | 看任务执行到哪一步了 |
| 客户端列表 | 看哪些客户端在干活 |
每个页面都是同一个结构:上面工具条 / 中间表格 / 下面状态条。 四个页面长得像是故意的,见 05 界面规范。
5. 常见报错
| 报错 | 原因 | 怎么办 |
|---|---|---|
go: command not found |
Go 没装或不在 PATH | 装 Go,重开 PowerShell |
dial tcp ... i/o timeout |
拉不到模块 | 配 GOPROXY,见第 2 步 |
no required module provides package |
依赖没装 | 回第 2 步跑那三条 go get |
listen tcp :8080: bind: ... |
8080 端口被占了 | 换端口:go run . -port 8081,或关掉占用的程序 |
| 页面全是没样式的白底黑字 | 静态文件没加载到 | 确认是从 admin/ 目录启动的,静态文件路径是相对的 |
database is locked |
有别的程序占着数据库 | 关掉 DB Browser 再试;程序运行时只读打开是可以的 |
| 导入 Excel 报错但没说哪一行 | 解析器没带行号 | 这是 bug,报错必须带行号,见 06 §2 |
6. 数据库在哪、怎么看
跟 Client 一样是便携模式——数据都在程序旁边的 data/ 里:
admin/data/
├── admin.db 数据库
├── logs/ 运行日志
└── uploads/ 上传的 Excel 原件
跑源码时在 admin\data\;将来打包成 exe 后,在 exe 旁边。
用 DB Browser for SQLite 打开 admin.db 就能看数据。
每张表什么意思见 03 数据模型。
写代码时不要自己拼这个路径,用统一的
DataDir()函数, 见 02 架构 §6。
7. 拿样本数据试一下导入
蝦皮的真实报表不在仓库里——里面有逐商品的台币销售额,属于商业数据,
已在 .gitignore 里排除。
需要的话找项目负责人要一份,放到仓库根目录的 raw_data/ 下:
raw_data/蝦皮数据样本.xlsx
参考样本是 11287 行 = 5195 商品汇总行 + 6092 SKU 行, 导入后应得到 5195 条商品 + 6092 条 SKU。数字对不上就是解析有问题。
写自动化测试不要用这份大文件,用
admin/testdata/下已脱敏的小样本, 见 06 质量与安全 §2.1。
解析规则见 03 数据模型 §3.3,那里说明了为什么一个文件要拆成两张表。
8. 提交代码前的自检
cd D:\chengma\cmautobuy\admin
go vet ./... # 静态检查,有问题会打印出来
go build ./... # 能编译
go test ./... # 测试能过
三条都没报错就算通过。完整验证要求见 admin/AGENTS.md §验证。
9. 接下来读什么
| 我要做的事 | 读这份 |
|---|---|
| 改页面、加表格列 | 05 界面规范 |
| 加字段、改表、写 SQL | 03 数据模型 |
| 改给 Client 的接口 | 04 Client 接口实现 + Client 侧契约 |
| 改 Excel 导入 | 03 数据模型 §3.3 |
| 搞不清这功能要不要做 | 01 产品需求基线 |
无论做哪一样,都必须先看一遍 admin/AGENTS.md(技术栈和红线)。