java开发规范

### Java开发规范详解 #### 一、引言 1. **编写目的** 本文档旨在为瑞丽航空信息技术部门提供一套Java编程规范，确保所有Java开发人员能够遵循一致的编码标准和风格，以此提高代码质量、维护性和可读性。 2. **定义** 规范内包含三种不同等级的要求： - **强制**：必须严格遵守的规定。 - **推荐**：鼓励执行，但可以根据项目具体情况灵活调整。 - **参考**：提供的建议，开发者可以选择性采纳。 3. **参考资料** 本文档基于《阿里巴巴Java开发手册》进行了定制化修改，融入了瑞丽航空的实际需求和最佳实践。 #### 二、规范 ##### 2.1 代码规约 1. **命名规约** - **禁止**：代码中的标识符不得以`_`（下划线）或`$`（美元符号）开头或结尾。 - **强制**：所有变量（方法、参数、成员变量、局部变量）使用`lowerCamelCase`（小驼峰式）命名法。 - **正例**：`localValue`、`getHttpMessage()`、`inputUserId` - **反例**：`local_value`、`GetHttpMessage()`、`InputUserId` - **强制**：类名采用`UpperCamelCase`（大驼峰式）命名法。 - **正例**：`UserDO`、`XmlService`、`TcpUdpDeal`、`TaPromotion` - **反例**：`User_do`、`xml_service`、`TCPUDPDeal` - **强制**：常量名全大写，使用`_`分隔单词。 - **正例**：`MAX_STOCK_COUNT` - **反例**：`maxStockCount` - **强制**：包名一律小写，单词间用`.`分隔。 - **正例**：`net.rlair.oa.util` - **反例**：`Net.Rlair.OA.Util` - **强制**：命名不得使用拼音或中文字符。 - **正例**：`rlair`、`kunming` - **反例**：`DaZhePromotion`、`getPingfenByName()` - **强制**：抽象类名前加`Abstract`或`Base`；异常类名以`Exception`结尾；测试类名以被测类名开始，以`Test`结尾。 - **禁止**：随意缩写导致命名难以理解。 - **反例**：`AbsClass`、`Condi` 2. **常量定义** - **强制**：常量名全大写，单词间使用`_`分隔，以清晰表达其意义。 - **正例**：`MAX_STOCK_COUNT` - **反例**：`MAX_COUNT` 3. **格式规约** - **强制**：遵循特定的命名约定和代码风格，如上述所述。 4. **注释规约** - **强制**：为关键代码段添加有意义的注释，解释其作用、目的及实现逻辑。 - **推荐**：使用Javadoc格式为类、方法等添加文档注释。 5. **控制语句** - **强制**：遵循一定的控制流设计原则，如循环、分支等，确保逻辑清晰。 6. **OOP规约** - **强制**：面向对象编程时，合理使用继承、封装、多态等特性。 - **推荐**：若涉及设计模式，应在类名中体现具体模式。 - **正例**：`OrderFactory`、`LoginProxy`、`ResourceObserver` 7. **集合处理** - **强制**：在处理集合时，注意空值检查、容量预设等细节。 - **推荐**：根据集合实际应用场景选择最合适的集合类型。 8. **并发处理** - **强制**：使用线程安全的数据结构和同步机制，防止数据竞争条件。 9. **其他** - **推荐**：遵循其他有助于提升代码质量和可维护性的最佳实践。 ##### 2.2 异常处理 - **强制**：合理使用异常处理机制，区分业务异常和系统异常。 ##### 2.3 日志规约 - **强制**：使用统一的日志记录框架，如Log4j、SLF4J等。 - **推荐**：为不同级别的日志设置适当的日志级别。 ##### 2.4 MySQL规约 1. **建表规约** - **强制**：遵循统一的表结构设计原则。 2. **索引规约** - **强制**：合理创建索引，避免过度索引导致性能下降。 3. **SQL规约** - **强制**：编写高效、易读的SQL查询语句。 4. **ORM规约** - **强制**：合理使用ORM框架，如Hibernate、MyBatis等。 ##### 2.5 工程规约 1. **应用分层** - **强制**：按照模块化、层次化的结构组织代码。 2. **二方库规约** - **推荐**：合理引入第三方库，避免不必要的依赖。 3. **服务器规约** - **强制**：遵守服务器配置、部署等方面的规范。 ##### 2.6 安全规约 - **强制**：采取有效措施保护数据安全，包括但不限于加密、验证等。 ### 总结 以上总结的Java开发规范不仅包含了基础的代码编写准则，还深入探讨了面向对象编程、数据库操作、异常处理等多个方面。遵循这些规范可以帮助开发者写出高质量、可维护的代码，同时也能促进团队间的协作和沟通。希望每位开发者都能够认真对待这些规范，将其作为日常工作的指南。