唯品会Java开发规范手册

"唯品会Java开发手册是一个基于阿里巴巴Java开发手册，并结合唯品会内部实践，参考《Clean Code》和《Effective Java 2nd》等经典书籍制定的开发规范。该手册旨在提供一套适用于企业级Java开发的详细规则，包括命名、格式、注释、方法设计、类设计等多个方面，旨在提升代码质量和团队协作效率。" 1. **命名规约** - 强制性规则1：禁止使用拼音缩写，以减少阅读难度。 - 强制性规则2：禁止使用非标准的英文缩写，确保代码的清晰度。 - 强制性规则3：禁用其他编程语言的前缀和后缀，如_name, name_, mName, i_name等，以保持Java语言的统一性。 - 推荐规则4：包名应全小写，由一个英语单词组成，尽量避免使用下划线或大小写分隔。 - 强制性规则5：类名和接口名遵循UpperCamelCase风格，TCP、XML等缩写也要遵循驼峰形式，但允许特定例外，如DTO、VO等。 2. **格式规约** - 预计这部分涵盖代码缩进、空格使用、括号位置、行宽限制等方面的规范，确保代码整洁、易读。 3. **注释规约** - 注释应清晰明了，描述代码功能、作用和修改历史，以便他人理解代码。 4. **方法设计** - 方法设计可能涉及单一职责原则、方法参数数量限制、返回值使用、异常处理等方面，旨在提高代码的可维护性和可测试性。 5. **类设计** - 类的设计应遵循开闭原则、里氏替换原则等面向对象设计原则，同时考虑封装、继承和多态的使用。 6. **控制语句** - 控制语句的规范可能包括if-else、switch-case的使用、循环结构的优化等。 7. **基本类型** - 基本类型的使用应避免装箱拆箱，减少不必要的性能损耗。 8. **集合处理** - 集合类的使用应遵循最佳实践，避免空指针异常，正确使用泛型，以及考虑并发安全问题。 9. **并发处理** - 并发处理部分可能包括锁的使用、并发集合的选择、线程池的管理等，确保多线程环境下的正确性和性能。 10. **异常处理** - 异常处理要求明确区分检查异常和运行时异常，避免滥用try-catch，确保异常信息的清晰和有意义。 11. **日志规约** - 日志记录应包含必要的上下文信息，级别设定合理，便于问题排查。 12. **其他设计** - 可能涉及模块划分、代码复用、设计模式等更广泛的设计原则。 13. **规范落地** - 规则的实施依靠Eclipse/Intellij的格式化模板和Sonar代码规则检查工具，对不符合规则的部分进行定制和优化。 14. **参考资料** - 包括《Clean Code》、《Effective Java 2nd》等经典书籍，以及SEI CERT Oracle编码标准和Sonar代码检查规则。 通过这些规约，开发者可以编写出更高质量、更具可读性和可维护性的Java代码，符合唯品会和业界的最佳实践。