媒体直播大数据编码规范.docx

for(inti0；i<10；i+)/在同一方法体中，不允许与其它代码块中的money命名相同fina1.intmoney615：/.c1.assSonextendsConfusingName/不允许与父类的成员变量名称相同pub!icintage：11 .【强制】杜绝完全不规范的维写，避免望文不知义。反例：AbStraetC1.ass"缩写"命名成AbsC1.ass：condition"缗写"命名成condi,此类随意缩写严重降低了代码的可阅读性。12 .为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。正例:在JDK中，表达原子更新的类名为：AtomicKeferenceFie1.dUpdatero一例:inta的随意命名方式。13 .【在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。正例：StartTime/WOrkQUeUe/name1.ist/TERMINATED_TIIREAD_COUNT反例：StartedAt/QueucOWork/IistName/COUNTTERMINATEDTHREAD14 .如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念IE例：pub1.icc1.assOrderFactory;pub1.icc1.ass1.oginProxy;B）领域模型命名规约1）数据对象：xxxDO,XXX即为数据表名。2）数据传输对象：xxxDTO,XXX为业务领域相关的名称。3）展示对象：XXXVO,XXX一般为网页名称。4） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxP0J0o（二）常量定义1 .【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。反例：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 .【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。正例：缓存相关常量放在类CacheConsts下：系统配置相关常量放在类ConfigConstsT04 .【推荐】常量的熨用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1）跨应用共享常量：放置在二方库中，通常是c1.ient,jar中的constant目录下。2）应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“YES”的变量：类A中：pub1.icstaticfina1.StringYES="yes"：类B中:pub1.icstaticfina1.StringYES="y"；A.YES.equa1.s（B.YES）,预期是true,但实际返回为fa1.se,导致线上问题。3 ）子工程内部共享常量：即在当前子工程的constant目录下。4 ）包内共享常量：即在当前包下单独的ConS1.ant目录下。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=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的textfi1.eencoding设置为UTF-8；IDE中文件的换行符便用UniX格式，不要使用Windows格式。11 .【单个方法的总行数不超过80行。说明：除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过80行。正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加清晰；共性逻辑抽取成为共性方法，便于复用和维护。12 .没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。正例：intone=1：1.ongtwo=21.；f1.oatthree=3F；StringBuiIdersb=newStringBui1.derO:说明：增加sb这个变量，如果需要对齐，则给one.two,three都要增加几个空格，在变量比较多的情况下，是非常累赘的事情。13 .，不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。说明：任何情形，没有必要插入多个空行进行隔开。(四)OoP规约1 .【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。2 .【强制】所有的覆写方法，必须加的Verride注解。说明:getbject()与getbject()的问题。一个是字母的0,一个是数字的0,加SOverride可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。3 .【强制】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。值。说眠：注意Seria1.VersionUID不一致会抛出序列化运行时异常。14 .【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。15 .【强制】POJO类必须写toString方法。使用IDE中的工具：source>generatetoString时，如果继承了另一个POJO类，注意在前面加一下super.toStringo说明:在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。16 .【强制】禁止在POJO类中，同时存在对应属性XXX的isXxx()和getXxx()方法。说明：框架在调用属性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/setter方法。说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有Service和DO的getter/setter方法放在类体最后。20 .】setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在getter/Setter方法中，不要增加业务逻辑，增加排查问题的难度。说明：对象c1.one方法默认是浅拷贝，若想实现深拷贝需覆写C1.one方法实现域对象的深度遍历式拷贝。24. t类成员与方法访问控制从严：1 ）如果不允许外部直接通过new来创建对象，那么构造方法必须是privateo2）工具类不允许有pub1.ic或defau1.t构造方法。3）类非static成员变量并且与子类共享，必须是protectedo4）类非static成员变量并且仅在本类使用，必须是privateo5）类static成员变量如果仅在本类使用，必须是privateo6）若是static成员变量，考虑是否为fina1.。7）类成员方法只供类内部调用，必须是PriVateI）8）类成员方法只对继承类公开，那么限制为protected.说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。思考：如果是一个private的方法，想删除就删除，可是一个pub1.ic的service成员方法或成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。（五）集合处理1.【强制】关于hashCode和equa1.s的处理，遵循如不规则：1）只要覆写equa1.s,就必须覆写hashCode02）因为Set存储的是不重复的对象，依据hashCode和equa1.s进行判断，所以Set存储的对象必须榄写这两个方法。3）如果自定义对象作为Map的键，那么必须覆写IiashCode和equa1.so说明：String已覆写hashCode和equa1.s方法，所以我们可以愉快地使用String对象作为key来使用。2.【强制】Array1.iSt的SUb1.iSt结果不可强转成Array1.ist,否则会抛出C1.assCastException异常，即java.uti1.RandomAccessSub1.istcannotbecasttojava.uti1.Array1.isto说明：sub1.ist返回的是Array1.iSt的内部类Sub1.ist,并不是Array1.iSt而是Array1.ist的一个视图，对于Sub1.ist子列表的所有操作最终会反映到原列表上。8 .【强制】使用工具类ArrayS.as1.ist()把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/cIear方法会抛出UnsupportedOperatiOnException异常。说明：as1.ist的返回对象是一个Arrays内部类，并没有实现集合的修改方法。Arrays.as1.ist体现的是适配器模式，只是转换接口，后台的数据仍是数组。Stringstr=newString,""yang","hao"；1.ist1.ist=Arrays.as1.ist(str)；第一种情况：1.ist,addCyangguanbao")；运行时异常