优雅Java01 优雅代码万岁

迈不过友情╰ 2023-10-09 22:08 38阅读 0赞

### 1. DTO转化 ###

@RequestMapping("/v1/api/user")
    @RestController
    public class UserApi {
    
        @Autowired
        private UserService userService;
    
        @PostMapping
        public User addUser(UserInputDTO userInputDTO){
            User user = new User();
            user.setUsername(userInputDTO.getUsername());
            user.setAge(userInputDTO.getAge());
    
            return userService.addUser(user);
        }
    }

可以优雅的简化为：

@PostMapping
    public User addUser(UserInputDTO userInputDTO){
        User user = new User();
        // BeanUtils.copyProperties 是一个浅拷贝方法
        BeanUtils.copyProperties(userInputDTO,user);
    
        return userService.addUser(user);
    }

再可以优雅地简化为：

@PostMapping
     public User addUser(UserInputDTO userInputDTO){
             User user = convertFor(userInputDTO);
    
             return userService.addUser(user);
     }
    
     private User convertFor(UserInputDTO userInputDTO){
    
             User user = new User();
             BeanUtils.copyProperties(userInputDTO,user);
             return user;
     }

再再可以优雅地简化为：

看一下抽象后的接口：
    public interface DTOConvert<S,T> {
        T convert(S s);
    }
    
    我们再来看接口实现：
    public class UserInputDTOConvert implements DTOConvert {
    	@Override
    	public User convert(UserInputDTO userInputDTO) {
    		User user = new User();
    		BeanUtils.copyProperties(userInputDTO,user);
    		return user;
    	}
    }
    
    
    我们这样重构后，我们发现现在的代码是如此的简洁，并且那么的规范：
    @RequestMapping("/v1/api/user")
    @RestController
    public class UserApi {
    
        @Autowired
        private UserService userService;
    
        @PostMapping
        public User addUser(UserInputDTO userInputDTO){
            User user = new UserInputDTOConvert().convert(userInputDTO);
    
            return userService.addUser(user);
        }
    }

不知道在看完这段代码之后，读者有是否发现还有其他问题的存在，作为一个优秀的 Java 程序员，请看一下这段我们刚刚抽象完的代码:

User user = new UserInputDTOConvert().convert(userInputDTO);

你会发现，new 这样一个 DTO 转化对象是没有必要的，而且每一个转化对象都是由在遇到 DTO 转化的时候才会出现，那我们应该考虑一下，是否可以将这个类和 DTO 进行聚合呢，看一下我的聚合结果:

public class UserInputDTO {
    private String username;
    private int age;
    
        public String getUsername() {
            return username;
        }
    
        public void setUsername(String username) {
            this.username = username;
        }
    
        public int getAge() {
            return age;
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    
    
        public User convertToUser(){
            UserInputDTOConvert userInputDTOConvert = new UserInputDTOConvert();
            User convert = userInputDTOConvert.convert(this);
            return convert;
        }
    
        private static class UserInputDTOConvert implements DTOConvert<UserInputDTO,User> {
            @Override
            public User convert(UserInputDTO userInputDTO) {
                User user = new User();
                BeanUtils.copyProperties(userInputDTO,user);
                return user;
            }
        }
    
    }

然后 API 中的转化则由：

User user = new UserInputDTOConvert().convert(userInputDTO);
    User saveUserResult = userService.addUser(user);

变成了：

User user = userInputDTO.convertToUser();
    User saveUserResult = userService.addUser(user);

再来看 DTO 内部转化的代码，它实现了我们自己定义的 DTOConvert 接口，但是这样真的就没有问题，不需要再思考了吗？

我觉得并不是，对于 Convert 这种转化语义来讲，很多工具类中都有这样的定义，这中 Convert 并不是业务级别上的接口定义，它只是用于普通 bean 之间转化属性值的普通意义上的接口定义，所以我们应该更多的去读其他含有 Convert 转化语义的代码。

我仔细阅读了一下 GUAVA 的源码，发现了 com.google.common.base.Convert 这样的定义：

public abstract class Converter<A, B> implements Function<A, B> {
        protected abstract B doForward(A a);
        protected abstract A doBackward(B b);
        //其他略
    }

从源码可以了解到，GUAVA 中的 Convert 可以完成正向转化和逆向转化，继续修改我们 DTO 中转化的这段代码：

private static class UserInputDTOConvert implements DTOConvert<UserInputDTO,User> {
            @Override
            public User convert(UserInputDTO userInputDTO) {
                    User user = new User();
                    BeanUtils.copyProperties(userInputDTO,user);
                    return user;
            }
    }

修改后：

private static class UserInputDTOConvert extends Converter<UserInputDTO, User> {
             @Override
             protected User doForward(UserInputDTO userInputDTO) {
                     User user = new User();
                     BeanUtils.copyProperties(userInputDTO,user);
                     return user;
             }
    
             @Override
             protected UserInputDTO doBackward(User user) {
                     UserInputDTO userInputDTO = new UserInputDTO();
                     BeanUtils.copyProperties(user,userInputDTO);
                     return userInputDTO;
             }
     }

看了这部分代码以后，你可能会问，那逆向转化会有什么用呢？其实我们有很多小的业务需求中，入参和出参是一样的，那么我们变可以轻松的进行转化，我将上边所提到的 UserInputDTO 和 UserOutputDTO 都转成 UserDTO 展示给大家。  
DTO：

public class UserDTO {
        private String username;
        private int age;
    
        public String getUsername() {
                return username;
        }
    
        public void setUsername(String username) {
                this.username = username;
        }
    
        public int getAge() {
                return age;
        }
    
        public void setAge(int age) {
                this.age = age;
        }
    
    
        public User convertToUser(){
                UserDTOConvert userDTOConvert = new UserDTOConvert();
                User convert = userDTOConvert.convert(this);
                return convert;
        }
    
        public UserDTO convertFor(User user){
                UserDTOConvert userDTOConvert = new UserDTOConvert();
                UserDTO convert = userDTOConvert.reverse().convert(user);
                return convert;
        }
    
        private static class UserDTOConvert extends Converter<UserDTO, User> {
                @Override
                protected User doForward(UserDTO userDTO) {
                        User user = new User();
                        BeanUtils.copyProperties(userDTO,user);
                        return user;
                }
    
                @Override
                protected UserDTO doBackward(User user) {
                        UserDTO userDTO = new UserDTO();
                        BeanUtils.copyProperties(user,userDTO);
                        return userDTO;
                }
        }
    
    }

API：

@PostMapping
     public UserDTO addUser(UserDTO userDTO){
             User user =  userDTO.convertToUser();
             User saveResultUser = userService.addUser(user);
             UserDTO result = userDTO.convertFor(saveResultUser);
             return result;
     }

当然，上述只是表明了转化方向的正向或逆向，很多业务需求的出参和入参的 DTO 对象是不同的，那么你需要更明显的告诉程序：逆向是无法调用的：

private static class UserDTOConvert extends Converter<UserDTO, User> {
             @Override
             protected User doForward(UserDTO userDTO) {
                     User user = new User();
                     BeanUtils.copyProperties(userDTO,user);
                     return user;
             }
    
             @Override
             protected UserDTO doBackward(User user) {
                     throw new AssertionError("不支持逆向转化方法!");
             }
     }

看一下 doBackward 方法，直接抛出了一个断言异常，而不是业务异常，这段代码告诉代码的调用者，这个方法不是准你调用的，如果你调用，我就”断言”你调用错误了。

### **jsr 303验证** ###

hibernate 提供的 jsr 303 实现，我觉得目前仍然是很优秀的，具体如何使用，我不想讲，因为谷歌上你可以搜索出很多答案!

再以上班的 API 实例进行说明，我们现在对 DTO 数据进行检查：

public class UserDTO {
        @NotNull
        private String username;
        @NotNull
        private int age;
            //其他代码略
    }

API 验证：

@PostMapping
        public UserDTO addUser(@Valid UserDTO userDTO){
                User user =  userDTO.convertToUser();
                User saveResultUser = userService.addUser(user);
                UserDTO result = userDTO.convertFor(saveResultUser);
                return result;
        }

我们需要将验证结果传给前端，这种异常应该转化为一个 api 异常(带有错误码的异常)。

@PostMapping
    public UserDTO addUser(@Valid UserDTO userDTO, BindingResult bindingResult){
         checkDTOParams(bindingResult);
    
         User user =  userDTO.convertToUser();
         User saveResultUser = userService.addUser(user);
         UserDTO result = userDTO.convertFor(saveResultUser);
         return result;
    }
    private void checkDTOParams(BindingResult bindingResult){
         if(bindingResult.hasErrors()){
                 //throw new 带验证码的验证错误异常
         }
    }

BindingResult 是 Spring MVC 验证 DTO 后的一个结果集，可以参考spring 官方文档（http://spring.io/）。

检查参数后，可以抛出一个“带验证码的验证错误异常”

### 拥抱 lombok ###

上边的 DTO 代码，已经让我看的很累了，我相信读者也是一样，看到那么多的 Getter 和 Setter 方法，太烦躁了，那时候有什么方法可以简化这些呢。

请拥抱 lombok,它会帮助我们解决一些让我们很烦躁的问题

去掉 Setter 和 Getter

其实这个标题，我不太想说，因为网上太多，但是因为很多人告诉我，他们根本就不知道 lombok 的存在，所以为了让读者更好的学习，我愿意写这样一个例子：

@Setter
    @Getter
    public class UserDTO {
        @NotNull
        private String username;
        @NotNull
        private int age;
    
        public User convertToUser(){
            UserDTOConvert userDTOConvert = new UserDTOConvert();
            User convert = userDTOConvert.convert(this);
            return convert;
        }
    
        public UserDTO convertFor(User user){
            UserDTOConvert userDTOConvert = new UserDTOConvert();
            UserDTO convert = userDTOConvert.reverse().convert(user);
            return convert;
        }
    
        private static class UserDTOConvert extends Converter<UserDTO, User> {
            @Override
            protected User doForward(UserDTO userDTO) {
                User user = new User();
                BeanUtils.copyProperties(userDTO,user);
                return user;
            }
    
            @Override
            protected UserDTO doBackward(User user) {
                throw new AssertionError("不支持逆向转化方法!");
            }
        }
    
    }

### bean 中的链式风格 ###

什么是链式风格？我来举个例子，看下面这个 Student 的 bean：

public class Student {
        private String name;
        private int age;
    
        public String getName() {
            return name;
        }
    
        public Student setName(String name) {
            this.name = name;
            return this;
        }
    
        public int getAge() {
            return age;
        }
    
        public Student setAge(int age) {
            return this;
        }
    }

仔细看一下 set 方法，这样的设置便是 chain 的 style，调用的时候，可以这样使用：

Student student = new Student()
            .setAge(24)
            .setName("zs");

相信合理使用这样的链式代码，会更多的程序带来很好的可读性，那看一下如果使用 lombok 进行改善呢，请使用 @Accessors(chain = true)，看如下代码：

@Accessors(chain = true)
    @Setter
    @Getter
    public class Student {
        private String name;
        private int age;
    }

这样就完成了一个对于 bean 来讲很友好的链式操作。

### 静态构造方法 ###

静态构造方法的语义和简化程度真的高于直接去 new 一个对象。比如 new 一个 List 对象，过去的使用是这样的：

List<String> list = new ArrayList<>();

看一下 guava 中的创建方式：

List<String> list = Lists.newArrayList();

Lists 命名是一种约定(俗话说：约定优于配置)，它是指 Lists 是 List 这个类的一个工具类，那么使用 List 的工具类去产生 List，这样的语义是不是要比直接 new 一个子类来的更直接一些呢，答案是肯定的，再比如如果有一个工具类叫做 Maps，那你是否想到了创建 Map 的方法呢：

HashMap<String, String> objectObjectHashMap = Maps.newHashMap();

好了，如果你理解了我说的语义，那么，你已经向成为 Java 程序员更近了一步了。

再回过头来看刚刚的 Student，很多时候，我们去写 Student 这个 bean 的时候，他会有一些必输字段，比如 Student 中的 name 字段，一般处理的方式是将 name 字段包装成一个构造方法，只有传入 name 这样的构造方法，才能创建一个 Student 对象。

接上上边的静态构造方法和必传参数的构造方法，使用 lombok 将更改成如下写法（@RequiredArgsConstructor 和 @NonNull）:

@Accessors(chain = true)
    @Setter
    @Getter
    @RequiredArgsConstructor(staticName = "ofName")
    public class Student {
        @NonNull private String name;
        private int age;
    }

测试代码：

Student student = Student.ofName("zs");

这样构建出的 bean 语义是否要比直接 new 一个含参的构造方法(包含 name 的构造方法)要好很多。

当然，看过很多源码以后，我想相信将静态构造方法 ofName 换成 of 会先的更加简洁：

@Accessors(chain = true)
    @Setter
    @Getter
    @RequiredArgsConstructor(staticName = "of")
    public class Student {
            @NonNull private String name;
            private int age;
    }
    
    
    
    测试代码：
    Student student = Student.of("zs");

当然他仍然是支持链式调用的：

Student student = Student.of("zs").setAge(24);

这样来写代码，真的很简洁，并且可读性很强。

### 使用 builder ###

Builder 模式我不想再多解释了，读者可以看一下《Head First》(设计模式) 的建造者模式。

今天其实要说的是一种变种的 builder 模式，那就是构建 bean 的 builder 模式，其实主要的思想是带着大家一起看一下 lombok 给我们带来了什么。

看一下 Student 这个类的原始 builder 状态:

public class Student {
        private String name;
        private int age;
    
        public String getName() {
                return name;
        }
    
        public void setName(String name) {
                this.name = name;
        }
    
        public int getAge() {
                return age;
        }
    
        public void setAge(int age) {
                this.age = age;
        }
    
        public static Builder builder(){
                return new Builder();
        }
        public static class Builder{
                private String name;
                private int age;
                public Builder name(String name){
                        this.name = name;
                        return this;
                }
    
                public Builder age(int age){
                        this.age = age;
                        return this;
                }
    
                public Student build(){
                        Student student = new Student();
                        student.setAge(age);
                        student.setName(name);
                        return student;
                }
        }
    
    }

调用方式：

Student student = Student.builder().name("zs").age(24).build();

这样的 builder 代码，让我是在恶心难受，于是我打算用 lombok 重构这段代码：

@Builder
    public class Student {
        private String name;
        private int age;
    }

调用方式：

Student student = Student.builder().name("zs").age(24).build();

### 代理模式 ###

正如我们所知的，在程序中调用 rest 接口是一个常见的行为动作，如果你和我一样使用过 spring 的 RestTemplate，我相信你会我和一样，对他抛出的非 http 状态码异常深恶痛绝。

所以我们考虑将 RestTemplate 最为底层包装器进行包装器模式的设计：

public abstract class FilterRestTemplate implements RestOperations {
            protected volatile RestTemplate restTemplate;
    
            protected FilterRestTemplate(RestTemplate restTemplate){
                    this.restTemplate = restTemplate;
            }
    
            //实现RestOperations所有的接口
    }

然后再由扩展类对 FilterRestTemplate 进行包装扩展：

public class ExtractRestTemplate extends FilterRestTemplate {
        private RestTemplate restTemplate;
        public ExtractRestTemplate(RestTemplate restTemplate) {
                super(restTemplate);
                this.restTemplate = restTemplate;
        }
    
        public <T> RestResponseDTO<T> postForEntityWithNoException(String url, Object request, Class<T> responseType, Object... uriVariables)
                        throws RestClientException {
                RestResponseDTO<T> restResponseDTO = new RestResponseDTO<T>();
                ResponseEntity<T> tResponseEntity;
                try {
                        tResponseEntity = restTemplate.postForEntity(url, request, responseType, uriVariables);
                        restResponseDTO.setData(tResponseEntity.getBody());
                        restResponseDTO.setMessage(tResponseEntity.getStatusCode().name());
                        restResponseDTO.setStatusCode(tResponseEntity.getStatusCodeValue());
                }catch (Exception e){
                        restResponseDTO.setStatusCode(RestResponseDTO.UNKNOWN_ERROR);
                        restResponseDTO.setMessage(e.getMessage());
                        restResponseDTO.setData(null);
                }
                return restResponseDTO;
        }
    }

包装器 ExtractRestTemplate 很完美的更改了异常抛出的行为，让程序更具有容错性。在这里我们不考虑 ExtractRestTemplate 完成的功能，让我们把焦点放在 FilterRestTemplate 上，“实现 RestOperations 所有的接口”,这个操作绝对不是一时半会可以写完的，当时在重构之前我几乎写了半个小时,如下：

ublic abstract class FilterRestTemplate implements RestOperations {
    
        protected volatile RestTemplate restTemplate;
    
        protected FilterRestTemplate(RestTemplate restTemplate) {
                this.restTemplate = restTemplate;
        }
    
        @Override
        public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
                return restTemplate.getForObject(url,responseType,uriVariables);
        }
    
        @Override
        public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
                return restTemplate.getForObject(url,responseType,uriVariables);
        }
    
        @Override
        public <T> T getForObject(URI url, Class<T> responseType) throws RestClientException {
                return restTemplate.getForObject(url,responseType);
        }
    
        @Override
        public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
                return restTemplate.getForEntity(url,responseType,uriVariables);
        }
        //其他实现代码略。。。
    }

我相信你看了以上代码，你会和我一样觉得恶心反胃，后来我用 lombok 提供的代理注解优化了我的代码(@Delegate)：

@AllArgsConstructor
    public abstract class FilterRestTemplate implements RestOperations {
        @Delegate
        protected volatile RestTemplate restTemplate;
    }

这几行代码完全替代上述那些冗长的代码。

是不是很简洁，做一个拥抱 lombok 的程序员吧。

### 日期计算 ###

不是说所有的时间操作都用 Calendar 或 Date 去解决，一定要看场景。

对于时间的计算我们要考虑 joda-time 这种类似的成熟时间计算框架来写代码，它会让代码更加简洁和易读。

请读者先考虑这个需求如何用 Java 代码完成，或先写一个你觉得完成这个代码的思路，再来看我下边的代码，这样，你的收获会更多一些：

final DateTime DISTRIBUTION_TIME_SPLIT_TIME = new DateTime().withTime(15,0,0,0);
    private Date calculateDistributionTimeByOrderCreateTime(Date orderCreateTime){
        DateTime orderCreateDateTime = new DateTime(orderCreateTime);
        Date tomorrow = orderCreateDateTime.plusDays(1).toDate();
        Date theDayAfterTomorrow = orderCreateDateTime.plusDays(2).toDate();
        return orderCreateDateTime.isAfter(DISTRIBUTION_TIME_SPLIT_TIME) ? wrapDistributionTime(theDayAfterTomorrow) : wrapDistributionTime(tomorrow);
    }
    private Date wrapDistributionTime(Date distributionTime){
        DateTime currentDistributionDateTime = new DateTime(distributionTime);
        DateTime plusOneDay = currentDistributionDateTime.plusDays(1);
        boolean isSunday = (DateTimeConstants.SUNDAY == currentDistributionDateTime.getDayOfWeek());
        return isSunday ? plusOneDay.toDate() : currentDistributionDateTime.toDate() ;
    }

读这段代码的时候，你会发现，我将判断和有可能出现的不同结果都当做一个变量，最终做一个三目运算符的方式进行返回，这样的优雅和可读性显而易见，当然这样的代码不是一蹴而就的，我优化了 3 遍产生的以上代码。读者可根据自己的代码和我写的代码进行对比。