JavaEE程序编码规范

变量的命名规则

1.1 常量(包含静态的)

一个或多个英文单词的组合，所有字母均大写，单词之间以“_”分隔，如：

public static final String UPDATE_FLAG = “T”；

final double PI = 3.14；

一般情况下常量的 public 等修饰符不可少。

1.2 类变量（静态变量）及实例变量

一个或多个英文单词的组合，第一个单词的首字母小写，其他单词首字母均大写，其余所有字母均小写。如:

private ProjectSes projectSes;

private static String providerUrl = “http://127.0.0.1”;

private Logger logger = Logging.getLogger("TestLogger");

一般情况下类变量（静态变量）及实例变量的 public 等修饰符不可少。

1.3 局部变量

一个或多个英文单词的组合，一般采用 Hungaryn naming 法（匈牙利定义法），如下：

以下是基本数据类型的前缀列表

其他数据类型的前缀列表

除上述情况以外的数据类型，都以 obj 作为前缀，后面跟一个能说明变量功能或意义单词作为变

量，如：

UserVO objUserVO;

1.4 参数

一个或多个英文单词的组合，第一个单词的首字母小写，其他单词首字母均大写，其余所有字母均小写。如:

public void setProjectVO(ProjectVO projectVO)

public void setUserId(String userId)

建议方法的参数不要超过 5 个，超过时可以将多个参数合并为一个对象进行传递。

1.5 其它



常用数据类型的变量，采用固定的命名，包括以下几种:

Connection conn；

ResultSet rs；

PreparedStatement pstmt；

Statement stmt；



数组变量命名与普通变量命名规则一致，如：

int iProjectId[];

public String userName[];



每个变量的声明单独占一行。不能一个类型同时声明两个变量。如：int i, j; 这样的写

法是不允许的。



不要在代码中出现不使用的变量，如果以后会用到或有其他用途要写上注释说明。



类名、变量名中含缩写词组：缩写词组全部大写，如:

String strSQL;Java 程序编码规范

第 3页

public class ProjectDAO{

}

2 方法的命名规则



方法命名的基本原则：容易看懂



一般的方法名采用两个单词动宾结构形式的名称，两个单词之间不要带其它符号，第

二个单词的首字母大写，其它的都小写。

如：readBudget(int budgetId)、deleteBudget(int budgetId)



只有一个动词形式的方法名不推荐使用。



不容易看明白的方法名或有歧义的方法名可采用多单词的形式，每两个单词之间不要

带其它符号，从第二个单词开始，每个单词的首字母大写，其它的都小写。

如：readBudgetByProjectId(int projectId)、readBudgetByProjectIdAndYear(int

projectId,int year)



方法命名不得采用缩写形式。

3 类及接口的命名规则

3.1 一般类名

一个或多个英文单词的组合，所有单词的首字母大写，其余所有字母均小写，如：

public class ProjectUser {

}

3.2 值对象

数据库表的逻辑名+VO，如：

表 PUB_DICTIONARY 的值对象名为 DictionaryVO。

3.3 Action

表名/模块名+Action，如：

字典的 Action 类名为 DictionaryAction。Java 程序编码规范

3.4 MyBatis 配置文件

表名/模块名+SQL.xml，如：

字典模块的 MyBatis 配置文件命名为 DictionarySQL.xml。

3.5 DAO

DAO 类名为模块名+DAO，如：

字典 DAO 类名为：DictionaryDAO

3.6 Application Service

Application Service 类名为模块名+AppService，如：

字典 Application Service 类名为：DictionaryAppService

3.7 工具类

工具类的类名为模块名+Util，如：

字典的工具类名为：DictionaryUtil

3.8 门面类

门面类的类名为模块名+Facade，如：

字典的门面类名为：DictionaryFacade

3.9 代理类

代理类的类名为模块名+Man，如：

字典的代理类名为：DictionaryMan

3.10 异常类

异常类的类名为模块名+Exception，如：

字典的异常类名为：DictionaryException

第 4页Java 程序编码规范

第 5页

3.11 接口类

接口类的类名为模块名+Interface，如：

字典的接口类名为：DictionaryInterface

3.12 接口实现类

接口实现类的类名为实现名+Imp，如：

字典的接口实现类名为：DictionaryImp

4 作用域

4.1 类的作用域



类的作用域保持最小范围。供包外其它类引用的类才添加 public 作用域修饰符。

4.2 方法的作用域



只供对象或类内部调用的方法必须使用 private 作用域修饰符。



包外不会调用的方法严禁使用 public 作用域修饰符。

4.3 属性的作用域



静态常量（类常量）属性可以使用各种作用域修饰符。



对象属性变量严禁使用 public 作用域修饰符。



VO 对象属性变量必须使用 private 作用域修饰符。

4.4 局部变量的作用域

【下载地址】

百度网盘链接：https://pan.baidu.com/s/1gQCsS7rGvEtbjUYB2ZTwhA

提取码：petj