阿里巴巴开发规范文档解读(二):常量定义、代码格式、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

相关文章

Linux jq命令的使用解读

《Linuxjq命令的使用解读》jq是一个强大的命令行工具,用于处理JSON数据,它可以用来查看、过滤、修改、格式化JSON数据,通过使用各种选项和过滤器,可以实现复杂的JSON处理任务... 目录一. 简介二. 选项2.1.2.2-c2.3-r2.4-R三. 字段提取3.1 普通字段3.2 数组字段四.

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,:本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D

基于Python开发Windows自动更新控制工具

《基于Python开发Windows自动更新控制工具》在当今数字化时代,操作系统更新已成为计算机维护的重要组成部分,本文介绍一款基于Python和PyQt5的Windows自动更新控制工具,有需要的可... 目录设计原理与技术实现系统架构概述数学建模工具界面完整代码实现技术深度分析多层级控制理论服务层控制注

Java集合之Iterator迭代器实现代码解析

《Java集合之Iterator迭代器实现代码解析》迭代器Iterator是Java集合框架中的一个核心接口,位于java.util包下,它定义了一种标准的元素访问机制,为各种集合类型提供了一种统一的... 目录一、什么是Iterator二、Iterator的核心方法三、基本使用示例四、Iterator的工

Java 线程池+分布式实现代码

《Java线程池+分布式实现代码》在Java开发中,池通过预先创建并管理一定数量的资源,避免频繁创建和销毁资源带来的性能开销,从而提高系统效率,:本文主要介绍Java线程池+分布式实现代码,需要... 目录1. 线程池1.1 自定义线程池实现1.1.1 线程池核心1.1.2 代码示例1.2 总结流程2. J

使用EasyPoi快速导出Word文档功能的实现步骤

《使用EasyPoi快速导出Word文档功能的实现步骤》EasyPoi是一个基于ApachePOI的开源Java工具库,旨在简化Excel和Word文档的操作,本文将详细介绍如何使用EasyPoi快速... 目录一、准备工作1、引入依赖二、准备好一个word模版文件三、编写导出方法的工具类四、在Export

MySQL之搜索引擎使用解读

《MySQL之搜索引擎使用解读》MySQL存储引擎是数据存储和管理的核心组件,不同引擎(如InnoDB、MyISAM)采用不同机制,InnoDB支持事务与行锁,适合高并发场景;MyISAM不支持事务,... 目录mysql的存储引擎是什么MySQL存储引擎的功能MySQL的存储引擎的分类查看存储引擎1.命令

利用Python操作Word文档页码的实际应用

《利用Python操作Word文档页码的实际应用》在撰写长篇文档时,经常需要将文档分成多个节,每个节都需要单独的页码,下面:本文主要介绍利用Python操作Word文档页码的相关资料,文中通过代码... 目录需求:文档详情:要求:该程序的功能是:总结需求:一次性处理24个文档的页码。文档详情:1、每个

Spring的基础事务注解@Transactional作用解读

《Spring的基础事务注解@Transactional作用解读》文章介绍了Spring框架中的事务管理,核心注解@Transactional用于声明事务,支持传播机制、隔离级别等配置,结合@Tran... 目录一、事务管理基础1.1 Spring事务的核心注解1.2 注解属性详解1.3 实现原理二、事务事

JS纯前端实现浏览器语音播报、朗读功能的完整代码

《JS纯前端实现浏览器语音播报、朗读功能的完整代码》在现代互联网的发展中,语音技术正逐渐成为改变用户体验的重要一环,下面:本文主要介绍JS纯前端实现浏览器语音播报、朗读功能的相关资料,文中通过代码... 目录一、朗读单条文本:① 语音自选参数,按钮控制语音:② 效果图:二、朗读多条文本:① 语音有默认值:②