Java代码整洁之道

冷不防 2021-11-17 13:56 356阅读 0赞

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

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

现象描述：

// 调用代码
    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;
    }

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

现象描述：

// 获取订单总额函数
    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)编程。

**11.3 主要收益**

内部函数尽量使用基础类型，避免了隐式封装类型的打包和拆包；

内部函数参数使用基础类型，用语法上避免了内部函数的参数空指针判断；

内部函数返回值使用基础类型，用语法上避免了调用函数的返回值空指针判断。

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

**12.1 案例一：尽量避免返回的数组为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;
    }

**12.2 案例二：尽量避免返回的列表为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;
    }

**12.3 主要收益**

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

## 13.封装函数传入参数 ##

**13.1 案例一：当传入参数过多时，应封装为参数类**

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;
    }

**13.2 案例二：当传入成组参数时，应封装为参数类**

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

现象描述：

// 获取距离函数
    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;
    }

**13.3 主要收益**

封装过多函数参数为类，使函数更便于扩展和维护；

封装成组函数参数为类，使业务概念更明确更清晰。

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

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

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

**14.1 案例一：尽量用函数替换匿名内部类（包括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)代替匿名内部类实现。

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

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

现象描述：

// 清除过期数据
    cleanExpiredData("用户日志表", new CleanExpiredDataOperator() {
        @Override
        public List<Date> queryExpiredDate(Integer remainDays) {
            return userDAO.queryExpiredDate(remainDays);
        }
        @Override
        public 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);
    }

**14.3 主要收益**

定义函数并指定参数，明确规定了匿名内部类的代码边界；

利用Lambda表达式简化匿名内部类实现，使代码更简洁。

## 15.利用return精简不必要的代码 ##

**15.1 案例一：删除不必要的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;
    }

**15.2 案例二：删除不必要的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);
    }

**15.3 案例三：删除不必要的变量**

现象描述：

// 查询用户函数
    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);
    }

**15.4 主要收益**

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

## 16.利用临时变量优化代码 ##

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

**16.1 案例一：利用临时变量厘清逻辑**

现象描述：

// 是否土豪用户函数
    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;
    }

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

**16.2 案例二：利用临时变量精简代码**

现象描述：

// 构建用户函数
    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;
    }

**16.3 主要收益**

利用临时变量厘清逻辑，显得业务逻辑更清晰；

利用临时变量精简代码，看变量名称即知其义，减少了大量无用代码；

如果获取函数比较复杂耗时，利用临时变量可以提高运行效率；

利用临时变量避免函数的级联调用，可有效预防空指针异常。

## 17.仅保留函数需要的参数 ##

**17.1 案例一：删除多余的参数**

现象描述：

// 修改用户状态函数
    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);
    }

**17.2 案例二：用属性取代对象**

现象描述：

// 删除用户函数
    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个，可以不必使用该规则。

**17.3 主要收益**

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

参考：[https://mp.weixin.qq.com/s/Zr5U2Q35StwUUUBBbj9Mww][https_mp.weixin.qq.com_s_Zr5U2Q35StwUUUBBbj9Mww]

[https_mp.weixin.qq.com_s_Zr5U2Q35StwUUUBBbj9Mww]: https://mp.weixin.qq.com/s/Zr5U2Q35StwUUUBBbj9Mww