Leo秋实先生
Leo秋实先生

阿里巴巴代码规范离线注释版本

一、编程规约

(一) 命名风格

  1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

          反例：_name / __name / $name / name_ / name$ / name__

解释：有很多开源代码是下划线开头，比如我们要讲的eureka源码中，我们可以不吸收这种风格。因为python下划线开头是内部变量，此规定是让其他语言转过来的开发者更容易理解。

  1. 【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免采用。

正例：renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。

反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

解释：虽然山东舰交付了，中国在世界上影响力增大了，但还是不建议用拼音或中文，中文有同音字，汉字会有编码问题，Pingfen：评分，平分。

  1. 【强制】类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。

正例：JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例：javaserverlessplatform / UserDo / XMLService / TCPUDPDeal / TAPromotion

Ta：谢谢。

解释:DO（ Data Object）：与数据库表结构一一对应，通过DAO层向上传输数据源对象。

DTO（ Data Transfer Object）：数据传输对象，Service或Manager向外传输的对象。

BO（ Business Object）：业务对象。 由Service层输出的封装业务逻辑的对象。

VO（ View Object）：显示层对象，通常是Web向模板渲染引擎层传输的对象。

AO (Application Object) :应用对象,在 Web 层与 Service 层之间抽象的复用对象模型,极为贴近展示层,复用度不高。

POJO 是 DO / DTO / BO / VO 的统称.

  1. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。

正例： localValue / getHttpMessage() / inputUserId

  1. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME

反例：MAX_COUNT / EXPIRED_TIME

  1. 【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。
  2. 【强制】类型与中括号紧挨相连来表示数组。

正例：定义整形数组 int[] arrayDemo;

反例：在 main 参数中，使用 String args[]来定义。

解释：便于阅读，一下就知道是数组。国产化标准。像高铁。

  1. 【强制】POJO 类中布尔类型变量都不要加 is 前缀，否则部分框架解析会引起序列化错误。

说明：在本文 MySQL 规约中的建表约定第一条，表达是与否的值采用 is_xxx 的命名方式，所以，需要在设置从 is_xxx 到 xxx 的映射关系。

反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，RPC 框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。

解释：这是开发中的一个坑，如果不知道，这个点，很难发现问题。debug，com.p3c.controller.ApiTestController，在postman中传入

{

  "num":1,

  "isSuccess":true

}

但是controller收到的却是false;

  1. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

正例：应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils（此规则参考 spring 的框架结构）

10. 【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。

说明：子类、父类成员变量名相同，即使是 public 类型的变量也是能够通过编译，而局部变量在同一方法内的不同代码块中同名也是合法的，但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员变量名称相同。

反例：

public class ConfusingName {

public int age;

// 非 setter/getter 的参数名称，不允许与本类成员变量同名

public void getData(String alibaba) {

if(condition) {

final int money = 531;

// ...

}

for (int i = 0; i < 10; i++) {

// 在同一方法体中，不允许与其它代码块中的 money 命名相同

final int money = 615;

// ...

}

}

}

class Son extends ConfusingName {

//允许与父类的成员变量名称相同

public int age;

}

解释：便于阅读。

11. 【强制】杜绝完全不规范的缩写，避免望文不知义。

反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。

解释：你懂但是别人不懂。

 

12. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。

正例：在 JDK 中，表达原子更新的类名为：AtomicReferenceFieldUpdater。

反例：int a 的随意命名方式。

13. 【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。

正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT

反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

解释：没有原因，正常些思考。

14. 【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。

正例：

     public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

15. 【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

正例：接口方法签名 void commit();

接口基础常量 String COMPANY = "alibaba";

反例：接口方法定义 public abstract void f();

说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

解释：接口变量：public static final，接口方法：public abstract，大家都知道的，就没必要累赘。

16. 接口和实现类的命名有两套规则：

1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。

例：CacheServiceImpl 实现 CacheService 接口。

2） 【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形容词）。

正例：AbstractTranslator 实现 Translatable 接口。

解释：SOA：Service-Oriented Architecture，面向服务架构。服务间只通过接口进行沟通。

17. 【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。

正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。

18. 【参考】各层命名规约：

A) Service/DAO 层方法命名规约

1） 获取单个对象的方法用 get 做前缀。

2） 获取多个对象的方法用 list 做前缀，复数形式结尾如：listObjects。

3） 获取统计值的方法用 count 做前缀。

4） 插入的方法用 save/insert 做前缀。

5） 删除的方法用 remove/delete 做前缀。

6） 修改的方法用 update 做前缀。

  1. 领域模型命名规约

1） 数据对象：xxxDO，xxx 即为数据表名。

2） 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。

3） 展示对象：xxxVO，xxx 一般为网页名称。

4） POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

解释：领域模型是一个分析模型，帮助系统分析人员、用户认识现实业务的工具，描述的是业务中涉及到的实体及其相互之间的关系，它是需求分析的产物，与问题域相关。

DO（ Data Object）：与数据库表结构一一对应，通过DAO层向上传输数据源对象。

DTO（ Data Transfer Object）：数据传输对象，Service或Manager向外传输的对象。

BO（ Business Object）：业务对象。 由Service层输出的封装业务逻辑的对象。

VO（ View Object）：显示层对象，通常是Web向模板渲染引擎层传输的对象。

(二)  常量定义

  1. 【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。

反例：String key = "Id#taobao_" + tradeId;

cache.put(key, value);

// 缓存 get 时，由于在代码复制时，漏掉下划线，导致缓存击穿而出现问题

  1. 【强制】在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数

字 1 混淆，造成误解。

说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2。

  1. 【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。

说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。

正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

解释：大而全其实相当于没有，比如读书，重点划线，如果一本书都划线，和没划线有什么区别呢？

  1. 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、

包内共享常量、类内共享常量。

1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。

2） 应用内共享常量：放置在一方库中，通常是子模块中的 constant 目录下。

反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“YES”的变量：

类 A 中：public static final String YES = "yes";

类 B 中：public static final String YES = "y";

A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致线上问题。

3） 子工程内部共享常量：即在当前子工程的 constant 目录下。

4） 包内共享常量：即在当前包下单独的 constant 目录下。

5） 类内共享常量：直接在类内部 private static final 定义。

  1. 【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。

说明：如果存在名称之外的延伸属性应使用 enum 类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。

正例：

public enum SeasonEnum {

SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);

private int seq;

SeasonEnum(int seq) {

this.seq = seq;

}

public int getSeq() {

return seq;

}

}

(三)  代码格式

  1. 【强制】如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格；如果是非

空代码块则：

1） 左大括号前不换行。

2） 左大括号后换行。

3） 右大括号前换行。

4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。

  1. 【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左

大括号前需要空格。详见第 5 条下方正例提示。

反例：if (空格 a == b 空格)

  1. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
  2. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。

说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

解释：小时候第一次看马老师视频，才知道要加运算符两边的空格这个东西。所以花钱学东西很值得，如果花1万，马上知道这个知识点，不花这个钱，有可能2 3年后知道，损失的就不止1万了。

  1. 【强制】采用 4 个空格缩进，禁止使用 tab 字符。

说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时，请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。

正例： （涉及 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");

// 在右大括号后直接结束，则必须换行

}

}

解释：

阿里巴巴代码规范离线注释版本_第1张图片

  1. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。

正例：

// 这是示例注释，请注意在双斜线之后有一个空格

String param = new String();

  1. 【强制】在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。

正例：

long first = 1000000000000L;

int second = (int)first + 2;

  1. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：

1）第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。

2）运算符与下文一起换行。

3）方法调用的点符号与下文一起换行。

4）方法调用中的多个参数需要换行时，在逗号后进行。

5）在括号前不要换行，见反例。

正例：

StringBuilder sb = new StringBuilder();

// 超过 120 个字符的情况下，换行缩进 4 个空格，点号和方法名称一起换行

sb.append("Jack").append("Ma")...

.append("alibaba")...

.append("alibaba")...

.append("alibaba");

反例：

StringBuilder sb = new StringBuilder();

// 超过 120 个字符的情况下，不要在括号前换行

sb.append("Jack").append("Ma")...append

("alibaba");

// 参数很多的方法调用可能超过 120 个字符，不要在逗号前换行 method(args1, args2, args3, ...

, argsX);

  1. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。

正例：下例中实参的 args1，后边必须要有一个空格。

method(args1, args2, args3);

10. 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式。

解释：很多windows格式会有问题，比如记事本开头添加0xefbbbf（十六进制）的字符。会导致文本问题。

阿里巴巴代码规范离线注释版本_第2张图片

11. 【推荐】单个方法的总行数不超过 80 行。

说明：除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过

  1. 行。

正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加清晰；共性逻辑抽取成为共性方法，便于复用和维护。

解释：不仅仅写代码，生活中方方面面也一样，绿叶就当好绿叶，否则惹人烦。比如重要会议高层讲话，一个低层员工总插嘴，那就很可能会被单独抽取出来。放到公司外面。

12. 【推荐】没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。

正例：

int one = 1;

long two = 2L;

float three = 3F;

StringBuilder sb = new StringBuilder();

说明：增加 sb 这个变量，如果需要对齐，则给 one、two、three 都要增加几个空格，在变量比较多的情况下，是非常累赘的事情。

13. 【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

说明：任何情形，没有必要插入多个空行进行隔开。

解释：点到为止，不要过分。否则会激发逆反情绪，小时候玩CS，人已经被打死了，就不要一直突突了，小时候在网吧有一次因为游戏中的鞭尸发生肢体冲突。

(四)  OOP 规约

  1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。

     解释：不是说语法错，而是增加jvm成本，每增加一个对象变量，new一个对象需要分配内存空间，增加无谓的内存消耗。调用时会去堆中检索对象，用类名访问只需要去方法区中找，减少了堆中检索的成本。

  1. 【强制】所有的覆写方法，必须加@Override 注解。

说明：getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

解释：jdk5.0才有这个注解，可以帮助我们做数据检测，上例中的O和0眼睛看不出来。

  1. 【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。

说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）

正例：public List listUsers(String type, Long... ids) {...}

解释：可变参数本质上就是一个数组（经编译器编译后转化为对应类型的数组）。因为如果遇到此种业务，绝对会定下类型，而不是Object，可变参数会增加jdk编译成本，会将它作为一个数组转换，增加编译成本，运行时也会预留内存空间，额外增加运行空间。

  1. 【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。

          解释：因为现在微服务比较多，有dubbo，rpc调用，spring cloud rest（特例，bean参数不同）调用，如果方法签名改了，会对调用者造成麻烦。我们可以用重写，重载的方式进行扩展。扩展接口升级url中加上版本号v1,v2等。但是原来使用的接口不要停。

  1. 【强制】不能使用过时的类或方法。

说明：java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。

解释：如果有可替代的，不要用过时的。肯定是有问题，才会声明过时。没人喜欢过期的食物，为什么编程时就喜欢用过期的方法，而就不想着用新方法呢？

  1. 【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。

正例："test".equals(object);

反例：object.equals("test");

说明：推荐使用 java.util.Objects#equals（JDK7 引入的工具类）。

解释：字面值做调用方。避免空指针。看代码：oop包下EqualsTest

  1. 【强制】所有整型包装类对象之间值的比较，全部使用 equals 方法比较。

说明：对于 Integer var = ? 在-128 至 127 范围内的赋值，Integer 对象是在 IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断。

解释：面试大坑，Integer intA = 3,intB =3 ,用==判断是不是true？不是基本类型，都用equals。equal比较内容。看代码oop.EqualsTest

  1. 【强制】浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用equals 来判断。

说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数，具体原理参考《马士兵Java基础课程》。

反例：

float a = 1.0f - 0.9f;

float b = 0.9f - 0.8f;

if (a == b) {

  • 预期进入此代码快，执行其它业务逻辑
  • 但事实上 a==b 的结果为 false

}

Float x = Float.valueOf(a);

 

Float y = Float.valueOf(b);

if (x.equals(y)) {

  • 预期进入此代码快，执行其它业务逻辑
  • 但事实上 equals 的结果为 false

}

正例：

  1. 指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。

float a = 1.0f - 0.9f;

float b = 0.9f - 0.8f;

float diff = 1e-6f;

if (Math.abs(a - b) < diff) {

System.out.println("true");

}

  1. 使用 BigDecimal 来定义值，再进行浮点数的运算操作。

BigDecimal a = new BigDecimal("1.0");

BigDecimal b = new BigDecimal("0.9");

BigDecimal c = new BigDecimal("0.8");

BigDecimal x = a.subtract(b);

BigDecimal y = b.subtract(c);

if (x.equals(y)) {

System.out.println("true");

}

解释：在10进制下，我们将1分成10份，还能表示0.1，0.2等，但表示1/3，只能无限接近，永远达不到。所以精度不够。完全相等是不可能的。

  1. 【强制】定义数据对象 DO 类时，属性类型要与数据库字段类型相匹配。

正例：数据库字段的 bigint 必须与类属性的 Long 类型相对应。

反例：某个案例的数据库表 id 字段定义类型 bigint unsigned，实际类对象属性为 Integer，随着 id 越来越大，超过 Integer 的表示范围而溢出成为负数。

解释：门当户对，否则匹配不上出问题。天天吵架调bug，太费精力。

10. 【强制】为了防止精度损失，禁止使用构造方法 BigDecimal(double)的方式把 double 值转化为 BigDecimal 对象。

说明：BigDecimal(double)存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。

如：BigDecimal g = new BigDecimal(0.1f); 实际的存储值为：0.10000000149

正例：优先推荐入参为 String 的构造方法，或使用 BigDecimal 的 valueOf 方法，此方法内部其实执行了 Double 的 toString，而 Double 的 toString 按 double 的实际能表达的精度对尾数进行了截断。

BigDecimal recommend1 = new BigDecimal("0.1");

BigDecimal recommend2 = BigDecimal.valueOf(0.1);

解释：官方注释说了unpredictable，你以为的你以为的不是你以为的。BigDecimal(0.1)这货实际上等于0.1000000000000000055511151231257827021181583404541015625，因为准确的来说0.1本身不能算是一个double（其实0.1不能代表任何一个定长二进制分数）。去EqualsTests看源码 注释

11. 关于基本数据类型与包装数据类型的使用标准如下：

1） 【强制】所有的 POJO 类属性必须使用包装数据类型。

2） 【强制】RPC 方法的返回值和参数必须使用包装数据类型。

3） 【推荐】所有的局部变量使用基本数据类型。

说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何 NPE 问题，或者入库检查，都由使用者来保证。

正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。

反例：比如显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调用不成功时，返回的是默认值，页面显示为 0%，这是不合理的，应该显示成中划线。所以包装数据类型的 null 值，能够表示额外的信息，如：远程调用失败，异常退出。

解释：局部变量大多数用于计算，基本类型有优势，不需要拆箱装箱，效率高。属性用包装类型：因为有可能序列化。看代码，当用Integer做参数时，num为空时，接受到的是null，由使用者注意，但 为int时收到的是0。如果使用者由于没有npe忘了，上线会出问题。

12. 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。

反例：POJO 类的 createTime 默认值为 new Date()，但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

解释：

DO:data object 和数据库表对应，可以1个do对应多个表，。

Dto：trans 转换 dao输出的对象，do和dto不绝对一样。Dto可以对数据做额外的处理，do整理后需要向上传递时用。

Vo：渲染视图。Vo和do有时候也相同。

当do用于页面渲染用分页时，需要vo，do做一些特殊处理时，用dto。

pojo：属性，set，get，object方法，没有业务含义。

Pojo是纯净的。

设置默认值，会让错误不好排查。

13. 【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

说明：注意 serialVersionUID 不一致会抛出序列化运行时异常。

解释：用了版本号，如果改了版本号，有地方有序列化的对象，在反序列化时就会报错。如果抛弃原来所有的，全部进行升级，无所谓了。Io 文件，内存，网络。反序列化 会读取流中的 版本号，如果版本号和类中版本号不一致，会报错。也可以让所以类版本号有的都是1L，就像2个人同一个身份证号，正常活没问题。Hashcode方法，返回0也行，但是不建议。看代码：oop.SerializeTest

 

  1. 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。
解释：为了逻辑清晰，不要让孩子快出生的时候，干些他成为独立的人之后才能干的活。先让他生出来再说，别着急。可以在init上加上，@PostConstruct注解，在构造方法执行结束后调用。在服务发现DiscoveryClient中构造方法执行了业务逻辑，我们不学。国产标准。

15. 【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具：source> generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。

说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排查问题。

解释：异常处理会用到。

16. 【强制】禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx()和 getXxx()方法。

说明：框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到。

17. 【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。

说明：

String str = "a,b,c,,";

String[] ary = str.split(",");

// 预期大于 3，结果是 3

System.out.println(ary.length);

解释：看代码：oop.SpiltTest

 

  1. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读，此条规则优先于下一条。

解释：构造方法，overload，属性，getter/setter分别放在一起。

 

19. 【推荐】 类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter / setter 方法。

说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有 Service 和 DAO 的 getter/setter 方法放在类体最后。

解释：方便看代码的人。

20. 【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在 getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。

反例：

public Integer getData() {

if (condition) {

return this.data + 100;

} else {

return this.data - 100;

}

}

解释：加了业务逻辑，别人会误解。

 

21. 【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。

说明：下例中，反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行 append 操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。

反例：

String str = "start";

for (int i = 0; i < 100; i++) {

str = str + "hello";

}

解释：减少对象的构建过程，builder用的时char[]实现。减少堆中不必要对象的创建过程。

 

22. 【推荐】final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字：

1） 不允许被继承的类，如：String 类。

2） 不允许修改引用的域对象。

3） 不允许被覆写的方法，如：POJO 类的 setter 方法。

4） 不允许运行过程中重新赋值的局部变量。

  1. 避免上下文重复使用一个变量，使用 final 可以强制重新定义一个变量，方便更好地进行重构。

23. 【推荐】慎用 Object 的 clone 方法来拷贝对象。

说明：对象 clone 方法默认是浅拷贝，若想实现深拷贝需覆写 clone 方法实现域对象的深度遍历式拷贝。

解释：clone是浅拷贝。就当没有clone这个方法。Oop.CloneTest

https://blog.csdn.net/meism5/article/details/90414050

24. 【推荐】类成员与方法访问控制从严：

1） 如果不允许外部直接通过 new 来创建对象，那么构造方法必须是 private。

2） 工具类不允许有 public 或 default 构造方法。

3） 类非 static 成员变量并且与子类共享，必须是 protected。

4） 类非 static 成员变量并且仅在本类使用，必须是 private。

5） 类 static 成员变量如果仅在本类使用，必须是 private。

6） 若是 static 成员变量，考虑是否为 final。

7） 类成员方法只供类内部调用，必须是 private。

8） 类成员方法只对继承类公开，那么限制为 protected。

说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。思考：如果是一个 private 的方法，想删除就删除，可是一个 public 的 service 成员方法或成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。

 

解释：最小知道原则。阿里安全条例，关于信息传递也是。

(五)  集合处理

  1. 【强制】关于 hashCode 和 equals 的处理，遵循如下规则：

1） 只要覆写 equals，就必须覆写 hashCode。

2） 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须覆写这两个方法。

3） 如果自定义对象作为 Map 的键，那么必须覆写 hashCode 和 equals。

说明：String 已覆写 hashCode 和 equals 方法，所以我们可以愉快地使用 String 对象作为 key 来使用。

解释：

比特币:Collision resistance:哈希碰撞，哈希碰撞不可避免，因为输入空间远远大于输出空间。比如256位的哈希值，输出空间只有2的 256次方。根据鸽笼原理。（鸽笼原理(抽屉原理)就是"如果有五个鸽子笼，养鸽人养了6只鸽子，那么当鸽子飞回笼中后，至少有一个笼子中装有2只鸽子。"）

hashCode规范：

在程序的一次运行中，只要没有修改equals()中用于比较的信息，x.hashCode()总是返回一致的hash值

如果x.equals(y)返回true，则x和y具有相等的hash值

如果x和y具有相等的hash值，x.equals(y)并不一定返回true

map key要排除重复。这个问题主要和映射(Map接口)相关. 我们知道Map接口的类会使用到键(Key)的哈希码, 当我们调用put()/get()方法操作Map容器时, 都是根据Key的哈希码来计算存储位置的, 因此如果我们对哈希码的获取没有相关保证, 就可能会得不到预期的结果.

eqaul方法就可以判断对象相等，但是equal方法里面判断的逻辑会很多，很复杂，说白了就是性能不够好。

hashcode方法判断起来，就一行简单的代码，执行效率高，但是hashcode 有一个致命问题就是两个对象hash的时候值可能会一样。所以hashcode有时并不是都靠谱，但是如果hashcode不一样，两个对象肯定不一样。

正确的对比过程应该是这样：先用hash函数对比，如果结果一样，再用equal方法对比判断两个对象是否相等；如果结果不一样，直接判定这两个对象不是同一个。

2.【强制】ArrayList 的 subList 结果不可强转成 ArrayList，否则会抛出 ClassCastException 异常，即 java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。

说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList 而是 ArrayList 的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。

解释：sublist重置了下标规范。看代码collector.SubListTest。SubList1，

Sub可以影响源集合，但源集合不影响外面。

 

  1. 【强制】使用 Map 的方法 keySet()/values()/entrySet()返回集合对象时，不可以对其进行添加元素操作，否则会抛出 UnsupportedOperationException 异常。

解释：怕程序员代码写hign了，忘了。警钟长鸣。镜像不能修改，就像不能做伪证，原来是啥就是啥。Collector.MapTest中

  1. 【强制】Collections 类返回的对象，如：emptyList()/singletonList()等都是 immutable

list，不可对其进行添加或者删除元素的操作。

反例：如果查询无结果，返回 Collections.emptyList()空集合对象，调用方一旦进行了添加元素的操作，就会触发 UnsupportedOperationException 异常。

解释：看Collections 的emptyList源码，因为返回的是final类型。

  1. 【强制】在 subList 场景中，高度注意对原集合元素的增加或删除，均会导致子列表的遍历、增加、删除产生 ConcurrentModificationException 异常。

          解释：父集合  1 2 3 4 5 ，sublist 刚开始用 4 5下标分布式3 4，结果父集合删掉了123，45往前挪。Sublis访问会报错。看代码collector.SubListTest.subList2

  1. 【强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一

致、长度为 0 的空数组。

反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它类型数组将出

  • ClassCastException 错误。

正例：List list = new ArrayList<>(2);

list.add("guan");

list.add("bao");

String[] array = list.toArray(new String[0]);

说明：使用 toArray 带参方法，数组空间大小的 length：

1） 等于 0，动态创建与 size 相同的数组，性能最好。

  1. 大于 0 但小于 size，重新创建大小等于 size 的数组，增加 GC 负担。

3） 等于 size，在高并发情况下，数组创建完成之后，size 正在变大的情况下，负面影响与上相同。

4）大于 size，空间浪费，且在 size 处插入 null 值，存在 NPE 隐患。

解释：把内存中的数据直接进行数值转换，会比较快。

数组大小设置不当的时候，不仅回降低性能，还会浪费空间，

当不需要获取新数组的时候，尽量避免数组长度小于集合长度的情况发生，同时尽可能使用带参方法。看源码：    public T[] toArray(T[] a) {

        if (a.length < size)

            // Make a new array of a's runtime type, but my contents:

            return (T[]) Arrays.copyOf(elementData, size, a.getClass());

        System.arraycopy(elementData, 0, a, 0, size);

        if (a.length > size)

            a[size] = null;

        return a;

}

发现只要小于size，则效率一样。

  1. 【强制】在使用 Collection 接口任何实现类的 addAll()方法时，都要对输入的集合参数进行NPE 判断。

说明：在 ArrayList#addAll 方法的第一行代码即 Object[] a = c.toArray(); 其中 c 为输入集合参数，如果为 null，则直接抛出异常。

解释：看源码：因为会调用c.add(element);;如果为null就会 npe。Collector.ListToArray

    @SafeVarargs

    public static boolean addAll(Collectionsuper T> c, T... elements) {

        boolean result = false;

        for (T element : elements)

            result |= c.add(element);

        return result;

}

会调用c.add.

  1. 【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。

说明：asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。

String[] str = new String[] { "yang", "hao" };

List list = Arrays.asList(str);

第一种情况：list.add("yangguanbao"); 运行时异常。

第二种情况：str[0] = "changed"; 也会随之修改，反之亦然。

解释：看返回ArrayList的源码，其实并没有实现add等方法。此规定是怕程序员写high了。忘了。ListTest看源码发现set正常，而add异常。因为内部类有set没有add。

  1. 【强制】泛型通配符来接收返回的数据，此写法的泛型集合不能使用 add 方法，而不能使用 get 方法，作为接口调用赋值时易出错。

说明：扩展说一下 PECS(Producer Extends Consumer Super)原则：第一、频繁往外读取内容的，适合用。第二、经常往里插入的，适合用

解释:5.0出现的泛型时一种主观的认为，而不是实际上真正的东西。List a = List出错。List get(){return List} a = get();不出错。

Extends 读取撑死了是T，插入不知道插的啥，super插入撑死了T，读取不知道是啥。

PECS,的主角是 它本身。它自己往外输出是P，消费是C。

10. 【强制】在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行 instanceof 判断，避免抛出 ClassCastException 异常。

说明：毕竟泛型是在 JDK5 后才出现，考虑到向前兼容，编译器是允许非泛型集合与泛型集合互相赋值。

反例：

List<String> generics = null;

List notGenerics = new ArrayList(10);

notGenerics.add(new Object());

notGenerics.add(new Integer(1));

generics = notGenerics;

// 此处抛出 ClassCastException 异常

String string = generics.get(0);

解释：GenericsTest

11. 【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator 方式，如果并发操作，需要对 Iterator 对象加锁。

正例：

List list = new ArrayList<>();

list.add("1");

list.add("2");

Iterator iterator = list.iterator();

while (iterator.hasNext()) {

String item = iterator.next();

if (删除元素的条件) {

iterator.remove();

}

}

反例：

for (String item : list) {

if ("1".equals(item)) {

list.remove(item);

}

}

说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的结果吗？

解释：foreach底层用的 iterator实现，游标可能会错乱。一般foreach只允许读，不要写。

代码解释：modCount时ArrayList从AbstractList继承下来的属性，在add,remove等时，会修改，而expectedModCount时ArrayList的内部类ltr的属性，只有在迭代器操作list时才会修改。报异常是由于取下一个值 next()时才报。参见：ForeachTest

 

12. 【强制】在 JDK7 版本及以上，Comparator 实现类要满足如下三个条件，不然 Arrays.sort， Collections.sort 会抛 IllegalArgumentException 异常。

说明：三个条件如下

1） x，y 的比较结果和 y，x 的比较结果相反。

2） x>y，y>z，则 x>z。

3） x=y，则 x，z 比较结果和 y，z 比较结果相同。

反例：下例中没有处理相等的情况，交换两个对象判断结果并不互反，不符合第一个条件，在实际使用中可能会出现异常。

new Comparator() {

@Override

public int compare(Student o1, Student o2) {

return o1.getId() > o2.getId() ? 1 : -1;

}

};

解释：自反性，传递性，对称性。

Sort种用到了插入排序，快速排序，归并排序，并不是挨着比较，可能下标1和8比，后来2和8比，然后1和2比，1>8,2<8,如果compare方法有问题，不能确定1和2 的大小。就抛异常。

 

13. 【推荐】集合泛型定义时，在 JDK7 及以上，使用 diamond 语法或全省略。

说明：菱形泛型，即 diamond，直接使用<>来指代前边已经指定的类型。

正例：

// diamond 方式，即<>

HashMap userCache = new HashMap<>(16); // 全省略方式

ArrayList users = new ArrayList(10);

 

14. 【推荐】集合初始化时，指定集合初始值大小。

说明：HashMap 使用 HashMap(int initialCapacity) 初始化。

正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loader factor）默认为 0.75，如果暂时无法确定初始值大小，请设置为 16（即默认值）。

反例：HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容量 7 次被迫扩大，resize 需要重建 hash 表，严重影响性能。

解释：不指定大小，程序执行时会扩容，影响效率，所以我们要减少内存的膨胀次数。

 

15. 【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。

说明：keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。如果是 JDK8，使用 Map.forEach 方法。

正例：values()返回的是 V 值集合，是一个 list 集合对象；keySet()返回的是 K 值集合，是一个 Set 集合对象；entrySet()返回的是 K-V 值组合集合。

解释：entrySert遍历一次，keySet遍历2次。getValue(key),减少迭代次数。因为最终get(key)时，都需要遍历一遍。

 

16. 【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格：

 

集合类

Key

Value

Super

说明

 

 

 

 

 

Hashtable

不允许为 null

不允许为 null

Dictionary

线程安全

 

 

 

 

 

ConcurrentHashMap

不允许为 null

不允许为 null

AbstractMap

锁分段技术（JDK8:CAS）

 

 

 

 

 

TreeMap

不允许为 null

允许为 null

AbstractMap

线程不安全

 

 

 

 

 

HashMap

允许为 null

允许为 null

AbstractMap

线程不安全

 

 

 

 

 

 

反例：由于 HashMap 的干扰，很多人认为 ConcurrentHashMap 是可以置入 null 值，而事实上，存储 null 值时会抛出 NPE 异常。

 

17. 【参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。

说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是 order/sort。

解释：可以降低迭代压力，提高迭代效率。Sort是值存入1，4，2输出124，稳定性：3，5，1，351

 

18. 【参考】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的contains 方法进行遍历、对比、去重操作。

解释：list contains方法是迭代比较去 去重。从0开始比，依次比，集合多，会很慢。而set底层是依据hashCode和equals进行判断，

Set set = new HashSet<>(arrayList);

System.out.println(set.toString());

(六)  并发处理

  1. 【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。

说明：资源驱动类、工具类、单例工厂类都需要注意。

解释：因为不是线程安全，会创建不出真正的单例，有可能一个类有多个对象。

看代码：安全且在多线程情况下能保持高性能。thread.SingletonTest

  1. 【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。

正例：自定义线程工厂，并且根据外部特征进行分组，比如机房信息。

public class UserThreadFactory implements ThreadFactory {

private final String namePrefix;

private final AtomicInteger nextId = new AtomicInteger(1);

  • 定义线程组名称，在 jstack 问题排查时，非常有帮助

UserThreadFactory(String whatFeaturOfGroup) {

namePrefix = "From UserThreadFactory's " + whatFeaturOfGroup + "-Worker-";

}

@Override

public Thread newThread(Runnable task) {

String name = namePrefix + nextId.getAndIncrement(); Thread thread = new Thread(null, task, name, 0, false);

System.out.println(thread.getName());

return thread;

}

}

  1. 【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。

说明：线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

解释：就像我们使用各种连接池一样，jdbc连接池等。池化很重要。tcp和http一个长连接好处：效率高，减少了创建和销毁链接，http每次都得重新建立连接。

4.【强制】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

说明：Executors 返回的线程池对象的弊端如下：

1） FixedThreadPool 和 SingleThreadPool：

允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。

2） CachedThreadPool和newScheduledThreadPool

允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。

解释：看代码。thread包下ExecutorsTest。点进去：newFixedThreadPool，发现其实Executor都是基于ThreadPoolExecutor创建的，只不过传入不同的参数，

参数含义如下：

corePoolSize：线程池中核心线程数量。

maximumPoolSize：线程池最大线程数量。

keepAliveTime：超出核心线程数量时，多出的空闲线程的存活时间。

unit: keepAliveTime的单位。

workQueue：任务队列，当没有空闲线程时，任务存储在该队列。

threadFactory：线程工厂，被用于创建线程。一般使用Executors.defaultThreadFactory()即可。若想清楚的了解自己任务的线程，可以利用该工厂定制化线程。

handler：拒绝策略，当任务太多，如何拒绝任务。

其他参数容易理解：重点：workQueue和handler。

有界队列：ArrayBlockingQueue

创建时必须指定容量。当有新任务时，如果即将使用线程数量 < corePoolSize,则会创建新的线程执行，如果 > corePoolSize,则会将新的任务加入到任务队列中。当任务队列已满，如果线程数量

无界队列：LinkedBlockingQueue

该队列没有界限，除非是系统资源耗尽，否则它不会出现入队失败情况。当新的任务提交，如果使用线程数量

直接提交队列：SynchronousQueue

该队列没有容量，也就是说它不存储任务。当有新的任务来时，如果没有空闲的线程，则会创建新的线程，如果线程数量已经达到最大值，就会执行拒绝策略。newCachedThreadPool()就是使用该队列，使用该队列时，应该把最大线程数量设置尽量大，否则很容易就会执行拒绝策略，newCachedThreadPool()就设置的为Integer.MAX_VALUE。

优先任务队列:PriorityBlockingQueue

控制任务的执行顺序，它属于无界队列，但是比较特殊。不论是无界还是有界队列都是按照先进先出的顺序处理任务，而PriorityBlockingQueue则可以根据任务自身的优先级顺序执行，它总能确保高优先级的任务先执行。

拒绝策略:

AbortPolicy:直接抛出异常，阻止应用正常工作。（默认使用该策略）

CallerRunsPolicy:不会真正丢弃任务，当线程池未关闭，该策略直接在调用者线程中运行当前丢弃任务。

DiscardPolicy:丢弃无法处理的任务，不做任何处理。

DiscardOldestPolicy:丢弃最老的任务，也就是即将执行的任务，并尝试提交当前任务。

也可以自定义拒绝策略。

newFixedThreadPool和newSingleThreadExecutor点参数队列进去：

public LinkedBlockingQueue() {

        this(Integer.MAX_VALUE);

}

 public static ExecutorService newCachedThreadPool() {

        return new ThreadPoolExecutor(0, Integer.MAX_VALUE,

                                      60L, TimeUnit.SECONDS,

                                      new SynchronousQueue());

    }

  1. 【强制】SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为static，必须加锁，或者使用 DateUtils 工具类。

正例：注意线程安全，使用 DateUtils。亦推荐如下处理：

private static final ThreadLocal df = new ThreadLocal() { @Override

protected DateFormat initialValue() {

return new SimpleDateFormat("yyyy-MM-dd");

}

};

说明：如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar， DateTimeFormatter 代替 SimpleDateFormat，官方给出的解释：simple beautiful strong immutable thread-safe。

解释：看代码：SimpleDateFormatTest

阿里巴巴代码规范离线注释版本_第3张图片

代码中有两种方式，不安全和安全。

ThreadLocal 是线程的局部变量， 是每一个线程所单独持有的，其他线程不能对其进行访问。

当使用ThreadLocal维护变量的时候 为每一个使用该变量的线程提供一个独立的变量副本，即每个线程内部都会有一个该变量，这样同时多个线程访问该变量并不会彼此相互影响，因此他们使用的都是自己从内存中拷贝过来的变量的副本， 这样就不存在线程安全问题，也不会影响程序的执行性能。

但是要注意，虽然ThreadLocal能够解决上面说的问题，但是由于在每个线程中都创建了副本，所以要考虑它对资源的消耗，比如内存的占用会比不使用ThreadLocal要大。

  1. 【强制】必须回收自定义的 ThreadLocal 变量，尤其在线程池场景下，线程经常会被复用，如果不清理自定义的 ThreadLocal 变量，可能会影响后续业务逻辑和造成内存泄露等问题。

尽量在代理中使用 try-finally 块进行回收。

正例：

objectThreadLocal.set(userInfo);

try {

// ...

} finally {

objectThreadLocal.remove();

}

解释：simpleDateFormatSalfe.remove();

  1. 【强制】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。

说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。

解释：调用rpc会时间长，怕导致死锁。

8、【强制】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会

造成死锁。

说明：线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是A、B、C，否则可能出现死锁。

解释：讨厌的锁，能不用就不用。不按照顺序，会造成互相等待死锁。

  1. 【强制】在使用阻塞等待获取锁的方式中，必须在 try 代码块之外，并且在加锁方法与 try 代码块之间没有任何可能抛出异常的方法调用，避免加锁成功后，在 finally 中无法解锁。

说明一：如果在 lock 方法与 try 代码块之间的方法调用抛出异常，那么无法解锁，造成其它线程无法成功获取锁。

说明二：如果 lock 方法在 try 代码块之内，可能由于其它方法抛出异常，导致在 finally 代码块中， unlock 对未加锁的对象解锁，它会调用 AQS 的 tryRelease 方法（取决于具体实现类），抛出 IllegalMonitorStateException 异常。

说明三：在 Lock 对象的 lock 方法实现中可能抛出 unchecked 异常，产生的后果与说明二相同。

正例：

Lock lock = new XxxLock();

// ...

lock.lock();

try {

doSomething();

doOthers();

} finally {

lock.unlock();

}

反例：Lock lock = new XxxLock();

// ...

try {

// 如果此处抛出异常，则直接执行 finally 代码块

doSomething();

// 无论加锁是否成功，finally 代码块都会执行

lock.lock();

doOthers();

} finally {

lock.unlock();

}

 

解释：保持锁的完整性。网约车中会讲到这部分，有分布锁讲解。比如锁订单号出现了异常，下个线程进来正常执行完，释放锁，结果把上次的订单锁释放掉。https://www.cnblogs.com/waterystone/p/4920797.html

  1. 【强制】在使用尝试机制来获取锁的方式中，进入业务代码块之前，必须先判断当前线程是否持有锁。锁的释放规则与锁的阻塞等待方式相同。

说明：Lock 对象的 unlock 方法在执行时，它会调用 AQS 的 tryRelease 方法（取决于具体实现类），如果当前线程不持有锁，则抛出 IllegalMonitorStateException 异常。

正例：

Lock lock = new XxxLock();

// ...

boolean isLocked = lock.tryLock();

if (isLocked) {

try {

doSomething();

doOthers();

} finally {

lock.unlock();

}

}

11. 【强制】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。

说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于

  1. 次。

解释：概率计算，看资源和访问资源的情况。

重试：https://blog.csdn.net/HXNLYW/article/details/94558449

  1. 【强制】多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，如果在处理定时任务时使用 ScheduledExecutorService 则没有这个问题。

解释：在我们讲eureka源码时可以看到这种用法。com.netflix.discovery.DiscoveryClient 1267行   

private void initScheduledTasks() {

点scheduler，private final ScheduledExecutorService scheduler;

13. 【推荐】资金相关的金融敏感信息，使用悲观锁策略。

说明：乐观锁在获得锁的同时已经完成了更新操作，校验逻辑容易出现漏洞，另外，乐观锁对冲突的解决策略有较复杂的要求，处理不当容易造成系统压力或数据异常，所以资金相关的金融敏感信息不建议使用乐观锁更新。

解释：https://blog.csdn.net/qq_34337272/article/details/81072874

14. 【推荐】使用 CountDownLatch 进行异步转同步操作，每个线程退出前必须调用 countDown 方法，线程执行代码注意 catch 异常，确保 countDown 方法被执行到，避免主线程无法执行至 await 方法，直到超时才返回结果。

说明：注意，子线程抛出异常堆栈，不能在主线程 try-catch 到。

解释：看代码CountDownLatchTest

15. 【推荐】避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一 seed 导致的性能下降。

说明：Random 实例包括 java.util.Random 的实例或者 Math.random()的方式。

正例：在 JDK7 之后，可以直接使用 API ThreadLocalRandom，而在 JDK7 之前，需要编码保证每个线程持有一个实例。

解释：JDK7之后，可以使用ThreadLocalRandom来获取随机数。

    public Random(long seed) {

        if (getClass() == Random.class)

            this.seed = new AtomicLong(initialScramble(seed));

        else {

            // subclass might have overriden setSeed

            this.seed = new AtomicLong();

            setSeed(seed);

        }

}

    private static long initialScramble(long seed) {

        return (seed ^ multiplier) & mask;

    }

而multiplier & mask都是static的，所以共享。

seed含义见代码：RandomTest，seed一样，一组产生的随机数一样。

16. 【推荐】在并发场景下，通过双重检查锁（double-checked locking）实现延迟初始化的优化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration)，推荐解决方案中较为简单一种（适用于 JDK5 及以上版本），将目标属性声明为 volatile 型。

反例：

public class LazyInitDemo {

private Helper helper = null;

public Helper getHelper() {

if (helper == null) synchronized(this) {

if (helper == null)

helper = new Helper();

}

return helper;

}

// other methods and fields...

}

解释：1.线程的可见性

2.防止指令重排

感兴趣 Java基础课。

17. 【参考】volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。

说明：如果是 count++操作，使用如下类实现：AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8，推荐使用 LongAdder 对象，比 AtomicLong 性能更好（减少乐观锁的重试次数）。

18. 【参考】HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在开发过程中可以使用其它数据结构或加锁来规避此风险。

19. 【参考】ThreadLocal 对象使用 static 修饰，ThreadLocal 无法解决共享对象的更新问题。

说明：这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

(七)  控制语句

  1. 【强制】在一个 switch 块内，每个 case 要么通过 continue/break/return 等来终止，要么注释说明程序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使它什么代码也没有。

说明：注意 break 是退出 switch 语句块，而 return 是退出方法体。

解释：最好让程序确定的退出，否则就会执行到你不知道的地方。

  1. 【强制】当 switch 括号内的变量类型为 String 并且此变量为外部参数时，必须先进行 null 判断。

反例：猜猜下面的代码输出是什么？

public class SwitchString {

public static void main(String[] args) {

method(null);

}

public static void method(String param) {

switch (param) {

// 肯定不是进入这里

case "sth":

System.out.println("it's sth");

break;

// 也不是进入这里

case "null":

System.out.println("it's null");

break;

// 也不是进入这里

default:

System.out.println("default");

}

}

}

解释：control.SwitchString，做switch匹配时，就NPE了。

  1. 【强制】在 if/else/for/while/do 语句中必须使用大括号。

说明：即使只有一行代码，避免采用单行的编码方式：if (condition) statements;

  1. 【强制】在高并发场景中，避免使用”等于”判断作为中断或退出的条件。

说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。

反例：判断剩余奖品数量等于 0 时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变成了负数，这样的话，活动无法终止。

解释：严于律己，不能刚刚好，就行，考虑恶劣情况。为了程序的健壮性。

  1. 【推荐】表达异常的分支时，少用 if-else 方式，这种方式可以改写成：

if (condition) {

...

return obj;

}

// 接着写 else 的业务逻辑代码;

说明：如果非使用 if()...else if()...else...方式表达逻辑，避免后续代码维护困难，

【强制】请勿超过 3 层。

正例：超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现，其中卫语句即代码逻辑先考虑失败、异常、中断、退出等直接返回的情况，以方法多个出口的方式，解决代码中判断分支嵌套的问题，这是逆向思维的体现。

示例如下：

public void findBoyfriend(Man man) {

if (man.isUgly()) {

System.out.println("本姑娘是外貌协会的资深会员");

return;

}

if (man.isPoor()) {

System.out.println("贫贱夫妻百事哀");

return;

}

if (man.isBadTemper()) {

System.out.println("银河有多远，你就给我滚多远");

return;

}

System.out.println("可以先交往一段时间看看");

}

 

  1. 【推荐】除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

说明：很多 if 语句内的逻辑表达式相当复杂，与、或、取反混合运算，甚至各种方法纵深调用，理解成本非常高。如果赋值一个非常好理解的布尔变量名字，则是件令人爽心悦目的事情。

正例：

// 伪代码如下

final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);

if (existed) {

...

}

反例：

public final void acquire(long arg) {

if (!tryAcquire(arg) &&

acquireQueued(addWaiter(Node.EXCLUSIVE), arg)) {

selfInterrupt();

}

}

解释：先提炼，再说具体场景。

  1. 【推荐】不要在其它表达式（尤其是条件表达式）中，插入赋值语句。

说明：赋值点类似于人体的穴位，对于代码的理解至关重要，所以赋值语句需要清晰地单独成为一行。

反例：

public Lock getLock(boolean fair) {

// 算术表达式中出现赋值操作，容易忽略 count 值已经被改变

threshold = (count = Integer.MAX_VALUE) - 1;

// 条件表达式中出现赋值操作，容易误认为是 sync==fair return (sync = fair) ? new FairSync() : new NonfairSync();

}

 

  1. 【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的 try-catch 操作（这个 try-catch 是否可以移至循环体外）。
  2. 【推荐】避免采用取反逻辑运算符。

说明：取反逻辑不利于快速理解，并且取反逻辑写法必然存在对应的正向逻辑写法。

正例：使用 if (x < 628) 来表达 x 小于 628。

反例：使用 if (!(x >= 628)) 来表达 x 小于 628。

解释：直接表达最好。

10. 【推荐】接口入参保护，这种场景常见的是用作批量操作的接口。

11. 【参考】下列情形，需要进行参数校验：

1） 调用频次低的方法。

2） 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。

3） 需要极高稳定性和可用性的方法。

4） 对外提供的开放接口，不管是 RPC/API/HTTP 接口。

5） 敏感权限入口。

12. 【参考】下列情形，不需要进行参数校验：

1） 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。

2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台服务器中，所以 DAO 的参数校验，可以省略。

3） 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

 

(八)  注释规约

  1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用

// xxx 方式。

说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

  1. 【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

说明：对子类的实现要求，或者调用注意事项，请一并说明。

  1. 【强制】所有的类都必须添加创建者和创建日期。
  2. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
  3. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
  4. 【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。

反例：“TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。

 

  1. 【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。

说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。

  1. 【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。

说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库已然保存了历史代码）。

解释：没用的东西，不要舍不得丢。

  1. 【参考】对于注释的要求：第一、能够准确反映设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。

 

10. 【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

反例：

// put elephant into fridge

put(elephant, fridge);

方法名 put，加上两个有意义的变量名 elephant 和 fridge，已经说明了这是在干什么，语义清晰的代码不需要额外的注释。

11. 【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

1） 待办事宜（TODO）:（标记人，标记时间，[预计处理时间]）

表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc 还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。

2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）

在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

解释：不要觉得烦，当被公司罚款的时候，就觉得不烦了。

Windows show win   tasks

 

阿里巴巴代码规范离线注释版本_第4张图片

 

(九)  其它

  1. 【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。

说明：不要在方法体内定义：Pattern pattern = Pattern.compile(“规则”);

  1. 【强制】velocity 调用 POJO 类的属性时，直接使用属性名取值即可，模板引擎会自动按规范调用 POJO 的 getXxx()，如果是 boolean 基本数据类型变量（boolean 命名不需要加 is 前缀），会自动调用 isXxx()方法。

说明：注意如果是 Boolean 包装类对象，优先调用 getXxx()的方法。

解释：velocity模板引擎。其他模板引擎也要考虑此种情况。

 

  1. 【强制】后台输送给页面的变量必须加$!{var}——中间的感叹号。

说明：如果 var 等于 null 或者不存在，那么${var}会直接显示在页面上。

  1. 【强制】注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法。

解释:看代码thread.RandomTest

  1. 【强制】获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();

说明：如果想获取更加精确的纳秒级时间值，使用 System.nanoTime()的方式。在 JDK8 中，针对统计时间等场景，推荐使用 Instant 类。

解释：为什么不用new Date（），看源码，是多此一举。先用 System.currentTimeMillis()，在getTime获取System.currentTimeMillis()。

Instant使用方法：https://blog.csdn.net/weixin_41987908/article/details/89204729

  1. 【强制】日期格式化时，传入 pattern 中表示年份统一使用小写的 y。

说明：日期格式化时，yyyy 表示当天所在的年，而大写的 YYYY 代表是 week in which year（JDK7 之后引入的概念），意思是当天所在的周属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的 YYYY 就是下一年。另外需要注意：

表示月份是大写的 M

表示分钟则是小写的 m 24 小时制的是大写的 H 12 小时制的则是小写的 h

正例：表示日期和时间的格式如下所示：

new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

 

  1. 【推荐】不要在视图模板中加入任何复杂的逻辑。

说明：根据 MVC 理论，视图的职责是展示，不要抢模型和控制器的活。

  1. 【推荐】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
  2. 【推荐】及时清理不再使用的代码段或配置信息。

说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。

正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。

 

二、异常日志

(一)  异常处理

  1. 【强制】Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过 catch 的方式来处理，比如：NullPointerException，IndexOutOfBoundsException 等等。

说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，可能存在数字格式错误，不得不通过 catch NumberFormatException 来实现。

正例：if (obj != null) {...}

反例：try { obj.method(); } catch (NullPointerException e) {…}

解释:运行时异常基本上是程序员粗心，懒。不要catch，也不要抛出。遇到解决掉。除了说明中没办法的情况。

  1. 【强制】异常不要用来做流程控制，条件控制。

说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。

解释：这样写能减少一些流程判断，比如1，2，3情况，是异常，走另一套逻辑，通过异常统一处理了。太懒了。异常相当于生病，不能说不吃饭，不喝水，不睡觉（流程判断）等着生病，再去医院一起处理。是不是傻。生活中该吃饭就吃饭，该喝水就喝水。否则降低了代码的健壮性。

  1. 【强制】catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。

说明：对大段代码进行 try-catch，使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。

正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上作出分门别类的判断，并提示给用户。

解释：不要只准备一个大异常全部解决掉所有问题，比如电脑有问题，统一处理就重启，去医院脂肪肝，统一处理就换肝，但也不要走向另一个极端，每一行都捕获异常，没必要，平时说话，散步时不会生病的，散步没必要去医院，分代码块来处理异常。责任是价值观。

  1. 【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。

          解释：遇到事情。自己处理，也上报。自己事情自己做，不要依赖别人。Dao异常（封自己处理，并装成DAOException向上抛），service异常（自己处理，并封装成ServiceException向上抛），controller（ 捕获异常，进行友好的错误提示）。网站忙等。最外层一定不要直接展示异常。有异常回滚操作等。

我有个朋友 招聘要求：灵光些，基本素质是：有问题解决不了，要说出来，别憋着。自己处理不了要及时上报。打广告。

  1. 【强制】有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回滚事务。
  2. 【强制】finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。

说明：如果 JDK7 及以上，可以使用 try-with-resources 方式。

解释：代码解释resource。Try(Input in = new FileInputStream();其他初始语句){}catch(exception e){}相当于默认写了finally关闭流语句，关闭try后面初始化的内容，初始化时顺序，关闭是逆序。可以用with resource，但还是手写好。易于阅读

 

7.  【强制】不要在 finally 块中使用 return。

说明：try 块中的 return 语句执行成功后，并不马上返回，而是继续执行 finally 块中的语句，如果此处存在 return 语句，则在此直接返回，无情丢弃掉 try 块中的返回点。

反例：

private int x = 0;

public int checkReturn() {

try {

// x 等于 1，此处不返回

return ++x;

} finally {

// 返回的结果是 2

return ++x;

}

}

解释：做资源回收的，就做好资源回收就像，不要影响写字楼里的其他业务。别自作主张，替楼里的公司回复客户的业务信息。

  1. 【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。

说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。

解释：先兜住，再处理。兜不住，啥都没有意义。

  1. 【强制】在调用 RPC、二方包、或动态生成类的相关方法时，捕捉异常必须使用 Throwable类来进行拦截。

说明：通过反射机制来调用方法，如果找不到方法，抛出 NoSuchMethodException。什么情况会抛出 NoSuchMethodError 呢？二方包在类冲突时，仲裁机制可能导致引入非预期的版本使类的方法签名不匹配，或者在字节码修改框架（比如：ASM）动态创建或修改类时，修改了相应的方法签名。这些情况，即使代码编译期是正确的，但在代码运行期时，会抛出 NoSuchMethodError。

10. 【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值。

说明：本手册明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回 null 的情况。

解释：用javadoc 注释好，为了防止调用者出现空指针异常。严于律己。

 

11. 【推荐】防止 NPE，是程序员的基本修养，注意 NPE 产生的场景：

1） 返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE。

反例：public int f() { return Integer 对象}， 如果为 null，自动解箱抛 NPE。

2） 数据库的查询结果可能为 null。

3） 集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null。

4） 远程调用返回对象时，一律要求进行空指针判断，防止 NPE。

5） 对于 Session 中获取的数据，建议进行 NPE 检查，避免空指针。

6） 级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE。

正例：使用 JDK8 的 Optional 类来防止 NPE 问题。

解释：对自己职业的尊重。3，集合可以add null，isNotEmpty只判断size的大小。只要调用别人的方法一定判断空指针。严于律己宽以待人，允许别人犯错误。6，级联调用不推荐，如果返回当前对象，可以用级联调用，否则，别用。stringbuilder可以级联，返回当前对象可以级联调用。不是当前对象建议一步一调用。

Optional用法

https://blog.csdn.net/JoshuaXin/article/details/84849363

 

12. 【推荐】定义时区分 unchecked / checked 异常，避免直接抛出 new RuntimeException()，更不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DAOException / ServiceException 等。

13. 【参考】对于公司外的 http/api 开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间 RPC 调用优先考虑使用 Result 方式，封装 isSuccess()方法、“错误码”、“错误简短信息”。

说明：关于 RPC 方法返回方式使用 Result 方式的理由：

1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。

2）如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。

解释：看网约车 统一返回的bean。公司内部有一个网关转换，就是内部异常，外部错误码。

14. 【参考】避免出现重复的代码（Don't Repeat Yourself），即 DRY 原则。

说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。

正例：一个类中有多个 public 方法，都需要进行数行相同的参数校验操作，这个时候请抽取：

private boolean checkParam(DTO dto) {...}

解释：当自己有复制代码冲动的时候，就要考虑复用了。

 

  •  日志规约

优先级从高到低分别是ERROR、WARN、INFO、DEBUG

  1. 【强制】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(Test.class);

解释:日志门面，是门面模式的一个典型的应用。

门面模式（Facade Pattern），也称之为外观模式，其核心为：外部与一个子系统的通信必须通过一个统一的外观对象进行，使得子系统更易于使用。

就像前面介绍的几种日志框架一样，每一种日志框架都有自己单独的API，要使用对应的框架就要使用其对应的API，这就大大的增加应用程序代码对于日志框架的耦合性。

为了解决这个问题，就是在日志框架和应用程序之间架设一个沟通的桥梁，对于应用程序来说，无论底层的日志框架如何变，都不需要有任何感知。只要门面服务做的足够好，随意换另外一个日志框架，应用程序不需要修改任意一行代码，就可以直接上线。

  1. 【强制】所有日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。网络运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操作需要留存相关的网络日志不少于 6 个月。

解释：法律规定：国家三级等保要求是6个月。

  1. 【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：

appName_logType_logName.log。logType:日志类型，如 stats/monitor/access 等；logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。

说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。

正例：force-web 应用中单独监控时区转换异常，如：force_web_timeZoneConvert.log

 

  1. 【强制】在日志输出时，字符串变量之间的拼接使用占位符的方式。

说明：因为 String 字符串的拼接会使用 StringBuilder 的 append()方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。

正例：logger.debug("Processing trade with id: {} and symbol: {}", id, symbol);

解释:append会不停的创建string对象，可以看append源码。

  1. 【强制】对于 trace/debug/info 级别的日志输出，必须进行日志级别的开关判断。

说明：虽然在 debug(参数)的方法体内第一行代码 isDisabled(Level.DEBUG_INT)为真时（Slf4j 的常见实现Log4j 和 Logback），就直接 return，但是参数可能会进行字符串拼接运算。此外，如果debug(getName())这种参数内有 getName()方法调用，无谓浪费方法调用的开销。

正例：

  • 如果判断为真，那么可以输出 trace 和 debug 级别的日志

if (logger.isDebugEnabled()) {

logger.debug("Current ID is: {} and name is: {}", id, getName());

}

解释：减少后面getName（）方法的执行。

  1. 【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。

正例：

解释：它是 子Logger 是否继承 父Logger 的 输出源（appender）的标志位。具体说，默认情况下子Logger会继承父Logger的appender，也就是说子Logger会在父Logger的appender里输出。若是additivity设为false，则子Logger只会在自己的appender里输出，而不会在父Logger的appender里输出

  1. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 throws 往上抛出。

正例：logger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);

解释：此时用到前面pojo必须实现toString的约定。

  1. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘

撑爆，并记得及时删除这些观察日志。

说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

  1. 【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警。

说明：注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息。

  1. 【推荐】尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。

【强制】国际化团队或海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息。

三、单元测试

  1. 【强制】好的单元测试必须遵守 AIR 原则。

说明：单元测试在线上运行时，感觉像空气（AIR）一样并不存在，但在测试质量的保障上，却是非常关键的。好的单元测试宏观上来说，具有自动化、独立性、可重复执行的特点。

A：Automatic（自动化）

I：Independent（独立性）

R：Repeatable（可重复）

  1. 【强制】单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的，执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用 System.out 来进行人肉验证，必须使用 assert 来验证。
  2. 【强制】保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之间决不能互相调用，也不能依赖执行的先后次序。

反例：method2 需要依赖 method1 的执行，将执行结果作为 method2 的输入。

  1. 【强制】单元测试是可以重复执行的，不能受到外界环境的影响。

说明：单元测试通常会被放到持续集成中，每次有代码 check in 时单元测试都会被执行。如果单测对外部环境（网络、服务、中间件等）有依赖，容易导致持续集成机制的不可用。

正例：为了不受外界环境影响，要求设计代码时就把 SUT 的依赖改成注入，在测试时用 spring 这样的 DI 框架注入一个本地（内存）实现或者 Mock 实现。

解释：SUT System 强调整体

  1. 【强制】对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是方法级别。

说明：只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的交互逻辑，那是集成测试的领域。

  1. 【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。

说明：新增代码及时补充单元测试，如果新增代码影响了原有单元测试，请及时修正。

  1. 【强制】单元测试代码必须写在如下工程目录：src/test/java，不允许写在业务代码目录下。

     说明：源码编译时会跳过此目录，而单元测试框架默认是扫描此目录。

 

  1. 【推荐】单元测试的基本目标：语句覆盖率达到 70%；核心模块的语句覆盖率和分支覆盖率都要达到 100%

说明：在工程规约的应用分层中提到的 DAO 层，Manager 层，可重用度高的 Service，都应该进行单元测试。

  1. 【推荐】编写单元测试代码遵守 BCDE 原则，以保证被测试模块的交付质量。

B：Border，边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。

C：Correct，正确的输入，并得到预期的结果。

D：Design，与设计文档相结合，来编写单元测试。

E：Error，强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果。

 

10. 【推荐】对于数据库相关的查询，更新，删除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。

反例：删除某一行数据的单元测试，在数据库中，先直接手动增加一行作为删除目标，但是这一行新增数据并不符合业务插入规则，导致测试结果异常。

 

11. 【推荐】和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。

正例：在企业智能事业部的内部单元测试中，使用 ENTERPRISE_INTELLIGENCE _UNIT_TEST_的前缀来标识单元测试相关代码。

12. 【推荐】对于不可测的代码在适当的时机做必要的重构，使代码变得可测，避免为了达到测试要求而书写不规范测试代码。

 

13. 【推荐】在设计评审阶段，开发人员需要和测试人员一起确定单元测试范围，单元测试最好覆盖所有测试用例。

 

14. 【推荐】单元测试作为一种质量保障手段，在项目提测前完成单元测试，不建议项目发布后补充单元测试用例。

解释：原来公司这么做过。却决于着急程度。

 

15. 【参考】为了更方便地进行单元测试，业务代码应避免以下情况：

构造方法中做的事情过多。

存在过多的全局变量和静态方法。存在过多的外部依赖。

存在过多的条件语句。

说明：多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。

解释：设计模式，马老师有相关课程。

 

16. 【参考】不要对单元测试存在如下误解：

那是测试同学干的事情。本文是开发手册，凡是本文内容都是与开发同学强相关的。单元测试代码是多余的。系统的整体功能与各单元部件的测试正常与否是强相关的。单元测试代码不需要维护。一年半载后，那么单元测试几乎处于废弃状态。

单元测试与线上故障没有辩证关系。好的单元测试能够最大限度地规避线上故障。

 

 

四、安全规约

  1. 【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。

说明：防止没有做水平权限校验就可随意访问、修改、删除别人的数据，比如查看他人的私信内容、修改他人的订单。

解释：产品没有说，也要这么做，基本素质。

  1. 【强制】用户敏感数据禁止直接展示，必须对展示数据进行脱敏。

说明：中国大陆个人手机号码显示为:137****0969，隐藏中间 4 位，防止隐私泄露。

解释:三级等保要求。

  1. 【强制】用户输入的 SQL 参数严格使用参数绑定或者 METADATA 字段值限定，防止 SQL 注入，禁止字符串拼接 SQL 访问数据库。
  2. 【强制】用户请求传入的任何参数必须做有效性验证。

说明：忽略参数校验可能导致：

page size 过大导致内存溢出   

恶意 order by 导致数据库慢                                                      

查询任意重定向                                                                         

SQL 注入

反序列化注入

正则输入源串拒绝服务 ReDoS

说明：Java 代码用正则来验证客户端的输入，有些正则写法验证普通用户输入没有问题，但是如果攻击人员使用的是特殊构造的字符串来验证，有可能导致死循环的结果。

解释：

Orderby https://www.cnblogs.com/fengtingxin/p/11215164.html

正则拒绝服务 aaaaaaaaaa8

ReDoS(Regular expression Denial of Service) 正则表达式拒绝服务攻击。开发人员使用了正则表达式来对用户输入的数据进行有效性校验, 当编写校验的正则表达式存在缺陷或者不严谨时, 攻击者可以构造特殊的字符串来大量消耗服务器的系统资源，造成服务器的服务中断或停止。

非确定型有限状态自动机(Nondeterministic Finite Automation: NFA)

NFA则是“表达式主导”捏着正则式去比文本，吃掉一个字符，就把它跟正则式比较，匹配就记下来，然后继续匹配。一旦不匹配，就把刚吃的这个字符吐出来，一个个的吐，直到回到上一次匹配的地方。

阿里巴巴代码规范离线注释版本_第5张图片

https://blog.csdn.net/qq_37053783/article/details/89021727

反正：用户输入的东西都要校验。还是有坏用户的。

  1. 【强制】禁止向 HTML 页面输出未经安全过滤或未正确转义的用户数据。
  2. 【强制】表单、AJAX 提交必须执行 CSRF 安全验证。

说明：CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在 CSRF 漏洞的应用/网站，攻击者可以事先构造好 URL，只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。

解释：https://www.cnblogs.com/meituantech/p/9777222.html

https://blog.csdn.net/qq_40005100/article/details/88927869

大家不要试，不要面向监狱编程。

  1. 【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。

说明：如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。

解释：网约车项目中会有短信验证码的三档安全验证。

 

  1. 【推荐】发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。

 

五、MySQL 数据库

(一)  建表规约

  1. 【强制】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned

tinyint（1 表示是，0 表示否）。

说明：任何字段如果为非负数，必须是 unsigned。

注意：POJO 类中的任何布尔类型的变量，都不要加 is 前缀，所以，需要在<resultMap>设置从 is_xxx 到 Xxx 的映射关系。数据库表示是与否的值，使用 tinyint 类型，坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。

正例：表达逻辑删除的字段名 is_deleted，1 表示删除，0 表示未删除。

解释：如果数据取值不会有负数，就用只用正数类型，能省就省。打100人的土匪没必要派山东舰过去。

 

  1. 【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重

考虑。

说明：MySQL 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。

正例：aliyun_admin，rdc_config，level3_name

反例：AliyunAdmin，rdcConfig，level_3_name

 

 

  1. 【强制】表名不使用复数名词。

说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数形式，符合表达习惯。

解释：便于延续类定义的单数习惯。

 

  1. 【强制】禁用保留字，如 desc、range、match、delayed 等，请参考 MySQL 官方保留字。

     解释：也不推荐用mysql已经有的表名，做自己项目的表名。比如user。

  1. 【强制】主键索引名为 pk_字段名；唯一索引名为 uk_字段名；普通索引名则为 idx_字段名。

说明：pk_ 即 primary key；uk_ 即 unique key；idx_ 即 index 的简称。

解释：有的人用ak表示唯一索引，我们要能看懂。

索引：https://blog.csdn.net/u012954706/article/details/81241049

  1. 【强制】小数类型为 decimal，禁止使用 float 和 double。

说明：在存储的时候，float 和 double 都存在精度损失的问题，很可能在比较值的时候，得到不正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数并分开存储。

 

解释：钱的计算，直接用整数，单位是分，一是没有精度损失，二是运算效率高。

Decimal范围：https://www.cnblogs.com/owenma/p/7097602.html

  1. 【强制】如果存储的字符串长度几乎相等，使用 char 定长字符串类型。

     解释：1、不浪费空间，不如地区编码。就是6位。2、varchar会动态计算字符串长度，效率低。

  1. 【强制】varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度大于此值，定义字段类型为 text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。

解释：因为text上不会建索引。用主表id，当存储text数据的id。

9.  【强制】表必备三字段：id, create_time, update_time。

说明：其中 id 必为主键，类型为 bigint unsigned、单表时自增、步长为 1。create_time, update_time 的类型均为 datetime 类型。

解释：创建时间用代码控制，更新时间用数据库控制。

10. 【推荐】表的命名最好是遵循“业务名称_表的作用”。

正例：alipay_task / force_project / trade_config

11. 【推荐】库名与应用名称尽量一致。

12. 【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。

13. 【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：

1） 不是频繁修改的字段。

2） 不是 varchar 超长字段，更不能是 text 字段。

3） 不是唯一索引的字段。

正例：商品类目名称使用频率高，字段长度短，名称基本一不变，可在相关联的表中冗余存储类目名称，避免关联查询。

解释：频繁修改得改多个表影响效率；太长增加存储压力；唯一索引冗余后，基本上不唯一，比如用户名冗余到订单表，一个用户多个订单的情况。

 

14. 【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。

说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

解释：表设计考虑的情况会变多。表连接有难度。丧失表连接查询的能力。

 

15. 【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。

正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。

 

 

对象

 

 

年龄区间

 

 

类型

 

字节

 

表示范围

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

人

 

150 岁之内

 

tinyint unsigned

1

无符号值：0

到 255

 

 

 

 

 

 

 

 

 

 

 

 

龟

 

数百岁

 

smallint unsigned

2

无符号值：0

到 65535

 

 

 

 

 

 

 

 

 

 

 

 

恐龙化石

 

数千万年

 

int unsigned

4

无符号值：0

到约 42.9 亿

 

 

 

 

 

 

 

 

 

 

 

 

太阳

 

约 50 亿年

 

bigint unsigned

8

无符号值：0

到约 10 的 19 次方

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

解释：总之合适就好。

 

(二)  索引规约

  1. 【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。

说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。

解释：

  1. 不仅要有db主键，还要有业务主键，比如银行卡，有db主键通过磁条和芯片对应，卡号全球规划，属于业务主键。
  2. 500万条数据 或 2G 数据以内，索引影响的插入效率可以忽略不计。
  3. 墨菲定律（如果事情有变坏的可能，不管这种可能性有多小，它总会发生。），即使高并发程序控制的如何好，db层不做控制，也会发生脏数据。
  1. 【强制】超过三个表禁止 join。需要 join 的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。

说明：即使双表 join 也要注意表索引、SQL 性能。

 

解释：是绝对一致，类型和长度。

  1. 【强制】在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。

 

说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达90%以上，可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度来确定。

解释：SELECT count(distinct left(phone_number, 20))/count(*) FROM tbl_sms

 

  1. 【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。

说明：索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。

解释：左模糊，全模糊，会导致索引失效。推荐右模糊。

 

  1. 【推荐】如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合

索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。

正例：where a=? and b=? order by c; 索引：a_b_c

反例：索引如果存在范围查询，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引 a_b 无法排序。

 

解释：如果order by 无法形成索引，则会产生file_sort，降低效率。

filesort 是Mysql里一种速度比较慢的外部排序，如果能避免是最好的了，很多时候，我们可以通过优化索引来尽量避免出现Using filesort，从而提高速度。

Filesort过程：https://www.cnblogs.com/aeolian/p/10212892.html

 

  1. 【推荐】利用覆盖索引来进行查询操作，避免回表。

说明：如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。

正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效

果，用 explain 的结果，extra 列会出现：using index。

解释：select的数据列只用从索引中就能够取得，不必从数据表中读取，换句话说查询列要被所使用的索引覆盖。

 

 

  1. 【推荐】利用延迟关联或者子查询优化超多分页场景。

说明：MySQL 并不是跳过 offset 行，而是取 offset+N 行，然后返回放弃前 offset 行，返回 N 行，那当 offset 特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行 SQL 改写。

 

正例：先快速定位需要获取的 id 段，然后再关联：

SELECT a.* FROM 表 1 a, (select id from 表 1 where 条件 LIMIT 100000,20 ) b where a.id=b.id

 

解释：100万条记录，我们查 limit 900000 20,会查出来 900020，条数据，然后抛掉前面900000条。因为pk查询效率极高。这样把分页动作转移到主键。

索引最左匹配 idx（a,b,c）只要a作为查询条件在最前面，就会走索引，按照顺序。

何谓"延迟关联" ：通过使用覆盖索引查询返回需要的主键,再根据主键关联原表获得需要的数据

 

  1. 【推荐】SQL 性能优化的目标：至少要达到 range 级别，要求是 ref 级别，如果可以是

consts 最好。

说明：

1） consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。

2） ref 指的是使用普通的索引（normal index）。

3） range 对索引进行范围检索。

反例：explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别比较 range 还低，与全表扫描是小巫见大巫。

 

  1. 【推荐】建组合索引的时候，区分度最高的在最左边。

正例：如果 where a=? and b=? ，如果 a 列的几乎接近于唯一值，那么只需要单建 idx_a 索引即可。

说明：存在非等号和等号混合时，在建索引时，请把等号条件的列前置。如：where c>? and d=? 那么即使 c 的区分度更高，也必须把 d 放在索引的最前列，即索引 idx_d_c。

解释：年龄，性别，因为性别只能区分2种类型，年龄可以一些筛选掉很多人。

 

10. 【推荐】防止因字段类型不同造成的隐式转换，导致索引失效。

mysql中，字符串不加单引号索引会失效。正确写法：select * from t_user where username = 'lujin';

11. 【参考】创建索引时避免有如下极端误解：

1） 宁滥勿缺。认为一个查询就需要建一个索引。

2） 宁缺勿滥。认为索引会消耗空间、严重拖慢记录的更新以及行的新增速度。

3） 抵制惟一索引。认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。

 

(三)  SQL 语句

1.【强制】不要使用 count(列名)或 count(常量)来替代 count(*)，count(*)是 SQL92 定义的标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。

说明：count(*)会统计值为 NULL 的行，而 count(列名)不会统计此列为 NULL 值的行。

  1. 【强制】count(distinct col) 计算该列除 NULL 之外的不重复行数，注意 count(distinct col1, col2) 如果其中一列全为 NULL，那么即使另一列有不同的值，也返回为 0。
  2. 【强制】当某一列的值全是 NULL 时，count(col)的返回结果为 0，但 sum(col)的返回结果

为 NULL，因此使用 sum()时需注意 NPE 问题。

正例：使用如下方式来避免 sum 的 NPE 问题：SELECT IFNULL(SUM(column), 0) FROM table;

 

  1. 【强制】使用 ISNULL()来判断是否为 NULL 值。

说明：NULL 与任何值的直接比较都为 NULL。

1） NULL<>NULL 的返回结果是 NULL，而不是 false。

2） NULL=NULL 的返回结果是 NULL，而不是 true。

3） NULL<>1 的返回结果是 NULL，而不是 true。

 

  1. 【强制】代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。

解释：代码加上count判断。

  1. 【强制】不得使用外键与级联，一切外键概念必须在应用层解决。

说明：以学生和成绩的关系为例，学生表中的 student_id 是主键，那么成绩表中的 student_id 则为外键。如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度，微服务更是如此。

 

  1. 【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。

 

  1. 【强制】数据订正（特别是删除、修改记录操作）时，要先 select，避免出现误删除，确认无误才能执行更新语句。
  2. 【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控制在 1000 个之内。

 

10. 【参考】如果有国际化需要，所有的字符存储与表示，均以 utf-8 编码，注意字符统计函数的区别。

说明：

SELECT LENGTH("轻松工作")； 返回为 12

SELECT CHARACTER_LENGTH("轻松工作")； 返回为 4

如果需要存储表情，那么选择 utf8mb4 来进行存储，注意它与 utf-8 编码的区别。

 

解释:https://blog.csdn.net/vacherf/article/details/89291262

 

11. 【参考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE 无事务且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。

说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

 

 

(四)  ORM 映射

  1. 【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。

说明：1）增加查询分析器解析成本。2）增减字段容易与 resultMap 配置不一致。3）无用字段增加网络消耗，尤其是 text 类型的字段。

  1. 【强制】POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行

字段与属性之间的映射。

说明：参见定义 POJO 类以及数据库字段定义规定，在中增加映射，是必须的。在 MyBatis Generator 生成的代码中，需要进行对应的修改。

 

  1. 【强制】不要用 resultClass 当返回参数，即使所有类属性名与数据库字段一一对应，也需要

定义；反过来，每一个表也必然有一个 POJO 类与之对应。

说明：配置映射关系，使字段与 DO 类解耦，方便维护。

解释：关键是：解耦。

 

  1. 【强制】sql.xml 配置参数使用：#{}，#param# 不要使用${} 此种方式容易出现 SQL 注入。
  2. 【强制】iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使用。

说明：其实现方式是在数据库取到 statementName 对应的 SQL 语句的所有记录，再通过 subList 取

start,size 的子集合。

正例：Map map = new HashMap<>();

map.put("start", start);

map.put("size", size);

  1. 【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。

说明：resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。

  1. 【强制】更新数据表记录时，必须同时更新记录对应的 gmt_modified 字段值为当前时间。
  2. 【推荐】不要写一个大而全的数据更新接口。传入为 POJO 类，不管是不是自己的目标更新字段，都进行 update table set c1=value1,c2=value2,c3=value3; 这是不对的。执行 SQL

时，不要更新无改动的字段，一是易出错；二是效率低；三是增加 binlog 存储。

 

  1. 【参考】@Transactional 事务不要滥用。事务会影响数据库的 QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。

解释：QPS/TPS,每秒请求的数量，每秒事务的数量。

10. 【参考】中的 compareValue 是与属性值对比的常量，一般是数字，表示相等时带上此条件；表示不为空且不为 null 时执行；表示不为 null 值时执行。

解释:https://blog.csdn.net/evilcry2012/article/details/52702775

六、工程结构

  •  应用分层

阿里巴巴代码规范离线注释版本_第6张图片

 

 

 

 

 

  1. 【推荐】图中默认上层依赖于下层，箭头关系表示可直接依赖，如：开放接口层可以依赖于 Web 层，也可以直接依赖于 Service 层，依此类推：
  • 开放接口层：可直接封装 Service 方法暴露成 RPC 接口；通过 Web 封装成 http 接口；进行网关安全控制、流量控制等。
  • 终端显示层：各个端的模板渲染并执行显示的层。当前主要是 velocity 渲染，JS 渲染，JSP 渲染，移动端展示等。
  • Web 层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
  • Service 层：相对具体的业务逻辑服务层。
  • Manager 层：通用业务处理层，它有如下特征：

1） 对第三方平台封装的层，预处理返回结果及转化异常信息。

2） 对 Service 层通用能力的下沉，如缓存方案、中间件通用处理。

3） 与 DAO 层交互，对多个 DAO 的组合复用。

    • DAO 层：数据访问层，与底层 MySQL、Oracle、Hbase 等进行数据交互。
    • 外部接口或第三方平台：包括其它部门 RPC 开放接口，基础平台，其它公司的 HTTP 接口。

 

解释：velocity apache旗下的一种渲染模板。DAO纯粹的数据库访问层。多次db操作可以在manager中实现。

  1. 【参考】（分层异常处理规约）在 DAO 层，产生的异常类型有很多，无法用细粒度的异常进行 catch，使用 catch(Exception e)方式，并 throw new DAOException(e)，不需要打印日志，因为日志在 Manager/Service 层一定需要捕获并打印到日志文件中去，如果同台服务器再打日志，浪费性能和存储。在 Service 层出现异常时，必须记录出错日志到磁盘，尽可能带上参数信息，相当于保护案发现场。如果 Manager 层与 Service 同机部署，日志方式与 DAO 层处理一致，如果是单独部署，则采用与 Service 一致的处理方式。Web 层绝不应该继续往上抛异常，因为已经处于顶层，如果意识到这个异常将导致页面无法正常渲染，那么就应该直接跳转到友好错误页面，加上用户容易理解的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。

 

解释：

  1. 日志记需要的东西，比如我想记录每天的一些行为，记几点刷牙，洗脸，上班，没必要记几点打开牙膏盒。
  2. 日志记录用log4j等，不要用sysout。开发可以用sysout。

 

  1. 【参考】分层领域模型规约：
    • DO（Data Object）：此对象与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。
    • DTO（Data Transfer Object）：数据传输对象，Service 或 Manager 向外传输的对象。
    • BO（Business Object）：业务对象，由 Service 层输出的封装业务逻辑的对象。
    • AO（Application Object）：应用对象，在 Web 层与 Service 层之间抽象的复用对象模型，极为贴近展示层，复用度不高。
    • VO（View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。
    • Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输。

解释：

  1. 如果DAO调用db的函数、存储过程，返回的结果，不是DO，也可以用DTO接收。
  2. 如果service或manager向外传输，没有有特殊处理，也可以仅仅返回DO。
  3. VO 是一些分页相关的信息。
  4. 不要用map传递参数，不知道里面是什么。

 

  •  二方库依赖

说明： 阿里定义： 一方库：本工程中各模块依赖。

          二方库：公司内部依赖库，依赖其他模块的库。

          三方库：公司之外的库。

 

  1. 【强制】定义 GAV 遵从以下规则：

1） GroupID 格式：com.{公司/BU }.业务线 [.子业务线]，最多 4 级。

说明：{公司/BU} 例如：alibaba/taobao/tmall/aliexpress 等 BU 一级；子业务线可选。

正例：com.taobao.jstorm 或 com.alibaba.dubbo.register

2） ArtifactID 格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。

正例：dubbo-client / fastjson-api / jstorm-tool

  1. Version：详细规定参考下方。

解释：举例，不推荐用快照SNAPSHOT 。Maven。G：一般3级就够了。介绍一些我们的课程。

 

  1. 【强制】二方库版本号命名方式：主版本号.次版本号.修订号

1）主版本号：产品方向改变，或者大规模 API 不兼容，或者架构不兼容升级。

2） 次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的 API 不兼容修改。

3） 修订号：保持完全兼容性，修复 BUG、新增次要功能特性等。

说明：注意起始版本号必须为：1.0.0，而不是 0.0.1，正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级。如当前版本：1.3.3，那么下一个合理的版本号：1.3.4 或 1.4.0 或 2.0.0

 

解释：主版本：大规模，参考spring boot。Java -version

 

  1. 【强制】线上应用不要依赖 SNAPSHOT 版本（安全包除外）。

说明：不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外，也可以加快编译时的打包建。

 

解释： SNAPSHOT压根不要，因为snapshot版本每次打包都要重构，怕有一些问题。安全包指不再改不再升级的版本。开发过程可以用，但不要上线。

 

  1. 【强制】二方库的新增或升级，保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变，必须明确评估和验证。

说明：在升级时，进行 dependency:resolve 前后信息比对，如果仲裁结果完全不一致，那么通过dependency:tree 命令，找出差异点，进行排除 jar 包。

 

解释：比如引入dubbo某版本，会引入spring某版本，我们需要排除spring 某版本。在spring boot中starter-web依赖下有 tomcat的依赖，我们想用别的服务器，可以排除tomcat。再引入别的。

 

  1. 【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的 POJO 对象。

解释:枚举有好处，约束数据范围，但返回时要考虑返回结果在其他应用中是否可以正常使用。

  1. 【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。

说明：依赖 springframework-core,-context,-beans，它们都是同一个版本，可以定义一个变量来保存

版本：${spring.version}，定义依赖的时候，引用该版本。

解释：比如a，b（a,b是依赖群）的1.0依赖jdk1.7，1.1依赖1.8，不要用a的1.0，b的1.1，别给自己找麻烦。统一版本号。

  1. 【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId，相同的 ArtifactId，但是不同的Version。

说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个 war，只能有一个版本号出现在最后的 lib 目录中。可能出现线下调试是正确的，发布到线上却出故障的问题。

解释：因为父用1.0，打成war包后，子虽然用了1.1，但子的1.1会被忽略。就会出问题。

 

  1. 【推荐】底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。
  2. 【推荐】所有 pom 文件中的依赖声明放在语句块中，所有版本仲裁放在

语句块中。

说明：里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version 和 scope 都读取自父 pom。而所有声明在主 pom 的里的依赖都会自动引入，并默认被所有的子项目继承。

 

解释：查一些这个两个xml的区别。

 

  1. 【推荐】二方库不要有配置项，最低限度不要再增加配置项。

解释：使用者不好扩展。

 

11. 【参考】为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则：

1）精简可控原则。移除一切不必要的 API 和依赖，只包含 Service API、必要的领域模型对象、Utils类、常量、枚举等。如果依赖其它二方库，尽量是 provided 引入，让二方库使用者去依赖具体版本号；无 log 具体实现，只依赖日志框架。

 

2）稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能方便查到。

除非用户主动升级版本，否则公共二方库的行为不应该发生变化。

解释：1：避免依赖不需要的库，防止别人因为自己的多余有版本，对别人出现版本冲突。2：本地私有库，详细记录。

(三)  服务器

 

  1. 【推荐】高并发服务器建议调小 TCP 协议的 time_wait 超时时间。

说明：操作系统默认 240 秒后，才会关闭处于 time_wait 状态的连接，在高并发访问下，服务器端会因为处于 time_wait 的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。

正例：在 linux 服务器上请通过变更/etc/sysctl.conf 文件去修改该缺省值（秒）：

net.ipv4.tcp_fin_timeout = 30

 

  1. 【推荐】调大服务器所支持的最大文件句柄数（File Descriptor，简写为 fd）。

说明：主流操作系统的设计是将 TCP/UDP 连接采用与文件一样的方式去管理，即一个连接对应于一个fd。主流的 linux 服务器默认所支持最大 fd 数量为 1024，当并发连接数很大时很容易因为 fd 不足而出现 “open too many files”错误，导致新的连接无法建立。建议将 linux 服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。

 

  1. 【推荐】给 JVM 环境参数设置-XX:+HeapDumpOnOutOfMemoryError 参数，让 JVM 碰到

OOM 场景时输出 dump 信息。

说明：OOM 的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助。

解释：听扫地僧马老师的课程。

  1. 【推荐】在线上生产环境，JVM 的 Xms 和 Xmx 设置一样大小的内存容量，避免在 GC 后调整堆大小带来的压力。

 

  1. 【参考】服务器内部重定向使用 forward；外部重定向地址使用 URL 拼装工具类来生成，否则会带来 URL 维护不一致的问题和潜在的安全风险。

 

  • 设计规约
  1. 【强制】存储方案和底层数据结构的设计获得评审一致通过，并沉淀成为文档。

说明：有缺陷的底层数据结构容易导致系统风险上升，可扩展性下降，重构成本也会因历史数据迁移和系统平滑过渡而陡然增加，所以，存储方案和数据结构需要认真地进行设计和评审，生产环境提交执行后，需要进行 double check。

 

正例：评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否满足业务发展、表或字段之间的辩证关系、字段名称、字段类型、索引等；数据结构变更（如在原有表中新增字段）也需要进行评审通过后上线。

 

  1. 【强制】在需求分析阶段，如果与系统交互的 User 超过一类并且相关的 User Case 超过 5 个，使用用例图来表达更加清晰的结构化需求。
  2. 【强制】如果某个业务对象的状态超过 3 个，使用状态图来表达并且明确状态变化的各个触发条件。

说明：状态图的核心是对象状态，首先明确对象有多少种状态，然后明确两两状态之间是否存在直接转换关系，再明确触发状态转换的条件是什么。

正例：淘宝订单状态有已下单、待付款、已付款、待发货、已发货、已收货等。比如已下单与已收货这两种状态之间是不可能有直接转换关系的。

  1. 【强制】如果系统中某个功能的调用链路上的涉及对象超过 3 个，使用时序图来表达并且明确各调用环节的输入与输出。

 

说明：时序图反映了一系列对象间的交互与协作关系，清晰立体地反映系统的调用纵深链路。

解释：我们网约车系统中有很多时序图。

 

  1. 【强制】如果系统中模型类超过 5 个，并且存在复杂的依赖关系，使用类图来表达并且明确类之间的关系。

说明：类图像建筑领域的施工图，如果搭平房，可能不需要，但如果建造蚂蚁 Z 空间大楼，肯定需要详细的施工图。

  1. 【强制】如果系统中超过 2 个对象之间存在协作关系，并且需要表示复杂的处理流程，使用活动图来表示。

说明：活动图是流程图的扩展，增加了能够体现协作关系的对象泳道，支持表示并发等。

  1. 【推荐】需求分析与系统设计在考虑主干功能的同时，需要充分评估异常流程与业务边界。

反例：用户在淘宝付款过程中，银行扣款成功，发送给用户扣款成功短信，但是支付宝入款时由于断网演练产生异常，淘宝订单页面依然显示未付款，导致用户投诉。

 

  1. 【推荐】类在设计与实现时要符合单一原则。

说明：单一原则最易理解却是最难实现的一条规则，随着系统演进，很多时候，忘记了类设计的初衷。

 

  1. 【推荐】谨慎使用继承的方式来进行扩展，优先使用聚合/组合的方式来实现。

说明：不得已使用继承的话，必须符合里氏代换原则，此原则说父类能够出现的地方子类一定能够出现，比如，“把钱交出来”，钱的子类美元、欧元、人民币等都可以出现。

 

10. 【推荐】系统设计时，根据依赖倒置原则，尽量依赖抽象类与接口，有利于扩展与维护。

说明：低层次模块依赖于高层次模块的抽象，方便系统间的解耦。

11. 【推荐】系统设计时，注意对扩展开放，对修改闭合。

说明：极端情况下，交付线上生产环境的代码都是不可修改的，同一业务域内的需求变化，通过模块或类的扩展来实现。

 

12. 【推荐】系统设计阶段，共性业务或公共行为抽取出来公共模块、公共配置、公共类、公共方法等，避免出现重复代码或重复配置的情况。

说明：随着代码的重复次数不断增加，维护成本指数级上升。

 

13. 【推荐】避免如下误解：敏捷开发 = 讲故事 + 编码 + 发布。

说明：敏捷开发是快速交付迭代可用的系统，省略多余的设计方案，摒弃传统的审批流程，但核心关键点上的必要设计和文档沉淀是需要的。

反例：某团队为了业务快速发展，敏捷成了产品经理催进度的借口，系统中均是勉强能运行但像面条一样的代码，可维护性和可扩展性极差，一年之后，不得不进行大规模重构，得不偿失。

14. 【参考】系统设计主要目的是明确需求、理顺逻辑、后期维护，次要目的用于指导编码。

说明：避免为了设计而设计，系统设计文档有助于后期的系统维护和重构，所以设计结果需要进行分类归档保存。

 

15. 【参考】设计的本质就是识别和表达系统难点，找到系统的变化点，并隔离变化点。

说明：世间众多设计模式目的是相同的，即隔离系统变化点。

16. 【参考】系统架构设计的目的：

确定系统边界。确定系统在技术层面上的做与不做。

确定系统内模块之间的关系。确定模块之间的依赖关系及模块的宏观输入与输出。

确定指导后续设计与演化的原则。使后续的子系统或模块设计在规定的框架内继续演化。确定非功能性需求。非功能性需求是指安全性、可用性、可扩展性等。

 

17. 【参考】在做无障碍产品设计时，需要考虑到：

所有可交互的控件元素必须能被 tab 键聚焦，并且焦点顺序需符合自然操作逻辑。用于登陆校验和请求拦截的验证码均需提供图形验证以外的其它方式。

 

自定义的控件类型需明确交互方式。

解释：无障碍指，没有鼠标或者键盘，只有一个也能正常操作。

 

附 1：版本历史

 

 

版本号

 

版本名

更新日期

 

备注

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

--

 

--

2016.12.07

 

试读版本首次对外发布

 

 

 

 

 

 

 

 

 

 

1.0.0

 

正式版

2017.02.09

 

阿里巴巴集团正式对外发布

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1）修正 String[]的前后矛盾。

 

1.0.1

 

--

2017.02.13

 

2）vm 修正成 velocity。

 

 

 

 

 

 

3）修正 countdown 描述错误。

 

 

 

 

 

 

 

 

 

 

1.0.2

 

--

2017.02.20

 

1）去除文底水印。2）数据类型中引用太阳系年龄问题。3）修正关于异常和方法签

 

 

 

名的部分描述。4）修正 final 描述。5）去除 Comparator 部分描述。

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1.1.0

 

--

2017.02.27

 

1）增加前言。2）增加描述和说明。3）增加版本历史。4）增加专有

 

 

 

名词解释。

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1.1.1

 

--

2017.03.31

 

修正页码总数和部分示例。

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1）根据云栖社区的“聚能聊”活动反馈，对手册的页码、排版、描述进行修正。2）

 

1.2.0

 

完美版

2017.05.20

 

增加 final 的适用场景描述。3）增加关于锁的粒度的说明。4）增加“指定集合大

 

 

 

小”的详细说明以及正反例。5）增加卫语句的示例代码。6）明确数据库表示删除概

 

 

 

 

 

 

 

 

 

 

 

 

念的字段名为 is_deleted

 

 

 

 

 

 

 

1.3.0

 

终极版

2017.09.25

增加单元测试规约，阿里开源的 IDE 代码规约检测插件：点此下载

 

 

 

 

 

 

 

 

 

1.3.1

 

纪念版

2017.11.30

修正部分描述；采用和 P3C 开源 IDE 检测插件相同的 Apache2.0 协议。

 

 

 

 

 

 

 

 

1.4.0

 

详尽版

2018.05.20

 

增加设计规约大类，共 16 条。

 

 

 

 

 

 

 

 

 

 

 

 

 

1）鉴于本手册是社区开发者集体智慧的结晶，本版本移除阿里巴巴 Java 开发手册的

 

 

 

 

 

 

限定词“阿里巴巴”。

 

 

 

 

 

 

2）新增 21 条新规约。比如，switch 的 NPE 问题、浮点数的比较、无泛型限制、锁

 

1.5.0

 

华山版

2019.06.19

 

的使用方式、判断表达式、日期格式等。

 

 

 

 

 

 

3）修改描述 112 处。比如，IFNULL 的判断、集合的 toArray、日志处理等。

 

 

 

 

 

 

4）完善若干处示例。比如，命名示例、卫语句示例、enum 示例、finally 的 return

 

 

 

 

 

 

示例等。

 

 

 

 

 

 

 

 

 

 

 

附 2：专有名词解释

 

  1. POJO（Plain Ordinary Java Object）: 在本手册中，POJO 专指只有 setter / getter / toString 的简单类，包括 DO/DTO/BO/VO 等。
  2. GAV（GroupId、ArtifactctId、Version）: Maven 坐标，是用来唯一标识 jar 包。
  3. OOP（Object Oriented Programming）: 本手册泛指类、对象的编程处理方式。
  4. ORM（Object Relation Mapping）: 对象关系映射，对象领域模型与底层数据之间的转换，本文泛指 iBATIS, mybatis 等框架。
  5. NPE（java.lang.NullPointerException）: 空指针异常。
  6. SOA（Service-Oriented Architecture）: 面向服务架构，它可以根据需求通过网络对松散耦合的粗粒度应用组件进行分布式部署、组合和使用，有利于提升组件可重用性，可维护性。
  7. IDE（Integrated Development Environment）: 用于提供程序开发环境的应用程序，一般包括代码编辑器、编译器、调试器和图形用户界面等工具，本《手册》泛指 IntelliJ IDEA 和eclipse。

 

  1. OOM（Out Of Memory）: 源于 java.lang.OutOfMemoryError，当 JVM 没有足够的内存来为对象分配空间并且垃圾回收器也无法回收空间时，系统出现的严重状况。
  2. 一方库：本工程内部子项目模块依赖的库（jar 包）。

10. 二方库：公司内部发布到中央仓库，可供公司内部其它应用依赖的库（jar 包）。

11. 三方库：公司之外的开源库（jar 包）。

完20191226

 

你可能感兴趣的:(学习历程)

  • 机器学习 流形数据降维：UMAP 降维算法 小嗷犬 Python机器学习#数据分析及可视化机器学习算法人工智能
    ✅作者简介：人工智能专业本科在读，喜欢计算机与编程，写博客记录自己的学习历程。个人主页：小嗷犬的个人主页个人网站：小嗷犬的技术小站个人信条：为天地立心，为生民立命，为往圣继绝学，为万世开太平。本文目录UMAP简介理论基础特点与优势应用场景在Python中使用UMAP安装umap-learn库使用UMAP可视化手写数字数据集UMAP简介UMAP（UniformManifoldApproximatio
  • 宇宙公民第10期高效阅读营第2课收获 宇宙公民Cathy
    第二节课学习了冥想，校长传授了很多很多的知识和自己的心得体会，非常感谢她的无私分享。课程由八部分组成，一是校长的冥想学习历程，二是冥想的重要性。三世冥想的含义，四是冥想的类别，五是初学者入门的方法，六是冥想的步骤，七是冥想的误区，八是冥想的练习。结合今天的作业内容，我先谈一谈今天冥想环节，脑海里出现的画面。我躺在沙滩的树荫下，细腻柔软的沙子传来阵阵温暖，树叶在海风的吹拂下沙沙作响。耳边传来的是大海
  • 精读论语复盘：用跨越千年的时代瑰宝为人生加持 慢慢学说话
    21天的精读论语训练营告于段落，回顾我的学习历程，每个阶段的学习都认真听讲，结合自身实际提炼总结卡文，每篇卡文都荣幸的推选为精选。积极参加班级的思启活动，与书友们分享了《赞美的力量》和《从拆弹专家到炸弹专家，一场心灵的自我救赎》，结合论语启发思考。参与小组PK和班级PK活动，撰写了小组PK赛中论语大辩论的脚本，并担任辩论主持，撰写了班级PK赛中《上位风波》的脚本并饰演同事小赵，都取得的不错的成绩。
  • Python 元组 小嗷犬 Python#Python入门基础python开发语言
    ✅作者简介：人工智能专业本科在读，喜欢计算机与编程，写博客记录自己的学习历程。个人主页：小嗷犬的博客个人信条：为天地立心，为生民立命，为往圣继绝学，为万世开太平。本文内容：Python元组更多内容请见Python入门基础专栏Python字符串Python常用字符串方法Python元组创建元组tuple函数圆括号多重赋值元组特性单个元素的元组可以省略的圆括号不可变性为什么需要元组除了两个方面，元组数
  • SOC学习历程概述 weixin_30376509 操作系统嵌入式运维
    从开始接触soc到现在大概有两年半左右的时间了，经历了ORSOC到minsoc再到mkg-soc的搭建，以及现在的大小核系统的搭建首先先讲下学习的前期需要具备的知识，前面3点是必须，后面3点可以中间学习的过程再学习。之所以有这些要求主要是以防中间的学习过程中，有些东西看不懂而走弯路。学习的前期准备：1、学过数电，有一定的电路基础。2、熟练掌握verilog语言。3、对于计算机组成原理，体系结构有一
  • 2022-03-16 Wednesday 永夜的叶子
    感觉还真的挺快的，又到了周三了。这两天，其实我一直在琢磨个事儿，那就是，如何培养起自己的‘世界大观’。这个词又是我自己新建的，世界观主要是对于世界格局的整体了解和认知，但是世界大观，这个词在我这里代表了一种最高智慧。它是融合了地缘政治、历史、地理、社会学、经济等等一系列的东西。以史为鉴，可以知得失。这句话常常听说，但是实际上，因为过于空泛，反倒是不知道该如何下手。根据我对于心理学的学习历程，我得到
  • LaTeX 文本对齐：ragged2e 宏包 小嗷犬 LaTeXLaTeX
    ✅作者简介：人工智能专业本科在读，喜欢计算机与编程，写博客记录自己的学习历程。个人主页：小嗷犬的个人主页个人网站：小嗷犬的技术小站个人信条：为天地立心，为生民立命，为往圣继绝学，为万世开太平。本文目录ragged2e宏包简介ragged2e宏包的使用加载宏包对齐命令对齐效果ragged2e宏包简介ragged2e是一个LaTeX宏包，它为LaTeX文档提供了一种改进的、更加灵活的文本对齐方式，特别
  • DataCastle 员工离职预测 Baseline 小嗷犬 Python机器学习机器学习数据挖掘sklearn
    ✅作者简介：人工智能专业本科在读，喜欢计算机与编程，写博客记录自己的学习历程。个人主页：小嗷犬的个人主页个人网站：小嗷犬的技术小站个人信条：为天地立心，为生民立命，为往圣继绝学，为万世开太平。本文目录比赛介绍比赛链接赛题描述评分标准比赛数据数据下载数据说明Baseline导包数据读取数据缺失状况样本标签是否均衡打印类别特征类别特征编码特征衍生数据标准化数据降维特征选择不均衡样本处理模型调参XGBo
  • 变分自编码器（VAE）PyTorch Lightning 实现 小嗷犬 Python深度学习pytorch人工智能python
    ✅作者简介：人工智能专业本科在读，喜欢计算机与编程，写博客记录自己的学习历程。个人主页：小嗷犬的个人主页个人网站：小嗷犬的技术小站个人信条：为天地立心，为生民立命，为往圣继绝学，为万世开太平。本文目录VAE简介基本原理应用与优点缺点与挑战使用VAE生成MNIST手写数字忽略警告导入必要的库设置随机种子cuDNN设置超参数设置数据加载定义VAE模型定义损失函数定义Lightning模型训练模型绘制训
  • Datawhale用免费GPU线上跑AI项目实践课程任务一学习笔记。部署ChatGLM3-6B模型 Hoogte-oile 学习笔记学习笔记人工智能自然语言处理
    前言本篇文章为学习笔记，流程参照Datawhale用免费GPU线上跑AI项目实践课程任务，个人写此文章为记录学习历程和补充概念，并希望为后续的学习者开辟道路，没有侵权的意思。如有错误也希望大佬们批评指正。模型介绍ChatGLM-6B是一个开源的、支持中英双语问答的对话语言模型，基于GeneralLanguageModel(GLM)架构，具有62亿参数。结合模型量化技术，用户可以在消费级的显卡上进行
  • 《STM32从零开始学习历程》——DMA直接存储区访问理论知识 EnzoReventon STM32ARM嵌入式stm32
    《STM32从零开始学习历程》@EnzoReventonDMA—直接存储区访问理论知识本文主要介绍STM32F4DMA直接存储区的理论知识部分，本文主要参考手册为：[野火EmbedFire]《STM32库开发实战指南——基于野火霸天虎开发板》[正点原子]STM32F4开发指南-库函数版本_V1.2[ST]《STM32F4xx中文参考手册》在学习野火教程第22章的基础上进行理解、解读与拓展，争取以一
  • 萌新驾到，C语言的学习及其步入嵌入式，与CSDN的结缘 考试可爱又可恨 学习心路c语言学习单片机学习方法蓝桥杯笔记
    大家好，我是来自物联网工程专业的准大二学生一枚，随着时间线的推移，我不知不觉中度过了大一的一个学年，进入了象征大一结局的暑假，在这大一的一年里，我与CSDN的初识是因为C语言。原来只是游客观看，近期想着记录学习历程，学习成果，也心生感慨想做以记录，巩固学习到的知识。本篇文章是作为一个普通物联网学生的大一一年学习历程。在刚刚进入大学校园时，为了不使大学四年的青春白费，我参加了本校的一个学习工作室，该
  • 中原焦点团队——马祎蔓中22坚持分享第167天第6周约练第3次共124次（2020.1.22） 祎曼静美
    由于今天记错了时间，想参加周日集体大约练，结果也没约练成，又没参加大约练，就利用这段时间。整理了一下初25的第一节课程，在整的过程中，有几点顿悟：1，一定要参加初级班的复训。这次听和第一次听感受完全不一样。第一次听感觉到好奇。什么都想往脑子里记。几乎想要把刘老师讲的话全部记录下来。可最后感觉啥都没记住。而这次复训，记得少了。脑海里边会边听便回顾这段学习历程。能够把刘老师所讲的要点前后连贯起来。也能
  • 2021-09-21 凤舞九天
    中原焦点团队高级6期肖巧风，坚持第536天原创分享，第五期挑战每周3次。《新手咨询师的五大焦虑》第一、学习的焦虑。当你走进咨询行业，就有很多同道向你推荐各种各样的课程，每个课程都有其好的特点，也觉得需要学习，那么就很容易形成不是在学习的现场，就是在学习的路上。反思学习历程，反而感觉得越学需要学的东西越多了。深挖一口井，互融互通，最后就是关注到人。第二、助人的焦虑。特别是作为新手咨询师，容易被卷入，
  • 感恩日志 第【1769】天：（2020.10.10）星期六 23~16℃ 多云 山东慧恩贺守金
    韩老师在精捷谢老师在华睿兴达1.感恩老师们同在一座城两家企业服务，为老师们点赞，幸福啦！2.感恩收获的一天，小伙伴们收5张门票，不论在济南还是淄博，不管是汽配还是汽修，都能有所得，幸福啦！3.感恩老同事阿新帮助流失的客户：丹东乔总，重新找到组织，建立链接，开启新的学习历程！图片发自App
  • 记录vim的学习历程 一把吉他
    自己就是一个编程菜鸟，也是第一次开始记录自己的学习过程，用来督促自己学习。人生本就不易，我也希望大佬，大神们切勿嘲笑与我，为难与我。时光如梭，不知不觉已经混到大二，马上就大三了，仍然纠结考研与就业的问题，但我想无论选择那条道路，都要有软实力吧，于是先从自己的编程速度开始提升，开始学习vim，我主要是想熟练掌握光标移动的操作，同学也给我推荐了一些帖子，我并没有下载vim编辑器，只是在vscode上下
  • 别让天赋掩盖了你的努力 梦梦_9b95
    ——F17期梦梦成长报告觉得时间过得很快的话，就不说了，因为自从有了孩子以后，我似乎一直在跟时间赛跑，总想拥有更多的时间能做更多的事情。对，我就是一只停不下来的陀螺，陀螺的使命，不就是让自己一直不停的转动吗？第一次看到作业要求，有点懵！“个人成长报告”，难道我还是个学生？可不是吗？如果没有学生的姿态，又怎么能把知识学进去呢？索性，就回顾一下自己的塔罗学习历程，整理好过去，才能更清晰的迈向未来。早在
  • SpringBoot学习历程（六）：集成Lombok RabbitsInGrass
    1.简介  ProjectLombokmakesjavaaspicierlanguagebyadding‘handlers’thatknowhowtobuildandcompilesimple,boilerplate-free,not-quite-javacode.即Lombok通过增加一些“处理程序”，可以让java变得简洁、快速。  Lombok能通过注解的方式，在编译时自动为属性生成构造器、
  • 2023：既是结束也是开始 抱抱宝 总结记录学习程序人生考研职场和发展
    2023年注定是不平凡的一年，这一年真的经历了很多事，包括学习、生活、工作等等，上半年忙着毕业以及一些其他的事情，很多挖的坑都没来得及填，下半年研一开学以后终于有了足够的时间学习，接下来就用这篇文章来回顾一下2023下半年这段时间的学习历程吧！1.学习内容总结话不多说，先上图：该图非常具体的描述了这半年来学习的东西，有之前的知识总结，也有新的知识学习，在不同的方向持续探索，寻找适合自己的方向，既要
  • 理财之路--一个小白的成长（二） 从此热爱生活
    一直很想记录自己这几个月思想的变化，尤其是对于投资理财方面知识的学习历程。当然我也想先明确一下，因为我们不是专职投资人士，只是在日常工作之余，通过理财使存款不要日益贬值，能够有被动收入，这是我这些文章讨论的内容范围。相信很多人有过跟我一样的经历，几个朋友窃窃私语，互相告知一些他们认为是内部消息的股票或者基金信息，以前我会问一问，为什么这家公司的股票会涨?这家公司是从事什么的?对方好心将“内部消息”
  • 《如何阅读》佳佳 坚持的佳
    图片发自App一个人的知识、学历、才华等都是外化，其真正具有竞争性的资本是他的学习能力。其实终身学习才是未来的核心竞争力！！！懂得深入思考，才能成就高质量的学习。努力本身是一种才能，需要有效的策略。学习必须以思考为前提，思考又需要以提问为前提，只有这样你的学习才具备效率。从知识到技能再到才干，才是最完整和有价值的学习历程。希望以后，要多读点书，多长点知识。尤其在早上跑步时，多听下樊登读书会以及喜马
  • 学习心理学的心得体会 我爱一帆风顺
    学习心理学的心得体会我最早认识心理学是通过一个港剧《读心神探》，它是通过微表情进行破案，当时看完以后觉得心理好神秘，能够了解自己的行为，也能够能够理解别人行为背后的意义。但在学习心理学的这段时间以来我更加科学的认识到了心理学的含义，我被其中的奥妙吸引，它是实实在在的科学，并没有很多的虚幻的东西在里面。回顾心理学的学习历程，最初与心理学结缘是因为复杂的夫妻关系和紧张的亲子关系。我们夫妻常常为了鸡毛蒜
  • 【VulnHub靶场】——BEELZEBUB: 1 Hacking庆尘 VulnHub靶场网络安全web安全安全
    作者名：Demo不是emo主页面链接：主页传送门创作初心：对于计算机的学习者来说，初期的学习无疑是最迷茫和难以坚持的，中后期主要是经验和能力的提高，我也刚接触计算机1年，也在不断的探索，在CSDN写博客主要是为了分享自己的学习历程，学习方法，总结的经验等等，希望能帮助到大家座右铭：不要让时代的悲哀成为你的悲哀专研方向：网络安全，数据结构每日emo：她今天写一份BEELZEBUB:1靶场教程（简单难
  • 分享VMware Workstation Pro ESXI7创建虚拟机和配置硬盘空间（分享自己的学习历程意在帮助有需要的小伙伴） Java000I 学习历程学习服务器性能优化ESXI7ESXIVMwareESXI7.0
    背景：因公司项目需求改用VMwareWorkstationPro，已经使用1个月目前除了中途出现过一次问题被解决后一直稳定运行至今，1:这里贴出拿出现的问题提示及解决方法的链接：解决vmWareESXI7.3报错;2:如果你是第一次接触VMwareWorkstationProESXI7,想使用他但是不知道如何安装配置的话请看这里：VMwareWorkstationPro使用开启虚拟机上达限25后，
  • 星辰 赵楚熙《关于“初一到初二上的几何脑图”》 若芷幽兰
    第一周星辰的赵楚熙小论文分享整篇脑图这篇数学脑图我的大思路是：“几何变换”，也就是怎么样从“点”到“线”、从“线”再到“面”，再到未来从“面”到“体”。脑图的二级分支接下来的二级分支里面的其他小分支，我是按照我们的学习历程来制作的。欧氏几何的地基是什么？是公理！我们每次的探究也都是从公理开始，有了公理我们才可以推理出一个个定理。这就是我二级分支以后的思路。清晰了思路，我们就开始脑图的制作。这也是做
  • 日进六功第54天 腾飞爱自己
    1.见证成长千晓年会的总结让我看到了我的成长和学习历程，每一位大咖老师都是我学习的榜样！段丽晓老师（最爱的女神，偶像，榜样，灯塔），李丽英老师（榜样，感恩您的引进门），裴明老师（简快导师，暖男），宋少伟老师（男神，学习治疗师创始人，开创积极学习系统科学实验室），史敬飞老师（敬飞小物件创始人，小史飞刀，），还有林德勇老师（读人识心专家），王金燕老师（亲子沟通专家），王娜老师（问题行为矫正专家）都是能
  • Docker学习历程 徐子元竟然被占了！！ 运维docker学习
    Docker学习历程Q1、docker还没启动Q2、Docker容器名称冲突的问题Q3：启动minio时发现，容器已经再重启Q4：容器被占用的情况Q5：查看日志Q1、docker还没启动dockerrun--envMODE=standalone--namenacos--restart=always-d-p8848:8848nacos/nacos-server:1.2.0docker:Cannotc
  • 2020-03-10 蹋挞祂
    [转载]数字证书原理，公钥私钥加密-读过最浅显易懂的密钥topicNinthDay已关注22016.05.0413:25:37字数12,631阅读5,9622018-Read-Record记录我的2018学习历程文中首先解释了加密解密的一些基础知识和概念，然后通过一个加密通信过程的例子说明了加密算法的作用，以及数字证书的出现所起的作用。接着对数字证书做一个详细的解释，并讨论一下windows中数字
  • FPGA学习记录-Vivado工程创建、仿真、编译 zoeybbb VivadoFPGAXilinxfpga开发学习
    目录前言工程创建工程仿真引脚配置编译前言本系列文章作为对特权同学《深入浅出玩转FPGA》课程学习的记录，对课程内容进行总结，比记录遇到的问题与解决办法，以此见证个人FPGA学习历程。这篇文章主要对工程的创建、仿真、编译、烧录过程进行总结，不足之处，还请各位在评论区指出，谢谢！开发板：SF-AT7软件平台：Vivado2016.2工程创建在创建工程之前建立一个新的文件夹用于存放之后建立的工程，注意路
  • 这是一篇学习记录(一) — RPA 疯狂的豆包 RPA学习rpa
    犹豫再三要不要记录一下这次的学习历程，说起RPA，可能很多人不了解，那么RPA到底是什么，它有什么用处。机器人流程自动化(RPA)，又称为软件机器人，是一种利用智能自动化技术来模拟人类执行后台任务的方法。具体而言，RPA工具可以自动执行重复性的办公任务，例如数据提取、表单填写和文件移动。RPA结合了API和用户界面（UI）互动，能够整合并执行企业与生产力应用之间的重复性任务。通过部署用于模拟人工流
  • log4j对象改变日志级别 3213213333332132 javalog4jlevellog4j对象名称日志级别
    log4j对象改变日志级别可批量的改变所有级别，或是根据条件改变日志级别。 log4j配置文件： log4j.rootLogger=ERROR,FILE,CONSOLE,EXECPTION #log4j.appender.FILE=org.apache.log4j.RollingFileAppender log4j.appender.FILE=org.apache.l
  • elk+redis 搭建nginx日志分析平台 ronin47 elasticsearchkibanalogstash
                 elk+redis 搭建nginx日志分析平台 logstash,elasticsearch,kibana 怎么进行nginx的日志分析呢？首先，架构方面，nginx是有日志文件的，它的每个请求的状态等都有日志文件进行记录。其次，需要有个队 列，redis的l
  • Yii2设置时区 dcj3sjt126com PHPtimezoneyii2
    时区这东西，在开发的时候，你说重要吧，也还好，毕竟没它也能正常运行，你说不重要吧，那就纠结了。特别是linux系统，都TMD差上几小时，你能不痛苦吗？win还好一点。有一些常规方法，是大家目前都在采用的1、php.ini中的设置，这个就不谈了，2、程序中公用文件里设置，date_default_timezone_set一下时区3、或者。。。自己写时间处理函数，在遇到时间的时候，用这个函数处理（比较
  • js实现前台动态添加文本框，后台获取文本框内容 171815164 文本框
    <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://w
  • 持续集成工具 g21121 持续集成
            持续集成是什么？我们为什么需要持续集成？持续集成带来的好处是什么？什么样的项目需要持续集成？...        持续集成(Continuous integration ,简称CI)，所谓集成可以理解为将互相依赖的工程或模块合并成一个能单独运行
  • 数据结构哈希表(hash)总结 永夜-极光 数据结构
    1.什么是hash 来源于百度百科: Hash，一般翻译做“散列”，也有直接音译为“哈希”的，就是把任意长度的输入，通过散列算法，变换成固定长度的输出，该输出就是散列值。这种转换是一种压缩映射，也就是，散列值的空间通常远小于输入的空间，不同的输入可能会散列成相同的输出，所以不可能从散列值来唯一的确定输入值。简单的说就是一种将任意长度的消息压缩到某一固定长度的消息摘要的函数。  
  • 乱七八糟 程序员是怎么炼成的
    eclipse中的jvm字节码查看插件地址： http://andrei.gmxhome.de/eclipse/ 安装该地址的outline 插件  后重启，打开window下的view下的bytecode视图 http://andrei.gmxhome.de/eclipse/   jvm博客： http://yunshen0909.iteye.com/blog/2
  • 职场人伤害了“上司” 怎样弥补 aijuans 职场
    由于工作中的失误，或者平时不注意自己的言行“伤害”、“得罪”了自己的上司，怎么办呢？ 　　在职业生涯中这种问题尽量不要发生。下面提供了一些解决问题的建议： 　　一、利用一些轻松的场合表示对他的尊重 　　即使是开明的上司也很注重自己的权威，都希望得到下属的尊重，所以当你与上司冲突后，最好让不愉快成为过去，你不妨在一些轻松的场合，比如会餐、联谊活动等，向上司问个好，敬下酒，表示你对对方的尊重，
  • 深入浅出url编码 antonyup_2006 应用服务器浏览器servletweblogicIE
    出处：http://blog.csdn.net/yzhz  杨争   http://blog.csdn.net/yzhz/archive/2007/07/03/1676796.aspx 一、问题：         编码问题是JAVA初学者在web开发过程中经常会遇到问题，网上也有大量相关的
  • 建表后创建表的约束关系和增加表的字段 百合不是茶 标的约束关系增加表的字段
      下面所有的操作都是在表建立后操作的,主要目的就是熟悉sql的约束,约束语句的万能公式   1,增加字段(student表中增加 姓名字段)   alter table 增加字段的表名 add 增加的字段名 增加字段的数据类型 alter table student add name varchar2(10);   &nb
  • Uploadify 3.2 参数属性、事件、方法函数详解 bijian1013 JavaScriptuploadify
    一.属性 属性名称 默认值 说明 auto true 设置为true当选择文件后就直接上传了，为false需要点击上传按钮才上传。 buttonClass ” 按钮样式 buttonCursor ‘hand’ 鼠标指针悬停在按钮上的样子 buttonImage null 浏览按钮的图片的路
  • 精通Oracle10编程SQL(16)使用LOB对象 bijian1013 oracle数据库plsql
    /* *使用LOB对象 */ --LOB(Large Object)是专门用于处理大对象的一种数据类型，其所存放的数据长度可以达到4G字节 --CLOB/NCLOB用于存储大批量字符数据，BLOB用于存储大批量二进制数据，而BFILE则存储着指向OS文件的指针 /* *综合实例 */ --建立表空间 --#指定区尺寸为128k,如不指定，区尺寸默认为64k CR
  • 【Resin一】Resin服务器部署web应用 bit1129 resin
    工作中，在Resin服务器上部署web应用，通常有如下三种方式：   配置多个web-app 配置多个http id 为每个应用配置一个propeties、xml以及sh脚本文件 配置多个web-app   在resin.xml中,可以为一个host配置多个web-app   <cluster id="app&q
  • red5简介及基础知识 白糖_ 基础
      简介   Red5的主要功能和Macromedia公司的FMS类似，提供基于Flash的流媒体服务的一款基于Java的开源流媒体服务器。它由Java语言编写，使用RTMP作为流媒体传输协议，这与FMS完全兼容。它具有流化FLV、MP3文件，实时录制客户端流为FLV文件，共享对象，实时视频播放、Remoting等功能。用Red5替换FMS后,客户端不用更改可正
  • angular.fromJson boyitech AngularJSAngularJS 官方APIAngularJS API
    angular.fromJson 描述: 把Json字符串转为对象 使用方法: angular.fromJson(json); 参数详解: Param Type Details json string JSON 字符串 返回值: 对象, 数组, 字符串 或者是一个数字 示例: <!DOCTYPE HTML> <h
  • java-颠倒一个句子中的词的顺序。比如： I am a student颠倒后变成：student a am I bylijinnan java
    public class ReverseWords { /** * 题目：颠倒一个句子中的词的顺序。比如： I am a student颠倒后变成：student a am I.词以空格分隔。 * 要求： * 1.实现速度最快,移动最少 * 2.不能使用String的方法如split,indexOf等等。 * 解答：两次翻转。 */ publ
  • web实时通讯 Chen.H Web浏览器socket脚本
    关于web实时通讯，做一些监控软件。 由web服务器组件从消息服务器订阅实时数据，并建立消息服务器到所述web服务器之间的连接，web浏览器利用从所述web服务器下载到web页面的客户端代理与web服务器组件之间的socket连接，建立web浏览器与web服务器之间的持久连接；利用所述客户端代理与web浏览器页面之间的信息交互实现页面本地更新，建立一条从消息服务器到web浏览器页面之间的消息通路
  • [基因与生物]远古生物的基因可以嫁接到现代生物基因组中吗? comsci 生物
          大家仅仅把我说的事情当作一个IT行业的笑话来听吧..没有其它更多的意思     如果我们把大自然看成是一位伟大的程序员,专门为地球上的生态系统编制基因代码,并创造出各种不同的生物来,那么6500万年前的程序员开发的代码,是否兼容现代派的程序员的代码和架构呢?   
  • oracle 外部表 daizj oracle外部表external tables
        oracle外部表是只允许只读访问，不能进行DML操作，不能创建索引，可以对外部表进行的查询，连接，排序，创建视图和创建同义词操作。 you can select, join, or sort external table data. You can also create views and synonyms for external tables. Ho
  • aop相关的概念及配置 daysinsun AOP
    切面(Aspect): 通常在目标方法执行前后需要执行的方法（如事务、日志、权限），这些方法我们封装到一个类里面，这个类就叫切面。 连接点（joinpoint） spring里面的连接点指需要切入的方法，通常这个joinpoint可以作为一个参数传入到切面的方法里面（非常有用的一个东西）。 通知（Advice） 通知就是切面里面方法的具体实现，分为前置、后置、最终、异常环
  • 初一上学期难记忆单词背诵第二课 dcj3sjt126com englishword
    middle 中间的，中级的 well 喔，那么；好吧 phone 电话，电话机 policeman 警察 ask 问 take 拿到；带到 address 地址 glad 高兴的，乐意的 why 为什么  China 中国 family 家庭 grandmother (外)祖母 grandfather (外)祖父 wife 妻子 husband 丈夫 da
  • Linux日志分析常用命令 dcj3sjt126com linuxlog
    1.查看文件内容 cat -n 显示行号 2.分页显示 more Enter 显示下一行 空格 显示下一页 F 显示下一屏 B 显示上一屏 less /get 查询"get"字符串并高亮显示 3.显示文件尾 tail -f 不退出持续显示 -n 显示文件最后n行 4.显示头文件 head -n 显示文件开始n行 5.内容排序 sort -n 按照
  • JSONP 原理分析 fantasy2005 JavaScriptjsonpjsonp 跨域
    转自 http://www.nowamagic.net/librarys/veda/detail/224 JavaScript是一种在Web开发中经常使用的前端动态脚本技术。在JavaScript中，有一个很重要的安全性限制，被称为“Same-Origin Policy”（同源策略）。这一策略对于JavaScript代码能够访问的页面内容做了很重要的限制，即JavaScript只能访问与包含它的
  • 使用connect by进行级联查询 234390216 oracle查询父子Connect by级联
    使用connect by进行级联查询          connect by可以用于级联查询，常用于对具有树状结构的记录查询某一节点的所有子孙节点或所有祖辈节点。          来看一个示例，现假设我们拥有一个菜单表t_menu，其中只有三个字段：
  • 一个不错的能将HTML表格导出为excel,pdf等的jquery插件 jackyrong jquery插件
    发现一个老外写的不错的jquery插件，可以实现将HTML 表格导出为excel,pdf等格式， 地址在： https://github.com/kayalshri/ 下面看个例子，实现导出表格到excel,pdf <html> <head> <title>Export html table to excel an
  • UI设计中我们为什么需要设计动效 lampcy UIUI设计
    关于Unity3D中的Shader的知识 首先先解释下Unity3D的Shader，Unity里面的Shaders是使用一种叫ShaderLab的语言编写的，它同微软的FX文件或者NVIDIA的CgFX有些类似。传统意义上的vertex shader和pixel shader还是使用标准的Cg/HLSL 编程语言编写的。因此Unity文档里面的Shader，都是指用ShaderLab编写的代码，
  • 如何禁止页面缓存 nannan408 htmljspcache
    禁止页面使用缓存~ ------------------------------------------------ jsp:页面no cache： response.setHeader("Pragma","No-cache"); response.setHeader("Cache-Control","no-cach
  • 以代码的方式管理quartz定时任务的暂停、重启、删除、添加等 Everyday都不同 定时任务管理spring-quartz
          【前言】在项目的管理功能中，对定时任务的管理有时会很常见。因为我们不能指望只在配置文件中配置好定时任务就行了，因为如果要控制定时任务的 “暂停” 呢？暂停之后又要在某个时间点 “重启” 该定时任务呢？或者说直接 “删除” 该定时任务呢？要改变某定时任务的触发时间呢？ “添加” 一个定时任务对于系统的使用者而言，是不太现实的，因为一个定时任务的处理逻辑他是不
  • EXT实例 tntxia ext
      （1） 增加一个按钮   JSP:   <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%> <% String path = request.getContextPath(); Stri
  • 数学学习在计算机研究领域的作用和重要性 xjnine Math
    最近一直有师弟师妹和朋友问我数学和研究的关系，研一要去学什么数学课。毕竟在清华，衡量一个研究生最重要的指标之一就是paper,而没有数学，是肯定上不了世界顶级的期刊和会议的，这在计算机学界尤其重要！你会发现，不论哪个领域有价值的东西，都一定离不开数学！在这样一个信息时代，当google已经让世界没有秘密的时候，一种卓越的数学思维，绝对可以成为你的核心竞争力.  无奈本人实在见地
按字母分类： ABCDEFGHIJKLMNOPQRSTUVWXYZ其他