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

《媒体直播大数据编码规范.docx》由会员分享，可在线阅读，更多相关《媒体直播大数据编码规范.docx（20页珍藏版）》请在课桌文档上搜索。

1、for(inti0；igeneratetoString时，如果继承了另一个POJO类，注意在前面加一下super.toStringo说明:在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。16 .【强制】禁止在POJO类中，同时存在对应属性XXX的isXxx()和getXxx()方法。说明：框架在调用属性XXX的提取方法时，并不能确定哪个方法一定是被优先调用到。17 .使用索引访问用String的sp1.it方法得到的数组时，需做最后一个分幅符后有无内容的检查，否则会有把IndeXOUtofBOUndSEXCePtiOn的风险。说明：Strings

2、tr=atb,c,；String11ary=str.sp1.it(,)；/7于员期大于3,行果是3System,out.printin(ary.1.ength)：18 .【当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读，此条规则优先于下一条。19 .I类内方法定义的顺序依次是：公有方法或保护方法私有方法getter/setter方法。说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有Service和DO的ge

3、tter/setter方法放在类体最后。20 .】setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在getter/Setter方法中，不要增加业务逻辑，增加排查问题的难度。说明：对象c1.one方法默认是浅拷贝，若想实现深拷贝需覆写C1.one方法实现域对象的深度遍历式拷贝。24. t类成员与方法访问控制从严：1 ）如果不允许外部直接通过new来创建对象，那么构造方法必须是privateo2）工具类不允许有pub1.ic或defau1.t构造方法。3）类非static成员变量并且与子类共享，必须是protectedo4）类非static成员变量并且仅在本类使用，必须

4、是privateo5）类static成员变量如果仅在本类使用，必须是privateo6）若是static成员变量，考虑是否为fina1.。7）类成员方法只供类内部调用，必须是PriVateI）8）类成员方法只对继承类公开，那么限制为protected.说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。思考：如果是一个private的方法，想删除就删除，可是一个pub1.ic的service成员方法或成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。（五）集合处理1.【强制】关于hashCo

5、de和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.RandomAcc

6、essSub1.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.

7、as1.ist体现的是适配器模式，只是转换接口，后台的数据仍是数组。Stringstr=newString,yang,hao；1.ist1.ist=Arrays.as1.ist(str)；第一种情况：1.ist,addCyangguanbao)；运行时异常。第二种情况：str01=changed；也会随之修改，反之亦然。9 .【强制】泛型通配符?extendsT来接收返回的数据，此写法的泛型集合不能使用add方法，而?superT不能使用get方法，作为接口调用赋值时易出错。说明：扩展说一下PECS(ProducerExtendsConsumerSUPer)原则：第一、频繁往外读取内容的，适合

8、用?extendsTo第二、经常往里插入的，适合用?superT10 .【强制】在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行instanceof判断，避免抛出C1.assCastException异常。说明：毕竟泛型是在JDK5后才出现，考虑到向前兼容，编译器是允许非泛型集合与泛型集合互相赋值。反例：1.istStringgenericsnu1.1.1.istRotGenericsnewArray1.ist10；notGenericsaddnewObject1)：notGenerics.addnewInteger11：genericsnotGenerics：/此处抛

9、出C1.assCastException异常Stringstringgenerics.get1O：11 .【强制】不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator方式，如果并发操作，需要对IteratOr对象加锁。Overridepub1.icintcompare(Studento1.,Studento2)returno1.get1.d()o2.getIdO?1：-1；)；13. 集合泛型定义时，在JDK7及以上，使用diamond语法或全省略。说明：菱形泛型，即diamond,直接使用来指代前边巳经指定的类型。正例：/diamond方式，即

10、use*Cache=newHashMapO(16)；/全省略方式Array1.istusers=newArray1.ist(10)：14. 集合初始化时，指定集合初始值大小。说口月：HaShMaP使用IIashMap(intinitia1.capacity)初始化正例：initia1.capacity=(需要存储的元素个数/负载因子)+1,注意负载因子(即1.oaderfactor)默认为0.75,如果簪时无法确定初始值大小，请设置为16(即默认值)。反例：HaShMaP需要放置1024个元素，由于没有设置容量初始大小，随着元素不断增加，容量7次被迫扩大，resize需要重建hash表，严重影

11、响性能。15. 使用entrySet遍历Map类集合KV,而不是keySet方式进行遍历。说明：keySet其实是遍历了2次，一次是转为Iterator对象，另一次是从hashMap中取出key所对应的VaIUeO而entrySet只是遍历了一次就把key和va1.ue都放到了entry中，效率更高。如果是JDK8,使用Map.forEach方法。工例：VaIUeS()返回的是V值集合，是一个1.ist集合对象；keySet()返回的是K值集合，是一个Set集合对象；entrySet()返回的是K-V值组合集合。16. 高度注意Map类集合K/V能不能存储nu1.1.值的情况，如下表格：nam

12、eprefixBromUserThreadFactory1S-WhatFeaturOfGroup+-Worker-：OverridepubicThreadnewThr111.)；ThreadthreadnewThreadnu1.1.,task.name.O,fa1.se)：Systemout.printInithreadgetName：)；returnthread；)3 .【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。说明：线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销,解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内

13、存或者“过度切换”的问题。4 .【强制】线程池不允许使用Executors去创建，而是通过ThreadPoo1.Executor的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。说明：Executors返回的线程池对象的弊端如下：1)FixedThreadPoo1.和Sing1.eThreadPoo1.：允许的请求队列长度为Integer.MAXJtA1.UE,可能会堆积大量的请求，从而导致OoMo2)CachedThreadPoo1：允许的创建线程数量为IntegerNAXVA1.UE,可能会创建大量的线程，从而导致OOMo5.【强制】SinIPIeDateFOr

14、mat是线程不安全的类，一般不要定义为static变量，如果定义为static,必须加锁，或者使用DateUtiIS工具类。正例：注意线程安全，使用DateUti1.s0亦推荐如下处理：锁方法与try代码块之间没有任何可能抛出异常的方法调用，避免加锁成功后，在fina1.1.y中无法解锁。说明一：如果在1.ock方法与try代码块之间的方法调用抛出异常，那么无法解锁，造成其它线程无法成功获取锁。说明二：如果1.ock方法在try代码块之内，可能由于其它方法抛出异常，导致在fina1.1.y代码块中，un1.ock对未加锁的对象解锁，它会调用AQS的IryRCIeaSe方法(取决于具体实现类)，

15、抛出11Iega1.MonitorStateException异常。说明三：在1.ock对象的1.ock方法实现中可能抛出unchecked异常，产生的后果与说明二相同。正例：1.ock1.ock=newXxx1.ockO；/.1.ock,1.ock()；trydoSomething()；doOthers()；fina1.1.y1.ock,un1.ock()；反例：)1.ock1.ock=newXxx1.ockO;/.try/如果此处抛出异常，则直接执行fina1.1.y代码块doSomething()；/无论加锁是否成功，fina1.1.y代码块都会执行1.ock,1.ock()；doOth

16、ers()；fina1.1.y13. 资金相关的金融敏感信息，使用悲观锁策略I;说明：乐观锁在获得锁的同时巳经完成了更新操作，校验逻辑容易出现漏洞，另外，乐观锁对冲突的解决策略有较复杂的要求，处理不当容易造成系统压力或数据异常，所以资金相关的金融敏感信息不建议使用乐观锁更新。14. 使用Coun1.Down1.atch进行异步转同步操作，每个线程退出前必须调用CountDown方法，线程执行代码注意catch异常，确保CountDown方法被执行到，避免主线程无法执行至await方法，直到超时才返回结果。说明：注意，子战程抛出异常堆栈，不能在主线程Ey-Catch至九15. 避免Random实

17、例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed导致的性能下降。说明：Random实例包括java,utiI.Random的实例或者Math.randomO的方式O王例：在JDK7之后，可以直接使用APIThread1.oca1Random,而在JDK7之前，需要编码保证每个线程持有一个实例。16. 在并发场景下，通过双重检查锁(doub1.e-checked1.ocking)实现延迟初始化的优化问题隐患(可参考TheDoub1.e-Checked1.ockingisBrokenDec1.aration),推荐解决方案中较为简单一种(适用于JDK5及以上版本)，将目标属性声明

18、为vo1.ati1.e型。反例：pub1.icc1.ass1.azyInitDemo.privateHe1.perhe1.per=nu1.1.；pub1.icHe1.pergetHe1.per()if(he1.per=nu1.1)synchronized(this)if(he1.per=nu1.1.)he1.per=newHe1.pcrO;)returnhe1.per；/othermethodsandfie1.ds.)反例：pub1.icfina1.voidacquire(1.ongarg)if(!trycquire(arg)&acquireQueued(addWaiter(Node.EXC1

19、.USIVE),arg),Se1.fInterruptO;)7 .不要在其它表达式(尤其是条件表达式)中，插入赋值语句。说明：赋值点类似于人体的穴位，对于代码的理解至关重要，所以赋值语句需要清晰地单独成为一行。反例：pub1.ic1.ockget1.ock(boo1.eanfair)(/算术表达式中出现求值操作，容易忽略gun1.值已经被改变thresho1.d=(count=Integer.MAXVA1.UE)-1：/条件表达式中出现赋值操作，容易误认为是sync=fairreturn(sync=fair)?newFairSyncO：newNonfairSyncO；8 .循环体中的语句要考量

20、性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-catch操作(这个try-catch是否可以移至循环体外)。9 .J避免采用取反逻辑运算符。说明：取反逻辑不利于快速理解，并且取反逐辑写法必然存在对应的正向逻辑写法。正例：使用if(x=628)来表达X小于628o10 .【接口入参保护，这种场景常见的是用作批量操作的接口。11 .【参考】下列情形，需要进行参数校验：1)调用频次低的方法。2)执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。3）需要极高稳定性和可用性的方法。4）对外

21、提供的开放接口，不管是RPCPIHTTP接口。5）敏感权限入口。12 .【参考】下列情形，不需要进行参数校险：1）极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。2）底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。3）被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校晚参数。（八）注释规约1 .【强制】类、类属性、类方法的注释必须使用JaYadOC规范，使

22、用/*内容*/格式，不得使用/XXX方式。说明：在IDE编辑窗口中，Javadoc方式会提示相关注释，生成JaVadoC可以正确输出相应注释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。2 .【强制】所有的抽象方法（包括接口中的方法）必须要用JaVadoC注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。说明：对子类的实现要求，或者调用注意事项，请一并说明。3 .【强制】所有的类都必须添加创建者和创建日期。4 .【强制】方法内部单行注释，在被注释语句上方另起一行，使用注释。方法内部多行注释使用/*/注释，注意与代码对齐。

23、5 .【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。6 .与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。2 )对SerViCe层通用能力的下沉，如缓存方案、中间件通用处理。3)与DAO层交互，对多个D0的组合复用。DAO层:数据访问层，与底层MySQ1.,Orac1.e,Hbase等进行数据交互。外部接口或第三方平台：包括其它部门RPC开放接口，基础平台，其它公司的HTTP接H。3 .【参考】(分层异常处理规约)在DAO层，产生的异常类型有很多，无法用细粒度的异常进行catch,使用catch(Exceptione)方式，并thrown

24、ewDAOException(e),不需要打印日志，因为日志在ManagerZService层一定需要捕获并打印到日志文件中去，如果同台服务器再打日志，浪费性能和存储。在Service层出现异常时，必须记录出错日志到磁盘，尽可能带上参数信息，相当于保护案发现场。如果Manager层与Service同机部署，日志方式与DAO层处理一致，如果是单独部署,则采用与Service一致的处理方式。Web层绝不应该继续往上抛异常，因为已经处于顶层，如果意识到这个异常将导致页面无法正常渲染，那么就应该直接跳转到友好错误页面，加上用户容易理解的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。4

25、 .【参考】分层领域模型规约：DO(DataObject)：此对象与数据库表结构对应，通过DAO层向上传输数据源对象。DTO(DataTransferObject)：数据传输对象，Service或Manager向外传输的对象。BO(BusinessObject)：业务对象，由Service层输出的封装业务逻辑的对象。AO(App1.icationObject)：应用对象，在Web层与SerViCe层之间抽象的复用对象模型，极为贴近展示层，复用度不高。VO(ViewObject)：显示层对象，通常是Web向模板渲染引擎层传输的对象。Query：数据查询对象，各层接收上层的查询请求。注意超过2个参

26、数的查询封装，禁止使用Map类来传输。(二)二方库依赖1 .【强制】定义GAV遵从以下规则:1） GroupID格式：Com.公司/BU.业务线.子业务线,最多4级。说明:公司BU例如:a1.ibaba/taobao/tma1.1/a1.iexpress等BU一级;子业务线可选。IF例：com.taobao.jstorm或com.a1.ibaba,dubbo.register2） ArtifaCt1.D格式：产品线名-模块名。语义不重里不遗漏，先到中央仓库去查证一下。正例：dubbo-c1.ient/fastjson-api/jstor11-too1.3） Version：详细规定参考下方。2

27、 .【强制】二方库版本号命名方式：主版本号.次版本号.修订号1）主版本号：产品方向改变，或者大规模API不兼容，或者架构不兼容升级。2）次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的AP1.不兼容修改。3）修订号：保持完全兼容性，修复BUG、新增次要功能特性等。说明：注意起始版本号必须为：1.0.0,而不是0.0.1,正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级。如当前版本：1.3.3,那么下一个合理的版本号：1.3.4或1.4.0或2.0.03 .【强制】线上应用不要依赖SNAPSHOT版本（安全包除外）。说明：不依赖SNAPSHOT版本是保

28、证应用发布的暴等性。另外，也可以加快编译时的打包构建。4 .【强制】二方库的新增或升级，保持除功能点之外的其它jar包仲裁结果不变。如果有改变，必须明确评估和验证。说明：在升级时，进行dependency：reso1.ve前后信息比对，如果仲裁结果完全不一致，那么通过dependency：tree命令，找出差异点，进行exc1.ude排除jar包。5 .【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。6 .【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。说明：依赖springframework-

29、core,-context,-beans,它们都是同一个版本，可以定义一个变量来保存版本：$SPring.version）,定义依赖的时候，引用该版本。7 .【强制】禁止在子项目的pom依赖中出现相同的GroupId,相同的ArtifactId,但是不同的Version0说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war,只能有一个版本号出现在最后的Iib目录中。可能出现线下调试是正确的，发布到线上却出故障的问题。1.1 ）底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。9 .所有pom文件中的依赖声明放在dependencies语句块中，所有版本仲裁放在

30、CdependencyManagement）语句块中。说明：VdependencyManagemenD里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version和scope都读取自父pom0而dependencies）所有声明在主pom的dependencies里的依赖都会自动引入，并默认被所有的子项目继承。10 .：二方库不要有配置项，最低限度不要再增加配置项。11 .【参考】为避免应用二方库的依籁冲突问题，二方库发布者应当遵循以下原则:1）精简可控原则，移除一切不必要的Ap1.和依赖，只包含ServiceAPI,必要的领域模型对象、Uti1.s类、常量、枚举等。如果依赖其它

31、二方库，尽量是provided引入，让二方库使用者去依赖具体版本号；无1.og具体实现，只依赖日志框架。2）稳定可追溯原则,每个版本的变化应该被记录，二方库由谁维护，源码在哪里,都需要能方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。（三）服务器1. 高并发服务器建议调小TCP怖议的time_wait超时时间。说明：操作系统默认240秒后，才会关闭处于time_wait状态的连接，在高并发访问下，服务器端会因为处于time_wait的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。壬瓦：在IinUX服务器上请通过变更etcsysct1.conf文件去修改该

32、缺省值（秒）：net.ipv4.tcp_fin_timeout=302. 调大服务器所支持的最大文件句柄数（FiIeDescriptor,简写为fd）O说明：主流操作系统的设计是将TCP/UDP连接采用与文件一样的方式去管理，即一个连接对应于一个fd主流的IinUX服务器默认所支持最大fd数量为1024,当并发连接数很大时很容易因为fd不足而出现“opentoomanyfi1.es错误，导致新的连接无法建立。建议将IinUX服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。3. r1给JVM环境参数设置-XX：+HCaPDUmPonOUtOMemoryError参数，让JVM碰到OO

33、v场景时输出dump信息。说明：OOM的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助。4. 】在线上生产环境，JVM的XmS和XmX设置一样大小的内存容量，避免在GC后调整堆大小带来的压力。5. 参考服务器内部重定向使用forward；外部重定向地址使用UR1.拼装工具类来生成，否则会带来UR1.维护不一致的问题和潜在的安全风险。七、设计规约1 .【强制】存储方案和底层数据结构的设计获得评审一致通过，并沉淀成为文档。说明：有缺陷的底层数据结构容易导致系统风险上升，可扩展性下降，重构成本也会因历史数据迁移和系统平滑过渡而陡然增加，所以，存储方案和数据结构需要认真地

34、进行设计和评审，生产环境提交执行后，需要进行d。UbIeCheck。正低：评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否满足业务发展、表或字段之间的辩证关系、字段名称、字段类型、索引等；数据结构变更（如在原有表中新增字段）也需要进行评审通过后上线。2 .【强制】在需求分析阶段，如果与系统交互的User越过一类并且相关的UserCase超过5个，使用用例图来表达更加清晰的结构化需求。3 .【强制】如果某个业务对象的状态超过3个，使用状态图来表达并且明确状态变化的各个触发条件I）说明：状态图的核心是对象状杰，首先明确对象有多少种状态,然后明确两两状态之间是否存在直接转

35、换关系，再明确触发状态转换的条件是什么。正例：淘宝订单状态有已下单、待付款、已付款、待发货、已发货、已收货等。比如已下单与已收货这两种状态之间是不可能有直接转换关系的。4 .【强制】如果系统中某个功能的调用链路上的涉及对象超过3个，使用时序图来表达并且明确各调用环节的输入与输出。说明：时序图反映了一系列对象间的交互与协作关系，清晰立体地反映系统的调用纵深链路。5 .【强制】如果系统中模型类超过5个，并且存在复杂的依赖关系，使用类图来表达并且明确类之间的关系。说明：类图像建筑领域的施工图，如果搭平房，可能不需要，但如果建造蚂蚁Z空间大楼，肯定需要详细的施工图。6 .【强制】如果系统中超过2个对象

36、之间存在协作关系，并且需要表示复杂的处理流程，使用活动图来表示。说明：活动图是流程图的扩展，增加了能够体现协作关系的对象泳道，支持表示并发等。7 .：需求分析与系统设计在考虑主干功能的同时，需要充分评估异常流程与业务边界。反例：用户在淘宝付款过程中，银行扣款成功，发送绐用户扣款成功短信，但是支付宝入款时由于断网演练产生异常，淘宝订单页面依然显示未付款，导致用户投诉。8 .类在设计与实现时要符合单一原则。说明：单一原则最易理解却是最难实现的一条规则，随着系统演进，很多时候，忘记了类设计的初衷。9 .谨慎使用继承的方式来进行扩展，优先使用聚合/组合的方式来实现。说明：不得已使用继承的话，必须符合里

37、氏代换原则，此原则说父类能够出现的地方子类一定能够出现，比如，“把钱交出来”，钱的子类美元、欧元、人民币等都可以出现。10 .系统设计时，根据依赖倒置原则，尽量依赖抽象类与接口，有利于扩展与维护。说明：低层次模块依赖于高层次模块的抽象，方便系统间的解耦。11 .系统设计时，注意对扩展开放，对修改闭合。说明：极端情况下，交付线上生产环境的代码都是不可修改的，同一业务域内的需求变化，通过模块或类的扩展来实现。12 .系统设计阶段，共性业务或公共行为抽取出来公共模块、公共配置、公共类,公共方法等，避免出现重复代码或重复配置的情况。说明：随着代码的重复次数不断增加，维护成本指数级上升。13 .避免如下误解：敏捷开发=讲故事+编码+发布。说明：敏捷开发是快速交付迭代可用的系统，省略多余的设计方案，摒弃传统的审批流程，但核心关键点上的必要设计和文档沉淀是需要的。反例：某团队为了业务快速发展，敏捷成了产品经理催进度的借口，系统中均是勉强能运行但像面条一样的代码，可维护性和可扩展性极差，一年之后，不得不进行大规模重构，得不偿失。14 .【参考】系统设计主要目的是明确需求、理顺逻辑、后期维护，次