Java编程规约是一份重要的开发指南，旨在提升Java代码的质量和可读性，确保团队遵循一致的编码标准。这份规约主要关注以下几个核心方面：
1. **命名风格**：
- 遵循UpperCamelCase命名规则，如类名、接口名等，除非遇到特定例外如DO/BO/DTO/VO/AO/PO/UID等。
- 方法名、参数名、成员变量和局部变量采用lowerCamelCase，体现驼峰式命名。
- 常量使用全大写，单词间用下划线分隔，确保清晰易懂。
- 抽象类名通常以Abstract或Base开头，异常类以Exception结尾，测试类以被测试类名+Test的形式。
2. **数据结构表示**：
- 使用明确的数组表示法，如int[] arrayDemo而非String args[]，以避免混淆。
- POJO类中避免使用is前缀于布尔类型变量，以防止序列化问题。
3. **包与命名规则**：
- 包名采用小写，且符合英语单词自然分隔，如com.example.myapp。
- 类名一般为单数形式，复数含义的类名用复数形式，保持一致性。
- 避免使用不规范的缩写，确保命名清晰易懂。
4. **设计模式的体现**：
- 在命名中反映所使用的模式，如OrderFactory体现工厂模式。
5. **接口与实现类**：
- Service和DAO类遵循SOA原则，对外提供接口，内部实现类以Impl后缀区分。
- 接口方法应简洁，无修饰符且有充分的Javadoc注释，避免内部变量，除非必要且是基础常量。
6. **接口与实现类命名**：
- 描述能力的接口以形容词形式命名，如Translatable。
- 枚举类名推荐加上Enum后缀，枚举成员全大写，单词间用下划线隔开。
7. **函数命名**：
- Service/DAO层的方法命名有规律：
- 获取单个对象用get前缀。
- 获取多个对象用list前缀，复数形式。
- 获取统计值用count前缀。
- 插入操作用save或类似词汇。
这些规约旨在创建一个可维护、可扩展且易于理解的Java开发环境，通过统一的编码风格和命名约定，减少误解，提高代码质量，促进团队协作。遵守这些规约有助于确保项目代码的一致性和稳定性。
我的内容管理
展开
