脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Java MapStruct使用

Java高效映射工具MapStruct的使用示例

 更新时间：2023年12月25日 10:38:30   作者：一只爱撸猫的程序猿  
MapStruct 是一个 Java 注解处理器,用于在不同 Java Beans 或数据传输对象（DTOs）之间自动生成类型安全的映射代码,这是一个编译时映射框架,意味着它利用注解在编译时生成代码,本文将给大家介绍一下Java注解处理器MapStruct的使用示例,需要的朋友可以参考下

引言

MapStruct 是一个 Java 注解处理器，用于在不同 Java Beans 或数据传输对象（DTOs）之间自动生成类型安全的映射代码。这是一个编译时映射框架，意味着它利用注解在编译时生成代码，从而提高了性能和减少了运行时的开销。

它适用于 Java 8 和更高版本。以下是一些 MapStruct 的基本使用示例：

1. 基本映射

假设你有两个简单的类 Person 和 PersonDTO，需要将 Person 实体映射到 PersonDTO 数据传输对象。

Person.java

public class Person {
    private String name;
    private int age;
    // getters and setters
}

PersonDTO.java

public class PersonDTO {
    private String name;
    private int age;
    // getters and setters
}

PersonMapper.java

@Mapper
public interface PersonMapper {
    PersonMapper INSTANCE = Mappers.getMapper(PersonMapper.class);
    PersonDTO personToPersonDTO(Person person);
}

2. 复杂类型映射

如果你的对象包含复杂类型或自定义类型，MapStruct 也可以处理这些。

Address.java

public class Address {
    private String street;
    private String city;
    // getters and setters
}

Person.java (现在包含 Address)

public class Person {
    private String name;
    private int age;
    private Address address;
    // getters and setters
}

PersonDTO.java (同样包含 Address)

public class PersonDTO {
    private String name;
    private int age;
    private String street;
    private String city;
    // getters and setters
}

PersonMapper.java

@Mapper
public interface PersonMapper {
    PersonMapper INSTANCE = Mappers.getMapper(PersonMapper.class);
    
    @Mapping(source = "address.street", target = "street")
    @Mapping(source = "address.city", target = "city")
    PersonDTO personToPersonDTO(Person person);
}

3. 使用表达式

有时，你可能需要在映射过程中使用自定义逻辑。MapStruct 允许你使用 Java 表达式来实现这一点。

Person.java

public class Person {
    private String firstName;
    private String lastName;
    // getters and setters
}

PersonDTO.java

public class PersonDTO {
    private String fullName;
    // getters and setters
}

PersonMapper.java

@Mapper
public interface PersonMapper {
    PersonMapper INSTANCE = Mappers.getMapper(PersonMapper.class);

    @Mapping(expression = "java(person.getFirstName() + ' ' + person.getLastName())", target = "fullName")
    PersonDTO personToPersonDTO(Person person);
}

4. 使用自定义方法

在某些情况下，你可能需要自定义映射逻辑。你可以在映射器接口中定义自己的方法来实现这一点。

Person.java

public class Person {
    private String birthdate; // 假设这是一个字符串
    // getters and setters
}

PersonDTO.java

public class PersonDTO {
    private LocalDate birthdate; // 在 DTO 中，我们使用 LocalDate
    // getters and setters
}

PersonMapper.java

@Mapper
public interface PersonMapper {
    PersonMapper INSTANCE = Mappers.getMapper(PersonMapper.class);

    @Mapping(target = "birthdate", source = "birthdate", dateFormat = "yyyy-MM-dd")
    PersonDTO personToPersonDTO(Person person);

    default LocalDate stringToLocalDate(String date) {
        return LocalDate.parse(date, DateTimeFormatter.ofPattern("yyyy-MM-dd"));
    }
}

5. 映射集合

MapStruct 也能很好地处理集合映射。

PersonMapper.java

@Mapper
public interface PersonMapper {
    PersonMapper INSTANCE = Mappers.getMapper(PersonMapper.class);

    List<PersonDTO> personsToPersonDTOs(List<Person> persons);
}

6. 使用依赖注入

如果你使用 Spring 或类似框架，可以将 MapStruct 与依赖注入框架结合使用。

PersonMapper.java

@Mapper(componentModel = "spring")
public interface PersonMapper {
    PersonDTO personToPersonDTO(Person person);
}

使用 componentModel = "spring"，MapStruct 将生成一个 Spring 组件，可以被注入到你的服务中。

7. 更新现有对象

MapStruct 也可以用于更新现有对象，而不是创建新的。

PersonMapper.java

@Mapper
public interface PersonMapper {
    void updatePersonFromDTO(PersonDTO personDto, @MappingTarget Person person);
}

这个方法将会根据 PersonDTO 中的数据更新一个已存在的 Person 对象，而不是创建一个新的。

8. 多源映射

你可以从多个源对象映射到一个目标对象。

Address.java

public class Address {
    private String city;
    // getters and setters
}

PersonDTO.java

public class PersonDTO {
    private String name;
    private String city;
    // getters and setters
}

PersonMapper.java

@Mapper
public interface PersonMapper {
    @Mapping(source = "person.name", target = "name")
    @Mapping(source = "address.city", target = "city")
    PersonDTO personAndAddressToDTO(Person person, Address address);
}

总结

MapStruct 的主要优点是它提供了一种高效、类型安全且易于使用的方式来自动化对象间的数据映射。这使得它成为处理 Java 应用中数据转换的理想选择，尤其是在涉及复杂对象和多层架构的场景中。通过减少手写的样板代码和提供清晰的映射定义，MapStruct 可以帮助开发人员节省时间，减少错误，并提高代码的可维护性。

以上就是Java注解处理器MapStruct的使用示例的详细内容，更多关于Java MapStruct使用的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • win10 64位 jdk1.8的方法教程详解

    win10 64位 jdk1.8的方法教程详解

    这篇文章主要介绍了win10 64位 jdk1.8的方法教程详解，本文给大家介绍的非常详细，对大家的工作或学习具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-03-03
  • 解决SpringBoot运行报错：找不到或无法加载主类的问题

    解决SpringBoot运行报错：找不到或无法加载主类的问题

    这篇文章主要介绍了解决SpringBoot运行报错：找不到或无法加载主类的问题,具有很好的参考价值,对大家的学习或工作有一定的参考价值,需要的朋友可以参考下
    2023-09-09
  • java selenium教程环境搭建基于Maven

    java selenium教程环境搭建基于Maven

    本文主要介绍Java selenium 环境的安装,这里介绍了基于Maven的环境搭建，有需要的小伙伴可以参考下
    2016-08-08
  • springboot 集成支付宝支付的示例代码

    springboot 集成支付宝支付的示例代码

    这篇文章主要介绍了springboot 集成支付宝支付的示例代码，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • Java枚举类型与泛型使用解读

    Java枚举类型与泛型使用解读

    这篇文章主要介绍了Java枚举类型与泛型使用解读，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-12-12
  • Java实现随机抽奖的三种方法

    Java实现随机抽奖的三种方法

    在Java中实现随机抽奖的方法,通常我们会使用java.util.Random类来生成随机数,然后基于这些随机数来选择中奖者,以下将给出几种常见的随机抽奖实现方式,需要的朋友可以参考下
    2024-09-09
  • 老生常谈 java匿名内部类

    老生常谈 java匿名内部类

    下面小编就为大家带来一篇老生常谈java匿名内部类。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2016-07-07
  • 新手易懂的Java客户管理小项目

    新手易懂的Java客户管理小项目

    本篇文章是作为一个很适合新手阅读的初级小项目，客户管理，它主要实现数据库的增删查改操作，管理每位客户的不同信息，如果你也是开始学Java不久，这篇文章将很适合你
    2021-11-11
  • Java自定义异常_动力节点Java学院整理

    Java自定义异常_动力节点Java学院整理

    这篇文章主要介绍了Java自定义异常_动力节点Java学院整理的相关资料,需要的朋友可以参考下
    2017-04-04
  • 通过prometheus监控springboot程序运行状态的操作流程

    通过prometheus监控springboot程序运行状态的操作流程

    jmx_exporter用于从Java应用程序中提取JMX指标,适用于SpringBoot应用,通过下载jar包和配置文件,可以抓取JVM基础指标,要获取应用级别指标,需要集成Prometheus客户端库并自定义指标,本文给大家介绍了如何通过prometheus监控springboot程序运行状态
    2025-02-02

最新评论