网进科技JAVA编码规范

【网进科技JAVA编码规范】 Java编码规范是指导开发者编写清晰、可读性强且易于维护的代码的重要准则。这份规范由网进科技制定，适用于所有参与项目开发的成员。规范的目的是提高代码质量和团队协作效率。 **文件构成** 1. **文件名与类的对应关系**：公共类应以类名作为文件名，例如，`public class Point` 应保存在 `Point.java` 文件中。非公共类可以放在主要使用的公共类文件中，但要注意保持 `.java` 和 `.class` 文件的一致性。 2. **文件位置**：遵循软件包结构，将软件包名的“.”转换为目录层次。例如，`myProject.framework` 包应该放在 `<ProjectRoot>/myProject/framework` 目录，而 `com.netmarch.dto` 包则位于 `<ProjectRoot>/com/netmarch/dto`。 3. **测试类命名与位置**：测试类名通常以 `ClassNameTest` 命名，如 `Point2DTest.java`，对于软件包的综合测试类，命名为 `LastPackageNameTest`，如 `ExtremeDomoTest.java`。测试类应与被测试类处于同一目录或其子目录 "test" 下，以便于维护。 **命名规则** 5. **软件包名**：使用“.”分隔的字符串，如 `com.netmarch.domainname.projectname`。在实际项目中，包名由项目经理和开发组长统一确定。以下是一些示例： - `com.netmarch.domain`：用于存储 DTO、POJO 和 JavaBean。 - `com.netmarch.spring`：存储 Spring 相关文件。 - `com.netmarch.struts.action`：存放 Struts ACTION 类。 - `com.netmarch.struts.form`：存放 Struts 表单类。 - `com.netmarch.filter`：存放过滤器，如 session 过滤器和字符过滤器。 - `com.netmarch.listener`：存放监听器，如访问流量监听器和配置文件读取监听器。 - `com.netmarch.util`：存放通用类库。 - `com.netmarch.maps`：iBATIS 的 XML 配置文件。 - `com.netmarch.interface`：接口类。 - `com.netmarch.infaimpl` 或 `com.netmarch.dao`：接口实现类。 - `com.netmarch.abst`：抽象类。 - `com.netmarch.hibernate`：Hibernate 相关类。 - `com.netmarch.test`：测试类。 - `com.netmarch.service`：业务接口外部调用类。 - `com.netmarch.common`：基础配置类。 - `com.netmarch.excel`：生成 Excel 的操作类。 遵循这些命名规则，可以确保代码组织有序，便于理解和查找。此外，规范还提及参考了 SUN、华为、日本的编码规范，以及 Spring 和 Struts 的特定实践，以适应不断发展的技术环境。 **总结** 网进科技的JAVA编码规范强调了文件组织、命名约定以及测试代码的管理，旨在创建一致性和可维护性。遵循这些规则，开发者可以编写出更高质量的代码，降低维护成本，并提高团队间的协作效率。通过统一的包名和类名，可以减少混淆，便于代码的搜索和重构。同时，测试类的定位和命名有助于持续集成和自动化测试，进一步提升软件质量。