mapstruct + springboot3 快速整合

最新推荐文章于 2025-04-25 14:55:14 发布

曹申阳

最新推荐文章于 2025-04-25 14:55:14 发布

阅读量1.7k

点赞数 19

CC 4.0 BY-SA版权

分类专栏：工作总结文章标签：开发语言 java spring boot

本文链接：https://blog.csdn.net/qq_34709175/article/details/142957933

工作总结专栏收录该内容

11 篇文章

订阅专栏

一、前言

相信在开发过程中大家都有过对象转换的经验，DO、VO、DTO 之间相互转换，当然你可以最传统的方式，new 一个对象，然后使用 set方法赋值，其实我开发过程中这种方式用的比较多，借助于插件，也不是很麻烦，这种方式的好处在于完全可控，出现 bug 也很容易发现。但是有时候偷懒也会使用 BeanUtils 通过 copy 完成对象创建，这个图省事的时候会用一下，但是这个有个问题就是如果字段名称不一样会导致意想不到的bug，所以在使用的时候要注意字段匹配，慎用。网上大多以性能为由吐槽这种方式，其实我并能没有直观的感受，在一些中小型的项目中只要使用得当，我觉得完全没有问题。我个人认为还是自己手写 **set方法 **最好。**大道至简。**但是本着学习的态度，使用 mapStruct 尝尝鲜。

二、快速整合

2.1 MapStruct 是什么？

首先看一下官方文档：https://mapstruct.org/

学习一门新的技术，官网是最权威的地方。

简单总结一下，就是说 MapStruct 是一个代码生成器，基于约定大于配置的方法，简化了 Java bean 之间的转换过程，因为使用了简单的方法调用，所以速度更快，更加安全。

目的在于解决对象转换的重复工作，以及可能出现错误，与其他框架相比是在编译时生成 bean 映射，确保了高性能，并且错误易于被发现。

易于整合，通过注解的方式使用，侵入性较低。

2.2 快速上手

如果有疑问，建议参考官方文档 https://mapstruct.org/documentation/installation/

2.2.1 引入依赖

  ...
  <properties>
      <org.mapstruct.version>1.6.2</org.mapstruct.version>
  </properties>
  ...
  <dependencies>
      <dependency>
          <groupId>org.mapstruct</groupId>
          <artifactId>mapstruct</artifactId>
          <version>${org.mapstruct.version}</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> <!-- depending on your project -->
                  <target>1.8</target> <!-- depending on your project -->
                  <annotationProcessorPaths>
                      <path>
                          <groupId>org.mapstruct</groupId>
                          <artifactId>mapstruct-processor</artifactId>
                          <version>${org.mapstruct.version}</version>
                      </path>
                      <!-- other annotation processors -->
                  </annotationProcessorPaths>
              </configuration>
          </plugin>
      </plugins>
  </build>

2.2.2 引入插件

我这里使用的是当前最小版本，使用说明: https://mapstruct.org/documentation/stable/reference/html/#introduction

注意官网明确说明当前版本必须使用 jdk9 或以上版本，如果使用的是8，自己降低一下版本，使用上应该查一下不大。

安装一下官方提供的插件，可以进行跳转等一些快捷操作

2.2.3 定义mapper

这里要注意和mybatisPlus的mapper区分。

为了便于管理，我在 mapper 下新建了一个文件夹用于存放 mapStruct 的 mapper

创建 UserMapper

public interface UserMapper {

    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);

    AdminUser UserCreateDTO2User(UserCreateDTO userCreateDTO);
}

添加注解（注意区分）

如果转换传入对象和返回对象字段一一对应，那么这样就可以了，如果有不一致的情况，我们可以通过注解手动去指定，@Mapping(target = “manufacturer”, source = “make”) ，还是比较方便的。

测试使用

public static void main(String[] args) {
        UserCreateDTO userCreateDTO = new UserCreateDTO();
        userCreateDTO.setUsername("aaaa");
        userCreateDTO.setPassword("12312432");
        userCreateDTO.setNickname("asdsfd");

        UserMapper userMapper = UserMapper.INSTANCE;
        AdminUser adminUser = userMapper.UserCreateDTO2User(userCreateDTO);
        System.out.println(adminUser.toString());
    }

可以看到如我们预期那样