智慧公共安全编码规范.docx

《智慧公共安全编码规范.docx》由会员分享，可在线阅读，更多相关《智慧公共安全编码规范.docx（34页珍藏版）》请在课桌文档上搜索。

1、公共安全编码规范XX科技股份有限公司编制目录一、编程规约3（一）命名风格3（二）常量定义7（三）代码格式8（四）OOP规约11（五）集合处理17（六）并发处理22（七）控制语句28（八）注释规约32（九）其它34二、异常日志35（一）异常处理35（二）日志规约38三、单元测试40四、安全规约42五、MySQ1.数据库43（一）建表规约43（二）索引规约46（三）SQ1.语句48（四）ORM映射49六、工程结构50（一）应用分层50（二）二方库依赖51（三）服务器53七、设计规约54附1：专有名词解释58一、编程规约（一）命名风格1 .【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下

2、划线或美元符号结束。反例：_name/name/Sname/name_/name$/name2 .【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免岐义。注意，纯拼音命名方式更要避免采用。正例:renminbi/a1.ibaba/taobao/youku/hangzhou等国际通用的名称，可视同英文。反例：DaZhePromotion打折/geIPingfenByNameO评分/int某变量=3【强制】类名使用UpperCame1.Case风格，但以下情形例外：DO/BO/DTO/VO/A0PO/UID等。上例：J

3、avaServer1.essP1.atform/UserDO/Xm1.Service/TcpUdpDea1./TaPromotion反例：Javaserver1.essp1.atforin/UserDo/XM1.Service/TCP1.DPDea1./TAPromotion4 .【强制】方法名、参数名、成员变量、局部变量都统一使用IowerCanic1.Case风格，必须遵从驼峰形式。王例：Ioca1.Va1.ue/getHttpMessageO/inputUser1.d5 .【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。IE例：MAX_SToCK_COU

4、NT/CACHEEXPIRED_TIME反例：MAXCOUNT/EXPIREDTIME6 .【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以TeSt结尾。7 .【强制】类型与中括号紧挨相连来表示数组。正例：定义整形数组intarrayDemo；反例：在main参数中，使用StringargS口来定义。8 .【强制】POJO类中布尔类型变量都不要加is前缀，否则部分框架解析会引起序列化错误。说明：在本文MySQ1.规约中的建表约定第一条，表达是与否的值采用is_xxx的命名方式，所以，需要在resu1.tMap设置

5、从is_xxx到XXX的映射关系。反例：定义为基本数据类型Boo1.eanisDe1.eted的属性，它的方法也是iSDe1.etedO,RPC框架在反向解析的时候，“误以为”对应的属性名称是de1.eted,导致属性获取不到，进而抛出异常。9 .【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。工例：应用工具类包名为com.a1.ibaba.ai.uti1.类名为MessageUtiIs（此规则参考spring的框架结构）10 .【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同

6、的命名，使可读性降低。说明：子类、父类成员变量名相同，即使是pub1.ic类型的变量也是能够通过编译,而局部变量在同一方法内的不同代码块中同名也是合法的，但是要避免使用。对于非setter/getter的参数名称也要避免与成员变量名称相同。反例：pub1icc1.assConfusingNamepub1.icintage：/非setter/getter的参数名称，不允许与本类成员变量同名pub1.icvoidgetDataStringa1.ibabaifconditionfina1.intmoney=531：/.for(inti0；i10；i+)/在同一方法体中，不允许与其它代码块中的mone

7、y命名相同fina1.intmoney615：/.c1.assSonextendsConfusingName/不允许与父类的成员变量名称相同pub!icintage：11 .【强制】杜绝完全不规范的维写，避免望文不知义。反例：AbStraetC1.ass缩写命名成AbsC1.ass：condition缗写命名成condi,此类随意缩写严重降低了代码的可阅读性。12 .为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。正例:在JDK中，表达原子更新的类名为：AtomicKeferenceFie1.dUpdatero一例:inta的随意命名方式。13 .【在常

8、量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。正例：StartTime/WOrkQUeUe/name1.ist/TERMINATED_TIIREAD_COUNT反例：StartedAt/QueucOWork/IistName/COUNTTERMINATEDTHREAD14 .如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念IE例：pub1.icc1.assOrderFactory;pub1.icc1.ass1.oginProxy;pub1.icc1.assKesourceObserver;15 .接口类中

9、的方法和属性不要加任何修饰符号(PUbIiC也不要加)，保持代码的简洁性，并加上有效的JaVadoC注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础富量。-E例：接口方法签名voidcommit()；接口基础常量StringCoMPANY=a1.ibaba；反例:接口方法定义pub1.icabstractvoidfO；说明：JDK8中接口允许有默认实现，那么这个defau1.t方法，是对所有实现类都有价值的默认实现。16 .接口和实现类的命名有两套规则：1)【强制】对于Service和DAo类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现

10、类用ImP1.的后缀与接口区别。正例:CacheServiceimp1.实现CaCheSerViCe接口。2) 如果是形容能力的接口名称，取对应的形容词为接口名(通常是-ab1.e的形容词)。正例：AbStraCtTranSIatOr实现Trans1.atab1.e接口。17 .【叁考】枚举类名带上Enum后缀，枚举成员名称需要全大写，单词问用下划线隔开。说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被.默认强制是私有。正例：枚举名字为ProcessStatusEnum的成员名称:SUCCESS/UNKNOWN.REASoN/18 .【参考】各层命名规约：SerViCe/DAO层方法命

11、名规约1) 获取单个对象的方法用get做前缀。2)获取多个对象的方法用1.ist做前掇，复数形式结尾如：IiStObjects03) 获取统计值的方法用count做前缀。4) 插入的方法用save/insert做前跟。5) 删除的方法用remove/de1.ete做前缀。6) 修改的方法用UPdate做前缀。B）领域模型命名规约1）数据对象：xxxDO,XXX即为数据表名。2）数据传输对象：xxxDTO,XXX为业务领域相关的名称。3）展示对象：XXXVO,XXX一般为网页名称。4） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxP0J0o（二）常量定义1 .【强制】不允许任何魔法

12、值（即未经预先定义的常量）直接出现在代码中。反例：Stringkey=Id#taobao_*+tradeId：cache.put（key,va1.ue）；/缓存get时，由于在代码复制时，漏掉下划线，导致缓存击穿而出现问题2 .【强制】在1.ong或者1.ong赋值时，数值后使用大写的1.,不能是小写的1,小写容易跟数字1混淆，造成误解。说明：1.onga=21；写的是数字的21,还是1.ong型的2。3 .【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。正例：缓存相关常量放在类Cach

13、eConsts下：系统配置相关常量放在类ConfigConstsT04 .【推荐】常量的熨用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1）跨应用共享常量：放置在二方库中，通常是c1.ient,jar中的constant目录下。2）应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“YES”的变量：类A中：pub1.icstaticfina1.StringYES=yes：类B中:pub1.icstaticfina1.StringYES=y；A.YES.e

14、qua1.s（B.YES）,预期是true,但实际返回为fa1.se,导致线上问题。3） 子工程内部共享常量：即在当前子工程的constant目录下。4） 包内共享常量：即在当前包下单独的ConS1.ant目录下。5） 类内共享常量：直接在类内部privatestaticfina1.定义。6） 【推荐】如果变量值仅在一个固定范围内变化用enum类型来定义。说明：如果存在名称之外的延伸属性应使用enum类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。正例：pub1.icenumSeasonEnuniSPRING(I),SUMMER(2),AUTUMN(3),WINTER(4)；pri

15、vateintseq；SeasonEnum(intseq)this.Seq=seq；Ipuh1.icintgetSeq()(returnseq;)(三)代码格式1 .【强制】如果是大括号内为空，则简洁地写成即可，大括号中间无需换行和空格；如果是非空代码块则：1)左大括号前不换行。2)左大括号后换行。3)右大括号前换行。4)右大括号后还有e1.se等代码则不换行：表示终止的右大括号后必须换行。2 .【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。详见第5条下方正例提示。反例：if(空格a=b空格)3 .【强制】if/for/whi1.e/swit

16、ch/do等保留字与括号之间都必须加空格。4 .【强制】任何二目、三目运算符的左右两边都需要加一个空格。说吃：运算符包括赋值运算符=、逻辑运算符&、加渡乘除符号等。5 .【强制】采用4个空格缩进，禁止使用tab字符。说明：如果使用tab缩进，必须设置1个tab为4个空格。IDEA设置tab为4个空格时，请勿勾选1.setabcharacter：而在ec1.ipse中，必须勾选insertspacesfortabs0正例：(涉及1-5点)pub1.icstaticvoidmain(Stringargs)/缩进4个空格Stringsay=he1.1.o；/运算符的左右必须有一个空格intf1.ag

17、=0；/关键词if与括号之间必须有一个空格，括号内的f与左括号，0与右括号不需要空格if(f1.ag=0)System.out.print1.n(say)；/左大括号前加空格且不换行；左大括号后换行if(f1.ag=1)System.out.printin(wor1.d)；/右大括号前换行，右大括号后有e1.se,不用换行e1.seSystem,out.PrintIn(ok)；/在右大括号后直接结束，则必须换行)6 .【强制】注释的双斜线与注释内容之间有且仅有一个空格。正例：/这是示例注释，请注意在双斜线之后有一个空格StringparamnewString)；10 .【强制】IDE的text

18、fi1.eencoding设置为UTF-8；IDE中文件的换行符便用UniX格式，不要使用Windows格式。11 .【单个方法的总行数不超过80行。说明：除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过80行。正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加清晰；共性逻辑抽取成为共性方法，便于复用和维护。12 .没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。正例：intone=1：1.ongtwo=21.；f1.oatthree=3F；StringBuiIdersb=newStringBui1.d

19、erO:说明：增加sb这个变量，如果需要对齐，则给one.two,three都要增加几个空格，在变量比较多的情况下，是非常累赘的事情。13 .，不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。说明：任何情形，没有必要插入多个空行进行隔开。(四)OOP规约1 .【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。2 .【强制】所有的覆写方法，必须加的Verride注解。说明:getbject()与getbject()的问题。一个是字母的0,一个是数字的0,加SOverride可以准确判断是否覆盖成功。另外，如果在抽象

20、类中对方法签名进行修改，其实现类会马上编译报错。3 .【强制】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。说明：可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)上例：pub1.ic1.istIistUsers(Stringtype,1.ong.ids)4 .【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加如CPreCaIed注解，并清晰地说明采用的新接口或者新服务是什么。5 .【强制】不能使用过时的类或方法。说明：.UR1.Decoder中的方法decode(StringencodeS

21、tr)这个方法已经过时，应该使用双参数decode(Stringsource.Stringencode)接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。6 .【强制】ObjeCt的equa1.s方法容易批空指针异常，应使用常量或确定有值的对象来调用equa1.s正例:test,equa1.s(object)；反例:object,equa1.s(test)；说明:推荐使用java.uti1.Objectstfequa1.s(JDK7引入的工具类)。7 .【强制】所有整型包装类对象之间值的比较，全部使用equa1.s方法比较。说明：对于

22、Integervar=?在-128至127范围内的赋值，Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用=进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equa1.s方法进行判断。8 .【强制】浮点数之间的等值判断，基本数据类型不能用=来比较，包装数据类型不能用equa1.s来判断。说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数，具体原理参考码出高效。反例：f1.oata1.0f-0.9f；f1

23、.oatb=0.9f-0.8f：if(a=b)/预期进入此代码快，执行其它业务逻辑/但事实上a=b的结果为fa1.seF1.oatxF1.oat.va1.ue1.ia：；F1.oatyF1.oat.va1.*0f1b)：ix.equa1.s：y：)(/预期进入此代码快，执行其它业务逻辑/但事实上equa1.s的结果为fa1.se)正例：(1)指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。f1.oata1.0f0.9f；f1.oatb0.9f-0.8f;f1.oatdiff1.e-6f:ifMath,absab)diff;Systemout.printin：true)：(2)使

24、用BigDecima1.来定义值，再进行浮点数的运算操作。BigDecima1.anewBigDecima1.1.0)：BigDecima1.bnewBigDecima1.0.9)：BigDewBigDecima1.0.8：BigDecima1.x=a.subtractgeneratetoString时，如果继承了另一个POJO类，注意在前面加一下super.toStringo说明:在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。16 .【强制】禁止在POJO类中，同时存在对应属性XXX的isXxx()和getXxx()方法。说明：框架在调用属性

25、XXX的提取方法时，并不能确定哪个方法一定是被优先调用到。17 .使用索引访问用String的sp1.it方法得到的数组时，需做最后一个分幅符后有无内容的检查，否则会有把IndeXOUtofBOUndSEXCePtiOn的风险。说明：Stringstr=atb,c,；String11ary=str.sp1.it(,)；/7于员期大于3,行果是3System,out.printin(ary.1.ength)：18 .【当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读，此条规则优先于下一条。19 .I类内方法定义的顺序依次是：公有方法或保护方法私有方法getter/

26、setter方法。说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有Service和DO的getter/setter方法放在类体最后。20 .】setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在getter/Setter方法中，不要增加业务逻辑，增加排查问题的难度。21 【强制】使用Map的方法keySet()/VaIUeSO/entrySetO返回集合对象时，不可以对其进行添加元素操作，否则会拗出UnSUPPOr

27、tedOPerationEXCePtiOn异常。22 【强制】COneCtiOnS类返回的对象，如：empty1.ist()/SingIetOn1.iSto等都是immutab1.e1.ist,不可对其进行添加或者删除元素的操作。反列：如果查询无结果，返回CO1.IeCtions.Cmp1.y1.istO空集合对象，调用方一旦进行了添加元素的操作，就会触发UnsupportedoperationException异常。23 【强制】在sub1.ist场景中，高度注意对原集合元素的增加或删除，均会导致子列表的遍历、增加、删除产生ConcurrentModificationException异常。

28、24 【强制】使用集合转数组的方法，必须使用集合的toArray(Tarray),传入的是类型完全一致、长度为0的空数组。反例：直接使用toArray无参方法存在问题，此方法返回值只能是ObjeCt口类，若强转其它类型数组将出现C1.assCastException错误。正例：1.ist1.ist=newArray1.istO(2)；1.ist,add(guan)；1.ist,add(bao)；Stringarray=1.ist.toArray(newStringO)：说明：使用toArray带参方法，数组空间大小的1.ength：1)等于0,动态创建与size相同的数组，性能最好。2)大于0

29、但小于size,重新创建大小等于size的数组，增加GC负担。3) 等于size,在高并发情况下，数组创建完成之后，size正在变大的情况下，负面影响与上相同。4)大于size,空间浪费，且在size处插入nu1.1.值，存在NPE隙患。7 .【强制】在使用CoIIeCtion接口任何实现类的addA1.1.()方法时，都要对输入的集合参数进行NPE判断。说明:在Array1.isttfaddA1.1.方法的第一行代码即Objecta=c.toArray()；其中c为输入集合参数，如果为nu1.1.,则直接批出异常。IK,M8 .【强制】使用工具类ArrayS.as1.ist()把数组转换成集

30、合时，不能使用其修改集合相关的方法，它的add/remove/cIear方法会抛出UnsupportedOperatiOnException异常。说明：as1.ist的返回对象是一个Arrays内部类，并没有实现集合的修改方法。Arrays.as1.ist体现的是适配器模式，只是转换接口，后台的数据仍是数组。Stringstr=newString,yang,hao；1.ist1.ist=Arrays.as1.ist(str)；第一种情况：1.ist,addCyangguanbao)；运行时异常。第二种情况：str01=changed；也会随之修改，反之亦然。9 .【强制】泛型通配符?exten

31、dsT来接收返回的数据，此写法的泛型集合不能使用add方法，而?superT不能使用get方法，作为接口调用赋值时易出错。说明：扩展说一下PECS(ProducerExtendsConsumerSUPer)原则：第一、频繁往外读取内容的，适合用?extendsTo第二、经常往里插入的，适合用?superT10 .【强制】在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行instanceof判断，避免抛出C1.assCastException异常。说明：毕竟泛型是在JDK5后才出现，考虑到向前兼容，编译器是允许非泛型集合与泛型集合互相赋值。反例：1.istStringgen

32、ericsnu1.1.1.istRotGenericsnewArray1.ist10；notGenericsaddnewObject1)：notGenerics.addnewInteger11：genericsnotGenerics：/此处抛出C1.assCastException异常Stringstringgenerics.get1O：11 .【强制】不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator方式，如果并发操作，需要对IteratOr对象加锁。正例：1.ist1.ist=newArray1.istOO；1.ist.add(1)；1.i

33、st,addC2);Iteratoriterator=1.ist,iterator()；whiIe(iterator.hasNext()(Stringitem=iterator,nextO；if(删除元素的条件)iterator,removeO：)反例：for(Stringitem：1.ist)if(1.equa1.s(item)1.ist,remove(item)；)说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1换成2”,会是同样的结果吗？12 .【强制】在JDK7版本及以上，Comparator实现类要满足如下三个条件，不然Arrays,sort.Co1.1.ections

34、,sort会批I1.1.ega1.ArgumentException0说明：三个条件如下1) X,y的比较结果和y,X的比较结果相反。2) xy,yz,则xzo3) x=y,则X,z比较结果和y,Z比较结果相同。反件：下例中没有处理相等的情况，交换两个对象判断结果并不互反，不符合第一个条件，在实际使用中可能会出现异常。newComparator()7 .不要在视图模板中加入任何复杂的逻辑。说明：根据MVC理论，视图的职责是展示，不要抢模型和控制器的活。8 .:任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。9 .及时清理不再使用的代码段或配置信息。说明：对于垃圾代码或过

35、时配置，坚决清理干净，避免程序过度腌肿，代码冗余。正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(/)来说明注释掉代码的理由。二、异常日志(一)异常处理1 .【强制】JaVa类库中定义的可以通过预检查方式规避的RuntimeException异常不应该通过CatCh的方式来处理，比如：NU1.1.POinterEXCeP1.iOn,IndexOutOfBoundsException等等。说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，可能存在数字格式错误，不得不通过catchNuinberFormatException来实现。正例:if

36、(obj!=nu1.1.).反例：tryIobj.method()；catch(Nu1.IPoiDterExcep1.ione),!,2 .【强制】异常不要用来做流程控制，条件控制。说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。3 .【强制】Ca1.Ch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的Cateh尽可能进行区分异常类型，再做对应的异常处理。说明：对大段代码进行try-catch,使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。正例：用户注册的场景中，如果用户输入

37、非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上作出分门别类的判断，并提示给用户。4 .【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常批给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。5 .【强制】有try块放到了事务代码中，catch异常后，如果需要回滚事务，一定要注意手动回滚事务。6 .【强制】fina1.1.y块必须对资源对象、流对象进行关闭，有异常也要做try-catcho说明：如果JDK7及以上，可以使用try-with-resources方式。【强制】不要在fina1.1.y块中使用re1.urn

38、0说明：try块中的return语句执行成功后，并不马上返回，而是继续执行fina1.1.y块中的语句，如果此处存在return语句，则在此直接返回，无情丢弃掉try块中的返回点。反例：privateintx=0；pub1.icintCheckReturn()try/x等于1,此处不返回return+x；fina1.1.y/返回的结果是2return+x；)8 .【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。9 .【强制】在调用RPC,二方包、或动态生成类的相关方法时，捕捉异常必须使用Throwab1.e

39、类来进行拦载。4 .【强制】在日志输出时，字符串变量之间的拼接使用占位符的方式。说明：因为String字符串的拼接会使用StringBui1.der的append。方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。正例：1.ogger.Processingradewitid：andsymbo1.：,.id.symbo1.；5 .【强制】对于trace/debug/info级别的日志输出，必须进行日志级别的开关判断。说明：虽然在debug(参数)的方法体内第一行代码isDisab1.ed(1.eve1.DEBUGNT)为真时(S1.f4j的常见实现1.og4j和1.ogback)

40、,就直接return,但是参数可能会进行字符串拼接运算。此外，如果debug(getName()这种参数内有getName()方法调用，无谓浪费方法调用的开销。正例：/如果判断为真，那么可以抢出IraCe和debug级别的日志if1.ogger.IsDebugEnab1.edO)1.ogger,debug(CurrentIDis：andnameis：(,id,getXame()；6 .【强制】避免重复打印日志，浪费磁盘空间，务必在1.og4j.xm1.中设置additivity=fa1.se工例：7 .【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字th

41、rows往上抛出。壬例:IOgger.error(各类参数或者对象toString()+e.getMessageO,);8 .谨慎地记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题,避免把服务器横盘撑爆，并记得及时删除这些观察日志。说明：大量地输出无效日志,不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？9 .可以使用warn日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出error级别，避免频繁报警。说明:注意日志输出的级别，error级别只记录系统逻辑出错、异常或者重要的错误信息。10 .【】尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。【强制】国际化团队或海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息。三、单元测试1 .【强制】好的单元测试必须遵守A1.R原则。说明：单元测试在线上运行时，感觉像空气（A1.R）一样并不存在，但在测试质量的保障上，却是非常关键的。好的单元测试宏观上