脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot MapStruct生成映射

SpringBoot使用MapStruct生成映射代码的示例详解

 更新时间：2024年11月26日 11:06:01   作者：鹏阿鹏  
MapStruct 是一个用于 Java 的代码生成器,专门用于生成类型安全的 bean 映射代码,它通过注解处理器在编译时生成映射代码,从而避免了运行时的性能开销和潜在的错误,本文给大家介绍了SpringBoot使用MapStruct生成映射代码的示例,需要的朋友可以参考下

定义

MapStruct 是一个用于 Java 的代码生成器，专门用于生成类型安全的 bean 映射代码。它通过注解处理器在编译时生成映射代码，从而避免了运行时的性能开销和潜在的错误。

MapStruct 的主要目标是简化和加速 Java 对象之间的转换，特别是当这些对象具有相似的结构时。

相关概念

  • Mapper 接口 Mapper 接口定义了对象之间的映射方法。你可以通过在接口上使用 @Mapper
    注解来标记这个接口是一个映射器。MapStruct 会在编译时生成这个接口的实现类。
  • Mapping 注解 @Mapping 注解用于定义源对象和目标对象之间的字段映射关系。你可以在 Mapper
    接口的方法上使用这个注解来指定具体的映射规则。
  • Mappings 注解 @Mappings 注解是 @Mapping 注解的容器，用于定义多个字段映射。
  • Component Model 通过 componentModel 属性，你可以指定生成的 Mapper 实现类的组件模型，例如Spring、CDI 或默认的无组件模型。

使用示例

  1. 定义源对象和目标对象
public class Source {
    private String name;
    private int age;
    private String address;

    // getters and setters
}

public class Target {
    private String fullName;
    private int age;
    private String location;

    // getters and setters
}
  • 定义Mapper接口
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.factory.Mappers;

@Mapper
public interface SourceTargetMapper {

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

    @Mapping(source = "name", target = "fullName")
    @Mapping(source = "address", target = "location")
    Target sourceToTarget(Source source);

    @Mapping(source = "fullName", target = "name")
    @Mapping(source = "location", target = "address")
    Source targetToSource(Target target);
}

或者，可以使用 @Mappings 注解来包含多个 @Mapping 注解。@Mappings 注解是 @Mapping 注解的容器，用于定义多个字段映射。

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;

@Mapper
public interface SourceTargetMapper {

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

    @Mappings({
        @Mapping(source = "name", target = "fullName"),
        @Mapping(source = "address", target = "location")
    })
    Target sourceToTarget(Source source);

    @Mappings({
        @Mapping(source = "fullName", target = "name"),
        @Mapping(source = "location", target = "address")
    })
    Source targetToSource(Target target);
}
  • 主方法
public class Main {
    public static void main(String[] args) {
        Source source = new Source();
        source.setName("John Doe");
        source.setAge(30);
        source.setAddress("123 Main St");

        SourceTargetMapper mapper = SourceTargetMapper.INSTANCE;
        Target target = mapper.sourceToTarget(source);

        System.out.println("Target Full Name: " + target.getFullName());
        System.out.println("Target Age: " + target.getAge());
        System.out.println("Target Location: " + target.getLocation());
    }
}

与Spring集成

通过设置 componentModel = "spring"，你可以将生成的 Mapper 实现类作为 Spring 组件进行管理，从而在 Spring 容器中进行依赖注入。

@Mapper(componentModel = "spring")
public interface SourceTargetMapper {
    // 映射方法
}

使用如下

@Service
public class SomeService {

    private final SourceTargetMapper sourceTargetMapper;

    @Autowired
    public SomeService(SourceTargetMapper sourceTargetMapper) {
        this.sourceTargetMapper = sourceTargetMapper;
    }

    // 使用 sourceTargetMapper 进行对象转换
}

表达式功能

可以使用 expression 属性在 @Mapping 注解中指定自定义的表达式。

示例场景：假设我们有一个场景，需要将一个包含日期字符串的源对象转换为目标对象，并且需要将日期字符串解析为 java.util.Date 对象。我们将使用 java.text.SimpleDateFormat 类来解析日期字符串。

public class Source {
    private String dateString;

    // getters and setters
}

public class Target {
    private Date date;

    // getters and setters
}

定义日期解析工具类

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

public class DateParser {
    private static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd");

    public static Date parse(String dateString) throws ParseException {
        return DATE_FORMAT.parse(dateString);
    }
}

定义Mapper接口，注意注解中的imports和expression

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;

@Mapper(componentModel = "spring", imports = {DateParser.class, ParseException.class})
public interface SourceTargetMapper {

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

    @Mappings({
        @Mapping(target = "date", expression = "java(DateParser.parse(source.getDateString()))")
    })
    Target sourceToTarget(Source source) throws ParseException;
}

在这个 Mapper接口中，使用了 imports 属性导入了 DateParser 和 ParseException 类。然后在 @Mapping 注解的 expression 属性中，通过 DateParser.parse(source.getDateString()) 来将 dateString 转换为 Date 对象。

public class Main {
    public static void main(String[] args) {
        Source source = new Source();
        source.setDateString("2024-11-25");

        SourceTargetMapper mapper = SourceTargetMapper.INSTANCE;
        try {
            Target target = mapper.sourceToTarget(source);
            System.out.println("Target Date: " + target.getDate());
        } catch (ParseException e) {
            e.printStackTrace();
        }
    }
}

在这个示例中，创建了一个包含日期字符串的 Source 对象，并使用 SourceTargetMapper 将其转换为 Target 对象。转换过程中，DateParser 类的 parse 方法被调用，将日期字符串解析为 Date 对象。

依赖：

<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
    <version>1.5.5.Final</version> <!-- 请根据需要替换为最新版本 -->
</dependency>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
    <version>1.5.5.Final</version> <!-- 请根据需要替换为最新版本 -->
    <scope>provided</scope>
</dependency>

以上就是SpringBoot使用MapStruct生成映射代码的示例详解的详细内容，更多关于SpringBoot MapStruct生成映射的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • 详解SpringBoot如何自定义一个Starter

    详解SpringBoot如何自定义一个Starter

    小伙伴们曾经可能都经历过整天写着CURD的业务，都没写过一些组件相关的东西，这篇文章记录一下SpringBoot如何自定义一个Starter。原理和理论就不用多说了，可以在网上找到很多关于该方面的资料，这里主要分享如何自定义
    2022-11-11
  • Bean的管理与SpringBoot自动装配原理解读

    Bean的管理与SpringBoot自动装配原理解读

    在SpringBoot项目中,启动时自动创建IOC容器并初始化bean对象,支持通过依赖注入获取,Bean可以通过name或类型获取,支持单例和非单例等多种作用域,对于第三方Bean,推荐在配置类中用@Bean标识方法进行定义
    2024-11-11
  • MybatisPlus代码生成器含XML文件详解

    MybatisPlus代码生成器含XML文件详解

    这篇文章主要介绍了MybatisPlus代码生成器含XML文件详解，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-01-01
  • IntelliJ IDEA2020.1版本更新pom文件自动导包的方法

    IntelliJ IDEA2020.1版本更新pom文件自动导包的方法

    这篇文章主要介绍了IntelliJ IDEA2020.1版本更新pom文件自动导包的方法,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • java foreach循环为什么不能赋值的讲解

    java foreach循环为什么不能赋值的讲解

    这篇文章主要介绍了java foreach循环为什么不能赋值的讲解，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-09-09
  • Java（enum）枚举用法详解

    Java（enum）枚举用法详解

    本篇文章主要介绍了Java 枚举用法详解，枚举的好处：可以将常量组织起来，统一进行管理。有兴趣的可以一起来了解一下。
    2016-11-11
  • Spring使用IOC与DI实现完全注解开发

    Spring使用IOC与DI实现完全注解开发

    IOC也是Spring的核心之一了，之前学的时候是采用xml配置文件的方式去实现的，后来其中也多少穿插了几个注解，但是没有说完全采用注解实现。那么这篇文章就和大家分享一下，全部采用注解来实现IOC + DI
    2022-09-09
  • SpringBoot密码加密的实现示例

    SpringBoot密码加密的实现示例

    本文主要介绍了SpringBoot密码加密的实现示例,包括引入依赖、配置加密工具、生成加密密钥、加密密码、配置解密,具有一定的参考价值,感兴趣的可以了解一下
    2024-08-08
  • 一文秒懂idea的git插件跟翻译插件

    一文秒懂idea的git插件跟翻译插件

    idea之类的开发软件真的超级多的插件，今天给大家分享idea的git插件跟翻译插件，感兴趣的朋友跟随小编一起看看吧
    2021-04-04
  • 基于Java的guava开源库工具类

    基于Java的guava开源库工具类

    guava是谷歌基于java封装好的开源库，这篇文章主要通过介绍几个好用的guava工具类，感兴趣的朋友可以参考下面文章内容
    2021-09-09

最新评论