java开发规范
(一)java命名规范
1、变量、成员、方法名统一采用驼峰命名(lowerCamelCase),做到见语知其义
例子:变量——用户数据(userList)、方法——getUserData(int type)等。
说明:正常变量定义使用驼峰命名,特殊的如DTO\VO\DO等除外。
2、类名的定义
(1)普通类名采用大写字母开始;
(2)抽象类采用Abstract或Base开头。 例子:普通类——class
UserModel,抽象类——abstract class AbstractUserDefinition等。
3、常量、类型、接口、子类的定义
(1)常量使用全大写且单词之间用"_“隔开; (2)boolean变量不能使用is开头;
(3)接口尽量不要修饰符、子类紧跟接口追加Impl。
例子:常量——SORT_TYPE,布尔类型——flag,接口——UserService,实现类——UserServiceImpl等。
说明:常量不可组装,需要原子性定义,不能出现"KEY”+SORT_TYPE这种内部出现。
4、包名、异常、枚举、方法名称的定义
(1)包名一律采用小写; (2)异常都采用_Exception结尾; (3)枚举都是以Enum结尾;
(4)方法名称——根据方法内容采用如插入insert-*。
例子:异常——UserException,包名——st,枚举——UserEnum,方法名称——insertUser等。
5、领域模型定义规范:主要是以VO\DTO\DO等结尾
例子:用户数据——UserDTO等 ​(1)数据对象:xxxDO,xxx 即为数据表名。
​(2)数据传输对象:xxxDTO,xxx为业务领域相关的名称。 (3)展示对象:xxxVO,xxx一般为网页名称。
​(4)POJO是DO/DTO/BO/VO的统称,禁止命名成xxxPOJO。
(二)代码格式规范
1、括号代码要求
左大括号前不换行、左大括号后换行、右大括号前换行、右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行。
如:
public static void main(String[] args) {
    String name = "test名称";
    if(name.equals("prod")){
        System.out.println("prod 谨慎!");
    }else if(name.equals("test")){
        System.out.println("test 不删服务器就行!");
    }else{
        System.out.println("别砸电脑就行!");
    }
}
2、括号中间的操作变量要有空格,左右括号不出现空格。
如:if(a == b)
3、注释规范:注释的双斜线与注释内容之间有且仅有一个空格
如:
// 变量作用
boolean switchTree = false;
4、行字符数限制不超过120个,超出需要换行,换行时遵循如下原则:
(1)第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进; ​
(2)运算符与下文一起换行;
​(3)方法调用的点符号与下文一起换行; ​
(4)方法调用中的多个参数需要换行时,在逗号后进行; ​
(5)在括号前不要换行。 例子:
StringBuilder sb = new StringBuilder(); // 超过 120 个字符的情况下,换行缩进 4 个空格,并且方法前的点号一起换行 sb.append(“A”).append(“B”)…java switch case string
.append(“C”)…
.append(“D”)…
.append(“E”);
错误示例:
StringBuilder sb = new StringBuilder(); // 超过120个字符的情况下,不要在括号前换行,下面是违反(5)条