没有合适的资源?快使用搜索试试~ 我知道了~
阿里巴巴java开发手册1.5-自己批注
需积分: 5 0 下载量 115 浏览量
2023-11-29
15:26:44
上传
评论
收藏 478KB DOCX 举报
温馨提示
试读
97页
(一) 命名风格 1.【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。 反例:_name / __name / $name / name_ / name$ / name__ 解释:有很多开源代码是下划线开头,比如我们要讲的eureka源码中,我们可以不吸收这种风格。因为python下划线开头是内部变量,此规定是让其他语言转过来的开发者更容易理解。 2.【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,纯拼音命名方式更要避免采用。 正例:renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。 反例:DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3 解释:中国在世界上影响力增大了,但还是不建议用拼音或中文,中文有同音字,汉字会有编码问题,Pingfen:评分,平分。 3.【强制】类名使用 UpperCamelCase 风格,但
资源推荐
资源详情
资源评论
一、编程规约
(一) 命名风格
1. 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美
元符号结束。
反例:_name / __name / $name / name_ / name$ / name__
解释:有很多开源代码是下划线开头,比如我们要讲的 eureka 源码中,我们
可以不吸收这种风格。因为 python 下划线开头是内部变量,此规定是让其他
语言转过来的开发者更容易理解。
2. 【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中
文的方式。
说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,纯拼
音命名方式更要避免采用。
正例:renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称
,可视同英文。
反例:DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量
= 3
解释:中国在世界上影响力增大了,但还是不建议用拼音或中文,中文有同音
字,汉字会有编码问题,Pingfen:评分,平分。
3. 【强制】类名使用 UpperCamelCase 风格,但以下情形例外:DO / BO /
DTO / VO / AO / PO / UID 等。
正例:JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal /
TaPromotion
反例:javaserverlessplatform / UserDo / XMLService / TCPUDPDeal /
TAPromotion
Ta:谢谢。
解释:DO( Data Object):与数据库表结构一一对应,通过 DAO 层向上传输
数据源对象。
DTO( Data Transfer Object):数据传输对象,Service 或 Manager 向外传
输的对象。
BO( Business Object):业务对象。 由 Service 层输出的封装业务逻辑的对
象。
VO( View Object):显示层对象,通常是 Web 向模板渲染引擎层传输的对
象。
AO (Application Object) :应用对象,在 Web 层与 Service 层之间抽象的复用对
象模型,极为贴近展示层,复用度不高。
POJO 是 DO / DTO / BO / VO 的统称.
4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase
风格,必须遵从驼峰形式。
正例: localValue / getHttpMessage() / inputUserId
5. 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,
不要嫌名字长。
正例:MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
反例:MAX_COUNT / EXPIRED_TIME
6. 【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用
Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。
7. 【强制】类型与中括号紧挨相连来表示数组。
正例:定义整形数组 int[] arrayDemo;
反例:在 main 参数中,使用 String args[]来定义。
解释:便于阅读,一下就知道是数组。国产化标准。像高铁。
8. 【强制】POJO 类中布尔类型变量都不要加 is 前缀,否则部分框架解析会引起
序列化错误。
说明:在本文 MySQL 规约中的建表约定第一条,表达是与否的值采用 is_xxx
的命名方式,所以,需要在<resultMap>设置从 is_xxx 到 xxx 的映射关系。
反例:定义为基本数据类型 Boolean isDeleted 的属性,它的方法也是
isDeleted(),RPC 框架在反向解析的时候,“误以为”对应的属性名称是
deleted,导致属性获取不到,进而抛出异常。
解释:这是开发中的一个坑,如果不知道,这个点,很难发现问题。
debug,com.p3c.controller.ApiTestController,在 postman 中传入
{
"num":1,
"isSuccess":true
}
但是 controller 收到的却是 false;
9. 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包
名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例:应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils(此规则参
考 spring 的框架结构)
10. 【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完
全相同的命名,使可读性降低。
说明:子类、父类成员变量名相同,即使是 public 类型的变量也是能够通过编译
,而局部变量在同一方法内的不同代码块中同名也是合法的,但是要避免使用。对
于非 setter/getter 的参数名称也要避免与成员变量名称相同。
反例:
public class ConfusingName {
public int age;
// 非 setter/getter 的参数名称,不允许与本类成员变量同名
public void getData(String alibaba) {
if(condition) {
final int money = 531;
// ...
}
for (int i = 0; i < 10; i++) {
// 在同一方法体中,不允许与其它代码块中的 money 命名相同
final int money = 615;
// ...
}
}
}
class Son extends ConfusingName {
//允许与父类的成员变量名称相同
public int age;
}
解释:便于阅读。
11. 【强制】杜绝完全不规范的缩写,避免望文不知义。
反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成
condi,此类随意缩写严重降低了代码的可阅读性。
解释:你懂但是别人不懂。
12. 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量
完整的单词组合来表达其意。
正例:在 JDK 中,表达原子更新的类名为:AtomicReferenceFieldUpdater。
反例:int a 的随意命名方式。
13. 【推荐】在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度。
正例:startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例:startedAt / QueueOfWork / listName /
COUNT_TERMINATED_THREAD
解释:没有原因,正常些思考。
14. 【推荐】如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模
式。
说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。
正例:
public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
15. 【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持
代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果
一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。
剩余96页未读,继续阅读
资源评论
不走小道
- 粉丝: 3206
- 资源: 5122
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功