Java編寫的實體返回VO工具

更新時間：2021年05月13日 09:35:19 作者：是小張啊

VO(value object)通常用于業(yè)務層之間的數(shù)據(jù)傳遞，VO的屬性是根據(jù)當前業(yè)務的不同而不同的，也就是說，它的每一個屬性都一一對應當前業(yè)務邏輯所需要的數(shù)據(jù)的名稱。本文將介紹如何將實體轉換為vo對象

好久不見最近些許有點懶惰程序員嘛每個月總會有幾天的你懂得

那最近發(fā)現(xiàn)好的代碼寫出來真的會讓人有種賞心悅目的存在相反就會有一種想掐死寫代碼的那個人

所以我最近寫了一個小工具就是實體轉換VO對象的一個小工具說到這里如果你的第一反應是 Spring的BeanUtils 那說明你肯定也有遇到過跟我一樣的問題

那具體是怎么做? （不考慮性能的情況下）等下分析

先看下如果正常返回VO我們需要怎么去操作?

現(xiàn)在有一個用戶實體

import lombok.Data;

/**
 * 用戶實體
 *
 * @author 是小張啊
 * @since 2021-05-06
 */
@Data
public class User {
    /**
     * 用戶id
     */
    private String id;

    /**
     * 用戶名稱（賬號）
     */
    private String name;

    /**
     * 密碼（不加密）
     */
    private String password;
}

現(xiàn)在需要返回一個VO的對象即

import lombok.Data;

/**
 * 用戶vo對象
 * @author 是小張啊
 * @since 2021-05-06
 */
@Data
public class UserVo {
    /**
     * 用戶id
     */
    private String id;

    /**
     * 用戶名稱（賬號）
     */
    private String name;
}

可以這樣處理

import org.springframework.beans.BeanUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author 是小張啊
 * @since 2021-05-06
 */
@RestController
public class UserController {

    /**
     * 查詢用戶
     * @return
     */
    @GetMapping("/select")
    public UserVo select() {
        User user = new User();
        user.setId(1);
        user.setName("是小張啊");
        UserVo userVo = new UserVo();
        BeanUtils.copyProperties(user, userVo);
        return userVo;
    }
}

這樣是沒有問題的不談性能這樣做是非常穩(wěn)的

現(xiàn)在有這樣的一個需求需要返回一個 List<UserVo> 如果你能想到用 java8的lambda表達式的去使用Spring的BeanUtils 那也是不錯的
具體實現(xiàn)就是

import org.springframework.beans.BeanUtils;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;

/**
 * @author 是小張啊
 * @since 2021-05-06
 */
@RestController
public class UserController {

    /**
     * 查詢用戶
     * @return
     */
    public List<UserVo> select() {
        // 初始化數(shù)據(jù)
        User user1 = new User();
        user1.setId(1);
        user1.setName("是小張啊");
        User user2 = new User();
        user2.setId(1);
        user2.setName("是小張啊");
        List<User> users = new ArrayList<>();
        users.add(user1);
        users.add(user2);

        // List<entity> -> List<vo>
        List<UserVo> userVos = users.stream().map(user -> {
            UserVo userVo = new UserVo();
            BeanUtils.copyProperties(user, userVo);
            return userVo;
        }).collect(Collectors.toList());
        return userVos;
    }

}

這其實也挺不錯的只是每次都這樣寫屬實不美觀如果能提取公共方法去調用就太舒服了所以這個方法也是根據(jù) BeanUtils去優(yōu)化這個工具

import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;

import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;

/**
 * Bean 工具類
 * @author 是小張啊
 * @since 2021-05-06
 */
@Slf4j
public class Utils extends BeanUtils {
   
    /**
     * 將實體批量轉換成 vo對象
     * 注：當前只針對 List
     *
     * @param source 實體集合
     * @param clazz  需要批量轉換成的對象
     * @param <T>
     * @param <S>
     * @return
     */
    @SneakyThrows
    public static <T, S> List<T> conversionVo(List<S> source, Class<T> clazz) {
        return source.stream().map(resources -> {
            T t = null;
            try {
                // 利用反射 創(chuàng)建一個新的實例
                t = clazz.newInstance();
                BeanUtils.copyProperties(resources, t);
            } catch (InstantiationException e) {
                log.info("{}實例化失敗", clazz);
            } catch (IllegalAccessException e) {
                log.info("{}不可訪問", clazz);
            }
            return t;
        }).collect(Collectors.toList());
    }
}

這樣就很方便只需要去調用即可

import top.lzmvlog.common.Utils;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

/**
 * @author 是小張啊
 * @since 2021-05-06
 */
@RestController
public class UserController {

    /**
     * 查詢用戶
     * @return
     */
    public List<UserVo> select() {
        // 初始化數(shù)據(jù)
        User user1 = new User();
        user1.setId(1);
        user1.setName("是小張啊");
        User user2 = new User();
        user2.setId(1);
        user2.setName("是小張啊");
        List<User> users = new ArrayList<>();
        users.add(user1);
        users.add(user2);
        List<UserVo> userVos = Utils.conversionVo(users, UserVo.class);
        return userVos;
    }

}