前言
碎碎念
最近快过年了,无心工作,只想回家过年。听着外面的鸟叫,明明是冬天却感觉像是春天才会出现的鸟儿。看来是小鸟说回家过年,回家过年了。哈哈哈,废话不多说,咱么继续书接上回。
正文
上回分享了规约的来历,以及规约的好处。好的,现在脑袋里都有了概念,我们继续。
常量定义
没学习规约之前,我的常量定义的都很随意。随用随定义,你问我不要用魔法值,我说Java还有魔法值?
- 【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。
反例:
// 本例中,开发者 A 定义了缓存的 key,然后开发者 B 使用缓存时少了下划线,即 key 是"Id#taobao"+tradeId,导致出现故障
String key = “Id#taobao_” + tradeId;
cache.put(key, value);
说明:常量的含义就是不变量的量,说明任何人想使用这个值都是不变的。我工作中一般这样使用常量(常量名大写):
private static final String NAME = "哪吒三太子";
private static final Integer AGE = 18;
2. 【强制】在long或者Long赋值时,数值后使用大写字母L,不能是小写字母l,小写容易跟数字混淆,造成误解。
说明:Long a = 2l; 写的是数字的 21,还是 Long 型的 2?
//正例
private static final Long money = 10000000000000L;
//反例(禁止使用)
private static final Long money = 10000l;
代码格式
1. 【强制】如果是大括号内为空,则简洁地写成{}即可,大括号中间无需换行和空格;如果是非 空代码块则:
- 左大括号前不换行。
- 左大括号后换行。
- 右大括号前换行。
- 右大括号后还有 else 等代码则不换行;表示终止的右大括号后必须换行。
2. 【强制】左小括号和右边相邻字符之间不出现空格;右小括号和左边相邻字符之间也不出现空 格;而左大括号前需要加空格。详见第 5 条下方正例提示。
反例:if (空格 a == b 空格)
3. 【强制】if/for/while/switch/do等保留字与括号之间都必须加空格。
4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。
说明:包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
5. 【强制】采用 4 个空格缩进,禁止使用 Tab 字符。
说明:如果使用 Tab 缩进,必须设置 1 个 Tab 为 4 个空格。IDEA 设置 Tab 为 4 个空格时,请勿勾选 Use tab character 。
正例: (涉及 1-5 点)
public static void main(String[] args) { // 缩进 4 个空格
String say = “hello”;
// 运算符的左右必须有一个空格
int flag = 0;
// 关键词 if 与括号之间必须有一个空格,括号内的 f 与左括号,0 与右括号不需要空格 if (flag == 0) {
System.out.println(say); }
// 左大括号前加空格且不换行;左大括号后换行
if (flag == 1) {
System.out.println(“world”);
// 右大括号前换行,右大括号后有 else,不用换行
} else {
System.out.println(“ok”);
// 在右大括号后直接结束,则必须换行
} }
;而在 Eclipse 中,必须勾选
insert spaces for tabs
5/59
Java 开发手册
6. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。
正例:
// 这是示例注释,请注意在双斜线之后有一个空格
String commentString = new String();
7. 【强制】在进行类型强制转换时,右括号与强制转换值之间不需要任何空格隔开。
正例:
8. 【强制】单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则: 1)第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。 2)运算符与下文一起换行。
3)方法调用的点符号与下文一起换行。 4)方法调用中的多个参数需要换行时,在逗号后进行。
5)在括号前不要换行,见反例。 正例:
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下,换行缩进 4 个空格,并且方法前的点号一起换行 sb.append(“yang”).append(“hao”)…
.append(“chen”)… .append(“chen”)… .append(“chen”);
反例:
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下,不要在括号前换行 sb.append(“you”).append(“are”)…append
(“lucky”);
// 参数很多的方法调用可能超过 120 个字符,逗号后才是换行处
method(args1, args2, args3, … , argsX);
9. 【强制】方法参数在定义和传入时,多个参数逗号后面必须加空格。 正例:下例中实参的 args1,后边必须要有一个空格。
method(args1, args2, args3);
10.【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式,不要使用 Windows 格式。
总结
教大家一招,只需要两步,自动搞定格式化。
1、control + A
2、option + command + L(Mac ) ctrl + alt + L(windows)
OOP规约
OOP(object oriente programming)面向对象程序设计。万物皆可对象,这是Java的设计理念。
1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成 本,直接用类名来访问即可。
说明:首先要明白,虚拟机是如何处理静态变量和静态方法。静态变量和静态方法随着类的加载而加载,是早于对象的创建,同时存放于方法区的静态领域中。因此可以直接使用类名进行访问。
对象创建的顺序可简化成:类加载检查—>分配内存—>初始化零值—>设置对象头—>执行 init 。由此可见,使用对象去访问静态方法或静态变量岂不是脱裤子放屁多此一举。
class Item{
private static final String NAME = "哪吒三太子";
}
//访问
Item.SNAME;
2. 【强制】所有的覆写方法,必须加@Override注解。
方法签名: 1、方法名 2、参数列表(形参类别、个数、顺序)
说明:getObject()与 get0bject()的问题。一个是字母的 O,一个是数字的 0,加@Override 可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错。
public abstract class