一、项目包结构（Package Naming）

com.yourcompany.projectname ├── controller// 控制器层，接收请求├── service// 业务逻辑层│ ├── impl// 服务实现类├── repository// 数据访问层（DAO），或使用 mapper├── model// 实体类（与数据库表对应）│ ├── dto// 数据传输对象（API 进出参数）│ ├── vo// 视图对象（用于前端展示）├── config// 配置类（如 Redis、Swagger、Security）├── common// 通用工具、常量、异常、枚举│ ├── constant │ ├── enums │ ├── exception │ ├── utils ├── interceptor// 拦截器├── filter// 过滤器├── aspect// AOP 切面├── event// 事件监听└──Application.java// 启动类

命名规则：

• 包名全小写，多个单词用.分隔，如com.example.usercenter。
• 分层清晰，避免循环依赖。

二、常用类文件命名规范

命名约定：

• 接口与实现：接口不加I前缀（避免 C# 风格），实现类加Impl后缀。
• DTO 按用途命名：XxxRequest,XxxResponse,XxxQuery,XxxCommand。
• 测试类：XxxTest.java或XxxTests.java，放在src/test/java对应包下。

三、配置文件命名及作用

Spring Boot 项目通常使用application.yml或application.properties，多环境配置遵循application-{profile}.yml模式。

推荐：用 yml 格式，清晰层次，避免重复。

四、接口（API）编写规范

1. URL 命名（RESTful 风格）

• 使用名词复数，小写，用/分隔，如：
  • GET /api/users→ 查询用户列表
  • GET /api/users/{id}→ 查询单个用户
  • POST /api/users→ 创建用户
  • PUT /api/users/{id}→ 全量更新
  • PATCH /api/users/{id}→ 部分更新
  • DELETE /api/users/{id}→ 删除用户
• 使用@RequestMapping("/api")作为根路径。

2. HTTP 方法对应操作

3. Controller 方法命名

• 方法名尽量体现业务，如listUsers(),getUserById(),createUser(),updateUser(),deleteUser()。
• 使用@GetMapping,@PostMapping等注解，明确路径。

4. 参数接收

• 路径参数：@PathVariable
• 查询参数：@RequestParam
• 请求体：@RequestBody
• 混合使用 DTO 接收复杂对象。

5. 统一响应格式

建议封装一个通用Result<T>类，包含code,message,data，让前端统一处理。

五、常用 Maven / Gradle 插件

Maven 插件（pom.xml）

Gradle 插件（build.gradle）

六、常用 IDE 插件（以 IntelliJ IDEA 为例）

七、其他关键文件

八、命名总结（快速记忆口诀）

• 包：全小写，点分隔，分层清晰。
• 类：大驼峰（PascalCase），名词，表达实体或功能。
• 方法：小驼峰（camelCase），动词 + 名词，如getUserById。
• 变量：小驼峰，名词，明确意义。
• 常量：全大写，下划线分隔，如MAX_RETRY_COUNT。
• 枚举：类名大驼峰，枚举值全大写。
• 接口 URL：资源名词复数，小写，使用/层级。

九、给小白的一些额外建议

1. 遵循命名约定：团队内部统一，借助插件（如 Alibaba 规约）检查。
2. 多利用 IDE 模板：如 IDEA 的live templates创建快捷代码片段。
3. 善用依赖管理：使用 Spring Boot Starter 可以减少繁琐配置。
4. 环境分离：开发、测试、生产配置独立，避免混淆。
5. 日志留痕：使用 Lombok 的@Slf4j，方便调试和问题定位。
6. 版本控制：及时提交，写好 commit message，遵循语义化版本。

这份清单涵盖了从项目结构到编码细节的大多数场景，希望它能帮助你快速上手并养成良好的习惯。如果你在具体使用中遇到问题，欢迎随时查阅官方文档或社区实践，也欢迎向我提问。祝编码愉快！🚀