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

相关文章

Python实例题之pygame开发打飞机游戏实例代码

《Python实例题之pygame开发打飞机游戏实例代码》对于python的学习者,能够写出一个飞机大战的程序代码,是不是感觉到非常的开心,:本文主要介绍Python实例题之pygame开发打飞机... 目录题目pygame-aircraft-game使用 Pygame 开发的打飞机游戏脚本代码解释初始化部

C++ 函数 strftime 和时间格式示例详解

《C++函数strftime和时间格式示例详解》strftime是C/C++标准库中用于格式化日期和时间的函数,定义在ctime头文件中,它将tm结构体中的时间信息转换为指定格式的字符串,是处理... 目录C++ 函数 strftipythonme 详解一、函数原型二、功能描述三、格式字符串说明四、返回值五

使用Python开发一个现代化屏幕取色器

《使用Python开发一个现代化屏幕取色器》在UI设计、网页开发等场景中,颜色拾取是高频需求,:本文主要介绍如何使用Python开发一个现代化屏幕取色器,有需要的小伙伴可以参考一下... 目录一、项目概述二、核心功能解析2.1 实时颜色追踪2.2 智能颜色显示三、效果展示四、实现步骤详解4.1 环境配置4.

Java中Map.Entry()含义及方法使用代码

《Java中Map.Entry()含义及方法使用代码》:本文主要介绍Java中Map.Entry()含义及方法使用的相关资料,Map.Entry是Java中Map的静态内部接口,用于表示键值对,其... 目录前言 Map.Entry作用核心方法常见使用场景1. 遍历 Map 的所有键值对2. 直接修改 Ma

Python使用smtplib库开发一个邮件自动发送工具

《Python使用smtplib库开发一个邮件自动发送工具》在现代软件开发中,自动化邮件发送是一个非常实用的功能,无论是系统通知、营销邮件、还是日常工作报告,Python的smtplib库都能帮助我们... 目录代码实现与知识点解析1. 导入必要的库2. 配置邮件服务器参数3. 创建邮件发送类4. 实现邮件

C#实现将Office文档(Word/Excel/PDF/PPT)转为Markdown格式

《C#实现将Office文档(Word/Excel/PDF/PPT)转为Markdown格式》Markdown凭借简洁的语法、优良的可读性,以及对版本控制系统的高度兼容性,逐渐成为最受欢迎的文档格式... 目录为什么要将文档转换为 Markdown 格式使用工具将 Word 文档转换为 Markdown(.

Java中JSON格式反序列化为Map且保证存取顺序一致的问题

《Java中JSON格式反序列化为Map且保证存取顺序一致的问题》:本文主要介绍Java中JSON格式反序列化为Map且保证存取顺序一致的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未... 目录背景问题解决方法总结背景做项目涉及两个微服务之间传数据时,需要提供方将Map类型的数据序列化为co

详解如何使用Python构建从数据到文档的自动化工作流

《详解如何使用Python构建从数据到文档的自动化工作流》这篇文章将通过真实工作场景拆解,为大家展示如何用Python构建自动化工作流,让工具代替人力完成这些数字苦力活,感兴趣的小伙伴可以跟随小编一起... 目录一、Excel处理:从数据搬运工到智能分析师二、PDF处理:文档工厂的智能生产线三、邮件自动化:

深入解析 Java Future 类及代码示例

《深入解析JavaFuture类及代码示例》JavaFuture是java.util.concurrent包中用于表示异步计算结果的核心接口,下面给大家介绍JavaFuture类及实例代码,感兴... 目录一、Future 类概述二、核心工作机制代码示例执行流程2. 状态机模型3. 核心方法解析行为总结:三

Nacos注册中心和配置中心的底层原理全面解读

《Nacos注册中心和配置中心的底层原理全面解读》:本文主要介绍Nacos注册中心和配置中心的底层原理的全面解读,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录临时实例和永久实例为什么 Nacos 要将服务实例分为临时实例和永久实例?1.x 版本和2.x版本的区别