阿里巴巴Java开发手册:命名规约详解
5星 · 超过95%的资源 需积分: 0 87 浏览量
更新于2024-07-20
收藏 627KB PDF 举报
"阿里巴巴JAVA开发文档"
阿里巴巴Java开发手册是一份详尽的编程规约,旨在提高代码质量和团队协作效率。这份文档由阿里巴巴集团技术部于2016年12月7日首次公开,适用于整个Java业界。手册主要包括编程规约、异常处理规约、控制结构规约、注释规约、编码规约、设计规约等多个方面。
在命名规约中,有以下几个核心要点:
1. 不允许以下划线或美元符号开头或结束命名,以避免不必要的混淆。例如,`_name`、`__name`、`$Object`、`name_`、`name$/Object$`都是不推荐的命名方式。
2. 禁止使用拼音与英文混合的方式命名,更不允许直接使用中文。提倡使用正确的英文拼写和语法,以增加可读性。例如,`DaZhePromotion`、`getPingfenByName`、`变量=3`是反例,而`ali`、`alibaba`、`taobao`等国际通用的名称被视为英文。
3. 类名应遵循UpperCamelCase风格,但领域模型相关命名如DO(Data Object)、DTO(Data Transfer Object)、VO(View Object)、DAO(Data Access Object)等例外。例如,`MarcoPolo`、`UserDO`、`XmlService`是正例,而`macroPolo`、`UserDo`、`XMLService`是反例。
4. 方法名、参数名、成员变量、局部变量都应使用lowerCamelCase风格,如`localValue`、`getHttpMessage`、`inputUserId`。
5. 常量命名应全大写,并使用下划线分隔单词,确保语义清晰,例如`MAX_STOCK_COUNT`,而`MAX_COUNT`是反例。
6. 抽象类命名建议以`Abstract`或`Base`开头,异常类以`Exception`结尾,测试类以其要测试的类名开始,以`Test`结尾。例如,`AbstractClass`、`MyException`、`MyClassTest`。
7. 数组定义时,中括号被视为数组类型的一部分,如`String[] args`,不应使用`String args[]`的方式定义。
8. POJO类(Plain Old Java Object)中的布尔型变量不应以`is`开头,因为这可能导致某些框架在序列化时出错。例如,`boolean isSuccess`是反例,应改为`boolean success`。
以上仅为部分编程规约内容,完整的文档还包括更多细节,如异常处理、控制结构、注释、编码和设计原则等,这些都对提升代码质量、可维护性和团队合作效率至关重要。遵循这些规约,可以减少代码中的误解和错误,增强代码的一致性和可读性。
2019-04-02 上传
点击了解资源详情
点击了解资源详情
2023-09-08 上传
2023-07-03 上传
2023-08-21 上传
2023-05-05 上传
东炫元芳
- 粉丝: 1
- 资源: 8
最新资源
- 计算机人脸表情动画技术发展综述
- 关系数据库的关键字搜索技术综述:模型、架构与未来趋势
- 迭代自适应逆滤波在语音情感识别中的应用
- 概念知识树在旅游领域智能分析中的应用
- 构建is-a层次与OWL本体集成:理论与算法
- 基于语义元的相似度计算方法研究:改进与有效性验证
- 网格梯度多密度聚类算法:去噪与高效聚类
- 网格服务工作流动态调度算法PGSWA研究
- 突发事件连锁反应网络模型与应急预警分析
- BA网络上的病毒营销与网站推广仿真研究
- 离散HSMM故障预测模型:有效提升系统状态预测
- 煤矿安全评价:信息融合与可拓理论的应用
- 多维度Petri网工作流模型MD_WFN:统一建模与应用研究
- 面向过程追踪的知识安全描述方法
- 基于收益的软件过程资源调度优化策略
- 多核环境下基于数据流Java的Web服务器优化实现提升性能