當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

干掉 BeanUtils！试试这款 Bean 自动映射工具，真心强大！

發布時間：2025/3/15 编程问答 43 豆豆

生活随笔收集整理的這篇文章主要介紹了干掉 BeanUtils！试试这款 Bean 自动映射工具，真心强大！小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

平時做項目的時候，經常需要做PO、VO、DTO之間的轉換。簡單的對象轉換，使用BeanUtils基本上是夠了，但是復雜的轉換，如果使用它的話又得寫一堆Getter、Setter方法了。今天給大家推薦一款對象自動映射工具MapStruct，功能真心強大！

?

關于BeanUtils

平時我經常使用Hutool中的BeanUtil類來實現對象轉換，用多了之后就發現有些缺點：

對象屬性映射使用反射來實現，性能比較低；
對于不同名稱或不同類型的屬性無法轉換，還得單獨寫Getter、Setter方法；
對于嵌套的子對象也需要轉換的情況，也得自行處理；
集合對象轉換時，得使用循環，一個個拷貝。

對于這些不足，MapStruct都能解決，不愧為一款功能強大的對象映射工具！

?

MapStruct簡介

MapStruct是一款基于Java注解的對象屬性映射工具，在Github上已經有4.5K+Star。使用的時候我們只要在接口中定義好對象屬性映射規則，它就能自動生成映射實現類，不使用反射，性能優秀，能實現各種復雜映射。

?

IDEA插件支持

作為一款非常流行的對象映射工具，MapStruct還提供了專門的IDEA插件，我們在使用之前可以先安裝好插件。

項目集成

在SpingBoot中集成MapStruct非常簡單，僅續添加如下兩個依賴即可，這里使用的是1.4.2.Final版本。

<dependency><dependency><groupId>org.mapstruct</groupId><artifactId>mapstruct</artifactId><version>${mapstruct.version}</version></dependency><dependency><groupId>org.mapstruct</groupId><artifactId>mapstruct-processor</artifactId><version>${mapstruct.version}</version><scope>compile</scope></dependency> </dependencies>

?

基本使用

集成完MapStruct之后，我們來體驗下它的功能吧，看看它有何神奇之處！

基本映射

我們先來個快速入門，體驗一下MapStruct的基本功能，并聊聊它的實現原理。

首先我們準備好要使用的會員PO對象Member；

/***?購物會員*?Created?by?macro?on?2021/10/12.*/ @Data @EqualsAndHashCode(callSuper?=?false) public?class?Member?{private?Long?id;private?String?username;private?String?password;private?String?nickname;private?Date?birthday;private?String?phone;private?String?icon;private?Integer?gender; }

然后再準備好會員的DTO對象MemberDto，我們需要將Member對象轉換為MemberDto對象；

/***?購物會員Dto*?Created?by?macro?on?2021/10/12.*/ @Data @EqualsAndHashCode(callSuper?=?false) public?class?MemberDto?{private?Long?id;private?String?username;private?String?password;private?String?nickname;//與PO類型不同的屬性private?String?birthday;//與PO名稱不同的屬性private?String?phoneNumber;private?String?icon;private?Integer?gender; }

然后創建一個映射接口MemberMapper，實現同名同類型屬性、不同名稱屬性、不同類型屬性的映射；

接下來在Controller中創建測試接口，直接通過接口中的INSTANCE實例調用轉換方法toDto；

/***?MapStruct對象轉換測試Controller*?Created?by?macro?on?2021/10/21.*/ @RestController @Api(tags?=?"MapStructController",?description?=?"MapStruct對象轉換測試") @RequestMapping("/mapStruct") public?class?MapStructController?{@ApiOperation(value?=?"基本映射")@GetMapping("/baseMapping")public?CommonResult?baseTest()?{List<Member>?memberList?=?LocalJsonUtil.getListFromJson("json/members.json",?Member.class);MemberDto?memberDto?=?MemberMapper.INSTANCE.toDto(memberList.get(0));return?CommonResult.success(memberDto);} }

運行項目后在Swagger中測試接口，發現PO所有屬性已經成功轉換到DTO中去了，Swagger訪問地址：http://localhost:8088/swagger-ui

其實MapStruct的實現原理很簡單，就是根據我們在Mapper接口中使用的@Mapper和@Mapping等注解，在運行時生成接口的實現類，我們可以打開項目的target目錄看下；

下面是MapStruct為MemberMapper生成好的對象映射代碼，可以和手寫Getter、Setter說再見了！

public?class?MemberMapperImpl?implements?MemberMapper?{public?MemberMapperImpl()?{}public?MemberDto?toDto(Member?member)?{if?(member?==?null)?{return?null;}?else?{MemberDto?memberDto?=?new?MemberDto();memberDto.setPhoneNumber(member.getPhone());if?(member.getBirthday()?!=?null)?{memberDto.setBirthday((new?SimpleDateFormat("yyyy-MM-dd")).format(member.getBirthday()));}memberDto.setId(member.getId());memberDto.setUsername(member.getUsername());memberDto.setPassword(member.getPassword());memberDto.setNickname(member.getNickname());memberDto.setIcon(member.getIcon());memberDto.setGender(member.getGender());return?memberDto;}} }

集合映射

MapStruct也提供了集合映射的功能，可以直接將一個PO列表轉換為一個DTO列表，再也不用一個個對象轉換了！

在MemberMapper接口中添加toDtoList方法用于列表轉換；

在Controller中創建測試接口，直接通過Mapper接口中的INSTANCE實例調用轉換方法toDtoList；

/***?MapStruct對象轉換測試Controller*?Created?by?macro?on?2021/10/21.*/ @RestController @Api(tags?=?"MapStructController",?description?=?"MapStruct對象轉換測試") @RequestMapping("/mapStruct") public?class?MapStructController?{@ApiOperation(value?=?"集合映射")@GetMapping("/collectionMapping")public?CommonResult?collectionMapping()?{List<Member>?memberList?=?LocalJsonUtil.getListFromJson("json/members.json",?Member.class);List<MemberDto>?memberDtoList?=?MemberMapper.INSTANCE.toDtoList(memberList);return?CommonResult.success(memberDtoList);} }

在Swagger中調用接口測試下，PO列表已經轉換為DTO列表了。

子對象映射

MapStruct對于對象中包含子對象也需要轉換的情況也是有所支持的。

例如我們有一個訂單PO對象Order，嵌套有Member和Product對象；

/***?訂單*?Created?by?macro?on?2021/10/12.*/ @Data @EqualsAndHashCode(callSuper?=?false) public?class?Order?{private?Long?id;private?String?orderSn;private?Date?createTime;private?String?receiverAddress;private?Member?member;private?List<Product>?productList; }

我們需要轉換為OrderDto對象，OrderDto中包含MemberDto和ProductDto兩個子對象同樣需要轉換；

/***?訂單Dto*?Created?by?macro?on?2021/10/12.*/ @Data @EqualsAndHashCode(callSuper?=?false) public?class?OrderDto?{private?Long?id;private?String?orderSn;private?Date?createTime;private?String?receiverAddress;//子對象映射Dtoprivate?MemberDto?memberDto;//子對象數組映射Dtoprivate?List<ProductDto>?productDtoList; }

我們只需要創建一個Mapper接口，然后通過使用uses將子對象的轉換Mapper注入進來，然后通過@Mapping設置好屬性映射規則即可；

/***?訂單對象映射*?Created?by?macro?on?2021/10/21.*/ @Mapper(uses?=?{MemberMapper.class,ProductMapper.class}) public?interface?OrderMapper?{OrderMapper?INSTANCE?=?Mappers.getMapper(OrderMapper.class);@Mapping(source?=?"member",target?=?"memberDto")@Mapping(source?=?"productList",target?=?"productDtoList")OrderDto?toDto(Order?order); }

接下來在Controller中創建測試接口，直接通過Mapper中的INSTANCE實例調用轉換方法toDto；

在Swagger中調用接口測試下，可以發現子對象屬性已經被轉換了。

合并映射

MapStruct也支持把多個對象屬性映射到一個對象中去。

例如這里把Member和Order的部分屬性映射到MemberOrderDto中去；

/***?會員商品信息組合Dto*?Created?by?macro?on?2021/10/21.*/ @Data @EqualsAndHashCode(callSuper?=?false) public?class?MemberOrderDto?extends?MemberDto{private?String?orderSn;private?String?receiverAddress; }

然后在Mapper中添加toMemberOrderDto方法，這里需要注意的是由于參數中具有兩個屬性，需要通過參數名稱.屬性的名稱來指定source來防止沖突（這兩個參數中都有id屬性）;

/***?會員對象映射*?Created?by?macro?on?2021/10/21.*/ @Mapper public?interface?MemberMapper?{MemberMapper?INSTANCE?=?Mappers.getMapper(MemberMapper.class);@Mapping(source?=?"member.phone",target?=?"phoneNumber")@Mapping(source?=?"member.birthday",target?=?"birthday",dateFormat?=?"yyyy-MM-dd")@Mapping(source?=?"member.id",target?=?"id")@Mapping(source?=?"order.orderSn",?target?=?"orderSn")@Mapping(source?=?"order.receiverAddress",?target?=?"receiverAddress")MemberOrderDto?toMemberOrderDto(Member?member,?Order?order); }

接下來在Controller中創建測試接口，直接通過Mapper中的INSTANCE實例調用轉換方法toMemberOrderDto；

/***?MapStruct對象轉換測試Controller*?Created?by?macro?on?2021/10/21.*/ @RestController @Api(tags?=?"MapStructController",?description?=?"MapStruct對象轉換測試") @RequestMapping("/mapStruct") public?class?MapStructController?{@ApiOperation(value?=?"組合映射")@GetMapping("/compositeMapping")public?CommonResult?compositeMapping()?{List<Order>?orderList?=?LocalJsonUtil.getListFromJson("json/orders.json",?Order.class);List<Member>?memberList?=?LocalJsonUtil.getListFromJson("json/members.json",?Member.class);Member?member?=?memberList.get(0);Order?order?=?orderList.get(0);MemberOrderDto?memberOrderDto?=?MemberMapper.INSTANCE.toMemberOrderDto(member,order);return?CommonResult.success(memberOrderDto);} }

在Swagger中調用接口測試下，可以發現Member和Order中的屬性已經被映射到MemberOrderDto中去了。

進階使用

通過上面的基本使用，大家已經可以玩轉MapStruct了，下面我們再來介紹一些進階的用法。

使用依賴注入

上面我們都是通過Mapper接口中的INSTANCE實例來調用方法的，在Spring中我們也是可以使用依賴注入的。

想要使用依賴注入，我們只要將@Mapper注解的componentModel參數設置為spring即可，這樣在生成接口實現類時，MapperStruct會為其添加@Component注解；

/***?會員對象映射（依賴注入）*?Created?by?macro?on?2021/10/21.*/ @Mapper(componentModel?=?"spring") public?interface?MemberSpringMapper?{@Mapping(source?=?"phone",target?=?"phoneNumber")@Mapping(source?=?"birthday",target?=?"birthday",dateFormat?=?"yyyy-MM-dd")MemberDto?toDto(Member?member); }

接下來在Controller中使用@Autowired注解注入即可使用；

/***?MapStruct對象轉換測試Controller*?Created?by?macro?on?2021/10/21.*/ @RestController @Api(tags?=?"MapStructController",?description?=?"MapStruct對象轉換測試") @RequestMapping("/mapStruct") public?class?MapStructController?{@Autowiredprivate?MemberSpringMapper?memberSpringMapper;@ApiOperation(value?=?"使用依賴注入")@GetMapping("/springMapping")public?CommonResult?springMapping()?{List<Member>?memberList?=?LocalJsonUtil.getListFromJson("json/members.json",?Member.class);MemberDto?memberDto?=?memberSpringMapper.toDto(memberList.get(0));return?CommonResult.success(memberDto);} }

在Swagger中調用接口測試下，可以發現與之前一樣可以正常使用。

使用常量、默認值和表達式

使用MapStruct映射屬性時，我們可以設置屬性為常量或者默認值，也可以通過Java中的方法編寫表達式來自動生成屬性。

例如下面這個商品類Product對象；

/***?商品*?Created?by?macro?on?2021/10/12.*/ @Data @EqualsAndHashCode(callSuper?=?false) public?class?Product?{private?Long?id;private?String?productSn;private?String?name;private?String?subTitle;private?String?brandName;private?BigDecimal?price;private?Integer?count;private?Date?createTime; }

我們想把Product轉換為ProductDto對象，id屬性設置為常量，count設置默認值為1，productSn設置為UUID生成；

/***?商品Dto*?Created?by?macro?on?2021/10/12.*/ @Data @EqualsAndHashCode(callSuper?=?false) public?class?ProductDto?{//使用常量private?Long?id;//使用表達式生成屬性private?String?productSn;private?String?name;private?String?subTitle;private?String?brandName;private?BigDecimal?price;//使用默認值private?Integer?count;private?Date?createTime; }

創建ProductMapper接口，通過@Mapping注解中的constant、defaultValue、expression設置好映射規則；

/***?商品對象映射*?Created?by?macro?on?2021/10/21.*/ @Mapper(imports?=?{UUID.class}) public?interface?ProductMapper?{ProductMapper?INSTANCE?=?Mappers.getMapper(ProductMapper.class);@Mapping(target?=?"id",constant?=?"-1L")@Mapping(source?=?"count",target?=?"count",defaultValue?=?"1")@Mapping(target?=?"productSn",expression?=?"java(UUID.randomUUID().toString())")ProductDto?toDto(Product?product); }

接下來在Controller中創建測試接口，直接通過接口中的INSTANCE實例調用轉換方法toDto；

/***?MapStruct對象轉換測試Controller*?Created?by?macro?on?2021/10/21.*/ @RestController @Api(tags?=?"MapStructController",?description?=?"MapStruct對象轉換測試") @RequestMapping("/mapStruct") public?class?MapStructController?{@ApiOperation(value?=?"使用常量、默認值和表達式")@GetMapping("/defaultMapping")public?CommonResult?defaultMapping()?{List<Product>?productList?=?LocalJsonUtil.getListFromJson("json/products.json",?Product.class);Product?product?=?productList.get(0);product.setId(100L);product.setCount(null);ProductDto?productDto?=?ProductMapper.INSTANCE.toDto(product);return?CommonResult.success(productDto);} }

在Swagger中調用接口測試下，對象已經成功轉換。

在映射前后進行自定義處理

MapStruct也支持在映射前后做一些自定義操作，類似AOP中的切面。

由于此時我們需要創建自定義處理方法，創建一個抽象類ProductRoundMapper，通過@BeforeMapping注解自定義映射前操作，通過@AfterMapping注解自定義映射后操作；

/***?商品對象映射（自定義處理）*?Created?by?macro?on?2021/10/21.*/ @Mapper(imports?=?{UUID.class}) public?abstract?class?ProductRoundMapper?{public?static?ProductRoundMapper?INSTANCE?=?Mappers.getMapper(ProductRoundMapper.class);@Mapping(target?=?"id",constant?=?"-1L")@Mapping(source?=?"count",target?=?"count",defaultValue?=?"1")@Mapping(target?=?"productSn",expression?=?"java(UUID.randomUUID().toString())")public?abstract?ProductDto?toDto(Product?product);@BeforeMappingpublic?void?beforeMapping(Product?product){//映射前當price<0時設置為0if(product.getPrice().compareTo(BigDecimal.ZERO)<0){product.setPrice(BigDecimal.ZERO);}}@AfterMappingpublic?void?afterMapping(@MappingTarget?ProductDto?productDto){//映射后設置當前時間為createTimeproductDto.setCreateTime(new?Date());} }

接下來在Controller中創建測試接口，直接通過Mapper中的INSTANCE實例調用轉換方法toDto；

/***?MapStruct對象轉換測試Controller*?Created?by?macro?on?2021/10/21.*/ @RestController @Api(tags?=?"MapStructController",?description?=?"MapStruct對象轉換測試") @RequestMapping("/mapStruct") public?class?MapStructController?{@ApiOperation(value?=?"在映射前后進行自定義處理")@GetMapping("/customRoundMapping")public?CommonResult?customRoundMapping()?{List<Product>?productList?=?LocalJsonUtil.getListFromJson("json/products.json",?Product.class);Product?product?=?productList.get(0);product.setPrice(new?BigDecimal(-1));ProductDto?productDto?=?ProductRoundMapper.INSTANCE.toDto(product);return?CommonResult.success(productDto);} }

在Swagger中調用接口測試下，可以發現已經應用了自定義操作。

處理映射異常

代碼運行難免會出現異常，MapStruct也支持處理映射異常。

我們需要先創建一個自定義異常類；

/***?商品驗證異常類*?Created?by?macro?on?2021/10/22.*/ public?class?ProductValidatorException?extends?Exception{public?ProductValidatorException(String?message)?{super(message);} }

然后創建一個驗證類，當price設置小于0時拋出我們自定義的異常；

/***?商品驗證異常處理器*?Created?by?macro?on?2021/10/22.*/ public?class?ProductValidator?{public?BigDecimal?validatePrice(BigDecimal?price)?throws?ProductValidatorException?{if(price.compareTo(BigDecimal.ZERO)<0){throw?new?ProductValidatorException("價格不能小于0！");}return?price;} }

之后我們通過@Mapper注解的uses屬性運用驗證類；

/***?商品對象映射（處理映射異常）*?Created?by?macro?on?2021/10/21.*/ @Mapper(uses?=?{ProductValidator.class},imports?=?{UUID.class}) public?interface?ProductExceptionMapper?{ProductExceptionMapper?INSTANCE?=?Mappers.getMapper(ProductExceptionMapper.class);@Mapping(target?=?"id",constant?=?"-1L")@Mapping(source?=?"count",target?=?"count",defaultValue?=?"1")@Mapping(target?=?"productSn",expression?=?"java(UUID.randomUUID().toString())")ProductDto?toDto(Product?product)?throws?ProductValidatorException; }

然后在Controller中添加測試接口，設置price為-1，此時在進行映射時會拋出異常；

/***?MapStruct對象轉換測試Controller*?Created?by?macro?on?2021/10/21.*/ @RestController @Api(tags?=?"MapStructController",?description?=?"MapStruct對象轉換測試") @RequestMapping("/mapStruct") public?class?MapStructController?{@ApiOperation(value?=?"處理映射異常")@GetMapping("/exceptionMapping")public?CommonResult?exceptionMapping()?{List<Product>?productList?=?LocalJsonUtil.getListFromJson("json/products.json",?Product.class);Product?product?=?productList.get(0);product.setPrice(new?BigDecimal(-1));ProductDto?productDto?=?null;try?{productDto?=?ProductExceptionMapper.INSTANCE.toDto(product);}?catch?(ProductValidatorException?e)?{e.printStackTrace();}return?CommonResult.success(productDto);} }

在Swagger中調用接口測試下，發現運行日志中已經打印了自定義異常信息。

總結

通過上面對MapStruct的使用體驗，我們可以發現MapStruct遠比BeanUtils要強大。當我們想實現比較復雜的對象映射時，通過它可以省去寫Getter、Setter方法的過程。當然上面只是介紹了MapStruct的一些常用功能，它的功能遠不止于此，感興趣的朋友可以查看下官方文檔。

參考資料

官方文檔：https://mapstruct.org/documentation/stable/reference/html

項目源碼地址

https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-mapstruct

有道無術，術可成；有術無道，止于術

歡迎大家關注Java之道公眾號

好文章，我在看??

總結

以上是生活随笔為你收集整理的干掉 BeanUtils！试试这款 Bean 自动映射工具，真心强大！的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇：推荐两款工具给爱做实验的人
下一篇：我以为我对Mysql索引很了解，直到我遇