MapStruct 介绍与使用指南

什么是 MapStruct?

MapStruct 是一个 Java 注解处理器，用于生成类型安全的 bean 映射代码。它通过在编译时生成映射代码，避免了手动编写繁琐的对象转换代码，同时保证了高性能（因为生成的代码是普通的 Java 方法调用，没有反射开销）。

主要特点

• 高性能：编译时生成代码，无反射开销
• 类型安全：编译器会检查映射是否正确
• 易于调试：生成的代码是普通 Java 代码，可以轻松调试
• 配置灵活：支持自定义映射规则
• 丰富的注解：提供多种注解满足不同映射需求
• 支持多级映射

实践

1.引入依赖

<dependencies>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>1.5.5.Final</version> <!-- 使用最新版本 -->
    </dependency>
</dependencies>

<build>
    <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>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>1.5.5.Final</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

2.简单类相互转换

1.两个user类

@Data
@I18nClassAnnotation
public class User {
   
   
    public String id;
    public String name;
    public String desc;
    public Integer age;
    public BigDecimal count;
    private List<String> a;
}

@Data
@Table(name = "`user`")
public class UserDTO {
   
   
    private int id;
    private String name;
    private Date createdTime;
    private BigDecimal number;
    private List<String> a;
}

2.添加UserMapperStruct

package com.example.demo.mapstruct;

import com.example.demo.domain.User;
import com.example.demo.domain.po.UserDTO;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.factory.Mappers;

import java.util.List;

/**
 * @author zhouxy
 * @date 2025年04月10日 16:34
 */
@Mapper
public interface UserMapperStruct {
   
   
    UserMapperStruct INSTANCE = Mappers.getMapper(UserMapperStruct.class);

    /**
     * 单个对象映射
     *
     * @author zhouxy
     * @date 2025/4/11 10:26
     */
    //属性转换
    @Mapping(source = "count", target = "number")
    //忽略某个属性赋值
    @Mapping(target = "id", ignore = true)
    UserDTO userToDTO(User user);

    /**
     * 集合映射
     *
     * @author zhouxy
     * @date 2025/4/10 17:27
     */
    //属性转换
    @Mapping(source = "count", target = "number")
    //忽略某个属性赋值
    @Mapping(target = "id", ignore = true)
    List<UserDTO> usersToDTOs(List<User> users);
}

3.测试

 @Test
 public void testMapping() {
   
   
     User user = new User();
     user.setId("3");
     user.setName("张三");
     user.setCount(BigDecimal.valueOf(2l));