Java编程规约(OOP)

1、【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析

成本,直接用类名来访问即可。

2、【强制】所有的覆写方法,必须加@Override 注解。

说明:getObject() get0bject()的问题。一个是字母的 O,一个是数字的 0,加@Override 可以准确判

断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错。

3、【强制】相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object

说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)

正例:public List<User> listUsers(String type, Long... ids) {...}

4、【强制】外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产

生影响。接口过时必须加@Deprecated 注解,并清晰地说明采用的新接口或者新服务是什

么。

5、【强制】不能使用过时的类或方法。

说明:java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时,应该使用双参数

decode(String source, String encode)。接口提供方既然明确是过时接口,那么有义务同时提供新的接

口;作为调用方来说,有义务去考证过时方法的新实现是什么。

6、【强制】Object equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用

equals

正例:"test".equals(object);

反例:object.equals("test");

说明:推荐使用 java.util.Objects#equalsJDK7 引入的工具类)。

7、【强制】所有整型包装类对象之间值的比较,全部使用 equals 方法比较。

说明:对于 Integer var = ? -128 127 范围内的赋值,Integer 对象是在 IntegerCache.cache

生,会复用已有对象,这个区间内的 Integer 值可以直接使用==进行判断,但是这个区间之外的所有数

据,都会在堆上产生,并不会复用已有对象,这是一个大坑,推荐使用 equals 方法进行判断。

8、【强制】浮点数之间的等值判断,基本数据类型不能用==来比较,包装数据类型不能用

equals 来判断。

说明:浮点数采用尾数+阶码的编码方式,类似于科学计数法的有效数字+指数的表示方式。二进制无法精确表示大部分的十进制小数。

反例:
float a = 1.0f - 0.9f; float b = 0.9f - 0.8f;
if (a == b) {
// 预期进入此代码快,执行其它业务逻辑 // 但事实上 a==b的结果为 false
}
Float x = Float.valueOf(a); 
Float y = Float.valueOf(b); 
if (x.equals(y)) {
// 预期进入此代码快,执行其它业务逻辑 // 但事实上 equals的结果为 false
}
 

正例:
(1) 指定一个误差范围,两个浮点数的差值在此范围之内,则认为是相等的。
float a = 1.0f - 0.9f; float b = 0.9f - 0.8f; float diff = 1e-6f;
if (Math.abs(a - b) < diff) {
 System.out.println("true"); }
(2) 使用 BigDecimal 来定义值,再进行浮点数的运算操作。
BigDecimal a = new BigDecimal("1.0");

BigDecimal b = new BigDecimal("0.9");

BigDecimal c = new BigDecimal("0.8");
BigDecimal x = a.subtract(b); BigDecimal y = b.subtract(c);
if (x.equals(y)) { }

9、关于基本数据类型与包装数据类型的使用标准如下:

1 【强制】所有的 POJO 类属性必须使用包装数据类型。

2 【强制】RPC 方法的返回值和参数必须使用包装数据类型。

3 【推荐】所有的局部变量使用基本数据类型。

说明:POJO 类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何 NPE 问题,或

者入库检查,都由使用者来保证。

正例:数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE 风险。

反例:比如显示成交总额涨跌情况,即正负 x%x 为基本数据类型,调用的 RPC 服务,调用不成功时,

返回的是默认值,页面显示为 0%,这是不合理的,应该显示成中划线。所以包装数据类型的 null 值,能

够表示额外的信息,如:远程调用失败,异常退出。

10、【强制】定义 DO/DTO/VO POJO 类时,不要设定任何属性默认值

反例:POJO 类的 createTime 默认值为 new Date(),但是这个属性在数据提取时并没有置入具体值,在

更新其它字段时又附带更新了此字段,导致创建时间被修改成当前时间。

11、【强制】序列化类新增属性时,请不要修改 serialVersionUID 字段,避免反序列失败;如果

完全不兼容升级,避免反序列化混乱,那么请修改 serialVersionUID 值。

说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。

12、【强制】构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在 init 方法中。

13、【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具:source> generate toString

时,如果继承了另一个 POJO 类,注意在前面加一下 super.toString

说明:在方法执行抛出异常时,可以直接调用 POJO toString()方法打印其属性值,便于排查问题。

14、【强制】禁止在 POJO 类中,同时存在对应属性 xxx isXxx() getXxx()方法。

说明:框架在调用属性 xxx 的提取方法时,并不能确定哪个方法一定是被优先调用到。

15、【推荐】使用索引访问用 String split 方法得到的数组时,需做最后一个分隔符后有无内

容的检查,否则会有抛 IndexOutOfBoundsException 的风险。

说明:

String str = "a,b,c,,"; String[] ary = str.split(",");

// 预期大于 3,结果是 3 System.out.println(ary.length);

16、【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,

便于阅读,此条规则优先于下一条。

17、【推荐】 类内方法定义的顺序依次是:公有方法或保护方法 > 私有方法 > getter / setter

方法。

说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好;保护方法虽然只是子类关心,也可

能是模板设计模式下的核心方法;而私有方法外部一般不需要特别关心,是一个黑盒实现;因为承载

的信息价值较低,所有 Service DAO getter/setter 方法放在类体最后。

 

18、【推荐】setter 方法中,参数名称与类成员变量名称一致,this.成员名 = 参数名。在

getter/setter 方法中,不要增加业务逻辑,增加排查问题的难度。

反例:

public Integer getData() {

 if (condition) {

return this.data + 100; } else {

 return this.data - 100;

}

}

19、【推荐】循环体内,字符串的连接方式,使用 StringBuilder append 方法进行扩展。

说明:下例中,反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象,然后进行

append 操作,最后通过 toString 方法返回 String 对象,造成内存资源浪费。

反例:

String str = "start";

for (int i = 0; i < 100; i++) {

str = str + "hello"; }

20、【推荐】final 可以声明类、成员变量、方法、以及本地变量,下列情况使用 final 关键字:

1 不允许被继承的类,如:String 类。

2 不允许修改引用的域对象。

3 不允许被覆写的方法,如:POJO 类的 setter 方法。

4 不允许运行过程中重新赋值的局部变量。

5 避免上下文重复使用一个变量,使用 final 可以强制重新定义一个变量,方便更好地进行重构。

21、【推荐】慎用 Object clone 方法来拷贝对象。

说明:对象 clone 方法默认是浅拷贝,若想实现深拷贝需覆写 clone 方法实现域对象的深度遍历式拷贝。

22、【推荐】类成员与方法访问控制从严:

1 如果不允许外部直接通过 new 来创建对象,那么构造方法必须是 private

2 工具类不允许有 public default 构造方法。

3 类非 static 成员变量并且与子类共享,必须是 protected

4 类非 static 成员变量并且仅在本类使用,必须是 private

5 static 成员变量如果仅在本类使用,必须是 private

6 若是 static 成员变量,考虑是否为 final

7 类成员方法只供类内部调用,必须是 private

8 类成员方法只对继承类公开,那么限制为 protected

说明:任何类、方法、参数、变量,严控访问范围。过于宽泛的访问范围,不利于模块解耦。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/445301.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

深度学习(07)-- 经典CNN网络结构(Inception (v1-v4))

文章目录目录1.Inception介绍1.1 Inception结构1.2 Inception V1(GoogleNet)1.3 Inception V2(Batch Norm)1.4 Inception V3&#xff08;Factorization&#xff09;1.5 Inception V4&#xff08;ResNet&#xff09;1.5 Inception v1~v4 总结1.6 Inception进阶2.Inception实现目…

Python(13)-函数,lambda语句

函数1 函数定义2 函数调用3 函数注释文档4 函数参数4.1 参数列表,默认参数,任意参数4.1.1 无缺省值参数4.1.2&#xff08;部分&#xff09;缺省值参数4.1.3 数量不定形参数4.2 可变对象和不可变对象4.3 作用域4.3.1 globals()函数4.3.2 global 声明变量为全局变量5 函数返回值5…

深度学习(08)-- Residual Network (ResNet)

文章目录目录1.残差网络基础1.1基本概念1.2VGG19、ResNet34结构图1.3 梯度弥散和网络退化1.4 残差块变体1.5 ResNet模型变体1.6 Residual Network补充1.7 1*1卷积核&#xff08;补充&#xff09;2.残差网络介绍&#xff08;何凯明&#xff09;3.ResNet-50(Ng)3.1 非常深的神经网…

Python(14)-模块

模块Python标准库&#xff0c;第三方库都是一个个模块&#xff0c;我们还可以编写自己的模块。模块python程序架构的核心模块&#xff0c;模块是一个工具包。 每一个以.py为扩展名的源代码文件都是一个模块。 想要使用工具包中的工具&#xff0c;可以使用Import的方式导入。 …

redis——命令请求的执行过程

发送命令请求 当用户在客户端中键入一个命令请求时&#xff0c; 客户端会将这个命令请求转换成协议格式&#xff0c; 然后通过连接到服务器的套接字&#xff0c; 将协议格式的命令请求发送给服务器。 读取命令请求 当客户端与服务器之间的连接套接字因为客户端的写入而变得可…

深度学习(09)-- DenseNet

文章目录目录1.DenseNet网络结构2.稠密连接及其优点3.代码实现4.补充说明目录 1.DenseNet网络结构 2.稠密连接及其优点 每层以之前层的输出为输入&#xff0c;对于有L层的传统网络&#xff0c;一共有L个连接&#xff0c;对于DenseNet&#xff0c;则有L*(L1)/2。 这篇论文主要…

redis——缓存击穿/穿透/雪崩

缓存穿透 一般的缓存系统&#xff0c;都是按照key去缓存查询&#xff0c;如果不存在对应的value&#xff0c;就去后端系统查找&#xff08;比如DB&#xff09;。 一些恶意的请求会故意查询不存在的key,请求量很大&#xff0c;就会对后端系统造成很大的压力。这就叫做缓存穿透…

python(15)-window7配置iPython

前提&#xff1a;安装了Pythonanaconda anaconda安装参考&#xff1a;https://www.zhihu.com/question/58033789 在window系统下可以使用两种方法来实现类似与于Linux终端命令运行程序的方法&#xff08;推荐方式2&#xff09;: 1.cmd:自己没有操作过&#xff0c;可以参考下面…

深度学习(10)-- Capsules Networks(CapsNet)

版权声明&#xff1a;本文为博主原创文章&#xff0c;未经博主允许不得转载。 https://blog.csdn.net/malele4th/article/details/79430464 </div><div id"content_views" class"markdown_views"><!-- flowchart 箭头图标 勿删 --&g…

手把手maven的功能/安装/使用/idea集成

看这篇文章不用着急安装&#xff0c;跟着步骤一定会成功&#xff0c;要理解maven是什么&#xff0c;如何使用。 介绍 maven官网 对于一个小白来说&#xff0c;官网有用的信息就是这些 不管如何介绍maven&#xff0c;作为使用者来说&#xff0c;主要感觉两个方面有帮助&#x…

python(16)-列表list,for循环

高级数据类型--列表1列表定义2列表中取值3列表的增&#xff0c;删&#xff0c;查&#xff0c;改3.1修改指定位置的数据3.2确定指定元素的索引3.3增加操作3.4删除操作3.5 元素是否存在与列表中 in3.6在指定索引位置插入元素4列表的数据统计5列表排序6列表的循环遍历-for7多维度l…

深度学习(11)-- GAN

TensorFlow &#xff08;GAN&#xff09; 目录 TensorFlow &#xff08;GAN&#xff09;目录1、GAN1.1 常见神经网络形式1.2 生成网络1.3 新手画家 & 新手鉴赏家1.4 GAN网络1.5 例子 1、GAN 今天我们会来说说现在最流行的一种生成网络, 叫做 GAN, 又称生成对抗网络, 也…

Python外(1)--try-expect

语法&#xff1a; try:正常情况下执行的代码块 expect 错误类型1:&#xff08;可选&#xff09;错误类型1对应的处理方案 expect 错误类型2:&#xff08;可选&#xff09;错误类型2对应的处理方案 expect:剩下的错误类型对应的处理方案 else:&#xff08;可选&#xff09;没有…

redis——数据结构和对象的使用介绍

redis官网 微软写的windows下的redis 我们下载第一个 额案后基本一路默认就行了 安装后&#xff0c;服务自动启动&#xff0c;以后也不用自动启动。 出现这个表示我们连接上了。 redis命令参考链接 String 字符串结构 struct sdshdr{//记录buf数组中已使用字节的数量int …

Python模块(1)-Argparse 简易使用教程

argparse 简易使用教程1.概况2. action3. argparse 使用demo3.1 argparse 实现加法器3.2 D-Model parser1.概况 argparse是Python中用于解析命令行参数的一个模块&#xff0c;可以自动生成help和usage信息&#xff1b;当从终端输入的参数无效时&#xff0c;模块会输出提示信息…

深度学习--Keras总结

Keras主要包括14个模块&#xff0c;本文主要对Models、layers、Initializations、Activations、Objectives、Optimizers、Preprocessing、metrics共计8个模块分别展开介绍&#xff0c;并通过一个简单的Bp神经网络说明各个模块的作用。 1. Model 包&#xff1a;keras.models …

redis——NOSQL及redis概述

NoSql入门概述 单机Mysql的美好时代 瓶颈&#xff1a; 数据库总大小一台机器硬盘内存放不下数据的索引&#xff08;B tree&#xff09;一个机器的运行内存放不下访问量&#xff08;读写混合&#xff09;一个实例不能承受Memcached&#xff08;缓存&#xff09; MySql 垂直拆…

Python(17)-元组tuple

高级数据类型--元组1.元组的定义2.元组基本操作3.元组的循环遍历4.元组的应用场景5.元组与格式化字符串6.元组与列表之间的转换元组的最大特征就是可访问不可改&#xff0c;可作为字典的键值&#xff0c;因为键值必须是唯一的。字符串也是不可边类型&#xff0c;因此也适合做字…

深度学习(莫烦 神经网络 lecture 3) Keras

神经网络 & Keras 目录 神经网络 & Keras目录1、Keras简介1.1 科普: 人工神经网络 VS 生物神经网络1.2 什么是神经网络 (Neural Network)1.3 神经网络 梯度下降1.4 科普: 神经网络的黑盒不黑1.5 Why Keras?1.6 兼容 backend 2、如何搭建各种神经网络2.1 Regressor回归…

阿里Java编程规约(集合)

【强制】关于 hashCode 和 equals 的处理&#xff0c;遵循如下规则&#xff1a; 1&#xff09; 只要覆写 equals&#xff0c;就必须覆写 hashCode。 2&#xff09; 因为 Set 存储的是不重复的对象&#xff0c;依据 hashCode 和 equals 进行判断&#xff0c;所以 Set 存储的对…