快捷導(dǎo)航

Java中MapStruct的使用詳解

更新時(shí)間：2023年09月19日 09:06:40 作者：韓_師兄

這篇文章主要介紹了Java中MapStruct的使用詳解,mapstruct,全稱是org.mapstruct.Mapper, 是將接口或抽象類標(biāo)記為映射器,并通過MapStruct為這個(gè)接口或者抽象類生成一個(gè)實(shí)現(xiàn)類,大大簡(jiǎn)化了Java bean類型之間轉(zhuǎn)換,需要的朋友可以參考下

mapstruct概述

mapstruct,全稱是org.mapstruct.Mapper, 是將接口或抽象類標(biāo)記為映射器，并通過MapStruct為這個(gè)接口或者抽象類生成一個(gè)實(shí)現(xiàn)類,大大簡(jiǎn)化了Java bean類型之間轉(zhuǎn)換

在維護(hù)一個(gè)新項(xiàng)目時(shí),突然發(fā)現(xiàn)了,項(xiàng)目中一個(gè)新奇的點(diǎn),就說關(guān)于MapStruct的使用,因?yàn)殛P(guān)于值傳遞映射,從最初的手動(dòng)映射,到后來的工具類. 對(duì)于MapStruct使用較少,故整理記錄一下該使用說明

優(yōu)點(diǎn):

mapstruct是在編譯時(shí)完成Bean轉(zhuǎn)換,
和傳統(tǒng)相比,提升了服務(wù)性能
編譯后在target目錄，生成對(duì)應(yīng)的xxximp.java文件,方便定位問題

缺點(diǎn):

必須添加一個(gè)接口或者抽象類，才能實(shí)現(xiàn)映射

mapstruct案例

依賴在spring環(huán)境中使用,通過編譯打包發(fā)現(xiàn),會(huì)生成對(duì)應(yīng)接口的實(shí)現(xiàn)類.

1 添加依賴

        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>1.4.2.Final</version>
        </dependency>

2 添加實(shí)體對(duì)象和DTO

實(shí)體對(duì)象

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private String id;
    private String name;
    private Date crateTime;
}

Dto對(duì)象

@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserDto {
    private String userId;
    private String userName;
    private Date beginTime;
}

3 添加接口

/**
 * componentModel 制定模式spring  將bean交給spring管理
 * unmappedTargetPolicy ignore 目標(biāo)屬性未匹配時(shí)系統(tǒng)忽略，不打印警告日志
 */
@Mapper(componentModel = "spring", unmappedTargetPolicy = ReportingPolicy.IGNORE )
public interface UserMapper {
    //靜態(tài)成員
    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);
    // 單個(gè)書寫
    // 常量
    @Mapping(source = "id", target = "userId",constant = "可以指定常量")
    // 默認(rèn)值
    @Mapping(source = "name", target = "userName", defaultValue = "可以指定默認(rèn)值")
    // 日期轉(zhuǎn)換
    @Mapping(source = "crateTime", target = "beginTime", dateFormat = "yyyy-MM-dd HH:mm:ss")
    UserDto userToUserDto(User user);
    // 批量寫法 與上述二選一
    @Mappings({
            // Integer 到 String的轉(zhuǎn)換
            @Mapping(source = "id", target = "numId" ,numberFormat = "$#.00"),
            @Mapping(source = "name", target = "userName"),
            //Date 轉(zhuǎn)字符串
            @Mapping(source = "crateTime", target = "crtTime", dateFormat = "dd.MM.yyyy"),
            // 使用java可執(zhí)行代碼或函數(shù)
            @Mapping(target = "crateTime", expression = "java(java.time.LocalDateTime.now()")
    })
    UserDto userToUserDto2(User user);
    // 批量轉(zhuǎn)換,循環(huán)調(diào)用上面單個(gè)轉(zhuǎn)換
    List<UserDto> userToUserDtoList(List<User> users);
}

4 通過Maven命令,編譯打包項(xiàng)目,發(fā)現(xiàn)target對(duì)應(yīng)包下面,生成了一個(gè)UserMapperImpl.class文件.

@Component
public class UserMapperImpl implements UserMapper {
    public UserMapperImpl() {
    }
    @Override
    public UserDto userToUserDto(User user) {
        if (user == null){
            return null;
        }else{
            UserDto userDto = new UserDto();
            user.setId(user.getId());
            user.setName(user.getName());
            user.setCrateTime(user.getCrateTime());
            return userDto;
        }
    }
    @Override
    public List<UserDto> userToUserDtoList(List<User> users) {
        if (users == null){
            return null;
        }else{
            List<UserDto> list = new ArrayList<>(users.size());
            Iterator var3 = users.iterator();
            while (var3.hasNext()){
                User user = (User) var3.next();
                list.add(this.userToUserDto(user));
            }
            return list;
        }
    }
}