AGENTS.md 1.2 KB

zxyj-backend

Spring Boot 2.7.18 后端服务,MyBatis-Plus ORM,JWT 认证。

WHERE TO LOOK

Task Location
REST API 端点 src/main/java/com/zxyj/controller/
业务逻辑 src/main/java/com/zxyj/service/
数据实体 src/main/java/com/zxyj/entity/
MyBatis Mapper src/main/java/com/zxyj/mapper/
SQL 映射文件 src/main/resources/mapper/
配置类 src/main/java/com/zxyj/config/

CONVENTIONS

  • 分层架构: Controller → Service → Mapper,禁止跨层调用
  • ORM: MyBatis-Plus,实体使用 @TableName、@TableId(type = IdType.AUTO)
  • 响应包装: 统一 Result<T> 返回,包含 code/message/data
  • 认证: JWT Token,Header Authorization: Bearer {token}
  • 命名: Controller 以 Controller 结尾,Service 以 Service 结尾

ANTI-PATTERNS

  • DO NOT 在 Controller 直接操作 Mapper
  • DO NOT 跳过 Service 层直接调用 Mapper
  • DO NOT 硬编码数据库连接,使用 application.yml
  • NEVER 在代码中硬编码 JWT 密钥

COMMANDS

mvn clean install       # 编译打包
mvn spring-boot:run     # 启动开发服务器 (localhost:8080)
mvn test                # 运行测试