Java Web SpringBoot 项目项目 Project 名、模块 Moudle 名、包名、类名、静态资源名命名规范在 Java Web SpringBoot 项目中遵循统一的命名规范是保证代码可读性、可维护性和团队协作效率的关键。虽然没有强制的硬性规定但业界已经形成了一套成熟的标准。以下是我为你整理的 SpringBoot 项目全方位命名规范指南1. 项目名与模块名命名风格kebab-case(短横线命名法)规则全部使用小写字母多个单词之间用连字符-分隔。原因避免在不同操作系统如 Windows 和 Linux路径中因大小写敏感性导致的问题同时符合 Maven 依赖引入的习惯。示例user-management-systempayment-serviceonline-bookstore模块命名建议如果是多模块项目子模块名通常基于主项目名进行扩展保持风格一致。格式{项目名}-{模块功能}示例主项目为data-processor子模块可以是data-processor-core、data-processor-api。2. 包名命名风格lowercase.dotted(全小写点分隔)规则全部使用小写字母单词之间用点.分隔严禁使用下划线或连字符。唯一性原则采用公司/组织域名反转的方式作为前缀以确保全球唯一性。例如公司域名为example.com则包名前缀为com.example。分层结构在域名后通常按照功能进行分层命名。推荐的包结构示例com.example.projectname ├── controller// 控制层 (API入口)├── service// 业务逻辑层│ └── impl// 服务实现类├── repository// 数据访问层 (DAO/Mapper)├── model// 实体类 (Entity/DTO/VO)├── config// 配置类├── util// 工具类├── exception// 异常处理└── constant// 常量类3. 类名与接口名命名风格UpperCamelCase(大驼峰命名法)规则每个单词的首字母都大写不包含下划线。具体分类规范类型命名规则示例说明Controller 类名词 ControllerUserController处理 Web 请求Service 接口名词 ServiceOrderService定义业务逻辑Service 实现名词 ServiceImplOrderServiceImpl实现业务逻辑实体类名词(单数)User,Product通常与数据库表对应Repository/DAO名词 Repository或名词 MapperUserRepository,UserMapper数据访问配置类名词 ConfigWebConfig,SecurityConfig工具类名词 UtilDateUtil,StringUtils抽象类Abstract或Base开头AbstractController接口形容词 (-able) 或 名词Runnable,TranslatableJava 中通常不加I前缀 (区别于 C#)4. 方法名与变量名命名风格lowerCamelCase(小驼峰命名法)规则第一个单词首字母小写从第二个单词开始首字母大写。方法名通常以动词开头描述动作。getUserById()calculateTotalPrice()isValid()变量名名词或名词短语避免使用单个字母循环变量除外。userListmaxRetryCount常量名全大写字母单词间用下划线分隔。MAX_CONNECTIONSDEFAULT_TIMEOUT5. 静态资源与配置文件名命名风格kebab-case或lowercase(取决于文件类型)规则通常使用全小写如果是多单词推荐使用连字符-分隔。配置文件application.yml/application.propertiesapplication-dev.yml(多环境配置)logback-spring.xml(日志配置)静态资源 (Web)目录src/main/resources/static/图片logo.png,user-avatar.jpgCSS/JSmain-style.css,app.js,utils.jsHTML 模板index.html,user-list.html(存放在templates目录下)SQL 脚本schema.sqldata-init.sql 总结速查表元素类型推荐风格示例关键点Project/Modulekebab-casepayment-service全小写短横线分隔Packagelower.dottedcom.example.project.controller域名反转全小写Class/InterfaceUpperCamelCaseUserService,OrderController首字母大写Method/VariablelowerCamelCasegetUser(),userList首字母小写ConstantUPPER_SNAKE_CASEMAX_COUNT全大写下划线分隔File (Static)kebab-casemain-style.css静态资源全小写遵循这些规范你的 SpringBoot 项目结构会非常清晰无论是自己维护还是团队协作都会更加顺畅。类名这块细节比较多需要我单独把 Controller、Service、Entity 的命名细则整理成一份速查表吗