阿里JAVA编码规范手册 下载本文

阿里巴巴 Java开发手册

6.【强制】依赖于一个二方库群时,必须定义一个统一的版本变量,避免版本号不一致。 说明:依赖 springframework-core,-context,-beans,它们都是同一个版本,可以定义一 个变量来保存版本:${spring.version},定义依赖的时候,引用该版本。

7.【强制】禁止在子项目的 pom依赖中出现相同的 GroupId,相同的 ArtifactId,但是不同的

Version。

说明:在本地调试时会使用各子项目指定的版本号,但是合并成一个 war,只能有一个版本号 出现在最后的 lib目录中。可能出现线下调试是正确的,发布到线上却出故障的问题。 8.【推荐】所有 pom文件中的依赖声明放在语句块中,所有版本仲裁放在 语句块中。

说明:里只是声明版本,并不实现引入,因此子项目需要显式的声 明依赖,version和 scope都读取自父 pom。而所有声明在主 pom的 里的依赖都会自动引入,并默认被所有的子项目继承。 9.【推荐】二方库尽量不要有配置项,最低限度不要再增加配置项。

10.【参考】为避免应用二方库的依赖冲突问题,二方库发布者应当遵循以下原则:

1)精简可控原则。移除一切不必要的 API和依赖,只包含 Service API、必要的领域模型对 象、Utils类、常量、枚举等。如果依赖其它二方库,尽量是 provided引入,让二方库使用 者去依赖具体版本号;无 log具体实现,只依赖日志框架。

2)稳定可追溯原则。每个版本的变化应该被记录,二方库由谁维护,源码在哪里,都需要能 方便查到。除非用户主动升级版本,否则公共二方库的行为不应该发生变化。

——禁止用于商业用途,违者必究—— 31 / 37

阿里巴巴 Java开发手册

(三)服务器规约

1.【推荐】高并发服务器建议调小 TCP协议的 time_wait超时时间。

说明:操作系统默认 240秒后,才会关闭处于 time_wait状态的连接,在高并发访问下,服 务器端会因为处于 time_wait的连接数太多,可能无法建立新的连接,所以需要在服务器上 调小此等待值。

正例:在 linux服务器上请通过变更/etc/sysctl.conf文件去修改该缺省值(秒):

net.ipv4.tcp_fin_timeout = 30

2.【推荐】调大服务器所支持的最大文件句柄数(File Descriptor,简写为 fd)。

说明:主流操作系统的设计是将 TCP/UDP连接采用与文件一样的方式去管理,即一个连接对 应于一个 fd。主流的 linux服务器默认所支持最大 fd数量为 1024,当并发连接数很大时很 容易因为 fd不足而出现“opentoomanyfiles”错误,导致新的连接无法建立。 建议将 linux 服务器所支持的最大句柄数调高数倍(与服务器的内存数量相关)。

3.【推荐】给 JVM设置-XX:+HeapDumpOnOutOfMemoryError参数,让 JVM碰到 OOM场景时输出

dump信息。

说明:OOM的发生是有概率的,甚至有规律地相隔数月才出现一例,出现时的现场信息对查错 非常有价值。

4.【参考】服务器内部重定向使用 forward;外部重定向地址使用 URL拼装工具类来生成,否则 会带来 URL维护不一致的问题和潜在的安全风险。

——禁止用于商业用途,违者必究—— 32 / 37

阿里巴巴 Java开发手册

五、安全规约

1.【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。

说明:防止没有做水平权限校验就可随意访问、修改、删除别人的数据,比如查看他人的私信 内容、修改他人的订单。

2.【强制】用户敏感数据禁止直接展示,必须对展示数据脱敏。

说明:查看个人手机号码会显示成:158****9119,隐藏中间 4位,防止隐私泄露。

3.【强制】用户输入的 SQL参数严格使用参数绑定或者 METADATA字段值限定,防止 SQL注入, 禁止字符串拼接 SQL访问数据库。

4.【强制】用户请求传入的任何参数必须做有效性验证。 说明:忽略参数校验可能导致:

? page size过大导致内存溢出 ? ?

恶意 order by导致数据库慢查询 任意重定向

? SQL注入 ? ?

反序列化注入

正则输入源串拒绝服务 ReDoS

说明:Java 代码用正则来验证客户端的输入,有些正则写法验证普通用户输入没有问题, 但是如果攻击人员使用的是特殊构造的字符串来验证,有可能导致死循环的结果。 5.【强制】禁止向 HTML页面输出未经安全过滤或未正确转义的用户数据。 6.【强制】表单、AJAX提交必须执行 CSRF安全过滤。

说明:CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在

CSRF漏洞的应用/网站,攻击者可以事先构造好 URL,只要受害者用户一访问,后台便在用户

不知情情况下对数据库中用户参数进行相应修改。

7.【强制】在使用平台资源,譬如短信、邮件、电话、下单、支付,必须实现正确的防重放限制, 如数量限制、疲劳度控制、验证码校验,避免被滥刷、资损。

说明:如注册时发送验证码到手机,如果没有限制次数和频率,那么可以利用此功能骚扰到其 它用户,并造成短信平台资源浪费。

8.【推荐】发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过 滤等风控策略。

——禁止用于商业用途,违者必究—— 33 / 37

阿里巴巴 Java开发手册

附 1:版本历史

版本号 1.0.0 1.0.1

更新日期 2017.2.9 2017.2.13

阿里巴巴正式对外发布

备注

1)修正 String[]的前后矛盾。2)vm修正成 velocity。3)修正 countdown描述错误。 1)去除文底水印。2)数据类型中引用太阳系年龄问题。3)修正关于异常和方法签名的部

1.0.2 2017.2.20

分描述。4)修正 final描述。5)去除 Comparator部分描述。

1.1.0 2017.2.27

1)增加前言。2)增加描述和说明。3)增加版本历史。4)增加专有名词 解释。

附 2:本规约专有名词

1.POJO(Plain Ordinary Java Object):在本规约中,POJO专指只有 setter/getter/toString的简单类,包括 DO/DTO/BO/VO等。 2.DO(Data Object):本手册指数据库表一一对应的 POJO类。

3.GAV(GroupId、ArtifactctId、Version):Maven坐标,是用来唯一标识 jar包。 4.OOP(Object Oriented Programming): 本手册泛指类、对象的编程处理方式。

5.ORM(Object Relation Mapping): 对象关系映射,对象领域模型与底层数据之间的转换, 本文泛指 iBATIS, mybatis等框架。

6.NPE(java.lang.NullPointerException): 空指针异常。 7.一方库:本工程内部子项目模块依赖的库(jar包)。

8.二方库:公司内部发布到中央仓库,可供公司内部依赖的库(jar包)。 9.三方库:公司之外的开源的依赖库(jar包)。

附 3:法律声明

本手册为阿里巴巴集团技术部的技术分享,版权归阿里巴巴集团所有,仅供大家交流、学习及研究 使用,禁止用于商业用途,违者必究。

——禁止用于商业用途,违者必究—— 34 / 37