唯品会Java开发手册 1.0.2版本

《唯品会Java开发手册1.0.2版本》是对阿里巴巴Java开发手册的补充和精简，结合了《Clean Code》和《Effective Java》等经典著作的精华，旨在为Java开发者提供一套符合唯品会实际需求的编码规范。手册涵盖命名、格式、注释、方法设计、类设计、控制语句、基本类型、集合处理、并发处理、异常处理、日志规约等多个方面，以提高代码质量和团队协作效率。 1. **命名规约** - **禁止拼音缩写**：避免使用拼音缩写，除非是中国特有的业务词汇没有通用英文对应。 - **避免非标准英文缩写**：例如，不应将`AbstractClass`缩写为`AbsClass`，`condition`缩写为`condi`。 - **禁止其他语言风格的前缀和后缀**：避免使用如_name, name_, mName, i_name等其他编程语言中的特殊前缀和后缀。 - **推荐明确的命名**：命名的模糊度要适中，局部变量应具有足够的描述性，如`userList`而非`list`，避免使用编号表示的变量如`a1, a2`。 - **包名全小写**：遵循单个英文单词点分隔的命名规则，不使用下划线或大小写分隔。 - **类名与接口名**：使用UpperCamelCase风格，如`UserId`, `XmlService`，特殊情况下如DTO/VO可例外。 - **方法名、参数名、成员变量、局部变量**：使用lowerCamelCase风格，如`localValue`, `getHttpMessage`。 2. **格式规约** - 手册中未具体列出，但通常包括代码缩进、空格使用、大括号放置位置等一致性规定，以保持代码整洁。 3. **注释规约** - 提供清晰的注释以解释复杂逻辑或不易理解的部分，避免无意义的注释。 4. **方法设计** - 方法应简洁，职责单一，遵循单一职责原则（SRP）。 5. **类设计** - 遵循面向对象的设计原则，如封装、继承、多态，以及 SOLID 原则。 - 类的职责应明确，避免过大的类和过长的方法。 6. **控制语句** - 避免使用复杂的嵌套控制结构，提倡使用更清晰的代码结构。 7. **基本类型** - 使用合适的包装类或基本类型，避免不必要的自动装箱拆箱。 8. **集合处理** - 遵循集合API的最佳实践，避免潜在的空指针异常和其他常见错误。 9. **并发处理** - 使用适当的同步机制，如`synchronized`关键字，`java.util.concurrent`包中的工具类。 10. **异常处理** - 适当的异常捕获和处理，避免过度使用`catch (Exception e)`。 11. **日志规约** - 使用合适的日志框架，如Log4j，制定统一的日志级别和格式。 12. **规范落地** - 通过代码格式模板和Sonar代码规则检查工具来实施这些规范，对Sonar规则进行定制以适应唯品会的特定需求。 此外，手册还提供了参考资料列表，包括《Clean Code》、《Effective Java 2nd》和Sonar Java Rules，以及定制记录，以跟踪与阿里巴巴Java开发手册的差异。 通过遵循这套规范，唯品会期望提升代码质量，降低维护成本，提高团队合作效率。对于开发者而言，理解和实践这些规范是提高个人专业素养的重要途径。