JAVA系统开发规范

JAVA开发规范

编写人：彭毅

批准人：

批准日期：

版本历史

目录

1前言 (4)

1.1文档目的 (4)

1.2适用范围 (4)

1.3名词解释 (4)

1.4参考资料 (4)

2Java开发规范 (4)

2.1排版规范 (5)

2.1.1缩进 (5)

2.1.2分界符（如大括号‘{’和‘}’） (5)

2.1.3空格 (6)

2.1.3.1 加空格的情况 (6)

2.1.3.2 不加空格的情况 (6)

2.2注释规范 (7)

2.3命名规范 (7)

2.3.1包名 (7)

2.3.2类名和接口 (7)

2.3.3方法名 (7)

2.3.4属性名 (8)

2.3.5变量 (8)

2.3.6常量 (8)

2.4编码规范 (8)

2.4.1明确方法功能 (8)

2.4.2明确类功能 (9)

2.4.3三层调用顺序 (9)

1 前言

1.1 文档目的

代码规范对程序员很重要的一些原因：

一、一个软件得花费其生命周期的80%去维护。

二、几乎没有任何软件在整个生命周期中是由其原作者维护的。

三、代码规范提高了软件的可读性，能够让工程师更快、更透彻的了解新的代码。

1.2 适用范围

本规范规定了使用Java语言编程时排版、注释、命名、编码的规则。

本规范适用于使用Java语言编程的产品和项目

1.3 名词解释

1.4 参考资料

2 Java开发规范

日志记录规范规范日志设计规范主要目的是节省工作量，帮助对问题进行诊断。最终终

端用户可以获得更好的应用程序，并能从技术支持团队获得迅速的响应。

2.1 排版规范

2.1.1 缩进

程序块要采用缩进风格编写，缩进一个tab键。

示例：以下例子不符合规范

public void add(int add,int addend){

return add + addend;

}

应该如下书写

public void add(int add,int addend){

return add + addend;

}

2.1.2 分界符（如大括号‘{’和‘}’）

根据我们的编码习惯，左大括号“{”位于声明语句同行的末尾，右大括号“}”另起一行，与相应的声明语句对齐，除非是一个空语句，“}”应紧跟在“{”之后。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式，空构造函数除外。

示例：以下例子不符合规范

for (...)

{

... // program code

}

if (...)

{

... // program code

}

void example_fun( void )

{

... // program code

}

public XX(){

}//空构造函数

应该如下书写

for (...) {

... // program code

}

if (...) {

... // program code

}

void example_fun( void ){

... // program code

}

public XX(){}

2.1.3 空格

在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。

2.1.

3.1 加空格的情况

一、逗号、分号只在后面加空格。

int a, b, c;

二、比较操作符, 赋值操作符"="、"+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格。

if (current_time >= MAX_TIME_VALUE)

a =

b + c;

a *= 2;

a =

b ^ 2;

三、if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。if (a >= b && c > d)

2.1.

3.2 不加空格的情况

一、"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。

flag = !isEmpty; // 非操作"!"与内容之间

i++; // "++","--"与内容之间

二、"."前后不加空格。

p.id = pid; // "."前后不加空格

2.2 注释规范

目前暂时不定，尽量使用类名、变量名和方法名代码注释。如保存用户方法，如果我们命名成saveUser，那么一看就知道这个方法是保存用户。

2.3 命名规范

2.3.1 包名

包名采用域后缀倒置的加上自定义的包名，采用小写字母。在项目内部应该规划好包名的范围，防止产生冲突。产品线的产品使用产品的名称加上模块的名称。

格式：

cn.shengyuan.项目名称(产品).模块名称.子模块名称

示例：

应该如下书写

通用dao模块包名：cn.shengyuan.ebp.core.dao;

通用util模块包名：cn.shengyuan.ebp.core.util;

2.3.2 类名和接口

类名和接口使用意义完整的英文和数字描述，每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。

类名是一个名词，尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被广泛的使用，如URL，HTML)。

示例：

OrderInformation, CustomerList, LogManager, LogConfig

2.3.3 方法名

方法名是一个动词，使用意义完整的英文和数字描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。

示例：

private void calculateRate();

public void addNewOrder();

方法中，存取属性的方法采用setter 和getter方法，动作方法采用动词和动宾结构。

直接使用工具生成(Sun标准)。

2.3.4 属性名

属性名使用意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同。

示例：

private userName;

private orderSn;

private productName;

2.3.5 变量

变量名应该简短且有意义。变量名的选择应该便于记忆，并设计得能顾名思义。除临时“一次性”的变量外，避免用一个字符的变量名。临时变量通用的名称是整型的i、j、k、m 和n；字符型的c、d、e。

示例：

int i;

char c;

float myWidth;

2.3.6 常量

常量名使用全大写的英文描述，英文单词之间用下划线分隔开，并且使用static final 修饰。

示例：

public final static int MAX_VALUE = 1000;

public final static String DEFAULT_START_DATE = "2001-12-08";

2.4 编码规范

2.4.1 明确方法功能

明确方法功能，精确（而不是近似）地实现方法设计。一个函数仅完成一件功能，即使简单功能也应该编写方法实现。

说明：虽然为仅用一两行就可完成的功能去编方法好象没有必要，但用方法可使功能明确化，增加程序可读性，亦可方便维护、测试。

示例：

不符合规范的

public void xxx(){

…

int sum = add + added;//a与b的和

….

}

应该如下书写:

public void xxx(){

…

int sum = add(add,added);//a与b的和

….

}

public add(int add,int added){

return add + added;

}

2.4.2 明确类功能

明确类的功能，精确（而非近似）地实现类的设计。一个类仅实现一组相近的功能。

说明：划分类的时候，应该尽量把逻辑处理、数据和显示分离，实现类功能的单一性。

示例：

数据类不能包含数据处理的逻辑。

通信类不能包含显示处理的逻辑。

2.4.3 三层调用顺序

control(展示层)->service（服务层）->dao（数据访问层）。control层的方法必须try..catch，同层之前最好不要调用，如果调用，则说明设计上有问题。从而service和dao 层不用try…catch（除非必须try..catch）。