唯品会Java开发手册：规范化编程实践

"唯品会Java开发手册v1.0.2是一份基于阿里巴巴Java开发手册定制的企业级规范文档，融入了唯品会内部实践经验和多部经典编程书籍的指导原则，如《Clean Code》和《Effective Java》。手册涵盖命名、格式、注释、方法设计、类设计、控制语句、基本类型、集合处理、并发处理、异常处理、日志规约、其他设计等多个方面，并提供Eclipse/IntelliJ格式模板和Sonar代码规则检查以确保规范落地。此外，手册还包含了对阿里巴巴手册的增补与删减记录，以及一系列命名规约的详细规则，强调避免使用拼音缩写，禁止非标准英文缩写，以及避免使用其他编程语言的特殊前缀和后缀。" 在唯品会的Java开发规范中，命名规约扮演着至关重要的角色，旨在提高代码可读性和维护性。例如： 1. 强制规定禁止使用拼音缩写，因为这可能会导致阅读者理解困难。如果必须使用中国式业务词汇，应选择广泛理解和接受的英文名称。 2. 非标准的英文缩写也被禁止，以保持一致性和标准。 3. 避免使用其他编程语言特有的前缀或后缀，以保证Java代码的纯粹性和一致性。 4. 推荐采用具有适当“模糊度”的命名策略，局部变量应根据上下文清晰度来决定其具体名称。例如，当上下文明确时，可使用简略的list，但在不确定的情况下，使用更具描述性的如userList。 5. 避免使用带编号的变量名，如a1、a2，以及无意义的重命名，如将方法参数名为bookList，局部变量名又命名为theBookList。 6. 类和方法的命名应当避免引起混淆，比如在同一应用或类中，Account、AccountInfo和AccountData类，或者getAccountInfo()、getAccountData()等函数，需要清晰区分它们的职责和用途。 此外，手册还包括了格式规约、注释规约、方法设计、类设计等多方面的详细指导，旨在提升代码质量和团队协作效率。通过Eclipse/IntelliJ格式模板和Sonar代码规则检查，开发者可以在编码过程中自动遵循这些规范，确保代码质量的统一和高标准。同时，手册还提供了Sonar规则的定制示例，以适应唯品会的具体需求。参考文献列表中包含《Clean Code》和《Effective Java》等经典著作，进一步强化了手册的专业性和权威性。