可运行的骨架:四个页面能打开、数据库自动建表、给 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>
72 lines
1.8 KiB
Go
72 lines
1.8 KiB
Go
// Package config 负责运行参数和文件路径。
|
||
//
|
||
// 改动本文件前必读 admin/AGENTS.md。最容易踩的一条:
|
||
// 路径必须走 DataDir(),不许硬编码、不许直接用 os.Getwd(),
|
||
// 打包成 exe 后那些写法会失效。详见 docs/admin/02-architecture.md §6。
|
||
package config
|
||
|
||
import (
|
||
"os"
|
||
"path/filepath"
|
||
"strings"
|
||
)
|
||
|
||
// DataDir 返回可写数据目录,不存在就创建。
|
||
//
|
||
// 打包成 exe 后 = exe 旁边的 data/
|
||
// go run 时 = 当前工作目录下的 data/
|
||
//
|
||
// 目录结构见 docs/admin/02-architecture.md §6:
|
||
//
|
||
// data/
|
||
// ├── admin.db
|
||
// ├── logs/
|
||
// └── uploads/
|
||
func DataDir() (string, error) {
|
||
exe, err := os.Executable()
|
||
if err != nil {
|
||
return "", err
|
||
}
|
||
|
||
dir := filepath.Join(filepath.Dir(exe), "data")
|
||
|
||
// go run 会把程序编译到系统临时目录再执行,
|
||
// 这种情况下 exe 旁边不是项目目录,要改用当前工作目录。
|
||
if isTempBuild(exe) {
|
||
wd, err := os.Getwd()
|
||
if err != nil {
|
||
return "", err
|
||
}
|
||
dir = filepath.Join(wd, "data")
|
||
}
|
||
|
||
if err := os.MkdirAll(dir, 0o755); err != nil {
|
||
return "", err
|
||
}
|
||
return dir, nil
|
||
}
|
||
|
||
// SubDir 返回 data/ 下的子目录,不存在就创建。
|
||
// 例如 SubDir("logs") -> <data>/logs
|
||
func SubDir(name string) (string, error) {
|
||
base, err := DataDir()
|
||
if err != nil {
|
||
return "", err
|
||
}
|
||
dir := filepath.Join(base, name)
|
||
if err := os.MkdirAll(dir, 0o755); err != nil {
|
||
return "", err
|
||
}
|
||
return dir, nil
|
||
}
|
||
|
||
// isTempBuild 判断这个可执行文件是不是 go run 生成的临时产物。
|
||
func isTempBuild(exe string) bool {
|
||
tmp := os.TempDir()
|
||
if tmp != "" && strings.HasPrefix(exe, tmp) {
|
||
return true
|
||
}
|
||
// go run 的产物路径里通常带 go-build 字样
|
||
return strings.Contains(filepath.ToSlash(exe), "/go-build")
|
||
}
|