用途
ABC 后端开发指南是 ABC 后端开发规范参考,用于在开发、调试、运维等常见场景中为使用者提供对应的规范与操作指引。它通过「场景路由」的方式,依据用户意图读取对应的场景文件,从而在不同后端开发任务中给出相应参考。
主要能力(场景与关键词)
该指南按场景组织内容,场景与关键词如下:
- 后端编码规范与基础:对应 coding-guide.md。关键词包括 Java、Spring Boot、注解、Lombok、分层架构、编码规范、Controller、Service、Entity、DTO、CRUD、增删改查。
- RPC 服务(提供/调用):对应 rpc-guide.md。关键词包括 RPC、Feign、微服务调用、服务间通信、AbcServiceResponseBody。
- 数据库表结构变更:对应 db-migration.md。关键词包括建表、加字段、加索引、改表、数据库变更、DDL。
- 后端问题排查调试:对应 debug-guide.md。关键词包括调试、排查、报错、traceId、SLS、链路追踪。
- 日志打印规范:对应 logging.md。关键词包括日志、log、打日志、message-index、AbcLogMarker、@LogReqAndRsp。
- 异常处理规范:对应 exception.md。关键词包括异常、Exception、抛异常、错误码、NotFoundException、CisCustomException。
- 启动后端项目:对应 local-dev.md。关键词包括启动、运行、端口、本地开发、环境配置、Gradle。
- Git 分支管理(通用):使用 abc-git-flow SKILL(如果安装了)。关键词包括分支、feature、hotfix、发布、提测、合并、灰度。
- Git 分支管理(后端特有):对应 backend-git-flow.md。关键词包括 dev-join、dev-joint、test-join、test-joint、联合分支、后端发布。
使用方式
指南给出的 Instructions 为:
- 先判断用户的意图属于哪个场景;
- 读取对应的场景文件(可以同时读取多个相关文件);
- 如果用户是学习目的,用通俗易懂的语言解释概念;
- 如果用户是编码目的,严格按照场景文件中的规范生成代码;
- 如果意图不明确,先问用户想做什么,再路由到对应场景。
适用场景
适用于 Java/Spring Boot 后端开发中的编码、新建 API 接口、新建 RPC 服务、数据库变更、调试排查、日志与异常处理、本地启动项目,以及 Git 分支管理等任务;既可用于学习理解概念,也可用于按规范生成代码。
限制与项目级差异
各项目可在 .claude/skills/ 中创建同名 SKILL 覆盖或补充本指南。关于各场景文件的具体内容、代码示例、安装方式与平台支持等细节,给定资料中暂未提供。