### JAVA程序员不可不注意的编码规范
在Java开发过程中，遵循一套合理的编码规范不仅能够提高代码的可读性和可维护性，还能够帮助团队成员更好地协作。本文将围绕标题及描述中的“JAVA程序员不可不注意的编码规范”进行展开，详细介绍相关的规范要点。
#### 一、包名（Package）
**规范要求：**
1. **命名规则：** 包名应当全部使用小写字母。这是为了避免与类名或将来可能导入的其他类名冲突。
2. **结构组织：** 通常情况下，包名的结构反映了公司的域名或者项目的模块划分。例如，一个来自域名为`com.yjhmily`的项目可能会使用`com.yjhmily.test`作为其包名的一部分。
3. **前缀选择：** 常见的顶级域名如`com`, `edu`, `gov`, `mil`, `net`, `org`等可以用于包名的前缀部分。
#### 二、类名（Class Name）
**规范要求：**
1. **命名规则：** 类名应当采用驼峰式命名法（Camel Case），即首字母大写，每个单词的首字母都大写，且单词间不使用下划线或空格分隔。例如，`FileDescription`。
2. **接口和类的区别：**
- **接口（Interface）:** 接口名通常以“I”开头，表示这是一个接口而不是具体实现类。例如，`IMenuEngine`。
- **枚举（Enum）:** 枚举类型的名称通常以“E”开头，以便与其他类型区分开来。例如，`EUserRole`。
#### 三、方法名（Method Name）
**规范要求：**
1. **命名规则：** 方法名也应采用驼峰式命名法。
2. **返回值类型：** 如果方法的返回值类型为`Boolean`，那么推荐使用`is`或`has`前缀，以明确表示这是一个布尔类型的判断方法。例如，`getCurrentUser()`, `addUser()`, `hasAuthority()`。
#### 四、参数名（Parameter Name）
**规范要求：**
1. **命名规则：** 参数名同样遵循驼峰式命名规则，并且应该能够清晰地表达该参数的含义。例如，`public UserContext getLoginUser(String loginName);`。
#### 五、常量（Constants）
**规范要求：**
1. **命名规则：** 常量名一般全部使用大写字母，并用下划线分隔单词。例如，`public static final Long FEEDBACK;` 和 `public static Long USER_STATUS;`。
2. **注释说明：** 对于重要的常量，应当添加注释说明其作用。
#### 六、注释
**规范要求：**
1. **文档注释：** 文档注释应包括类的功能介绍、作者信息以及版本控制等。
2. **文件头部注释：** 每个源文件的顶部都应该包含版权信息和文件描述。
3. **方法注释：** 对于复杂的方法，应当在方法定义前添加注释，描述该方法的功能、输入参数和返回值等。
4. **字段注释：** 对于类的成员变量，尤其是私有成员变量，应添加注释说明其用途。
5. **逻辑注释：** 对于复杂的逻辑块，需要添加注释来解释其实现细节。
6. **特殊符号注释：** 如使用到特殊符号时，也需要通过注释说明其意义。
#### 七、编码风格统一
**规范要求：**
1. **样式文件：** 可以创建一个样式文件`codetemplates.xml`来统一编码风格。例如，在IDEA（IntelliJ IDEA）或Eclipse等集成开发环境中，可以通过这种方式设置统一的编码风格。
2. **JSP文件命名：** 对于JSP文件，建议也采用类似的命名规则。例如，`viewMessage.jsp`、`editUser.jsp`等。
#### 八、项目结构
**规范要求：**
1. **Action类结构：** 通常，Action类会被放在特定的目录下，例如`WebRoot/WEB-INF/spring/action/`，并且会有一个对应的配置文件如`_ApplicationContext.xml`。
2. **服务层结构：** 服务层相关的类和配置文件也会被放在特定的目录下，例如`WebRoot/WEB-INF/spring/services/`。
3. **全局配置文件：** 全局配置文件一般命名为`globalMessages_+语言+.properties`。
4. **资源文件：** 资源文件（如`package.properties`）则用于存放各种静态资源信息。
#### 九、ORM映射文件
**规范要求：**
1. **Hibernate映射文件：** Hibernate映射文件用于数据库表和Java对象之间的映射关系，例如`Advertisement.hbm.xml`对应`Advertisement.java`。
2. **DAO层结构：** DAO层负责数据访问操作，通常会有接口和实现类，如`ICrossAdDAO`（接口）和`CrossAdDAO`（实现）。
3. **HQL查询文件：** HQL查询文件（如`resource.hbm.xml`）用于定义HQL查询语句。
#### 十、业务逻辑层
**规范要求：**
1. **业务逻辑层命名：** 业务逻辑层的命名通常包含业务逻辑相关的名词，例如`BusinessService`。
2. **BO（Business Object）：** BO对象是封装了业务逻辑的对象，用于处理复杂的业务逻辑操作。
#### 十一、查询对象
**规范要求：**
1. **查询对象命名：** 查询对象（如`QueryProgramSpec`）用于封装查询条件，方便进行复杂查询。
2. **命名规则：** 查询对象的命名规则通常为`Query+要查询的内容+Spec`，如`QueryProgramSpec`。
#### 十二、MVC模式
**规范要求：**
1. **Action设计：** 在MVC模式中，Action负责处理用户请求，并根据请求调用相应的业务逻辑层进行处理。例如，`LoginAction`可以处理用户的登录请求，并跳转到欢迎页面（如`toWelcome`）。
2. **资源文件命名：** 资源文件（如`package.properties`）用于存放各种静态资源信息。
3. **Spring配置文件：**
- **Action配置文件：** 存放在`WebRoot/WEB-INF/spring/action/`目录下的配置文件，如`_ApplicationContext.xml`。
- **服务层配置文件：** 存放在`WebRoot/WEB-INF/spring/services/`目录下的配置文件，如`Services_ApplicationContext.xml`。
- **全局配置文件：** 存放在`WebRoot/WEB-INF/spring/`目录下的配置文件，如`_ApplicationContext.xml`。
通过上述规范的制定和执行，不仅能够提升代码质量，还能有效减少后期维护成本，为项目成功打下坚实的基础。
