编码规范 | Java函数优雅之道(下)

上文背景

本文总结了一套与Java函数相关的编码规则,旨在给广大Java程序员一些编码建议,有助于大家编写出更优雅、更高质、更高效的代码。

内部函数参数尽量使用基础类型

案例一:内部函数参数尽量使用基础类型

现象描述:

// 调用代码
double price = 5.1D;
int number = 9;
double total = calculate(price, number);// 计算金额函数
private double calculate(Double price, Integer number) {return price * number;
}

建议方案:

// 调用代码
double price = 5.1D;
int number = 9;
double total = calculate(price, number);// 计算金额函数
private double calculate(double price, int number) {return price * number;
}

案例二:内部函数返回值尽量使用基础类型

现象描述:

// 获取订单总额函数
public double getOrderAmount(List<Product> productList) {double amount = 0.0D;for (Product product : productList) {if (Objects.isNull(product) || Objects.isNull(product.getPrice())|| Objects.isNull(product.getNumber())) {continue;}amount += calculate(product.getPrice(), product.getNumber());}return amount;
}// 计算金额函数
private Double calculate(double price, double number) {return price * number;
}

建议方案:

// 获取订单总额函数
public double getOrderAmount(List<Product> productList) {double amount = 0.0D;for (Product product : productList) {if (Objects.isNull(product) || Objects.isNull(product.getPrice())|| Objects.isNull(product.getNumber())) {continue;}amount += calculate(product.getPrice(), product.getNumber());}return amount;
}// 计算金额函数
private double calculate(double price, double number) {return price * number;
}

此处只是举例说明这种现象,更好的方式是采用流式(Stream)编程。

主要收益

  • 内部函数尽量使用基础类型,避免了隐式封装类型的打包和拆包;
  • 内部函数参数使用基础类型,用语法上避免了内部函数的参数空指针判断;
  • 内部函数返回值使用基础类型,用语法上避免了调用函数的返回值空指针判断。

尽量避免返回的数组和列表为null

案例一:尽量避免返回的数组为null,引起不必要的空指针判断

现象描述:

// 调用代码
UserVO[] users = queryUser();
if (Objects.nonNull(users)) {for (UserVO user : users) {// 处理用户信息}
}// 查询用户函数
private UserVO[] queryUser() {// 查询用户列表List<UserDO> userList = userDAO.queryAll();if (CollectionUtils.isEmpty(userList)) {return null;}// 转化用户数组UserVO[] users = new UserVO[userList.size()];for (int i = 0; i < userList.size(); i++) {UserDO user = userList.get(i);users[i] = new UserVO();users[i].setId(user.getId());users[i].setName(user.getName());}// 返回用户数组return users;
}

建议方案:

// 调用代码
UserVO[] users = queryUser();
for (UserVO user : users) {// 处理用户信息
}// 查询用户函数
private UserVO[] queryUser() {// 查询用户列表List<UserDO> userList = userDAO.queryAll();if (CollectionUtils.isEmpty(userList)) {return new UserVO[0];}// 转化用户数组UserVO[] users = new UserVO[userList.size()];for (int i = 0; i < userList.size(); i++) {UserDO user = userList.get(i);users[i] = new UserVO();users[i].setId(user.getId());users[i].setName(user.getName());}// 返回用户数组return users;
}

案例二:尽量避免返回的列表为null,引起不必要的空指针判断

现象描述:

// 调用代码
List<UserVO> userList = queryUser();
if (Objects.nonNull(userList)) {for (UserVO user : userList) {// 处理用户信息}
}// 查询用户函数
private List<UserVO> queryUser(){// 查询用户列表List<UserDO> userList = userDAO.queryAll();if(CollectionUtils.isEmpty(userList)) {return null;}// 转化用户列表List<UserVO> userVoList = new ArrayList<>(userList.size());for(UserDO user : userList) {UserVO userVo = new UserVO();userVo.setId(user.getId());userVo.setName(user.getName());userVoList.add(userVo);}// 返回用户列表return userVoList;
}

建议方案:

// 调用代码
List<UserVO> userList = queryUser();
for (UserVO user : userList) {// 处理用户信息}// 查询用户函数
private List<UserVO> queryUser(){// 查询用户列表List<UserDO> userList = userDAO.queryAll();if(CollectionUtils.isEmpty(userList)) {return Collections.emptyList();}// 转化用户列表List<UserVO> userVoList = new ArrayList<>(userList.size());for(UserDO user : userList) {UserVO userVo = new UserVO();userVo.setId(user.getId());userVo.setName(user.getName());userVoList.add(userVo);}// 返回用户列表return userVoList;
}

主要收益

  • 保证返回的数组和列表不为null, 避免调用函数的空指针判断。

封装函数传入参数

案例一:当传入参数过多时,应封装为参数类

Java规范不允许函数参数太多,不便于维护也不便于扩展。

现象描述:

// 修改用户函数
public void modifyUser(Long id, String name, String phone, Integer age, Integer sex, String address, String description) {// 具体实现逻辑
}

建议方案:

// 修改用户函数
public void modifyUser(User user) {// 具体实现内容
}// 用户类
@Getter
@Setter
@ToString
private class User{private Long id;private String name;private String phone;private Integer age;private Integer sex;private String address;private String description;
}

当传入成组参数时,应封装为参数类

既然参数成组出现,就需要封装一个类去描述这种现象。

现象描述:

// 获取距离函数
public double getDistance(double x1, double y1, double x2, double y2) {// 具体实现逻辑
}

建议方案:

// 获取距离函数
public double getDistance(Point point1, Point point2) {// 具体实现逻辑
}// 点类
@Getter
@Setter
@ToString
private class Point{private double x;private double y;
}

主要收益

  • 封装过多函数参数为类,使函数更便于扩展和维护;
  • 封装成组函数参数为类,使业务概念更明确更清晰。

尽量用函数替换匿名内部类的实现

Java匿名内部类的优缺点:
在匿名内部类(包括Lambda表达式)中可以直接访问外部类的成员,包括类的成员变量、函数的内部变量。正因为可以随意访问外部变量,所以会导致代码边界不清晰。

首先推荐用Lambda表达式简化匿名内部类,其次推荐用函数替换复杂的Lambda表达式的实现。

案例一:尽量用函数替换匿名内部类(包括Lambda表达式)的实现

现象描述:

// 发送结算数据
sendWorkerSettleData(WorkerPushDataType.CHECKER, () -> {Date beginDate = DateUtils.addDays(currDate, -aheadDays);Date endDate = DateUtils.addDays(currDate, 1);return auditTaskDAO.statCheckerSettleData(beginDate, endDate);
});

建议方案:

// 发送结算数据
sendWorkerSettleData(WorkerPushDataType.CHECKER, () -> statCheckerSettleData(currDate, aheadDays));// 统计验收员结算数据函数
private List<WorkerSettleData> statCheckerSettleData(Date currDate, int aheadDays) {Date beginDate = DateUtils.addDays(currDate, -aheadDays);Date endDate = DateUtils.addDays(currDate, 1);return auditTaskDAO.statCheckerSettleData(beginDate, endDate);
}

其实,还有一个更简单的办法。在调用函数sendWorkerSettleData(发送作业员结算数据)之前计算开始日期、结束日期,就直接可以用函数auditTaskDAO.statCheckerSettleData(beginDate, endDate)代替匿名内部类实现。

案例二:拆分复杂匿名内部类实现接口为多个函数类接口

如果一个匿名内部类实现的接口几个函数间关联性不大,可以把这个接口拆分为几个函数式接口,便于使用Lambda表达式。

现象描述:

// 清除过期数据
cleanExpiredData("用户日志表", new CleanExpiredDataOperator() {@Overridepublic List<Date> queryExpiredDate(Integer remainDays) {return userDAO.queryExpiredDate(remainDays);}@Overridepublic void cleanExpiredData(Date expiredDate) {userDAO.cleanExpiredData(expiredDate);}
});// 清除过期数据函数
private void cleanExpiredData(String tableName, CleanExpiredDataOperator ,
cleanExpiredDataOperator) {// 功能实现代码
}// 清除过期操作接口
interface CleanExpiredDataOperator {// 查询过期日期public List<Date> queryExpiredDate(Integer remainDays);// 清除过期数据public void cleanExpiredData(Date expiredDate);
}

建议方案:

// 清除过期数据
cleanExpiredData("用户日志表", userDAO::queryExpiredDate,userDAO::cleanExpiredData);// 清除过期数据函数
private void cleanExpiredData(String tableName, QueryExpiredDateOperator queryExpiredDateOperator, CleanExpiredDataOperator cleanExpiredDataOperator) {// 功能实现代码
}// 查询过期日期接口
interface QueryExpiredDateOperator {// 查询过期日期public List<Date> queryExpiredDate(Integer remainDays);
}// 清除过期操作接口
interface CleanExpiredDataOperator {// 清除过期数据public void cleanExpiredData(Date expiredDate);
}

主要收益

  • 定义函数并指定参数,明确规定了匿名内部类的代码边界;
  • 利用Lambda表达式简化匿名内部类实现,使代码更简洁。

利用return精简不必要的代码

案例一:删除不必要的if

现象描述:

// 是否通过函数
public boolean isPassed(Double passRate) {if (Objects.nonNull(passRate) && passRate.compareTo(PASS_THRESHOLD) >= 0) {return true;}return false;
}

建议方案:

// 是否通过函数
public boolean isPassed(Double passRate) {return Objects.nonNull(passRate) && passRate.compareTo(PASS_THRESHOLD) >= 0;
}

案例二:删除不必要的else

现象描述:

// 结算工资函数
public double settleSalary(Long workId, int workDays) {// 根据是否合格处理if (isQualified(workId)) {return settleQualifiedSalary(workDays);} else {return settleUnqualifiedSalary(workDays);}
}

建议方案:

// 结算工资函数
public double settleSalary(Long workId, int workDays) {// 根据是否合格处理if (isQualified(workId)) {return settleQualifiedSalary(workDays);}return settleUnqualifiedSalary(workDays);
}

案例三:删除不必要的变量

现象描述:

// 查询用户函数
public List<UserDO> queryUser(Long id, String name) {UserQuery userQuery = new UserQuery();userQuery.setId(id);userQuery.setName(name);List<UserDO> userList = userDAO.query(userQuery);return userList;
}

建议方案:

// 查询用户函数
public List<UserDO> queryUser(Long id, String name) {UserQuery userQuery = new UserQuery();userQuery.setId(id);userQuery.setName(name);return userDAO.query(userQuery);
}

主要收益

  • 精简不必要的代码,让代码看起来更清爽

利用临时变量优化代码

在一些代码中,经常会看到a.getB().getC()...getN()的写法,姑且叫做“函数的级联调用”,代码健壮性和可读性太差。建议:杜绝函数的级联调用,利用临时变量进行拆分,并做好对象空指针检查。

案例一:利用临时变量厘清逻辑

现象描述:

// 是否土豪用户函数
private boolean isRichUser(User user) {return Objects.nonNull(user.getAccount())&& Objects.nonNull(user.getAccount().getBalance())&& user.getAccount().getBalance().compareTo(RICH_THRESHOLD) >= 0;
}

这是精简代码控的最爱,但是可读性实在太差。

建议方案:

// 是否土豪用户函数
private boolean isRichUser(User user) {// 获取用户账户UserAccount account = user.getAccount();if (Objects.isNull(account)) {return false;}// 获取用户余额Double balance = account.getBalance();if (Objects.isNull(balance)) {return false;}// 比较用户余额return balance.compareTo(RICH_THRESHOLD) >= 0;
}

这个方案,增加了代码行数,但是逻辑更清晰。
有时候,当代码的精简性和可读性发生冲突时,个人更偏向于保留代码的可读性。

案例二:利用临时变量精简代码

现象描述:

// 构建用户函数
public UserVO buildUser(UserDO user) {UserVO vo = new UserVO();vo.setId(user.getId());vo.setName(user.getName());if (Objects.nonNull(user.getAccount())) {vo.setBalance(user.getAccount().getBalance());vo.setDebt(user.getAccount().getDebt());}return vo;
}

这么写,大约是为了节约一个临时变量把。

建议方案:

// 构建用户函数
public UserVO buildUser1(UserDO user) {UserVO vo = new UserVO();vo.setId(user.getId());vo.setName(user.getName());UserAccount account = user.getAccount();if (Objects.nonNull(account)) {vo.setBalance(account.getBalance());vo.setDebt(account.getDebt());}return vo;
}

主要收益

  • 利用临时变量厘清逻辑,显得业务逻辑更清晰;
  • 利用临时变量精简代码,看变量名称即知其义,减少了大量无用代码;
  • 如果获取函数比较复杂耗时,利用临时变量可以提高运行效率;
  • 利用临时变量避免函数的级联调用,可有效预防空指针异常。

仅保留函数需要的参数

在一些代码中,经常会看到a.getB().getC()...getN()的写法,姑且叫做“函数的级联调用”,代码健壮性和可读性太差。建议:杜绝函数的级联调用,利用临时变量进行拆分,并做好对象空指针检查。

案例一:删除多余的参数

现象描述:

// 修改用户状态函数
private void modifyUserStatus(Long userId, Integer status, String unused) {userCache.modifyStatus(userId, status);userDAO.modifyStatus(userId, status);
}
其中,unused参数是无用参数。建议方案:// 修改用户状态函数
private void modifyUserStatus(Long userId, Integer status) {userCache.modifyStatus(userId, status);userDAO.modifyStatus(userId, status);
}

案例二:用属性取代对象

现象描述:

// 删除用户函数
private void deleteUser(User user) {userCache.delete(user.getId());userDAO.delete(user.getId());
}

建议方案:

// 删除用户函数
private void deleteUser(Long userId) {userCache.delete(userId);userDAO.delete(userId);
}

建议方案:

调用函数时,参数对象不需要专门构建,而函数使用其属性超过3个,可以不必使用该规则。

主要收益

仅保留函数需要的参数,明确了调用时需要赋值的参数,避免了调用时还要去构造些无用参数。

后记

"众人拾柴火焰高"。如果有更多更好的观点,亦或有更好的代码案例,欢迎大家进行补充说明。笔者希望以此文抛砖引玉,如果最终形成一套完善的Java编码规范,善莫大焉。


原文链接
本文为云栖社区原创内容,未经允许不得转载。

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

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

相关文章

python3-numpy IO load()、save()、savez()、loadtxt()、savetxt()、tofile()、fromfile()

Numpy 可以读写磁盘上的文本数据或二进制数据。 NumPy 为 ndarray 对象引入了一个简单的文件格式&#xff1a;npy。 npy 文件用于存储重建 ndarray 所需的数据、图形、dtype 和其他信息。 常用的 IO 函数有&#xff1a; load() 和 save() 函数是读写文件数组数据的两个主要函数…

抽象思想解读Linux进程描述符

来源 | 嵌入式客栈责编 | Carol头图 | CSDN 下载自视觉中国内核是怎么工作的&#xff1f;首先要理解进程管理&#xff0c;进程调度&#xff0c;本文开始阅读进程管理部分&#xff0c;首先从进程的抽象描述开始。抽象是软件工程的灵魂&#xff0c;而对于Linux操作系统而言&#…

CentOS Linux 7.7 安装kafka zookeeper

文章目录一、软件下载1. zookeeper2. kafka二、安装与启动2.1. jdk2.2. zookeeper2.3. kafka三、 kafka 基本演示一、软件下载 1. zookeeper http://archive.apache.org/dist/zookeeper/zookeeper-3.5.7/apache-zookeeper-3.5.7-bin.tar.gz 2. kafka https://archive.apach…

《Java开发手册》2019最新版发布!

致全球Java开发者&#xff1a; 代码是二进制世界的交流方式&#xff0c;极致的代码是我们的荣耀。 2017年春天&#xff0c;《阿里巴巴Java开发手册》发布&#xff0c;我们希望在涵盖编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程规约、设计规约等7个维度上为开…

IDEA 惊天 bug:进程已结束,退出代码 1073741819

来源 | 沉默王二责编 | Carol头图 | CSDN 下载自视觉中国今天要写的文章中涉及到一串代码&#xff0c;关于 Undertow 的一个入门示例&#xff0c;贴出来大家看一下。public class UndertowTest {public static void main(final String[] args) {Undertow server Undertow.buil…

python3-Anaconda3 基本使用

1、下载 最新版本官网下载&#xff1a; https://www.anaconda.com/distribution/ 历史版本 清华镜像&#xff08;国内首选&#xff09;&#xff1a; https://mirrors.tuna.tsinghua.edu.cn/anaconda/archive/ 历史版本 官网镜像&#xff1a; https://repo.anaconda.com/archi…

淘宝应用柔性架构的探索

导读&#xff1a;随着淘宝业务的飞速发展&#xff0c;微服务架构在持续演进的过程中&#xff0c;也受到了越来越多的挑战&#xff1a;如同步模型带来的资源利用率有限、依赖调用并发度有限、下游故障引发应用自身出问题&#xff1b;又如静态限流随着业务代码的演进、依赖拓扑的…

js 传递参数中文乱码

换成这种方式接收 function getQueryString(key){var reg new RegExp("(^|&)"key"([^&]*)(&|$)");var result window.location.search.substr(1).match(reg);return result?decodeURIComponent(result[2]):null; }

iOS13 一次Crash定位 - 被释放的NSURL.host

每年一次的iOS升级&#xff0c;都会给开发者带来一些适配工作&#xff0c;一些原本工作正常的代码可能就会发生崩溃。 本文讲到了一种 CoreFoundation 对象的内存管理方式在iOS13上遇到的问题。 1. 问题 iOS 13 Beta 版本上&#xff0c;手淘出现了一个必现的崩溃&#xff1a; …

面试官吐槽:“Python程序员就是不行!”网友:我能把你面哭!

最近几年&#xff0c;Python莫名火了起来&#xff0c;很多公司都想赶上这“莫名”的热潮&#xff0c;招聘到大牛人才。但是&#xff0c;最近一个HR在社交网站的吐槽又火了&#xff1a;那么问题来了&#xff0c;市面上为什么鲜有企业满意的优秀的Python程序员&#xff1f;企业到…

python3-pandas 数据结构 Series、DataFrame 基础

Pandas 应用 Pandas 的主要数据结构是 Series &#xff08;一维数据&#xff09;与 DataFrame&#xff08;二维数据&#xff09;&#xff0c;这两种数据结构足以处理金融、统计、社会科学、工程等领域里的大多数典型用例。 数据结构 Series 是一种类似于一维数组的对象&#xf…

十年磨一剑 | 淘宝如何打造承载亿级流量的首页?

阿里妹导读&#xff1a;手机淘宝作为整个互联网领域旗舰 APP 之一&#xff0c;装机量和用户访问量都是名列前茅的。而首页作为打开手机淘宝的门面&#xff0c;是淘宝电商领域的主要流量入口和服务消费者的核心阵地&#xff0c;其业务的复杂性之高、系统的稳定性之重都有着极高的…

switchhosts 没有修改hosts的权限解决方案

使用swtichHost工具切换开发环境时候提示没有权限问题&#xff0c;如下图。。 解决方案有两点 1、进入 C:\Windows\System32\drivers\etc右键点击hosts的属性查看 属性的只读是否被勾选了&#xff0c;如果被勾选了将勾选勾去掉 上述完成后以管理员身份运行&#xff08;管理员…

闲鱼亿级商品结构化背后的思考和演进

1. 缘起 闲鱼是一个典型的C2C场景的闲置交易平台。每个在闲鱼的用户都能享受到自由交易的乐趣。在这里&#xff0c;可能你只要简单的输入商品名&#xff0c;商品价格&#xff0c;库存等信息就能完成一个商品的发布。即便是发布以后&#xff0c;你也可以随时修改价格&#xff0…

QingStor NeonSAN跻身四强 新风口下的青云QingCloud正在厚积薄发

人类以日新月异的速度刷新着科技的成果&#xff0c;其中存储的发展历史尤其悠久&#xff0c;堪称万年进化史。自文明诞生以来&#xff0c;我们就一直在寻求能够更有效存储信息的方式&#xff0c;从4万年前的洞穴壁画、6000年前泥板上的楔形文字&#xff0c;到今天正在普及的SSD…

python3-pandas DataFrame 索引、bool索引、pandas 字符串方法

1、DataFrame 索引 1.1 普通索引取值 pandas 取行或者列的注意点&#xff1a; 方括号写数组&#xff0c;表示取行&#xff0c;对行进行操作方括号写字符串&#xff0c;表示取列&#xff0c;对列进行操作 import pandas as pd import numpy as np # pandas 取行或者列的注意…

MySQL8.0.17 - 初探 Clone Plugin

MySQL8.0.17推出了一个重量级的功能&#xff1a;clone plugin。允许用户可以将当前实例进行本地或者远程的clone。这在某些场景尤其想快速搭建复制备份或者在group replication里加入新成员时非常有用。本文主要试玩下该功能&#xff0c;并试图阐述下其实现的机制是什么。 我们…

javascript判断IPV6格式

随着ipv6的普及&#xff0c;在web上添加ip6地址的要求逐渐增多&#xff0c;下面这个函数是我按照ipv6的定义写的判断&#xff0c;可以用来判断正常的,缩写的ipv6格式&#xff0c;同时可以判断ipv6和ipv4混合的格式&#xff1a; //统计 10F: 或者:10B的个数 function cLength(s…

阿里毕玄:推荐给Java程序员的7本好书

我主要还是个Java程序员&#xff0c;所以进阶类型的书就推荐Java相关的。 《Java并发编程实战》 并发是高级语言里都需要掌握的稍微高级一些的技巧&#xff0c;这本书尽管是2012年的书了&#xff0c;但我觉得仍然是无比经典&#xff0c;绝对是必读书。《Netty实战》 Netty是Ja…

释放虚拟GPU力量 NVIDIA 加速企业远程办公生产力变革

现在众多的企业拥抱云和AI技术进行着数字化转型。随着企业在信息化建设的加剧&#xff0c;相关从业人员数量增多的同时&#xff0c;也对设备的计算性能要求越来越高。2020年开年的这场疫情&#xff0c;强制性地让企业进入远程办公模式&#xff0c;这个突发的状况也为企业的IT设…