编程规范
遇到左大括号缩进一个tab的位置。
关联不是很大的语句间空行。
命名
命名风格
1.不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
2.严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。(有些国际通用的可以用拼音:renminbi,taobao)
3.驼峰命名。
4.杜绝完全不规范的缩写,避免望文不知义
5.为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意。
6.如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。
类名命名
1.大写开头(DO / BO / DTO / VO / AO/ PO / UID除外 )
2.抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾
3.POJO 类中布尔类型变量都不要加 is 前缀,否则部分框架解析会引起序列化错误。
4.包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
5.避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名,使可读性降低
6.接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默认实现。
7.接口和实现类的命名:
对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用Impl 的后缀与接口区别。CacheServiceImpl 实现 CacheService 接口。
如果是形容能力的接口名称,取对应的形容词为接口名(通常是–able 的形容词)AbstractTranslator 实现 Translatable 接口
8.枚举类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。枚举其实就是特殊的类,域成员均为常量,且构造方法被默认强制是私有。
9.Service/DAO 层方法命名规约
1) 获取单个对象的方法用 get 做前缀。
2) 获取多个对象的方法用 list 做前缀,复数形式结尾如:listObjects。
3) 获取统计值的方法用 count 做前缀。
4) 插入的方法用 save/insert 做前缀。
5) 删除的方法用 remove/delete 做前缀。
6) 修改的方法用 update 做前缀。
10.领域模型命名规约
1) 数据对象:xxxDO,xxx 即为数据表名。
2) 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
3) 展示对象:xxxVO,xxx 一般为网页名称。
4) POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO
方法名,参数名,变量名
1.小写开头。
2.类型与中括号紧挨相连来表示数组
3.在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度(startTime / workQueue / nameList / TERMINATED_THREAD_COUNT)
常量命名
1.常量命名全部大写,单词间用下划线隔开,不要嫌弃太长,一定见名知意。
2.不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。
3.在 long 或者 Long 赋值时,数值后使用大写的 L,不能是小写的 l,小写容易跟数字 1 混淆,造成误解
4.不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护。(缓存相关常量放在类 CacheConsts 下;系统配置相关常量放在类 ConfigConsts 下。)
5.常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
1) 跨应用共享常量:放置在二方库中,通常是 client.jar 中的 constant 目录下。
2) 应用内共享常量:放置在一方库中,通常是子模块中的 constant 目录下。
3) 子工程内部共享常量:即在当前子工程的 constant 目录下。
4) 包内共享常量:即在当前包下单独的 constant 目录下。
5) 类内共享常量:直接在类内部 private static final 定义。
6.如果变量值仅在一个固定范围内变化用 enum 类型来定义。
7.常量类
static final修饰的字段在javac编译时生成constantValue属性,在类加载的准备阶段直接把constantValue的值赋给该字段。可以理解为在编译期即把结果放入了常量池中。即在类未被加载时static final字段就有了值,这个值不需要对类进行初始化就可以读取,不像static变量,需要类加载后才会有值(类未加载进内存时值为默认值0或null)。
注:1.ConstantValue修饰的字段只限于基本类型和string。
2.ConstantValue修饰的字段若为String类型,必须要是编译期可以进行优化得到的即编译期常量才能满足不需要对类进行初始化就可以读取(例如:String s = “a”+“bc”;),否则这个值需要对类进行初始化才可以读取(例如:String s = new String(“abc”);)。
3.对于满足上两个条件的constantValue变量,在访问该变量时,无需初始化类即可访问(即访问时在常量池中寻找,不会执行类的静态成员和静态代码块)。
阿里文档和常量有关说明:
【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的javadoc注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。
正例:接口方法签名:void f();
接口基础常量表示:String COMPANY = “alibaba”;
反例:接口方法定义:public abstract void f();
说明:JDK8中接口允许有默认实现,那么这个default方法,是对所有实现类都有价值的默认实现
【强制】不允许出现任何魔法值(即未经定义的常量)直接出现在代码中。
反例: String key=”Id#taobao_”+tradeId;
cache.put(key, value);
【推荐】不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。如:缓存相关的常量放在类:CacheConsts下;系统配置相关的常量放在类:ConfigConsts类下。
说明:大而全的常量类,非得ctrl+f才定位到修改的常量,不利于理解,也不利于维护。
【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
1) 跨应用共享常量:放置在二方库中,通常是client.jar中的const目录下。
2) 应用内共享常量:放置在一方库的modules中的const目录下。
反例:易懂变量也要统一定义成应用内共享常量,两位攻城师在两个类中分别定义了表示“是”的变量:
类A中:public static final String YES = “yes”;
类B中:public static final String YES = “y”;
A.YES.equals(B.YES),预期是true,但实际返回为false,导致产生线上问题。
3) 子工程内部共享常量:即在当前子工程的const目录下。
4) 包内共享常量:即在当前包下单独建const目录下。
5) 类内共享常量:直接在类内部private static final定义。
【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可
代码格式
1.如果是大括号内为空,则简洁地写成{}即可,大括号中间无需换行和空格;如果是非空代码块则:
1) 左大括号前不换行。
2) 左大括号后换行。
3) 右大括号前换行。
4) 右大括号后还有 else 等代码则不换行;表示终止的右大括号后必须换行
2.左小括号和字符之间不出现空格;同样,右小括号和字符之间也不出现空格;而左大括号前需要空格。
3.if/for/while/switch/do 等保留字与括号之间都必须加空格。
4.任何二目、三目运算符的左右两边都需要加一个空格。
5.采用 4 个空格缩进,禁止使用 tab 字符
例子:
1 | public static void main(String[] args) { |
6.注释的双斜线与注释内容之间有且仅有一个空格
7.在进行类型强制转换时,右括号与强制转换值之间不需要任何空格隔开。
8.单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:
1)第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进。
2)运算符与下文一起换行。
3)方法调用的点符号与下文一起换行。
4)方法调用中的多个参数需要换行时,在逗号后进行。
5)在括号前不要换行,在逗号前不要换行
例子:
1 | StringBuilder sb = new StringBuilder(); |
9.方法参数在定义和传入时,多个参数逗号后边必须加空格
1 | method(args1, args2, args3); |
10.IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式,不要使用 Windows 格式。
11.单个方法的总行数不超过 80 行(除注释之外的所有行数)
代码逻辑分清红花和绿叶,个性和共性,绿叶逻辑单独出来成为额外方法,使主干代码更加清晰;共性逻辑抽取成为共性方法,便于复用和维护
12.没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐
13.不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性(任何情形,没有必要插入多个空行进行隔开)
OOP 规约
1.避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可
2.所有的覆写方法,必须加@Override 注解
3.相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object。(提倡同学们尽量不用可变参数编程)
4.外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生影响。接口过时必须加@Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。
5.不能使用过时的类或方法(接口提供方既然明确是过时接口,那么有义务同时提供新的接口;作为调用方来说,有义务去考证过时方法的新实现是什么)
6.Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals。推荐使用 java.util.Objects#equals(JDK7 引入的工具类)。
7.所有整型包装类对象之间值的比较,全部使用 equals 方法比较
对于 Integer var = ? 在-128 至 127 范围内的赋值,Integer 对象是在 IntegerCache.cache 产生,会复用已有对象,这个区间内的 Integer 值可以直接使用==进行判断,但是这个区间之外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑,推荐使用 equals 方法进行判断。
8.浮点数之间的等值判断,基本数据类型不能用==来比较,包装数据类型不能用equals 来判断。
浮点数采用“尾数+阶码”的编码方式,类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数
1 | 反例: |
9.定义数据对象 DO 类时,属性类型要与数据库字段类型相匹配。
数据库字段的 bigint 必须与类属性的 Long 类型相对应。
10.为了防止精度损失,禁止使用构造方法 BigDecimal(double)的方式把 double 值转化为 BigDecimal 对象。BigDecimal(double)存在精度损失风险,在精确计算或值比较的场景中可能会导致业务逻辑异常
如:BigDecimal g = new BigDecimal(0.1f); 实际的存储值为:0.10000000149
需使用:
1 | BigDecimal recommend1 = new BigDecimal("0.1"); |
11.关于基本数据类型与包装数据类型的使用标准:
所有的 POJO 类属性必须使用包装数据类型。
RPC 方法的返回值和参数必须使用包装数据类型。
所有的局部变量使用基本数据类型。
POJO 类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何 NPE 问题,或者入库检查,都由使用者来保证。
Java代码的规范
1.尽量在合适的场合使用单例
使用单例可以减轻加载的负担,缩短加载的时间,提高加载的效率,但并不是所有地方都适用于单例,单例主要适用于以下三个方面:
控制资源的使用,通过线程同步来控制资源的并发访问
控制实例的产生,以达到节约资源的目的
控制数据共享,在不建立直接关联的条件下,让多个不相关的进程或线程之间实现通信
2.尽量避免随意使用静态变量
要知道,当某个对象被定义为stataic变量所引用,那么gc通常是不会回收这个对象所占有的内存,如
1 | public class A{ |
此时静态变量b的生命周期与A类同步,如果A类不会卸载,那么b对象会常驻内存,直到程序终止。
3.尽量避免过多过常的创建java对象
尽量避免在经常调用的方法,循环中new对象,由于系统不仅要花费时间来创建对象,而且还要花时间对这些对象进行垃圾回收和处理,在我们可以控制的范围内,最大限度的重用对象,最好能用基本的数据类型或数组来替代对象。
4.尽量使用final修饰符
带有final修饰符的类是不可派生的。在Java核心API中,有许多应用final的例子,例如java.lang.String。为String类指定final防止了使用者覆盖length()方法。另外,如果一个类是final的,则该类所有方法都是final的。java编译器会寻找机会内联 (inline)所有的final方法(这和具体的编译器实现有关)。此举能够使性能平均提高50%。
5.尽量使用局部变量
调用方法时传递的参数以及在调用中创建的临时变量都保存在栈(Stack)中,速度较快。其他变量,如静态变量,实例变量等,都在堆(Heap)中创建,速度较慢。
6.尽量处理好包装类型和基本类型两者的使用场所
虽然包装类型和基本类型在使用过程中是可以相互转换,但它们两者所产生的内存区域是完全不同的,基本类型数据产生和处理都在栈中处理,包装类型是对象,是在堆中产生实例。
在集合类对象,有对象方面需要的处理适用包装类型,其他的处理提倡使用基本类型。
7.慎用synchronized,尽量减小synchronize的方法
都知道,实现同步是要很大的系统开销作为代价的,甚至可能造成死锁,所以尽量避免无谓的同步控制。synchronize方法被调用时,直接会把当前对象锁 了,在方法执行完之前其他线程无法调用当前对象的其他方法。所以synchronize的方法尽量小,并且应尽量使用方法同步代替代码块同步。
8.尽量使用StringBuilder和StringBuffer进行字符串连接
字符串缓冲区
9.尽量不要使用finalize方法
实际上,将资源清理放在finalize方法中完成是非常不好的选择,由于GC的工作量很大,尤其是回收Young代内存时,大都会引起应用程序暂停,所以再选择使用finalize方法进行资源清理,会导致GC负担更大,程序运行效率更差。
10.尽量使用基本数据类型代替对象
String str = “hello”;
上面这种方式会创建一个“hello”字符串,而且JVM的字符缓存池还会缓存这个字符串;
String str = new String(“hello”);
此时程序除创建字符串外,str所引用的String对象底层还包含一个char[]数组,这个char[]数组依次存放了h,e,l,l,o
11.单线程应尽量使用HashMap, ArrayList
HashTable,Vector等使用了同步机制,降低了性能。
12.尽量合理的创建HashMap
当你要创建一个比较大的hashMap时,充分利用另一个构造函数
public HashMap(int initialCapacity, float loadFactor)
避免HashMap多次进行了hash重构,扩容是一件很耗费性能的事,在默认中initialCapacity只有16,而loadFactor是 0.75,需要多大的容量,你最好能准确的估计你所需要的最佳大小,同样的Hashtable,Vectors也是一样的道理。
13.尽量减少对变量的重复计算
如
for(int i=0;i<list.size();i++)
应该改为
for(int i = 0,len = list.size();i< len;i++)
并且在循环中应该避免使用复杂的表达式。在循环中,循环条件会被反复计算,如果不使用复杂表达式,而使循环条件值不变的话,程序将会运行的更快。
14.尽量避免不必要的创建
如
A a = new A();
if(i==1){list.add(a);}
应该改为
if(i==1){
A a = new A();
list.add(a);}
15.尽量在finally块中释放资源
程序中使用到的资源应当被释放,以避免资源泄漏。这最好在finally块中去做。不管程序执行的结果如何,finally块总是会执行的,以确保资源的正确关闭。
16.尽量使用移位来代替’a/b’的操作
“/“是一个代价很高的操作,使用移位的操作将会更快和更有效
如
int num = a / 4;
int num = a / 8;
应该改为
int num = a >> 2;
int num = a >> 3;
但注意的是使用移位应添加注释,因为移位操作不直观,比较难理解
17.尽量使用移位来代替’a*b’的操作
同样的,对于’*’操作,使用移位的操作将会更快和更有效
如
int num = a * 4;
int num = a * 8;
应该改为
int num = a << 2;
int num = a << 3;
18.尽量确定StringBuffer的容器
StringBuffer 的构造器会创建一个默认大小(通常是16)的字符数组。在使用中,如果超出这个大小,就会重新分配内存,创建一个更大的数组,并将原先的数组复制过来,再 丢弃旧的数组。在大多数情况下,你可以在创建 StringBuffer的时候指定大小,这样就避免了在容量不够的时候自动增长,以提高性能。
如:StringBuffer buffer = new StringBuffer(1000);
19.尽量早释放无用对象的引用
大部分时,方法局部引用变量所引用的对象 会随着方法结束而变成垃圾,因此,大部分时候程序无需将局部,引用变量显式设为null。
例如:
Public void test(){
Object obj = new Object();
……
//执行耗时,耗内存操作;或调用耗时,耗内存的方法
}
上面这个就没必要了,随着方法test()的执行完成,程序中obj引用变量的作用域就结束了。但是如果是改成下面:
Public void test(){
Object obj = new Object();
……
Obj=null;
……
}
这时候就有必要将obj赋值为null,可以尽早的释放对Object对象的引用。
20.尽量避免使用二维数组
二维数据占用的内存空间比一维数组多得多,大概10倍以上。
21.尽量避免使用split
除非是必须的,否则应该避免使用split,split由于支持正则表达式,所以效率比较低,如果是频繁的几十,几百万的调用将会耗费大量资源,如果确实需要频繁的调用split,可以考虑使用apache的StringUtils.split(string,char),频繁split的可以缓存结果。
22.ArrayList & LinkedList
一 个是线性表,一个是链表,一句话,随机查询尽量使用ArrayList,ArrayList优于LinkedList,LinkedList还要移动指 针,添加删除的操作LinkedList优于ArrayList,ArrayList还要移动数据,不过这是理论性分析,事实未必如此,重要的是理解好2 者得数据结构,对症下药。
23.尽量使用System.arraycopy ()代替通过来循环复制数组
System.arraycopy() 要比通过循环来复制数组快的多
24.尽量缓存经常使用的对象
尽可能将经常使用的对象进行缓存,可以使用数组,或HashMap的容器来进行缓存,但这种方式可能导致系统占用过多的缓存,性能下降,推荐可以使用一些第三方的开源工具,如EhCache,Oscache进行缓存,他们基本都实现了FIFO/FLU等缓存算法。
25.尽量避免非常大的内存分配
有时候问题不是由当时的堆状态造成的,而是因为分配失败造成的。分配的内存块都必须是连续的,而随着堆越来越满,找到较大的连续块越来越困难。
26.慎用异常
当 创建一个异常时,需要收集一个栈跟踪(stack track),这个栈跟踪用于描述异常是在何处创建的。构建这些栈跟踪时需要为运行时栈做一份快照,正是这一部分开销很大。当需要创建一个 Exception 时,JVM 不得不说:先别动,我想就您现在的样子存一份快照,所以暂时停止入栈和出栈操作。栈跟踪不只包含运行时栈中的一两个元素,而是包含这个栈中的每一个元素。
如果您创建一个 Exception ,就得付出代价。好在捕获异常开销不大,因此可以使用 try-catch 将核心内容包起来。从技术上讲,您甚至可以随意地抛出异常,而不用花费很大的代价。招致性能损失的并不是 throw 操作——尽管在没有预先创建异常的情况下就抛出异常是有点不寻常。真正要花代价的是创建异常。幸运的是,好的编程习惯已教会我们,不应该不管三七二十一就 抛出异常。异常是为异常的情况而设计的,使用时也应该牢记这一原则。
MySQL 数据库规范
建表规约
1.表达是与否概念的字段,必须使用 is_xxx 的方式命名,数据类型是 unsigned tinyint(1 表示是,0 表示否)。任何字段如果为非负数,必须是 unsigned。
POJO 类中的任何布尔类型的变量,都不要加 is 前缀。
2.表名、字段名必须使用小写字母或数字,禁止出现数字开头,禁止两个下划线中间只出现数字。数据库字段名的修改代价很大,因为无法进行预发布,所以字段名称需要慎重考虑。不允许出现任何大写字母(因为MySQL 在 Windows 下不区分大小写,但在 Linux 下默认是区分大小写)
3.表名不使用复数名词。DO 类名也是单数形式
4.禁用保留字,如 desc、range、match、delayed 等
5.主键索引名(primary key)为 pk_字段名
;唯一索引名(unique key)为 uk_字段名
;普通索引名( index)则为 idx_字段名
6.小数类型为 decimal,禁止使用 float 和 double(在存储的时候,float 和 double 都存在精度损失的问题)。存储的数据范围超过 decimal 的范围,建议将数据拆成整数和小数并分开存储
7.如果存储的字符串长度几乎相等,使用 char 定长字符串类型。
8.varchar 是可变长字符串,不预先分配存储空间,长度不要超过 5000,如果存储长度大于此值,定义字段类型为 text,独立出来一张表,用主键来对应,避免影响其它字段索引效率。
9.表必备三字段:id(必为主键,类型为 bigint unsigned、单表时自增、步长为 1), create_time, update_time(类型均为 datetime 类型)。
10.表的命名最好是遵循“业务名称_表的作用”
11.库名与应用名称尽量一致
12.如果修改字段含义或对字段表示的状态追加时,需要及时更新字段注释
13.字段允许适当冗余,以提高查询性能,但必须考虑数据一致。冗余字段应遵循:
1) 不是频繁修改的字段。
2) 不是 varchar 超长字段,更不能是 text 字段。
3) 不是唯一索引的字段。
14.单表行数超过 500 万行或者单表容量超过 2GB,才推荐进行分库分表(预计三年后的数据量根本达不到这个级别,请不要在创建表时就分库分表)
15.合适的字符存储长度,不但节约数据库表空间、节约索引存储,更重要的是提升检索速度。无符号值(unsigned)可以避免误存负数,且扩大了表示范围。
对象 年龄区间 类型 字节 表示范围
人 150 岁之内 tinyint unsigned 1 无符号值:0 到 255
龟 数百岁 smallint unsigned 2 无符号值:0 到 65535
恐龙化石 数千万年 int unsigned 4 无符号值:0 到约 42.9 亿
太阳 约 50 亿年 bigint unsigned 8 无符号值:0 到约 10 的 19 次方
16.尽量避免NULL:应该指定列为NOT NULL,除非你想存储NULL。在MySQL中,含有空值的列很难进行查询优化。因为它们使得索引、索引的统计信息以及比较运算更加复杂。你应该用0、一个特殊的值或者一个空串代替空值。在设置默认值的时候,尽量不要用Null来当默认值,如果字段是int类型,默认为0,如果是varchar类型,默认值用空字符串(’’)会更好一些
17.习惯是任何数据表的任何列都是非空(NOT NULL),在此基础上将数字默认设为0,文本默认设为’’(在PHPMyAdmin中留空)
索引规约
1.业务上具有唯一特性的字段,即使是多个字段的组合,也必须建成唯一索引。(唯一索引影响 insert 速度,这个速度损耗可以忽略,但提高查找速度是明显的。没有唯一索引的话,必然有脏数据产生)
2.超过三个表禁止 join。需要 join 的字段,数据类型必须绝对一致;多表关联查询时,保证被关联的字段需要有索引(双表join时也要注意表索引、SQL性能)
3.在 varchar 字段上建立索引时,必须指定索引长度,没必要对全字段建立索引,根据实际文本区分度决定索引长度即可。索引的长度与区分度是一对矛盾体,一般对字符串类型数据,长度为 20 的索引,区分度会高达90%以上,可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度来确定
4.页面搜索严禁左模糊或者全模糊,如果需要请走搜索引擎来解决(索引文件具有 B-Tree 的最左前缀匹配特性,如果左边的值未确定,那么无法使用此索引。)
5.order by:注意利用索引的有序性(order by 最后的字段是组合索引的一部分,并且放在索引组合顺序的最后,避免出现 file_sort 的情况,影响查询性能)
6.利用覆盖索引来进行查询操作,避免回表(覆盖索引只是一种查询的一种效果,用 explain 的结果,extra 列会出现:using index)
7.利用延迟关联或者子查询优化超多分页场景
8.SQL 性能优化的目标:至少要达到 range 级别,要求是 ref 级别,如果可以是consts 最好。
1) consts 单表中最多只有一个匹配行(主键或者唯一索引),在优化阶段即可读取到数据。
2) ref 指的是使用普通的索引(normal index)。
3) range 对索引进行范围检索。
type=index,索引物理文件全扫描,速度非常慢,这个 index 级别比较 range还低,与全表扫描是小巫见大巫
9.建组合索引的时候,区分度最高的在最左边
10.防止因字段类型不同造成的隐式转换,导致索引失效
11.创建索引时,注意避免:
1) 宁滥勿缺。认为一个查询就需要建一个索引。
2) 宁缺勿滥。认为索引会消耗空间、严重拖慢记录的更新以及行的新增速度。
3) 抵制惟一索引。认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。
SQL 语句
1.不要使用 count(列名)或 count(常量)来替代 count(*)
,count(*)
是 SQL92 定义的标准统计行数的语法,跟数据库无关,跟 NULL 和非 NULL 无关。count(*)会统计值为 NULL 的行,而 count(列名)不会统计此列为 NULL 值的行。
2.count(distinct col) 计算该列除 NULL 之外的不重复行数,注意 count(distinct col1, col2) 如果其中一列全为 NULL,那么即使另一列有不同的值,也返回为 0。
3.当某一列的值全是 NULL 时,count(col)的返回结果为 0,但 sum(col)的返回结果为 NULL,因此使用 sum()时需注意 NPE 问题。
使用如下方式来避免 sum 的 NPE 问题:SELECT IFNULL(SUM(column), 0) FROM table;
4.使用 ISNULL()来判断是否为 NULL 值。NULL 与任何值的直接比较都为 NULL
5.代码中写分页查询逻辑时,若 count 为 0 应直接返回,避免执行后面的分页语句。
6.不得使用外键与级联,一切外键概念必须在应用层解决
7.禁止使用存储过程,存储过程难以调试和扩展,更没有移植性。
8.数据订正(特别是删除、修改记录操作)时,要先 select,避免出现误删除,确认无误才能执行更新语句。
9.in 操作能避免则避免,若实在避免不了,需要仔细评估 in 后边的集合元素数量,控制在 1000 个之内。
10.所有的字符存储与表示,均以 utf-8 编码,注意字符统计函数的区别。当需要存储表情,那么选择 utf8mb4 来进行存储,注意它与 utf-8 编码的区别
11.TRUNCATE TABLE 比 DELETE 速度快,且使用的系统和事务日志资源少,但TRUNCATE 无事务且不触发 trigger,有可能造成事故,故不建议在开发代码中使用此语句。
说明:TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。
ORM 映射
1.在表查询中,一律不要使用 * 作为查询的字段列表,需要哪些字段必须明确写明
1)增加查询分析器解析成本。
2)增减字段容易与 resultMap 配置不一致。
3)无用字段增加网络消耗,尤其是 text 类型的字段。
2.POJO 类的布尔属性不能加 is,而数据库字段必须加 is_,要求在 resultMap 中进行字段与属性之间的映射。
3.不要用 resultClass 当返回参数,即使所有类属性名与数据库字段一一对应,也需要定义;反过来,每一个表也必然有一个 POJO 类与之对应。
配置映射关系,使字段与 DO 类解耦,方便维护。
4.sql.xml 配置参数使用:#{},#param# 不要使用${} 此种方式容易出现 SQL 注入
5.iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使用。(因为它的实现方式是在数据库取到 statementName 对应的 SQL 语句的所有记录,再通过 subList 取start,size 的子集合)
6.不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
resultClass=”Hashtable”,会置入字段名和属性值,但是值的类型不可控
7.更新数据表记录时,必须同时更新记录对应的 gmt_modified 字段值为当前时间。
8.不要写一个大而全的数据更新接口。传入为 POJO 类,不管是不是自己的目标更新字段,都进行 update table set c1=value1,c2=value2,c3=value3; 这是不对的。执行 SQL时,不要更新无改动的字段,一是易出错;二是效率低;三是增加 binlog 存储。
9.@Transactional 事务不要滥用。事务会影响数据库的 QPS,另外使用事务的地方需要考虑各方面的回滚方案,包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。
10.<isEqual>
中的 compareValue 是与属性值对比的常量,一般是数字,表示相等时带上此条件;<isNotEmpty>表示不为空且不为 null 时执行;<isNotNull>
表示不为 null 值时执行。
自己的项目规范:
1.同级之间不要互相调用,上层只能调用下层,避免混乱。
2.swagger注解
controller类上:
@Api(value=””,tags=””)
controller类里的方法:
@ApiOperation(value=””,notes=””)@ApiParam(value = “”)
@ApiImplicitParams(
@ApiImplicitParam(name = "", value = "",paramType = "",required = true, dataType = "") )
@ApiResponses({
@ApiResponse(code = 0, message = “”,class=””)
})类上:
@ApiModel(value = “”,description=””)类的字段上:
@ApiModelProperty(value=””)
3.查数据用get,删,改,增数据用post
4.改东西前,加个备份,改东西后,加个记录
5.
设计规范
前后端接口规范:解耦接口,尽量不要用大接口。可以用公共的接口,但是尽量是前端需要什么信息,传递什么信息,不要查到所有信息再返回给前端。因为尽量避免暴露数据库表结构,避免传递不必要的信息。
前端传过来的数据也要做数据校验(即使前端已经做过校验),因为可能是通过接口发送的参数,绕过了前端页面
RESTful 架构
RESTful 只是一种指导风格,就像我们 Java 要用驼峰命名法。
REST 不是一个单词,是 Representational State Transfer 的缩写。直译过来就是表述性状态转移。其实它还有个主语 Resource ,所以是资源的表述性状态转移。
核心就是资源,用 URL 定位资源,用 HTTP 动词来描述所要做的操作。
HTTP的提供了很多动词:GET、PUT、POST、DELETE……这些动词都是有含义的。
比如:
GET 就是获取资源,是查询请求。
PUT 指的是修改资源,是幂等的。
POST 也是修改(新增也是一种修改),指的是不幂等的操作。
所以根据这些规范我们都能得知这次交互的一些动作,所以 RESTful 风格正确的使用姿势如下:
比如获取一个 user:
错误姿势:GET /getUserById?userId=1
。
正确姿势:GET /users/1
。
再比如新增 user:
错误姿势:POST /addUser
(省略body)。
正确姿势:POST /users
(省略body)。
可以看到 HTTP 的动词其实就能指代你要对资源做的操作,所以不需要在 URL 上做一些东西,就把 URL 表明的东西看作一个资源即可。
这里注意要用对 HTTP 动词,比如一个获取资源的请求用 PUT,用了也能获取资源但是这不合适。
其实更深一步的理解是 HTTP 是一个协议。
协议其实就是约定好的一个东西,协议就规定 GET 是获取资源,那你非得在 URL 上再重复一遍或者所有请求不论增删改都用 GET 这个动作,这其实就是没有完全遵循这个协议。
可以说只是把 HTTP 当成一个传输管道,而不是约定好的协议。
这其实是对 HTTP 更深一层的认识,我认为也是 RESTful 被推出的原因。
当然理想很丰满,现实很骨感,还是有很多人就 getUserById
。
不过我个人觉得问题不大,公司统一就行。
HATEOAS
即 Hypermedia as the Engine of Application State 的缩写,翻译过来就是作为应用状态引擎的超媒体。
这也是 REST 提出的设计。
比如你请求获取用户列表:
1 | GET /users |
此时的返回应该是:
1 | 200 OK |
重点就是这个 links,结果会返回你能对这个资源所做的操作。
比如对于 userId 是 1 的,你调用PUT /user/1
就是做修改这个用户,DELETE /user/1
就是删除这个用户。
最外层的 links 告诉你用 POST /user
就能再创建一个用户。
这里还有个隐藏信息,可以看到外层的 links 没有返回 DELETE 的信息,说明此时客户端无法删除用户!
所以说 RESTful API 还需要再返回此时能对资源做的操作,这样客户端就知道它能做什么。
它也不需要管具体怎么做,反正返回里面会告诉它 DELETE 就这样这样,POST 就这样这样。
没告诉它的就是不能做的。
然后这个时候再去理解下资源的表述性状态转移,是不是感觉来了?
如果说上一 part 提到用 HTTP 的动词来指代动作, URL 仅表示资源的现实是骨感的。
那么 HATEOAS 的现实就是骨灰。
基本上没几家公司会这么做。
就我个人而言这玩意没啥用。
它的出发点是让客户端从响应就能得知对资源操作的入口,并且通过响应得知哪些动作能执行。
听起来好像有点用,但是就我目前的功力,我只能看到响应变得十分冗余。
最后
这篇文章关于 RESTful API 具体的写法我就提到一些,还有挺多的就自己查资料吧。
文章的目的是为了让你理解 RESTful API,我再总结一下重点。
HTTP 是协议,不是传输通道。(对协议不理解的看我之前的 HTTP 分析)
所以协议约定了很多东西,推荐我们按照协议的用法进行客户端和服务端的交互。
也就是 RESTful 表明的面向资源,通过 HTTP 动作 + URL 上的资源。
RESTful 还提到了 HATEOAS,虽说基本上没什么公司会这样使用,但是它能让你更好的理解 REST 这个名字的含义。
RESTful 是一种风格,你是否采用这种风格对你的程序运行没有影响,类比驼峰命名来思考。
简而言之,RESTful 就是不要在 URL 上表现出动作,用 HTTP 动词代表动作,URL 上只做资源。
仅此而已。
至于要不要严格遵循 RESTful 风格,我个人的看法是公司内部保持一致就行