mapstruct-阿里云开发者社区

mapstruct

2023-11-22 65

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： mapstruct

你泛起山川，碧波里的人不是我。——《慕容雪》

首先按照官方文档引入GAV，但要注意和lombok有版本冲突问题，因此我选择这个版本：

这里放上主要配置

<properties>
    <java.version>1.8</java.version>
    <lombok.version>1.18.10</lombok.version>
    <mapstruct.version>1.3.0.Final</mapstruct.version>
</properties>
<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>${lombok.version}</version>
        <scope>provided</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${mapstruct.version}</version>
    </dependency>
</dependencies>
<plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.1</version>
        <configuration>
            <source>1.8</source>
            <target>1.8</target>
            <encoding>UTF-8</encoding>
            <annotationProcessorPaths>
                <path>
                    <groupId>org.projectlombok</groupId>
                    <artifactId>lombok</artifactId>
                    <version>${lombok.version}</version>
                </path>
                <path>
                    <groupId>org.mapstruct</groupId>
                    <artifactId>mapstruct-processor</artifactId>
                    <version>${mapstruct.version}</version>
                </path>
            </annotationProcessorPaths>
        </configuration>
    </plugin>
</plugins>

然后我准备两个实体类进行转换

package com.ruben.simplescaffold.entity;
import lombok.*;
import lombok.experimental.Accessors;
/**
 * 用户
 *
 * @author <achao1441470436@gmail.com>
 * @since 2021/7/30 10:22
 */
@Data
@ToString
@Builder
@Accessors(chain = true)
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = true)
public class UserDetail extends BaseEntity<UserDetail> {
    private static final long serialVersionUID = 1L;
    /**
     * 用户名
     */
    private String username;
    /**
     * 密码
     */
    private String password;
}

以及

package com.ruben.simplescaffold.pojo.vo;
import java.io.Serializable;
import lombok.Data;
/**
 * 用户VO
 *
 * @author <achao1441470436@gmail.com>
 * @since 2022/3/23 19:20
 */
@Data
public class UserVO implements Serializable {
    private static final long serialVersionUID = -6541515410807361292L;
    private String uname;
    private String pwd;
}

开始编写Mapper，注意此处注解导入的依赖为mapStruct的

package com.ruben.simplescaffold.mapper.mapstruct;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.factory.Mappers;
import com.ruben.simplescaffold.entity.UserDetail;
import com.ruben.simplescaffold.pojo.vo.UserVO;
/**
 * 用户mapstruct转换mapper
 *
 * @author <achao1441470436@gmail.com>
 * @since 2022/3/23 19:18
 */
@Mapper
public interface MapUserMapper {
    MapUserMapper INSTANCE = Mappers.getMapper(MapUserMapper.class);
    @Mapping(source = "username", target = "uname")
    @Mapping(source = "password", target = "pwd")
    UserVO convertPoToVo(UserDetail userDetail);
}

当然如果你想注入到spring容器中，可以指定@Mapper(componentModel = "spring")

然后编写测试类测试一下

package com.ruben.simplescaffold;
import org.junit.Test;
import org.junit.jupiter.api.Assertions;
import com.ruben.simplescaffold.entity.UserDetail;
import com.ruben.simplescaffold.mapper.mapstruct.MapUserMapper;
import com.ruben.simplescaffold.pojo.vo.UserVO;
/**
 * @author <achao1441470436@gmail.com>
 * @since 2022/3/23 19:22
 */
public class MapUserMapperTest {
    @Test
    public void convertPoToVoTest() {
        UserVO userVO = MapUserMapper.INSTANCE.convertPoToVo(UserDetail.builder().username("ruben").password("vampire").build());
        Assertions.assertEquals("ruben", userVO.getUname());
        Assertions.assertEquals("vampire", userVO.getPwd());
    }
}