电信人口大数据编码规范.docx

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等。上

3、例：JavaServer1.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_

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

5、p设置从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；i?andd=?那么即使C的区分度更高，也必须把c1.放

7、在索引的最前列，即索引idx_d_co10. 防止因字段类型不同造成的隐式转换，导致索引失效。11. 【参考】创建索引时避免有如下极端误解：1)宁滥勿缺。认为一个查询就需要建一个索引。2)宁缺勿滥。认为索引会消耗空间、严重拖慢记录的更新以及行的新增速度。3)抵制惟一索引。认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。合元素数量，控制在100O个之内。10 .【参考】如果有国际化需要，所有的字符存储与表示，均以utf-8编码，注意字符统计函数的区别。说明：SE1.ECT1.ENGTH（轻松工作”）；返回为12SE1.ECTaIARACTER.1.ENGTH（轻松工作”）；返回为4如果

8、需要存储表情，那么选择utf8mb4来进行存储，注意它与utf-8编码的区别。11 .（亨】TRUNCATETB1.E比DE1.ETE速度快，且使用的系统和事务日志资源少,但TRUNCATE无事务且不触发trigger,有可能造成事故，故不建议在开发代码中使用此语句。说用：TRUNCATETAB1.E在功能上与不带WHERE子句的DE1.ETE语句相同。（四）ORM映射1 .【强制】在表查询中，一律不要使用*作为查询的字段列表，需要哪些字段必须明确写明。说明：1）增加查询分析器解析成本。2）增减字段容易与resu1.tMap配置不一致。3）无用字段增加网络消耗，尤其是text类型的字段。2 .

9、强制】POJO类的布尔属性不能加is,而数据库字段必须加is_,要求在resu1.tMap中进行字段与属性之间的映射。说明：参见定义POJO类以及数据库字段定义规定，在resuhMap中增加映射，是必须的。在MyBa1.iSGenerator生成的代码中，需要进行对应的修改。3 .【强制】不要用resu1.tc1.ass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个POJO类与之对应。说明：配置映射关系，使字段与DO类解耦，方便维护。4 .【强制】Sq1.Xm1.配置参数使用：#,Sparamtf不要使用S此种方式容易出现SQ1.注入。【强制】iB

10、ATIS自带的queryFor1.ist（StringStatementName,intstart,iniSiZe）不推荐使用。说叫：其实现方式是在数据库取到StatementName对应的SQ1.语句的所有记录，再通过sub1.ist取start,size的子集合。正例:Mapmap=newHashMapOO；map.put（wstart,start）；map.put（size,size）；6 .【强制】不允许直接拿HashMap与Hashtab1.e作为查询结果集的输出。说明：resu1.tc1.ass=Hashtab1.e”，会置入字段名和属性值，但是值的类型不可控。7 .【强制】更新数

11、据表记录时，必须同时更新记录对应的gmt_modified字段值为当前时间。8 .【不要写一个大而全的数据更新接口。传入为POJO类，不管是不是自己的目标更新字段,都进行updatetab1.esetc1.=va1.ue1.,c2=va1.ue2,c3=va1.ue3;这是不对的。执行SQ1.时，不要更新无改动的字段，一是易出错；二是效率低；三是增加bin1.og存储。9 .QTransactiona1.事务不要溢用。事务会影响数据库的QPS,另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。10 .【甘考】isEqua1.中的CompareVa1.

12、ue是与属性值对比的常量，一般是数字，表示相等时带上此条件；isNotEmpty表示不为空且不为nu1.1.时执行；isNotNu1.1.表示不为nu1.1.值时执行。六、工程结构（一）应用分层1 .I图中默认上层依赖于下层，箭头关系表示可直接依赖，如：开放接口层可以依赖于WCb层,也可以直接依赖于Service层，依此类推：t据持久区（I）AOK1.开放接口层：可直接封装Service方法暴露成RPC接口；通过Web封装成http接口：进行网关安全控制、流量控制等。终端显示层：各个端的模板渲染并执行显示的层。当前主要是ve1.ocity渲染，JS演染，JSP渲染，移动端展示等。Wcb层：主要

13、是对访问控制进行转发，各类基本参数校跄，或者不复用的业务简单处理等。Service层：相对具体的业务逻辑服务层。Manager层：通用业务处理层，它有如下特征：1）对第三方平台封装的层，预处理返回结果及转化异常信息。2 )对SerViCe层通用能力的下沉，如缓存方案、中间件通用处理。3 )与DAO层交互，对多个D0的组合复用。DAO层:数据访问层，与底层MySQ1.,Orac1.e,Hbase等进行数据交互。外部接口或第三方平台：包括其它部门RPC开放接口，基础平台，其它公司的HTTP接H。4 .【参考】(分层异常处理规约)在DAO层，产生的异常类型有很多，无法用细粒度的异常进行catch,使

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

15、息。开放接口层要将异常处理成错误码和错误信息方式返回。5 .【参考】分层领域模型规约：DO(DataObject)：此对象与数据库表结构对应，通过DAO层向上传输数据源对象。DTO(DataTransferObject)：数据传输对象，Service或Manager向外传输的对象。BO(BusinessObject)：业务对象，由Service层输出的封装业务逻辑的对象。AO(App1.icationObject)：应用对象，在Web层与SerViCe层之间抽象的复用对象模型，极为贴近展示层，复用度不高。VO(ViewObject)：显示层对象，通常是Web向模板渲染引擎层传输的对象。Quer

16、y：数据查询对象，各层接收上层的查询请求。注意超过2个参数的查询封装，禁止使用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/jstor1

17、1-too1.3） Version：详细规定参考下方。2 .【强制】二方库版本号命名方式：主版本号.次版本号.修订号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

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

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

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

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

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

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

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

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

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

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