转自 https://blog.csdn.net/u013039395/article/details/86528164html
但如下例外:(分层领域模型规约2)
- DO( Data Object):数据对象,与数据库表结构一一对应,经过DAO层向上传输数据源对象。
- DTO( DataTransfer Object):数据传输对象,Service或Manager向外传输的对象。
- BO( BusinessObject):业务对象。 由Service层输出的封装业务逻辑的对象
- AO( Application Object):应用对象。在Web层与Service层之间抽象的复用对象模型,极为贴近展现层,复用度不高。
- VO( View Object):显示层对象或展现对象,一般是Web向模板渲染引擎层传输的对象
- POJO( Plain Ordinary Java Object):在本手册中, POJO专指只有setter/getter/toString的简单类,包括DO/DTO/BO/VO等。
- Query:数据查询对象,各层接收上层的查询请求。 注意超过2个参数的查询封装,禁止使用Map类来传输。java
反例:定义为基本数据类型Boolean isDeleted的属性,它的方法也是isDeleted(),RPC框架在反向解析的时候,“误觉得”对应的属性名称是deleted,致使属性获取不到,进而抛出异常。git
正例:应用工具类包名为com.alibaba.ai.util、类名为MessageUtils(此规则参考spring的框架结构)程序员
说明:JDK8中接口容许有默认实现,那么这个default方法,是对全部实现类都有价值的默认实现。
正例:接口方法签名void commit();
接口基础常量String COMPANY = “alibaba”;
反例:接口方法定义public abstract void f();github
A) Service/DAO层方法命名规约
1) 获取单个对象的方法用get作前缀。
2) 获取多个对象的方法用list作前缀,复数形式结尾如:listObjects。
3) 获取统计值的方法用count作前缀。
4) 插入的方法用save/insert作前缀。
5) 删除的方法用remove/delete作前缀。
6) 修改的方法用update作前缀。
B) 领域模型命名规约
1) 数据对象:xxxDO,xxx即为数据表名。
2) 数据传输对象:xxxDTO,xxx为业务领域相关的名称。
3) 展现对象:xxxVO,xxx通常为网页名称。
4) POJO是DO/DTO/BO/VO的统称,禁止命名成xxxPOJO。正则表达式
说明:大而全的常量类,杂乱无章,使用查找功能才能定位到修改的常量,不利于理解和维护。spring
说明:可变参数必须放置在参数列表的最后。(提倡同窗们尽可能不用可变参数编程)数据库
影响。接口过期必须加@Deprecated注解,并清晰地说明采用的新接口或者新服务是什么。编程
正例:“test”.equals(object);
反例:object.equals(“test”);
说明:推荐使用java.util.Objects#equals(JDK7引入的工具类)数组
说明:对于Integer var = ? 在-128至127范围内的赋值,Integer对象是在IntegerCache.cache产生,会复用已有对象,这个区间内的Integer值能够直接使用==进行判断,可是这个区间以外的全部数据,都会在堆上产生,并不会复用已有对象,这是一个大坑,
推荐使用equals方法进行判断。
1) 【强制】全部的POJO类属性必须使用包装数据类型。
2) 【强制】RPC方法的返回值和参数必须使用包装数据类型。
3) 【推荐】全部的局部变量使用基本数据类型。
说明:POJO类属性没有初值是提醒使用者在须要使用时,必须本身显式地进行赋值,任何
NPE问题,或者入库检查,都由使用者来保证。
说明:框架在调用属性xxx的提取方法时,并不能肯定哪一个方法必定是被优先调用到。
说明:
String str = “a,b,c,”;
String[] ary = str.split(",");
// 预期大于3,结果是3
System.out.println(ary.length);
说明:下例中,反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象,
而后进行append操做,最后经过toString方法返回String对象,形成内存资源浪费。
反例:
String str = “start”;
for (int i = 0; i < 100; i++) {
str = str + “hello”;
}
说明:对象的clone方法默认是浅拷贝,若想实现深拷贝须要重写clone方法实现域对象的
深度遍历式拷贝。
1.只要重写equals,就必须重写hashCode。
2.由于Set存储的是不重复的对象,依据hashCode和equals进行判断,因此Set存储的 对象必须重写这两个方法。
3.若是自定义对象做为Map的键,那么必须重写hashCode和equals。
说明:String重写了hashCode和equals方法,因此咱们能够很是愉快地使用String对象做为key来使用。
说明:subList 返回的是 ArrayList 的内部类 SubList,并非 ArrayList而是ArrayList 的一个视图,对于SubList子列表的全部操做最终会反映到原列表上。
说明:使用toArray带参方法,入参分配的数组空间不够大时,toArray方法内部将从新分配内存空间,并返回新数组地址;若是数组元素个数大于实际所需,下标为[ list.size() ]的数组元素将被置为null,其它数组元素保持原值,所以最好将方法入参数组大小定义与集合元素个数一致。
正例:
List list = new ArrayList(2);
list.add(“guan”);
list.add(“bao”);
String[] array = new String[list.size()];
array = list.toArray(array);
反例:直接使用toArray无参方法存在问题,此方法返回值只能Object[]类,若强转其它类型数组将出现ClassCastException错误。
说明:asList的返回对象是一个Arrays内部类,并无实现集合的修改方法。Arrays.asList体现的是适配器模式,只是转换接口,后台的数据还是数组。
String[] str = new String[] { “you”, “wu” };
List list = Arrays.asList(str);
第一种状况:list.add(“yangguanbao”); 运行时异常。
第二种状况:str[0] = “gujin”; 那么list.get(0)也会随之修改。
说明:扩展说一下PECS(Producer Extends Consumer Super)原则:第1、频繁往外读取内容的,适合用<? extends T>。第2、常常往里插入的,适合用<? super T>。
正例:
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”,会是一样的结果吗?答:正例执行成功;反例也执行成功,但把把“1”换成“2”会报ConcurrentModificationException.
说明:三个条件以下
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;
}
};
说明:菱形泛型,即diamond,直接使用<>来指代前边已经指定的类型。
正例:
// <> diamond方式
HashMap<String, String> userCache = new HashMap<>(16);
// 全省略方式
ArrayList users = new ArrayList(10);
说明:HashMap使用HashMap(int initialCapacity) 初始化。
正例:initialCapacity = (须要存储的元素个数 / 负载因子) + 1。注意负载因子(即loader
factor)默认为0.75,若是暂时没法肯定初始值大小,请设置为16(即默认值)。
反例:HashMap须要放置1024个元素,因为没有设置容量初始大小,随着元素不断增长,容量7次被迫扩大,resize须要重建hash表,严重影响性能。
说明:keySet实际上是遍历了2次,一次是转为Iterator对象,另外一次是从hashMap中取出key所对应的value。而entrySet只是遍历了一次就把key和value都放到了entry中,效率更高。若是是JDK8,使用Map.foreach方法。
正例:values()返回的是V值集合,是一个list集合对象;keySet()返回的是K值集合,是一个Set集合对象;entrySet()返回的是K-V值组合集合。
集合类 | 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异常。
说明:有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是必定的。如:ArrayList是order/unsort;HashMap是unorder/unsort;TreeSet是order/sort。
【强制】建立线程或线程池时请指定有意义的线程名称,方便出错时回溯。
【强制】线程资源必须经过线程池提供,不容许在应用中自行显式建立线程。
说明:使用线程池的好处是减小在建立和销毁线程上所消耗的时间以及系统资源的开销,解决
资源不足的问题。若是不使用线程池,有可能形成系统建立大量同类线程而致使消耗完内存或
者“过分切换”的问题。
【强制】线程池不容许使用Executors去建立,而是经过ThreadPoolExecutor的方式,这样的处理方式让写的同窗更加明确线程池的运行规则,规避资源耗尽的风险。
说明:Executors返回的线程池对象的弊端以下:
1)FixedThreadPool和SingleThreadPool:
容许的请求队列长度为Integer.MAX_VALUE,可能会堆积大量的请求,从而致使OOM。
2)CachedThreadPool和ScheduledThreadPool:
容许的建立线程数量为Integer.MAX_VALUE,可能会建立大量的线程,从而致使OOM。
【强制】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。
【强制】高并发时,同步调用应该去考量锁的性能损耗。能用无锁数据结构,就不要用锁;能锁区块,就不要锁整个方法体;能用对象锁,就不要用类锁。
说明:尽量使加锁的代码块工做量尽量的小,避免在锁代码块中调用RPC方法。
【强制】并发修改同一记录时,避免更新丢失,须要加锁。要么在应用层加锁,要么在缓存加锁,要么在数据库层使用乐观锁,使用version做为更新依据。
说明:若是每次访问冲突几率小于20%,推荐使用乐观锁,不然使用悲观锁。乐观锁的重试次
数不得小于3次。
【强制】多线程并行处理定时任务时,Timer运行多个TimeTask时,只要其中之一没有捕获抛出的异常,其它任务便会自动终止运行,使用ScheduledExecutorService则没有这个问题。
【推荐】使用CountDownLatch进行异步转同步操做,每一个线程退出前必须调用countDown方法,线程执行代码注意catch异常,确保countDown方法被执行到,避免主线程没法执行至await方法,直到超时才返回结果。
说明:注意,子线程抛出异常堆栈,不能在主线程try-catch到。
【推荐】避免Random实例被多线程使用,虽然共享该实例是线程安全的,但会因竞争同一seed 致使的性能降低。
说明:Random实例包括java.util.Random 的实例或者 Math.random()的方式。
正例:在JDK7以后,能够直接使用API ThreadLocalRandom,而在 JDK7以前,须要编码保证每一个线程持有一个实例。
【参考】volatile解决多线程内存不可见问题。
对于一写多读,是能够解决变量同步问题,可是若是多写,一样没法解决线程安全问题。若是是count++操做,使用以下类实现:
AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 若是是JDK8,推荐使用LongAdder对象,比AtomicLong性能更好(减小乐观锁的重试次数)。
【参考】 HashMap在容量不够进行resize时因为高并发可能出现死链,致使CPU飙升,在开发过程当中可使用其它数据结构或加锁来规避此风险
【强制】在一个switch块内,每一个case要么经过break/return等来终止,要么注释说明程序将继续执行到哪个case为止;在一个switch块内,都必须包含一个default语句而且放在最后,即便空代码。
【强制】在高并发场景中,避免使用”等于”判断做为中断或退出的条件。
说明:若是并发控制没有处理好,容易产生等值判断被“击穿”的状况,使用大于或小于的区间判断条件来代替。
反例:判断剩余奖品数量等于0时,终止发放奖品,但由于并发处理错误致使奖品数量瞬间变成了负数,这样的话,活动没法终止。
【推荐】循环体中的语句要考量性能,如下操做尽可能移至循环体外处理,如定义对象、变量、获取数据库链接,进行没必要要的try-catch操做(这个try-catch是否能够移至循环体外)。
【推荐】接口入参保护,这种场景常见的是用做批量操做的接口。
【参考】下列情形,须要进行参数校验:
1) 调用频次低的方法。
2) 执行时间开销很大的方法。此情形中,参数校验时间几乎能够忽略不计,但若是由于参
数错误致使中间执行回退,或者错误,那得不偿失。
3) 须要极高稳定性和可用性的方法。
4) 对外提供的开放接口,无论是RPC/API/HTTP接口。
5) 敏感权限入口。
【参考】下列情形,不须要进行参数校验:
1) 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
2) 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道,参数错误不太可能到底
层才会暴露问题。通常DAO层与Service层都在同一个应用中,部署在同一台服务器中,所
以DAO的参数校验,能够省略。
3) 被声明成private只会被本身代码所调用的方法,若是可以肯定调用方法的代码传入参
数已经作过检查或者确定不会有问题,此时能够不校验参数。
【强制】类、类属性、类方法的注释必须使用Javadoc规范,使用/*内容/格式,不得使用// xxx方式。
说明:在IDE编辑窗口中,Javadoc方式会提示相关注释,生成Javadoc能够正确输出相应注释;在IDE中,工程调用方法时,不进入方法便可悬浮提示方法、参数、返回值的意义,提升阅读效率(ps:idea默认window下使用ctrl+Q快捷键快速查看javadoc的注释)。
【强制】全部的枚举类型字段必需要有注释,说明每一个数据项的用途。
【推荐】与其“半吊子”英文来注释,不如用中文注释把问题说清楚。专有名词与关键字保持英文原文便可。
反例:“TCP链接超时”解释成“传输控制协议链接超时”,理解反而费脑筋。
【参考】谨慎注释掉代码。在上方详细说明,而不是简单地注释掉。若是无用,则删除。
说明:代码被注释掉有两种可能性:1)后续会恢复此段代码逻辑。2)永久不用。前者若是没有备注信息,难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)。
【参考】特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,经过标记扫描,常常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
1) 待办事宜(TODO):( 标记人,标记时间,[预计处理时间])
表示须要实现,但目前还未实现的功能。这其实是一个Javadoc的标签,目前的Javadoc
尚未实现,但已经被普遍使用。只能应用于类,接口和方法(由于它是一个Javadoc标签)。
2) 错误,不能工做(FIXME):(标记人,标记时间,[预计处理时间])
在注释中用FIXME标记某代码是错误的,并且不能工做,须要及时纠正的状况。
【强制】在使用正则表达式时,利用好其预编译功能,能够有效加快正则匹配速度。
说明:不要在方法体内定义:Pattern pattern = Pattern.compile(“规则”);
【强制】后台输送给页面的变量必须加$!{var}——中间的感叹号.
说明:若是var等于null或者不存在,那么${var}会直接显示在页面上。
【强制】注意 Math.random() 这个方法返回是double类型,注意取值的范围 0≤x<1(可以取到零值,注意除零异常),若是想获取整数类型的随机数,不要将x放大10的若干倍而后取整,直接使用Random对象的nextInt或者nextLong方法。
【强制】获取当前毫秒数System.currentTimeMillis(); 而不是new Date().getTime();
说明:若是想获取更加精确的纳秒级时间值,使用System.nanoTime()的方式。在JDK8中,
针对统计时间等场景,推荐使用Instant类。
【推荐】及时清理再也不使用的代码段或配置信息。
说明:对于垃圾代码或过期配置,坚定清理干净,避免程序过分臃肿,代码冗余。
正例:对于暂时被注释掉,后续可能恢复使用的代码片段,在注释代码上方,统一规定使用三
个斜杠(///)来讲明注释掉代码的理由。
【强制】异常不要用来作流程控制,条件控制。
说明:异常设计的初衷是解决程序运行中的各类意外状况,且异常的处理效率比条件判断方式要低不少。
【强制】catch时请分清稳定代码和非稳定代码,稳定代码指的是不管如何不会出错的代码。对于非稳定代码的catch尽量进行区分异常类型,再作对应的异常处理。
说明:对大段代码进行try-catch,使程序没法根据不一样的异常作出正确的应激反应,也不利于定位问题,这是一种不负责任的表现。
正例:用户注册的场景中,若是用户输入非法字符,或用户名称已存在,或用户输入密码过于简单,在程序上做出分门别类的判断,并提示给用户。
【强制】有try块放到了事务代码中,catch异常后,若是须要回滚事务,必定要注意手动回滚事务。
【强制】finally块必须对资源对象、流对象进行关闭,有异常也要作try-catch。
说明:若是JDK7及以上,可使用try-with-resources方式。
【强制】不要在finally块中使用return。
说明:finally块中的return返回后方法结束执行,不会再执行try块中的return语句。
【推荐】方法的返回值能够为null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么状况下会返回null值。
说明:本手册明确防止NPE是调用者的责任。即便被调用方法返回空集合或者空对象,对调用阿里巴巴Java开发手册 者来讲,也并不是高枕无忧,必须考虑到远程调用失败、序列化失败、运行时异常等场景返回
null的状况。
【推荐】防止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问题。
【参考】避免出现重复的代码(Don’t Repeat Yourself),即DRY原则。
说明:随意复制和粘贴代码,必然会致使代码的重复,在之后须要修改时,须要修改全部的副本,容易遗漏。必要时抽取共性方法,或者抽象公共类,甚至是组件化。
正例:一个类中有多个public方法,都须要进行数行相同的参数校验操做,这个时候请抽取:
private boolean checkParam(DTO dto) {…}
【强制】应用中不可直接使用日志系统(Log4j、Logback)中的API,而应依赖使用日志框架SLF4J中的API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);
ps:本人建议使用lombok的@slf4j注解
【强制】日志文件至少保存15天,由于有些异常具有以“周”为频次发生的特色。
【强制】对trace/debug/info级别的日志输出,必须使用条件输出形式或者使用占位符的方式。
说明:logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
若是日志级别是warn,上述日志不会打印,可是会执行字符串拼接操做,若是symbol是对象,
会执行toString()方法,浪费了系统资源,执行了上述操做,最终日志却没有打印。
正例:(条件)建设采用以下方式
if (logger.isDebugEnabled()) {
logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
}
正例:(占位符)
logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);
【推荐】谨慎地记录日志。生产环境禁止输出debug日志;有选择地输出info日志;若是使用warn来记录刚上线时的业务行为信息,必定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。
说明:大量地输出无效日志,不利于系统性能提高,也不利于快速定位错误点。记录日志时请
思考:这些日志真的有人看吗?看到这条日志你能作什么?能不能给问题排查带来好处?
【推荐】可使用warn日志级别来记录用户输入参数错误的状况,避免用户投诉时,无所适从。如非必要,请不要在此场景打出error级别,避免频繁报警。
说明:注意日志输出的级别,error级别只记录系统逻辑出错、异常或者重要的错误信息。
【推荐】尽可能用英文来描述日志错误信息,若是日志中的错误信息用英文描述不清楚的话使用中文描述便可,不然容易产生歧义。国际化团队或海外部署的服务器因为字符集问题,【强制】使用全英文来注释和描述日志错误信息。
未完待续…
参考: