阿里巴巴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,如需转载请自行联系原作者

相关文章
|
3月前
|
Java API Maven
如何使用Java开发抖音API接口?
在数字化时代,社交媒体平台如抖音成为生活的重要部分。本文详细介绍了如何用Java开发抖音API接口,从创建开发者账号、申请API权限、准备开发环境,到编写代码、测试运行及注意事项,全面覆盖了整个开发流程。
527 10
|
3月前
|
监控 Java API
如何使用Java语言快速开发一套智慧工地系统
使用Java开发智慧工地系统,采用Spring Cloud微服务架构和前后端分离设计,结合MySQL、MongoDB数据库及RESTful API,集成人脸识别、视频监控、设备与环境监测等功能模块,运用Spark/Flink处理大数据,ECharts/AntV G2实现数据可视化,确保系统安全与性能,采用敏捷开发模式,提供详尽文档与用户培训,支持云部署与容器化管理,快速构建高效、灵活的智慧工地解决方案。
|
2天前
|
JavaScript 安全 Java
智慧产科一体化管理平台源码,基于Java,Vue,ElementUI技术开发,二开快捷
智慧产科一体化管理平台覆盖从备孕到产后42天的全流程管理,构建科室协同、医患沟通及智能设备互联平台。通过移动端扫码建卡、自助报道、智能采集数据等手段优化就诊流程,提升孕妇就诊体验,并实现高危孕产妇五色管理和孕妇学校三位一体化管理,全面提升妇幼健康宣教质量。
28 12
|
25天前
|
前端开发 Java 程序员
菜鸟之路day02-04拼图小游戏开发一一JAVA基础综合项目
本项目基于黑马程序员教程,涵盖面向对象进阶、继承、多态等知识,历时约24小时完成。项目去除了登录和注册模块,专注于单机游戏体验。使用Git进行版本管理,代码托管于Gitee。项目包含窗体搭建、事件监听、图片加载与打乱、交互逻辑实现、菜单功能及美化界面等内容。通过此项目,巩固了Java基础并提升了实际开发能力。 仓库地址:[https://gitee.com/zhang-tenglan/puzzlegame.git](https://gitee.com/zhang-tenglan/puzzlegame.git)
42 6
|
28天前
|
Java 应用服务中间件 API
【潜意识Java】javaee中的SpringBoot在Java 开发中的应用与详细分析
本文介绍了 Spring Boot 的核心概念和使用场景,并通过一个实战项目演示了如何构建一个简单的 RESTful API。
38 5
|
28天前
|
前端开发 Java 数据库连接
【潜意识Java】深度解读JavaWeb开发在Java学习中的重要性
深度解读JavaWeb开发在Java学习中的重要性
29 4
|
28天前
|
SQL Java API
|
29天前
|
前端开发 Java 数据库连接
Java后端开发-使用springboot进行Mybatis连接数据库步骤
本文介绍了使用Java和IDEA进行数据库操作的详细步骤,涵盖从数据库准备到测试类编写及运行的全过程。主要内容包括: 1. **数据库准备**:创建数据库和表。 2. **查询数据库**:验证数据库是否可用。 3. **IDEA代码配置**:构建实体类并配置数据库连接。 4. **测试类编写**:编写并运行测试类以确保一切正常。
52 2
|
2月前
|
移动开发 前端开发 Java
Java最新图形化界面开发技术——JavaFx教程(含UI控件用法介绍、属性绑定、事件监听、FXML)
JavaFX是Java的下一代图形用户界面工具包。JavaFX是一组图形和媒体API,我们可以用它们来创建和部署富客户端应用程序。 JavaFX允许开发人员快速构建丰富的跨平台应用程序,允许开发人员在单个编程接口中组合图形,动画和UI控件。本文详细介绍了JavaFx的常见用法,相信读完本教程你一定有所收获!
1338 1
Java最新图形化界面开发技术——JavaFx教程(含UI控件用法介绍、属性绑定、事件监听、FXML)
|
1月前
|
监控 JavaScript 数据可视化
建筑施工一体化信息管理平台源码,支持微服务架构,采用Java、Spring Cloud、Vue等技术开发。
智慧工地云平台是专为建筑施工领域打造的一体化信息管理平台,利用大数据、云计算、物联网等技术,实现施工区域各系统数据汇总与可视化管理。平台涵盖人员、设备、物料、环境等关键因素的实时监控与数据分析,提供远程指挥、决策支持等功能,提升工作效率,促进产业信息化发展。系统由PC端、APP移动端及项目、监管、数据屏三大平台组成,支持微服务架构,采用Java、Spring Cloud、Vue等技术开发。