别再寫滿屏的 get & set 了，太 Low！試試 MapStruct 進階玩法！

1、自定義映射

當我們映射 DTO 的時候，如果某些參數的值 MapStruct 的映射配置不能滿足要求，可以使用自定義方法。

新增兩個 DTO 類：

UserCustomDTO 類裡面包含了 UserExtDTO 對象。

/**
 * 微信公衆号：Java技術棧
 * @author 棧長
 */
@Data
public class UserCustomDTO {

    private String name;

    private int sex;

    private boolean married;

    private String birthday;

    private String regDate;

    private UserExtDTO userExtDTO;

    private String memo;


}      

/**
 * 微信公衆号：Java技術棧
 * @author 棧長
 */
@Data
public class UserExtDTO {

    private String regSource;

    private String favorite;

    private String school;

    private int kids;

    private String memo;

}      

自定義映射：

如果 UserExtDTO 對象不想使用預設的映射，可以添加一個該參數的自定義映射方法。

/**
 * 微信公衆号：Java技術棧
 * @author 棧長
 */
@Mapper(componentModel = "spring")
public interface UserCustomStruct {

    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd")
    @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))")
    @Mapping(source = "userExtDO", target = "userExtDTO")
    @Mapping(target = "memo", ignore = true)
    UserCustomDTO toUserCustomDTO(UserDO userDO);

    default UserExtDTO toUserExtDTO(UserExtDO userExtDO) {
        UserExtDTO userExtDTO = new UserExtDTO();
        userExtDTO.setKids(userExtDO.getKids());
        userExtDTO.setFavorite(userExtDO.getFavorite());

        // 覆寫這兩個值
        userExtDTO.setRegSource("預設來源");
        userExtDTO.setSchool("預設學校");

        return userExtDTO;
    }

}      

當映射 UserExtDTO 對象的時候，會自動調用該接口中的自定義 toUserExtDTO 方法，完成自定義映射。

來看下生成的實作類源碼：

@Component
public class UserCustomStructImpl implements UserCustomStruct {
    public UserCustomStructImpl() {
    }

    public UserCustomDTO toUserCustomDTO(UserDO userDO) {
        if (userDO == null) {
            return null;
        } else {
            UserCustomDTO userCustomDTO = new UserCustomDTO();
            if (userDO.getBirthday() != null) {
                userCustomDTO.setBirthday((new SimpleDateFormat("yyyy-MM-dd")).format(userDO.getBirthday()));
            }

            userCustomDTO.setUserExtDTO(this.toUserExtDTO(userDO.getUserExtDO()));
            userCustomDTO.setName(userDO.getName());
            userCustomDTO.setSex(userDO.getSex());
            userCustomDTO.setMarried(userDO.isMarried());
            userCustomDTO.setRegDate(DateFormatUtils.format(userDO.getRegDate(), "yyyy-MM-dd HH:mm:ss"));
            return userCustomDTO;
        }
    }
}      

沒錯，setUserExtDTO 方法調用了 this.toUserExtDTO 自定義方法映射。

Spring Boot 基礎這篇就不介紹了，系列基礎教程和示例源碼可以看這裡：

https://github.com/javastacks/spring-boot-best-practice

測試一下：

/**
 * 微信公衆号：Java技術棧
 * @author 棧長
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserCustomStructTest {

    @Autowired
    private UserCustomStruct userCustomStruct;

    @Test
    public void test1() {
        UserExtDO userExtDO = new UserExtDO();
        userExtDO.setRegSource("公衆号：Java技術棧");
        userExtDO.setFavorite("寫代碼");
        userExtDO.setSchool("社會大學");
        userExtDO.setKids(1);

        UserDO userDO = new UserDO();
        userDO.setName("棧長自定義方法");
        userDO.setSex(1);
        userDO.setAge(18);
        userDO.setBirthday(new Date());
        userDO.setPhone("18888888888");
        userDO.setMarried(true);
        userDO.setRegDate(new Date());
        userDO.setMemo("666");
        userDO.setUserExtDO(userExtDO);

        UserCustomDTO userCustomDTO = userCustomStruct.toUserCustomDTO(userDO);
        System.out.println("=====自定義方法=====");
        System.out.println(userCustomDTO);
    }
}      

輸出結果：

可以看到自定義方法覆寫的兩個值，結果驗證成功。

2、多參數映射

之前介紹的映射方法中隻有一個參數，如果有多個參數映射成一個 DTO，該怎麼弄呢？

比如：有兩具單獨的 DO，UserDO、UserAddressDO 映射成 UserMultiDTO。

直接上代碼：

/**
 * 微信公衆号：Java技術棧
 * @author 棧長
 */
@Mapper(componentModel = "spring")
public interface UserMultiStruct {

    @Mapping(source = "userDO.birthday", target = "birthday", dateFormat = "yyyy-MM-dd")
    @Mapping(target = "userDO.regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(user.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))")
    @Mapping(source = "userAddressDO.postcode", target = "postcode")
    @Mapping(source = "userAddressDO.address", target = "address")
    @Mapping(target = "memo", ignore = true)
    UserMultiDTO toUserMultiDTO(UserDO userDO, UserAddressDO userAddressDO);

}      

直接使用指定的

對象名.屬性名

形式映射即可。

@Component
public class UserMultiStructImpl implements UserMultiStruct {
    public UserMultiStructImpl() {
    }

    public UserMultiDTO toUserMultiDTO(UserDO userDO, UserAddressDO userAddressDO) {
        if (userDO == null && userAddressDO == null) {
            return null;
        } else {
            UserMultiDTO userMultiDTO = new UserMultiDTO();
            if (userDO != null) {
                if (userDO.getBirthday() != null) {
                    userMultiDTO.setBirthday((new SimpleDateFormat("yyyy-MM-dd")).format(userDO.getBirthday()));
                }

                userMultiDTO.setName(userDO.getName());
                userMultiDTO.setSex(userDO.getSex());
                userMultiDTO.setMarried(userDO.isMarried());
                if (userDO.getRegDate() != null) {
                    userMultiDTO.setRegDate((new SimpleDateFormat()).format(userDO.getRegDate()));
                }
            }

            if (userAddressDO != null) {
                userMultiDTO.setPostcode(userAddressDO.getPostcode());
                userMultiDTO.setAddress(userAddressDO.getAddress());
            }

            return userMultiDTO;
        }
    }
}      

/**
 * 微信公衆号：Java技術棧
 * @author 棧長
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMultiStructTest {

    @Autowired
    private UserMultiStruct userMultiStruct;

    @Test
    public void test1() {
        UserDO userDO = new UserDO();
        userDO.setName("多參數映射");
        userDO.setSex(1);
        userDO.setAge(18);
        userDO.setBirthday(new Date());
        userDO.setPhone("18888888888");
        userDO.setMarried(true);
        userDO.setRegDate(new Date());
        userDO.setMemo("666");

        UserAddressDO userAddressDO = new UserAddressDO();
        userAddressDO.setProvince("廣東省");
        userAddressDO.setCity("深圳市");
        userAddressDO.setPostcode("666666");
        userAddressDO.setAddress("001号大街Java技術棧公衆号");
        userAddressDO.setMemo("位址資訊");

        UserMultiDTO userMultiDTO = userMultiStruct.toUserMultiDTO(userDO, userAddressDO);
        System.out.println("=====多參數映射=====");
        System.out.println(userMultiDTO);
    }
}      

個人資訊和位址資訊都輸出來了，結果驗證成功。

本文實戰源代碼完整版已經上傳：

3、嵌套映射

如果一個 DTO 中的值都是從一個對象中的多個嵌套對象映射時，如果不想一個個寫映射，目标可以用 . 表示。

/** * 微信公衆号：Java技術棧 * @author 棧長 */@Mapper(componentModel = "spring")public interface UserNestedStruct {    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd")    @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userNestedDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))")    @Mapping(source = "userAddressDO", target = ".")    @Mapping(source = "userExtDO", target = ".")    @Mapping(source = "userExtDO.memo", target = "memo")    UserNestedDTO toUserNestedDTO(UserNestedDO userNestedDO);}      

如果嵌套對象中出現重名的映射沖突，可以手動指定來源哪個嵌套對象。

@Componentpublic class UserNestedStructImpl implements UserNestedStruct {    public UserNestedStructImpl() {    }    public UserNestedDTO toUserNestedDTO(UserNestedDO userNestedDO) {        if (userNestedDO == null) {            return null;        } else {            UserNestedDTO userNestedDTO = new UserNestedDTO();            if (userNestedDO.getBirthday() != null) {                userNestedDTO.setBirthday((new SimpleDateFormat("yyyy-MM-dd")).format(userNestedDO.getBirthday()));            }            userNestedDTO.setMemo(this.userNestedDOUserExtDOMemo(userNestedDO));            userNestedDTO.setCity(this.userNestedDOUserAddressDOCity(userNestedDO));            userNestedDTO.setAddress(this.userNestedDOUserAddressDOAddress(userNestedDO));            userNestedDTO.setRegSource(this.userNestedDOUserExtDORegSource(userNestedDO));            userNestedDTO.setFavorite(this.userNestedDOUserExtDOFavorite(userNestedDO));            userNestedDTO.setSchool(this.userNestedDOUserExtDOSchool(userNestedDO));            userNestedDTO.setName(userNestedDO.getName());            userNestedDTO.setSex(userNestedDO.getSex());            userNestedDTO.setMarried(userNestedDO.isMarried());            userNestedDTO.setRegDate(DateFormatUtils.format(userNestedDO.getRegDate(), "yyyy-MM-dd HH:mm:ss"));            return userNestedDTO;        }    }    private String userNestedDOUserExtDOMemo(UserNestedDO userNestedDO) {        if (userNestedDO == null) {            return null;        } else {            UserExtDO userExtDO = userNestedDO.getUserExtDO();            if (userExtDO == null) {                return null;            } else {                String memo = userExtDO.getMemo();                return memo == null ? null : memo;            }        }    }    private String userNestedDOUserAddressDOCity(UserNestedDO userNestedDO) {        if (userNestedDO == null) {            return null;        } else {            UserAddressDO userAddressDO = userNestedDO.getUserAddressDO();            if (userAddressDO == null) {                return null;            } else {                String city = userAddressDO.getCity();                return city == null ? null : city;            }        }    }    private String userNestedDOUserAddressDOAddress(UserNestedDO userNestedDO) {        if (userNestedDO == null) {            return null;        } else {            UserAddressDO userAddressDO = userNestedDO.getUserAddressDO();            if (userAddressDO == null) {                return null;            } else {                String address = userAddressDO.getAddress();                return address == null ? null : address;            }        }    }    private String userNestedDOUserExtDORegSource(UserNestedDO userNestedDO) {        if (userNestedDO == null) {            return null;        } else {            UserExtDO userExtDO = userNestedDO.getUserExtDO();            if (userExtDO == null) {                return null;            } else {                String regSource = userExtDO.getRegSource();                return regSource == null ? null : regSource;            }        }    }    private String userNestedDOUserExtDOFavorite(UserNestedDO userNestedDO) {        if (userNestedDO == null) {            return null;        } else {            UserExtDO userExtDO = userNestedDO.getUserExtDO();            if (userExtDO == null) {                return null;            } else {                String favorite = userExtDO.getFavorite();                return favorite == null ? null : favorite;            }        }    }    private String userNestedDOUserExtDOSchool(UserNestedDO userNestedDO) {        if (userNestedDO == null) {            return null;        } else {            UserExtDO userExtDO = userNestedDO.getUserExtDO();            if (userExtDO == null) {                return null;            } else {                String school = userExtDO.getSchool();                return school == null ? null : school;            }        }    }}      

從源碼可以看到，從嵌套對象來的值都會新增一個方法判斷一下，以避免出現空指定。

/** * 微信公衆号：Java技術棧 * @author 棧長 */@RunWith(SpringRunner.class)@SpringBootTestpublic class UserNestedStructTest {    @Autowired    private UserNestedStruct userNestedStruct;    @Test    public void test1() {        UserExtDO userExtDO = new UserExtDO();        userExtDO.setRegSource("公衆号：Java技術棧");        userExtDO.setFavorite("寫代碼");        userExtDO.setSchool("社會大學");        userExtDO.setKids(1);        userExtDO.setMemo("擴充資訊");        UserAddressDO userAddressDO = new UserAddressDO();        userAddressDO.setProvince("廣東省");        userAddressDO.setCity("深圳市");        userAddressDO.setPostcode("666666");        userAddressDO.setAddress("001号大街Java技術棧公衆号");        userAddressDO.setMemo("位址資訊");        UserNestedDO userNestedDO = new UserNestedDO();        userNestedDO.setName("棧長嵌套映射");        userNestedDO.setSex(1);        userNestedDO.setAge(18);        userNestedDO.setBirthday(new Date());        userNestedDO.setPhone("18888888888");        userNestedDO.setMarried(true);        userNestedDO.setRegDate(new Date());        userNestedDO.setMemo("666");        userNestedDO.setUserExtDO(userExtDO);        userNestedDO.setUserAddressDO(userAddressDO);        UserNestedDTO userNestedDTO = userNestedStruct.toUserNestedDTO(userNestedDO);        System.out.println("=====嵌套映射=====");        System.out.println(userNestedDTO);    }}      

可以看到嵌套對象值，并且 memo 也是從指定的嵌套對象來的，結果驗證成功。

4、映射現有執行個體

以上介紹的都是映射并生成一個新的 DTO 執行個體，如果是已有的現有 DTO 執行個體呢，該怎麼映射呢？

/** * 微信公衆号：Java技術棧 * @author 棧長 */@Mapper(componentModel = "spring")public interface UserExistStruct {    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd")    @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))")    @Mapping(source = "userExtDO.regSource", target = "registerSource")    @Mapping(source = "userExtDO.favorite", target = "favorite")    @Mapping(target = "name", ignore = true)    @Mapping(target = "memo", ignore = true)    void toUserShowDTO(@MappingTarget UserShowDTO userShowDTO, UserDO userDO);}      

在方法上新增 DTO 對象參數并使用

@MappingTarget

對象修飾，參數位置可以調換。

@Componentpublic class UserExistStructImpl implements UserExistStruct {    public UserExistStructImpl() {    }    public void toUserShowDTO(UserShowDTO userShowDTO, UserDO userDO) {        if (userDO != null) {            if (userDO.getBirthday() != null) {                userShowDTO.setBirthday((new SimpleDateFormat("yyyy-MM-dd")).format(userDO.getBirthday()));            } else {                userShowDTO.setBirthday((String)null);            }            userShowDTO.setRegisterSource(this.userDOUserExtDORegSource(userDO));            userShowDTO.setFavorite(this.userDOUserExtDOFavorite(userDO));            userShowDTO.setSex(userDO.getSex());            userShowDTO.setMarried(userDO.isMarried());            userShowDTO.setRegDate(DateFormatUtils.format(userDO.getRegDate(), "yyyy-MM-dd HH:mm:ss"));        }    }    private String userDOUserExtDORegSource(UserDO userDO) {        if (userDO == null) {            return null;        } else {            UserExtDO userExtDO = userDO.getUserExtDO();            if (userExtDO == null) {                return null;            } else {                String regSource = userExtDO.getRegSource();                return regSource == null ? null : regSource;            }        }    }    private String userDOUserExtDOFavorite(UserDO userDO) {        if (userDO == null) {            return null;        } else {            UserExtDO userExtDO = userDO.getUserExtDO();            if (userExtDO == null) {                return null;            } else {                String favorite = userExtDO.getFavorite();                return favorite == null ? null : favorite;            }        }    }}      

userShowDTO 是作為方法參數傳入的，而不是新建立的。

/** * 微信公衆号：Java技術棧 * @author 棧長 */@RunWith(SpringRunner.class)@SpringBootTestpublic class UserExistStructTest {    @Autowired    private UserExistStruct userExistStruct;    @Test    public void test1() {        UserExtDO userExtDO = new UserExtDO();        userExtDO.setRegSource("公衆号：Java技術棧");        userExtDO.setFavorite("寫代碼");        userExtDO.setSchool("社會大學");        UserDO userDO = new UserDO();        userDO.setName("棧長");        userDO.setSex(1);        userDO.setAge(18);        userDO.setBirthday(new Date());        userDO.setPhone("18888888888");        userDO.setMarried(true);        userDO.setRegDate(new Date());        userDO.setMemo("666");        userDO.setUserExtDO(userExtDO);        System.out.println("=====映射現有執行個體前=====");        UserShowDTO userShowDTO = new UserShowDTO();        userShowDTO.setName("棧長NAME");        userShowDTO.setMemo("棧長MEMO");        System.out.println(userShowDTO);        System.out.println("=====映射現有執行個體後=====");        userExistStruct.toUserShowDTO(userShowDTO, userDO);        System.out.println(userShowDTO);    }}      

可以看到已有 DTO 對象的值及新映射的值，結果驗證成功。

注意：預設是以覆寫原有值的方式映射的，如果要保留原有 XX 的值，使用 ignore 忽略即可

總結

本文棧長介紹了 MapStruct 的 4 個進階玩法，足以應對各種 Bean 類映射了，其實還有很多複雜的、個性化用法，一篇難以寫完，棧長後面有時間會整理出來，陸續給大家分享。

感興趣的也可以參考官方文檔：

https://mapstruct.org/documentation/reference-guide/

另外，棧長一直介紹的是 DO --> DTO 的映射，其實反過來 DTO --> DO、BO 也是一樣的，隻是對象名稱不一樣，映射的用法是一樣的，這樣在服務 A 接收到服務 B 過來的 DTO 資料時，可以再進行一次反射映射供業務使用。

歡迎 Star 學習，後面 Spring Boot 示例都會在這上面提供！

好了，今天的分享就到這裡了，後面棧長會分享更多好玩的 Java 技術和最新的技術資訊，關注公衆号Java技術棧第一時間推送，我也将主流 Java 面試題和參考答案都整理好了，在公衆号背景回複關鍵字 "面試" 進行刷題。

最後，覺得我的文章對你用收獲的話，動動小手，給個在看、轉發，原創不易，棧長需要你的鼓勵。