MapStruct表達式應用及避坑詳解

更新時間：2022年02月22日 16:57:24 作者：kl

一不小心踩了MapStruct表達式的坑，發(fā)現(xiàn)了一個在官方文檔上都找不到的功能，有必要記錄下。MapStruct是一個代碼生成器，它基于約定優(yōu)于配置的方法大大簡化了Java?Bean類型之間的映射的實現(xiàn)

前言

生成的映射代碼使用簡單的方法調用，因此速度快，類型安全且易于理解。MapStruct的表達式功能是為了處理特殊對象屬性的映射問題，比如DTO中的status屬性轉換成PO中的status需要進一步的處理，這個時候就需要用到表達式功能了。這里不再贅述關于MapStruct的使用問題，更多的使用教程可參考文檔

MapStruct官方文檔：https://mapstruct.org/documentation/stable/reference/html/#mapping-composition

遇到的問題

先看一段映射的代碼：

@Mapper(imports = CustomProcessors.class)
public interface DepartmentsMapper {
    @Mapping(target = "status", expression = "java( DepartmentsMapper.toStatus(department.getStatus()) )")
    DepartmentsVO boToVo(DepartmentBO department);
    static String toStatus(String status){
        return status + "狀態(tài)";
    }
}

原本這段代碼表達的語義是：將DepartmentBO的status屬性賦值給DepartmentsVO時，需要進行一些簡單的轉換，轉換的方法就是Mapper接口里定義的toStatus靜態(tài)方法?？勺罱KMapStruct生成的代碼把其他屬性的賦值動作也做了處理。生成的代碼如下：

可以看到除了指定的status屬性加上了表達式中的代碼，其他的屬性也都加上了，這不是我們想要的效果。

發(fā)現(xiàn)原因

樓主反復查看官方文檔，最后就差把源碼拉下來看實現(xiàn)邏輯了，最后一個閃念猜想到了可能的原因。上面關于表達式的使用代碼沒有問題，官方文檔也寫的很清楚。主要是因為這里觸發(fā)了MapStruct的一個隱藏功能：仔細觀察生成的代碼發(fā)現(xiàn)，只有Integer屬性的字段加上表達式中的代碼了，樓主推斷只要在定義maping的接口中定義了轉換方法就會被自動應用到相同類型屬性的轉換上。后面驗證確實如此，比如我去掉表達式的定義：

@Mapper(imports = CustomProcessors.class)
public interface DepartmentsMapper {
    DepartmentsVO boToVo(DepartmentBO department);
    static Integer toStatus(Integer status){
        return status + 1;
    }
}

最終生成的代碼還是所有的Integer屬性的值都加上了toStatus的處理了