阿里Java开发手册：命名规范与工程结构详解

《开发命名规范》是一份由阿里巴巴在2017年推出的Java开发手册，旨在提升行业编码规范化的标准，提高开发质量和效率，减少代码维护成本。该规范自2010年起历经多次修订和完善，直至2017年9月25日发布了终极版，内容全面且进行了深入的修正，尤其强调了单元测试的规约。 命名规范部分是该文档的核心内容之一，着重于指导开发者如何构建和命名在NC（可能指的是某种产品或项目的缩写）开发中的不同类型的文件和目录结构。具体规则如下： 1. **模块命名**：采用小写的英文字母，尽可能简短且具有明确含义，便于理解和维护。模块名应反映其功能或用途。 2. **目录结构**： - `modules/<模块名>`：存放模块的主要代码，包括公开API、私有代码、补丁、扩展、配置文件等。 - `modules/<模块名>/lib`：存放公开API的JAR包，如接口和VO。 - `modules/<模块名>/classes`：包含带目录的类文件，主要供补丁使用。 - `modules/<模块名>/META-INF/lib`和`classes`：存放私有代码的JAR包和类文件。 - `modules/<模块名>/extension/lib,classes`：用于二次扩展的API。 - `modules/<模块名>/META-INF/module.xml`：配置模块基本信息，如名称、描述和ClassLoader。 - `modules/<模块名>/extension/META-INF/lib,classes`：私有扩展API。 - `modules/<模块名>/client/lib,classes`：客户端专用但非公共的API。 - `modules/<模块名>/config`：存储模块自身的配置文件。 - `webapps\nc_web\images`：存放产品模块的图像资源。 - `lib`, `classes`, `external/lib,classes`：平台维护的公共类库，禁止第三方修改。 此外，该规范还涉及创建LFW工程（可能是某个项目或框架的简称）的步骤，包括工程目录的组织结构和命名约定。评审、批准和发布日期等相关信息也被列出，以确保规范的权威性和版本控制。 总体而言，《阿里巴巴Java开发手册》的命名规范部分为开发团队提供了一套系统化的指导，帮助他们保持代码的一致性和可维护性，是所有Java开发者在阿里巴巴体系内遵循的重要参考。