阿里巴巴Java开发手册

简介:

一,命名风格

1,(强制)类的命名使用驼峰命名,DO(表名的数据对象),DTO(页面数据传输对象),VO(展示对象),可以以上的结尾,可以不遵守驼峰规则。(POJO是以上的统称)

2,(强制)抽象类使用Abstract开头,异常类使用Exception结尾,测试类使用Test结尾,枚举类使用Enum结尾。

3,(强制)所有的布尔类型的变量,都不加is,否则某些框架会有序列化的错误。

4,(强制)包名统一使用小写,包名使用单数形式。

5,(强制)杜绝不规范的缩写,比如condition简写成condi,降低了可读性。

6,(强制)尽量达到代码字解释目标,不要使用int a这样的变量名

7,(推荐)如果使用了设计模式,可以将设计模式名称放到命名中,增加可读性,比如OrderFactory,ResourceObserver

8,(强制)接口类中的方法,不加任何的修饰符,例如void f();不要public等修饰。

9,(推荐)service/DAO中方法命名规则:获得单个对象使用get前缀,获得多个对象使用list前缀,统计方法使用count前缀,插入的方法使用save/insert做前缀,删除使用remove/delete做前缀,修改使用update做前缀。


二,常量定义

1,(强制)不允许任何未定义的常量出现在代码中,比如未定义的字符串或者数字,“id_”,999等。

2,(强制)长整型的变量使用大写L不适用小写l,避免l和1混淆。比如使用Long a = 2L;不适用Long b = 2l;

3,(推荐)定义变量的类使用五层分开:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

4,(推荐)如果变量值仅在一个范围内变化,且带着名称之外的延伸属性,定义为枚举类型。


三,代码格式

1,(强制)if/for/while/switch/do等关键字和括号之间必须有空格

2,(强制)// 注释之间必须有一个空格

3,(强制)方法参数在定义和传入时,多个参数逗号后边必须加空格。


四,OOP规约

1,(强制)避免通过一个类的对象引用访问此类的静态方法或静态方法,直接用类名来访问

2,(强制)重写的方法都加上@Override

3,(强制)相同参数类型,相同业务含义,才可以使用可变参数,避免使用object做可变参数。

4,(强制)不能使用过时的类和方法,过时的类和方法必须注明替代方法

5,(强制)Object的equals方法容易造成空指针,使用"test".equals(object)不使用object.equals("test")

6,(强制)Integer在-128至127之内和基本数据类型是相同的,Integer的比较必须使用equals比较

7,(强制)所有的POJO,方法的接收参数返回值都是用包装数据类型,局部变量使用基本数据类型。

8,(强制)POJO中不设定任何属性的默认值,可能引起不必要的问题

9,(强制)构造方法中禁止加入任何的业务逻辑,如果有初始化逻辑,请放在init方法中

10,(强制)POJO类必须写toString方法。

15,(推荐)当一个类多个构造方法,或者多个重载方法,必须按顺序放置一起,方便阅读。

16,(推荐)类内的方法定义顺序:公有方法或保护方法>私有方法>getter/setter

17,(推荐)getter/setter中不增加业务逻辑

18,(推荐)慎用Object的clone方法来拷贝对象,因为默认是浅拷贝。



本文转自 斯然在天边 51CTO博客,原文链接:http://blog.51cto.com/13172906/1968953,如需转载请自行联系原作者

相关文章
|
29天前
|
Java
Java开发实现图片URL地址检验,如何编码?
【10月更文挑战第14天】Java开发实现图片URL地址检验,如何编码?
60 4
|
28天前
|
监控 Java 测试技术
Java开发现在比较缺少什么工具?
【10月更文挑战第15天】Java开发现在比较缺少什么工具?
34 1
|
29天前
|
Java
Java开发实现图片地址检验,如果无法找到资源则使用默认图片,如何编码?
【10月更文挑战第14天】Java开发实现图片地址检验,如果无法找到资源则使用默认图片,如何编码?
55 2
|
9天前
|
SQL 安全 Java
安全问题已经成为软件开发中不可忽视的重要议题。对于使用Java语言开发的应用程序来说,安全性更是至关重要
在当今网络环境下,Java应用的安全性至关重要。本文深入探讨了Java安全编程的最佳实践,包括代码审查、输入验证、输出编码、访问控制和加密技术等,帮助开发者构建安全可靠的应用。通过掌握相关技术和工具,开发者可以有效防范安全威胁,确保应用的安全性。
23 4
|
11天前
|
缓存 监控 Java
如何运用JAVA开发API接口?
本文详细介绍了如何使用Java开发API接口,涵盖创建、实现、测试和部署接口的关键步骤。同时,讨论了接口的安全性设计和设计原则,帮助开发者构建高效、安全、易于维护的API接口。
35 4
|
21天前
|
开发框架 JavaScript 前端开发
HarmonyOS UI开发:掌握ArkUI(包括Java UI和JS UI)进行界面开发
【10月更文挑战第22天】随着科技发展,操作系统呈现多元化趋势。华为推出的HarmonyOS以其全场景、多设备特性备受关注。本文介绍HarmonyOS的UI开发框架ArkUI,探讨Java UI和JS UI两种开发方式。Java UI适合复杂界面开发,性能较高;JS UI适合快速开发简单界面,跨平台性好。掌握ArkUI可高效打造符合用户需求的界面。
74 8
|
16天前
|
SQL Java 程序员
倍增 Java 程序员的开发效率
应用计算困境:Java 作为主流开发语言,在数据处理方面存在复杂度高的问题,而 SQL 虽然简洁但受限于数据库架构。SPL(Structured Process Language)是一种纯 Java 开发的数据处理语言,结合了 Java 的架构灵活性和 SQL 的简洁性。SPL 提供简洁的语法、完善的计算能力、高效的 IDE、大数据支持、与 Java 应用无缝集成以及开放性和热切换特性,能够大幅提升开发效率和性能。
|
17天前
|
存储 Java 关系型数据库
在Java开发中,数据库连接是应用与数据交互的关键环节。本文通过案例分析,深入探讨Java连接池的原理与最佳实践
在Java开发中,数据库连接是应用与数据交互的关键环节。本文通过案例分析,深入探讨Java连接池的原理与最佳实践,包括连接创建、分配、复用和释放等操作,并通过电商应用实例展示了如何选择合适的连接池库(如HikariCP)和配置参数,实现高效、稳定的数据库连接管理。
34 2
|
17天前
|
监控 Java 数据库连接
在Java开发中,数据库连接管理是关键问题之一
在Java开发中,数据库连接管理是关键问题之一。本文介绍了连接池技术如何通过预创建和管理数据库连接,提高数据库操作的性能和稳定性,减少资源消耗,并简化连接管理。通过示例代码展示了HikariCP连接池的实际应用。
18 1
|
25天前
|
Java 大数据 API
别死脑筋,赶紧学起来!Java之Steam() API 常用方法使用,让开发简单起来!
分享Java Stream API的常用方法,让开发更简单。涵盖filter、map、sorted等操作,提高代码效率与可读性。关注公众号,了解更多技术内容。