SDK 选择与版本说明
正式项目必须使用 Gitee tag 安装 SDK。本文档仅记录已从 SDK README 确认的安装格式和版本示例;如果 SDK 仓 README 或 Gitee tag 已更新,以 SDK 仓 README 和 Gitee tag 为准,不在下游项目里编造版本号。
后端 SDK
- SDK:
clsdk-go。 - 安装方式:
go get gitee.com/lixiaodongdong/clsdk-go@版本号。 - SDK README 版本示例:
go get gitee.com/lixiaodongdong/clsdk-go@v0.1.3。 - 用途:中间件服务态、用户态 token 校验、
CheckPermission、主数据、菜单、storage 等后端能力。
正式项目不得提交本地路径 replace。本地联调 SDK 源码时可以临时使用,联调完成后必须删除并恢复为 Gitee tag。
PCWEB SDK
- SDK:
clsdk-pcweb。 - 安装方式:
npm install git+https://gitee.com/lixiaodongdong/clsdk-pcweb.git#版本号。 - SDK README 版本示例:
npm install git+https://gitee.com/lixiaodongdong/clsdk-pcweb.git#v0.1.2。 - 用途:登录、菜单运行态、动态路由、权限状态、标准页面组件。
正式项目应引用明确 tag,不应直接引用 master。正式提交中不允许保留本地 file: 依赖。
APP / 小程序 SDK
- SDK:
clsdk-clapp。 - 安装方式:按 SDK 仓正式 README 和 Gitee tag 方式填写。
- SDK README 版本示例:
npm install git+https://gitee.com/lixiaodongdong/clsdk-clapp.git#v0.2.1。 - 用途:应用端登录、角色上下文、应用菜单权限、runtime provider、统一请求。
如果 tag 版本无法从 SDK README 或 Gitee tag 确认,应标注“以 SDK 仓 README 和 Gitee tag 为准”,不得编造版本。
密钥和请求头边界
SystemKey只允许后端保存。PermanentKey只允许后端保存。tempKey / X-App-Key只允许后端服务态使用。- PCWEB 和 APP / 小程序前端不得保存
SystemKey、PermanentKey、tempKey。 - PCWEB 和 APP / 小程序主要使用
app-id、addons-type、x-token等用户态上下文。 - 后端可通过
clsdk-go处理服务态能力。
版本落库与审查
go.mod、package.json、锁文件中的 SDK 版本必须能追溯到 Gitee tag。- 提交前检查是否出现本地
replace、file:、临时分支或未打 tag 的依赖。 - 升级 SDK 时同步记录变更原因和验收结果,不能只改版本号不跑构建。