快捷導(dǎo)航

MapStruct表達(dá)式應(yīng)用及避坑詳解

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

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

前言

生成的映射代碼使用簡單的方法調(diào)用，因此速度快，類型安全且易于理解。MapStruct的表達(dá)式功能是為了處理特殊對象屬性的映射問題，比如DTO中的status屬性轉(zhuǎn)換成PO中的status需要進(jìn)一步的處理，這個(gè)時(shí)候就需要用到表達(dá)式功能了。這里不再贅述關(guān)于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)";
    }
}

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

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

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

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

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

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

結(jié)語

最后發(fā)現(xiàn)的這個(gè)特性竟然在官方文檔上找不到絲毫的描述，其實(shí)可以算一個(gè)非常不錯(cuò)的功能，可以統(tǒng)一處理相同類型的屬性，比如屬性是一個(gè)對象時(shí)，只是在博主的這個(gè)場景下使用不到。最后的解決方案是將表達(dá)式中的代碼定義從Mapper接口中移出去就好了。

以上就是MapStruct表達(dá)式應(yīng)用及避坑詳解的詳細(xì)內(nèi)容，更多關(guān)于MapStruct表達(dá)式避坑的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: