13.(二) 常量定义 1. 【强制】不允许出现任何魔法值(即未经定义的常量)直接出现在代码中。 反例: String key= ”Id#taobao_” +tradeId; //本例中的”Id#taobao_”cache.put(key, value); 2. 【强制】long或者Long初始赋值时,必须使用大写的L,不能是小写的l,小写容易跟数字1混淆,造成误解。 说明:Long a = 2l; 写的是数字的21,还是Long型的2? 3. 【推荐】不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。如:缓存相关的常量放在类:CacheConsts下;系统配置相关的常量放在类:ConfigConsts下。 说明:大而全的常量类,非得ctrl+f才定位到修改的常量,不利于理解,也不利于维护。 4. 【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。 1) 跨应用共享常量:放置在二方库中,通常是client.jar中的const目录下。 2) 应用内共享常量:放置在一方库的modules中的const目录下。 反例:易懂变量也要统一定义成应用内共享常量,两位工程师在两个类中分别定义了表示“是”的变量: 类A中:public static final String YES = “yes”; 类B中:public static final String YES = “y”; A.YES.equals(B.YES),预期是true,但实际返回为false,导致产生线上问题。 3) 子工程内部共享常量:即在当前子工程的const目录下。 4) 包内共享常量:即在当前包下单独的const目录下。 5) 类内共享常量:直接在类内部private static final定义。 5. 【推荐】如果变量值仅在一个范围内变化用Enum类。如果还带有名称之外的延伸属性,必须使用Enum类,下面正例中的数字就是延伸信息,表示星期几。 正例:public Enum{ MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);} (三) 格式规约 1. 【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块则: 1) 左大括号前不换行。 2) 左大括号后换行。 3) 右大括号前换行。 4) 右大括号后还有else等代码则不换行;表示终止右大括号后必须换行。 2. 【强制】 左括号和后一个字符之间不出现空格;同样,右括号和前一个字符之间也不出现空格。详见第5条下方正例提示。
反例:if (空格a == b空格) 3. 【强制】if/for/while/switch/do等保留字与左右括号之间都必须加空格。 4. 【强制】任何运算符左右必须加一个空格。 说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。 5. 【强制】代码块缩进4个空格,如果使用tab缩进,请设置成1个tab为4个空格。 正例: (涉及1-5点)
public static void main(String args[]) {
// 缩进4个空格
String say = "hello";
// 运算符的左右必须有一个空格
int flag = 0;
// 关键词if与括号之间必须有一个空格,括号内flag与左括号,0与右括号不需要空格
if (flag == 0) {
System.out.println(say);
}
// 左大括号前加空格且不换行;左大括号后换
if (flag == 1) {
System.out.println("world");
// 右大括号前换行,右大括号后有else,不用换行
} else {
System.out.println("ok");
//右大括号作为结束必须换行
}
}
补充6.【强制】注释的双斜线与注释内容之间有且仅有一个空格。正例:
// 这是示例注释,请注意在双斜线之后有一个空格
String ygb = new String();
6.【强制】单行字符数限制不超过120个,超出需要换行,换行时,遵循如下原则: 1) 换行时相对上一行缩进4个空格。 2) 运算符与下文一起换行。 3) 方法调用的点符号与下文一起换行。 4) 在多个参数超长,逗号后进行换行。 5) 在括号前不要换行,见反例。 正例:
StringBuffer sb = new StringBuffer(); //超过120个字符的情况下,换行缩进4个空格,并且方法前的点符号一起换行
sb.append("zi").append("xin")…
.append("huang");
反例:
StringBuffer sb = new StringBuffer();
//超过120个字符的情况下,不要在括号前换行
sb.append("zi").append("xin")…append
("huang");
//参数很多的方法调用也超过120个字符,逗号后才是换行处
method(args1, args2, args3, ...
, argsX);
7.【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。 正例:下例中实参的”a”,后边必须要有一个空格。 method(“a”, “b”, “c”);
8.【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。 正例: int a = 3; long b = 4L; float c = 5F; StringBuffer sb = new StringBuffer(); 说明:增加sb这个变量,如果需要对齐,则给a、b、c都要增加几个空格,在变量比较多的情况下,是一种累赘的事情。
9.【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式,不要使用windows格式。
10.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。 说明:没有必要插入多行空格进行隔开。
