Alibaba《Java开发规范》笔记

前言

一种工具被发明出来，那么针对这种工具的各种使用规则、条条框框就随之而来。无规矩不成方圆，无制度则无国家，无风格不成代码！治国有国法、排兵布阵有章法、那么写代码也有它界内通用的不成俗的约定。最近刚好在看alibabaJava开发手册，只听说是业界内通用的Java代码规范小红书。这不也刚转入Java的阵营，怎的也不能落人之后啊。树要皮，人要脸，程序员的脸不就你写的那一手老代码嘛！！此书分为好几大块，我没有读完，但只针对基本Java代码规范做了阅读，然好记性不如烂笔头，遂以本文以录之。

命名风格

类、接口

• 统一采用 UpperCamelCase风格

// 正确的命名
class People {}

// 错误的命名
class people {}

• 抽象类

// 以```Abstract```或者```Base```命令开头

// 正确的命名
abstract class AbstractPeople {}

//错误的命名
abstract class People {}

• Service接口

// 命名应当以 Service结尾

// 正确的
interface OrderService {}

// 错误的
interface OrderServiceInterface {}

• 实现类接口

// 实现接口应当以 impl 结尾

// 正确的
class OrderServiceImpl {}


// 错误的
// 非以Impl结尾的类名

• Enum类

// enum类使用 enum结尾

// 正确的
enum OrderStatusEnum {}

• 异常类

// 以Exception结尾

// 正确的
class ParseTextException {}

• Test类

// 正确的
class OrderServiceTest {}

• 工具类

// 工作类那么以Utils结尾

// 正确
class MoneyUtils {}

• 数据传输对象(DTO)

分层设计的时候，通常有一个类来负责传递数据，从Controller通过转化传递到Service 或者 从Service传递到Spi,或者用以不同模板的数据传递。那么这种对象称之为DTO(Data Transfer Object)

// 命名方式以DTO结尾
// 必须实现 Serializable 接口
class UserInfoDTO implements Serializable {
  	
    // 必须有 定义 serialVersionUID
  	private static final long serialVersionUID = 8300693945573325343L;
  	
  	//getter setter 必须有
  	
  	// 必须有 toString方法
    public void toString() {
      	
    }
}

• 复杂聚合对象(BO)

有些业务场景十分的复杂，要用一个对象来聚合其他几个对象，来形成一个业务对象。比如订单商品BO，在这个BO里 既要有商品的信息、也要有活动的信息。那么这种对象可以称之为BO(Business Object)

// 命名方式以BO结尾
// 必须实现 Serializable 接口
class OrderComputeBO implements Serializable {
  	
    // 必须有 定义 serialVersionUID
  	private static final long serialVersionUID = 8300693945573325343L;
  	
  	//getter setter 必须有
  	
  	// 必须有 toString方法
    public void toString() {
      	
    }
}

• 接口输出VO

通常以用Api返回的数据结构，以VO结尾来命令(Value Object)

// 命名方式以VO结尾
// 必须实现 Serializable 接口
class GoodsInfoVO implements Serializable {
  	
    // 必须有 定义 serialVersionUID
  	private static final long serialVersionUID = 8300693945573325343L;
  	
  	//getter setter 必须有
  	
  	// 必须有 toString方法
    public void toString() {
      	
    }
}

常量

定义一个常量、几乎所有语言潜移默化都是大写，带下划线、每个单词用下划线分开，表达清楚，见词明意。

// 下面是一个用于定义默认的分享开头
private static final int DEFAULT_SHARE_SWITCH = 1

变量、方法、参数

这个国际通用、一律采用的是lowerCamelCase的命名规则、尽量的表达出意思。

/**
*	  1:方法以动词开始、表示某个行为，，见名明意
*   2:方法内参数用 ","隔开，每个后面有一个空格
*/

public String getUserBaseInfo(String name, int age) {
   	String baseInfo = name + age;
  	return baseInfo;
}

包名

• 统一使用小写、用点号分隔、使用单数

代码格式

缩进

• 采用 4 个空格缩进，禁止使用 Tab 字符。

注释

• 注释的双斜线与注释内容之间有且仅有一个空格。
• 类上的注释要表明作者、和日期
• 方法上面要注释要表明各参数的意义、以前方法的说明

/**
*@author Savey
*@date 2016/10/31
*/
class People {
  	
  	/**
  	* 功能：吃某种食物
  	* @params food 食物
  	*/
  	pulic void eat(Food food) {
        // 方法体内 单行 用 // 注释
      	
      	/*
      	*  多行使用\/**\/ 注释说明
      	*/
      	food.getName();
    }
}

代码块

• 一行不能超过120个字符

  • 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进
  • 运算符与下文一起换行
  • 法调用的点符号与下文一起换行
  • 方法调用中的多个参数需要换行时，在逗号后进行。
  • 在括号前不要换

• 方法入参数要有空格分开

• 单个方法的总行数不超过 80 行

其他

禁止：有反人伦、道德、地域歧视、种族歧视、性别歧视等一切违背社会主次核心价格观的观点或者描述性文字出现在代码里

上面为普通Java代码的编写规范，条条框框还是很多的，方方面面都说到了。下次再补充Mybatis、Sql、等规范！