阿里巴巴开发规范文档解读(二):常量定义、代码格式、OOP规约

本文主要是介绍阿里巴巴开发规范文档解读(二):常量定义、代码格式、OOP规约,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

与第一部分相比,这部分有较少的个人见解,算是开发文档的阉割版,整理了一些需要使用到的规范,放弃了一些常用、熟悉的规范。

二、常量定义

1.不允许任何魔法数值(未经预先定义的常量)出现在代码中
反例 ; int priceTable[] = new int[16]; //ERROR:这个16究竟有何含义呢?
正例 : static final int PRICE_TABLE_MAX = 16; //带名字int price Table[] = new int [PRICE_TABLE_MAX]; //名字的含义是很清楚的
2.不要使用一个大而全的常量维护所有常量,按常量的功能进行归类,分开维护。
例如:连接mongo数据库使用的连接名、字段名等使用一个 MongoDBConstants对于异常报的各种错误码可使用 ExceptionConstants

三、代码格式

1.if、for、switch、do、while等保留字与括号之间必须加空格
反例:if(a > 9)...
正例:if (a > 9)...
2.注释的双斜线与注释之间有且仅有一个空格
正例:
// 这是示例注释,请注意在双斜线之后有一个空格
String cs = "";
3.不同逻辑、不同语义、不同业务的代码之间插入一个空格分开来以提升可读性,没有必要查多行空格

四、OOP规约

1.避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可。
解读:如果使用一个类(类名为B)的静态方法(public static methodA()),直接使用B.methodB()即可,而不是使用 B b = new B(); b.methodB();
2.方法覆写使用@Override注解
例:impl实现Service,所有方法都使用@Override注解
3.可变参数:必须放在参数列表最后
例: public User getUsers(String type, Integer... ids)
4.接口过时必须加@Deprecated注解,并说明新服务是什么
5.基本数据类型和包装类型
i.所有POJO类属性必须使用包装数据类型
ii.RPC方法的返回值必须使用包装数据类型
iii.所有的局部变量使用基本数据类型
6.序列化类新增属性时,请不要修改serialVersionUID字段,避免反序列失败
7.构造方法里边禁止加入任何业务逻辑,如果有初始化逻辑,放在init方法中
8.POJO类必须写toString方法。因为现在都引用了lombok,可以使用@ToString注解
9.类内方法定义的顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter方法
10.谨慎使用object的Clone方法
11.类成员与方法访问控制从严:
成员变量:
1) 类非static成员变量并且与子类共享,必须是protected; 类成员变量(static OR 非static)且仅在本类使用,必须是private。
理解:i.这个protected使用场景很少,但是使用出来绝对是亮点。在model中,所有字段都有set、get方法,因此model很少用到protected,且由于封装特性,几乎都是private。ii.例:在一些service中使用mongoDB,是逃不脱使用MongoOperation或者MongoTemplate,因此我们可以在基类中定义 @Autowired private MongoTempate mongoTemplate;
2) 若是static成员变量,必须考虑是否为final。
方法:
3) 如果不允许外部直接通过new来创建对象,那么构造方法必须是private。 
4) 工具类不允许有public或default构造方法i.工具类里面的方法全部都是static的,它的构造方法必须是private的,这样可以通过 类名.方法名 调用方法。ii.使用private修饰构造方法时,这个类不能被实例化(无法通过new或者反射创建对象),也不能被继承,因此避免了创建多余的对象。iii.一般的model是需要使用new来直接创建对象的,因此它的构造方法并不是private的。	
6) 类成员方法只供类内部调用,必须是private。 
7) 类成员方法只对继承类公开,那么限制为protected。

这篇关于阿里巴巴开发规范文档解读(二):常量定义、代码格式、OOP规约的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1005912

相关文章

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

详解C#如何提取PDF文档中的图片

《详解C#如何提取PDF文档中的图片》提取图片可以将这些图像资源进行单独保存,方便后续在不同的项目中使用,下面我们就来看看如何使用C#通过代码从PDF文档中提取图片吧... 当 PDF 文件中包含有价值的图片,如艺术画作、设计素材、报告图表等,提取图片可以将这些图像资源进行单独保存,方便后续在不同的项目中使

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

Spring Boot + MyBatis Plus 高效开发实战从入门到进阶优化(推荐)

《SpringBoot+MyBatisPlus高效开发实战从入门到进阶优化(推荐)》本文将详细介绍SpringBoot+MyBatisPlus的完整开发流程,并深入剖析分页查询、批量操作、动... 目录Spring Boot + MyBATis Plus 高效开发实战:从入门到进阶优化1. MyBatis

Python基于wxPython和FFmpeg开发一个视频标签工具

《Python基于wxPython和FFmpeg开发一个视频标签工具》在当今数字媒体时代,视频内容的管理和标记变得越来越重要,无论是研究人员需要对实验视频进行时间点标记,还是个人用户希望对家庭视频进行... 目录引言1. 应用概述2. 技术栈分析2.1 核心库和模块2.2 wxpython作为GUI选择的优

Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)

《SpringBoot3.4.3基于SpringWebFlux实现SSE功能(代码示例)》SpringBoot3.4.3结合SpringWebFlux实现SSE功能,为实时数据推送提供... 目录1. SSE 简介1.1 什么是 SSE?1.2 SSE 的优点1.3 适用场景2. Spring WebFlu

java之Objects.nonNull用法代码解读

《java之Objects.nonNull用法代码解读》:本文主要介绍java之Objects.nonNull用法代码,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录Java之Objects.nonwww.chinasem.cnNull用法代码Objects.nonN

SpringBoot实现MD5加盐算法的示例代码

《SpringBoot实现MD5加盐算法的示例代码》加盐算法是一种用于增强密码安全性的技术,本文主要介绍了SpringBoot实现MD5加盐算法的示例代码,文中通过示例代码介绍的非常详细,对大家的学习... 目录一、什么是加盐算法二、如何实现加盐算法2.1 加盐算法代码实现2.2 注册页面中进行密码加盐2.