编码规范
衣舞晨风
不预测,只应对
展开
-
《阿里巴巴Java开发手册(正式版)》--编程规约
(一)命名规约1.【强制】 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。 反例: _name / __name / Object/name/nameObject / name_ / name / Object$ 2.【强制】 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯原创 2017-02-21 11:24:52 · 1739 阅读 · 0 评论 -
《阿里巴巴Java开发手册(正式版)》--异常日志
(一)异常处理1.【强制】不要捕获 Java类库中定义的继承自 RuntimeException的运行时异常类,如:IndexOutOfBoundsException / NullPointerException,这类异常由程序员预检查来规避,保证程序健壮性。 正例:if (obj != null) {...}反例:try { obj.method()} catch(NullPoint原创 2017-02-21 11:45:43 · 1190 阅读 · 0 评论 -
《阿里巴巴Java开发手册(正式版)》--MySQL规约
(一)建表规约1.【强制】表达是与否概念的字段,必须使用 is_xxx的方式命名,数据类型是 unsigned tinyint( 1表示是,0表示否),此规则同样适用于 odps建表。 说明:任何字段如果为非负数,必须是 unsigned。 2.【强制】表名、字段名必须使用小写字母或数字;禁止出现数字开头,禁止两个下划线中间只出现数字。数据库字段名的修改代价很大,因为无法进行预发布,所以字段名称原创 2017-02-21 11:55:06 · 13776 阅读 · 8 评论 -
《阿里巴巴Java开发手册(正式版)》--工程规约
(一)应用分层1.【推荐】图中默认上层依赖于下层,箭头关系表示可直接依赖,如:开放接口层可以依赖于Web层,也可以直接依赖于 Service层,依此类推: 开放接口层:可直接封装 Service接口暴露成 RPC接口;通过 Web封装成 http接口;网关控制层等。 终端显示层:各个端的模板渲染并执行显示层。当前主要是 velocity渲染,JS渲染,JSP渲染,移动端展示层等。 • We原创 2017-02-21 12:28:05 · 1283 阅读 · 0 评论 -
《阿里巴巴Java开发手册(正式版)》--安全规约
1.【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。 说明:防止没有做水平权限校验就可随意访问、操作别人的数据,比如查看、修改别人的订单。 2.【强制】用户敏感数据禁止直接展示,必须对展示数据脱敏。 说明:查看个人手机号码会显示成:158****9119,隐藏中间 4位,防止隐私泄露。 3.【强制】用户输入的 SQL参数严格使用参数绑定或者 METADATA字段值限定,防止 SQL原创 2017-02-21 12:30:38 · 1887 阅读 · 0 评论 -
RESTful API 设计指南
一、协议API与用户的通信协议,总是使用HTTPs协议。二、域名应该尽量将API部署在专用域名之下。https://api.example.com如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。https://example.org/api/三、版本(Versioning)应该将API的版本号放入URL。https://api....转载 2018-02-10 11:41:30 · 439 阅读 · 0 评论 -
RESTful API 末尾斜杠
默认情况下,请求末尾的斜杠,在服务端处理的情况是不确定的(如果用到了框架,框架对于/的处理也是不确定的),所以在请求的时候,api末尾不应该带有/。比如在iris框架中:POST http://localhost:8080/v1/projects/PUT http://localhost:8080/v1/proj...原创 2018-03-01 08:38:17 · 3106 阅读 · 0 评论