Mapstruct应用

最新推荐文章于 2024-10-13 14:27:42 发布
最新推荐文章于 2024-10-13 14:27:42 发布
阅读量310 收藏
点赞数
分类专栏： 工具 文章标签： python 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_44981526/article/details/133635527
版权

Mapstruct应用

1.说明

MapStruct是一个代码生成器，它极大地简化了基于约定优于配置方法的Java bean类型之间映射的实现。
生成的映射代码使用普通的方法调用，因此快速、类型安全且易于理解。

官方地址：https://mapstruct.org/

2.应用案例

2.1搭建maven工程引入相关依赖

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <org.mapstruct.version>1.4.1.Final</org.mapstruct.version>
        <org.projectlombok.version>1.18.12</org.projectlombok.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>${org.mapstruct.version}</version>
        </dependency>

        <!-- lombok dependencies should not end up on classpath -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${org.projectlombok.version}</version>
            <scope>provided</scope>
        </dependency>

        <!-- idea 2018.1.1 之前的版本需要添加下面的配置，后期的版本就不需要了，可以注释掉-->
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct-processor</artifactId>
            <version>${org.mapstruct.version}</version>
            <scope>provided</scope>
        </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.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                            <version>${org.projectlombok.version}</version>
                        </path>
                        <path>
                            <groupId>org.mapstruct</groupId>
                            <artifactId>mapstruct-processor</artifactId>
                            <version>${org.mapstruct.version}</version>
                        </path>
                    </annotationProcessorPaths>
                </configuration>
            </plugin>
        </plugins>
    </build>

关于lombok和mapstruct的版本兼容问题多说几句，maven插件要使用3.6.0版本以上、lombok使用1.16.16版本以上，另外编译的lombok mapstruct的插件不要忘了加上。否则会出现下面的错误：No property named “aaa” exists in source parameter(s). Did you mean “null”?

这种异常就是lombok编译异常导致缺少get setter方法造成的。还有就是缺少构造函数也会抛异常。

实体类

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Student {

    private String name;
    private int age;
    private GenderEnum gender;
    private Double height;
    private LocalDateTime birthday;

}

枚举

public enum GenderEnum {
    Male("1", "男"),
    Female("0", "女");

    private String code;
    private String name;

    public String getCode() {
        return this.code;
    }

    public String getName() {
        return this.name;
    }

    GenderEnum(String code, String name) {
        this.code = code;
        this.name = name;
    }
}

VO类

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class StudentVO {
    private String name;
    private int age;
    private String gender;
    private Double height;
    private String birthday;
}

转换类

@Mapper
public interface StudentConvert {

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

    @Mapping(source = "gender.name", target = "gender")
    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
    StudentVO student2StudentVO(Student student);
	
}

测试类

public class Test {

    public static void main(String[] args) {

        Student student = Student.builder().name("小明").age(6).gender(GenderEnum.Male).height(121.1).birthday(LocalDateTime.now()).build();
        System.out.println(student);
        // 这行代码便是实际要用的代码
        StudentVO studentVO = StudentConvert.INSTANCE.student2StudentVO(student);
        System.out.println(studentVO);

    }

}

测试结果

image-20231007102223681

在使用的过程中只需要短短的一行代码就可以实现类型转换，那么mapstruct帮我们做了什么，实现了类型的转换呢？来看一下编译后生成的接口实现类

public class StudentConvertImpl implements StudentConvert {
    public StudentConvertImpl() {
    }

    public StudentVO student2StudentVO(Student student) {
        if (student == null) {
            return null;
        } else {
            StudentVO studentVO = new StudentVO();
            //对枚举进行了转换,实体中的枚举值转换为了对应的中文描述
            studentVO.setGender(this.studentGenderName(student));
            // 对LocalDateTime对象按照指定格式进行了转换，同理Date也是一样
            if (student.getBirthday() != null) {
                studentVO.setBirthday(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss").format(student.getBirthday()));
            }

            studentVO.setName(student.getName());
            studentVO.setAge(student.getAge());
            studentVO.setHeight(student.getHeight());
            return studentVO;
        }
    }

    private String studentGenderName(Student student) {
        if (student == null) {
            return null;
        } else {
            GenderEnum gender = student.getGender();
            if (gender == null) {
                return null;
            } else {
                String name = gender.getName();
                return name == null ? null : name;
            }
        }
    }
}

2.2List转换

属性映射基于上面的mapping配置

转换类添加students2StudentVOs方法

public interface StudentConvert {

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

    @Mapping(source = "gender.name", target = "gender")
    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
    StudentVO student2StudentVO(Student student);

    List<StudentVO> students2StudentVOs(List<Student> studentList);

}

测试类

public class Test {

    public static void main(String[] args) {

        Student student = Student.builder().name("小明").age(6).gender(GenderEnum.Male).height(121.1).birthday(LocalDateTime.now()).build();

        List<Student> list = new ArrayList<>();
        list.add(student);
        List<StudentVO> result = StudentConvert.INSTANCE.students2StudentVOs(list);
        System.out.println(result);

    }

}

测试结果

image-20231007104915014

2.3 多对象转换到一个对象

实体类

  • 课程
@Data
@AllArgsConstructor
@Builder
@NoArgsConstructor
public class Course {

    private String courseName;
    private int sortNo;
    private long id;

}
  • 学生
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Student {

    private String name;
    private int age;
    private GenderEnum gender;
    private Double height;
    private LocalDateTime birthday;

}

VO类

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class StudentVO {
    private String name;
    private int age;
    private String gender;
    private Double height;
    private String birthday;
    private String course;
}

转换类

@Mapper
public interface StudentConvert {

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

    @Mapping(source = "student.gender.name", target = "gender")
    @Mapping(source = "student.birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
    @Mapping(source = "course.courseName", target = "course")
    StudentVO studentAndCourse2StudentVO(Student student, Course course);

    List<StudentVO> students2StudentVOs(List<Student> studentList);

}

测试类

public class Test {

    public static void main(String[] args) {
        Student student = Student.builder().name("小明").age(6).gender(GenderEnum.Male).height(121.1).birthday(LocalDateTime.now()).build();
        Course course = Course.builder().id(1L).courseName("语文").build();

        StudentVO studentVO = StudentConvert.INSTANCE.studentAndCourse2StudentVO(student, course);
        System.out.println(studentVO);

        List<Student> list = new ArrayList<>();
        list.add(student);
        List<StudentVO> result = StudentConvert.INSTANCE.students2StudentVOs(list);
        System.out.println(result);

    }

}

测试结果

image-20231007105438139

2.4默认值

转换类

@Mapper
public interface StudentConvert {

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


    @Mapping(source = "student.gender.name", target = "gender")
    @Mapping(source = "student.birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
    @Mapping(source = "course.courseName", target = "course")
    @Mapping(target = "name", source = "student.name", defaultValue = "张三")
    StudentVO studentAndCourse2StudentVO(Student student, Course course);

    List<StudentVO> students2StudentVOs(List<Student> studentList);

}

测试类

public class Test {

    public static void main(String[] args) {
        Student student = Student.builder().age(6).gender(GenderEnum.Male).height(121.1).birthday(LocalDateTime.now()).build();
        Course course = Course.builder().id(1L).courseName("语文").build();

        StudentVO studentVO = StudentConvert.INSTANCE.studentAndCourse2StudentVO(student, course);
        System.out.println(studentVO);

        List<Student> list = new ArrayList<>();
        list.add(student);
        List<StudentVO> result = StudentConvert.INSTANCE.students2StudentVOs(list);
        System.out.println(result);

    }

}

可以看到默认值对于集合的转换并不会生效

image-20231007105946136

编译后的接口实现类

public class StudentConvertImpl implements StudentConvert {
    public StudentConvertImpl() {
    }

    public StudentVO studentAndCourse2StudentVO(Student student, Course course) {
        if (student == null && course == null) {
            return null;
        } else {
            StudentVO.StudentVOBuilder studentVO = StudentVO.builder();
            if (student != null) {
                studentVO.gender(this.studentGenderName(student));
                if (student.getBirthday() != null) {
                    studentVO.birthday(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss").format(student.getBirthday()));
                }

                if (student.getName() != null) {
                    studentVO.name(student.getName());
                } else {
                    studentVO.name("张三");
                }

                studentVO.age(student.getAge());
                studentVO.height(student.getHeight());
            }

            if (course != null) {
                studentVO.course(course.getCourseName());
            }

            return studentVO.build();
        }
    }

    public List<StudentVO> students2StudentVOs(List<Student> studentList) {
        if (studentList == null) {
            return null;
        } else {
            List<StudentVO> list = new ArrayList(studentList.size());
            Iterator var3 = studentList.iterator();

            while(var3.hasNext()) {
                Student student = (Student)var3.next();
                list.add(this.studentToStudentVO(student));
            }

            return list;
        }
    }

    private String studentGenderName(Student student) {
        if (student == null) {
            return null;
        } else {
            GenderEnum gender = student.getGender();
            if (gender == null) {
                return null;
            } else {
                String name = gender.getName();
                return name == null ? null : name;
            }
        }
    }

    protected StudentVO studentToStudentVO(Student student) {
        if (student == null) {
            return null;
        } else {
            StudentVO.StudentVOBuilder studentVO = StudentVO.builder();
            studentVO.name(student.getName());
            studentVO.age(student.getAge());
            if (student.getGender() != null) {
                studentVO.gender(student.getGender().name());
            }

            studentVO.height(student.getHeight());
            if (student.getBirthday() != null) {
                studentVO.birthday(DateTimeFormatter.ISO_LOCAL_DATE_TIME.format(student.getBirthday()));
            }

            return studentVO.build();
        }
    }
}
llp1110
关注
专栏目录
【微服务】springboot整合对象映射工具MapStruct使用详解
congge
08-25 4992
springboot 整合 MapStruct 使用详解
MapStruct 1.2.0 参考指南
07-12
MapStruct是一个代码生成器的工具类，简化了不同的Java Bean之间映射的处理，所以映射指的就是从一个实体变化成一个实体。（带目录标签）
MapStruct应用指南
码客
11-09 946
目录 1、MapStruct是什么 2、MapStruct的使用 2.1、引入依赖 2.2、使用方式 2.2.1、工厂类方式 2.2.2、Spring 注入方式 2.3、转换方式 2.3.1、属性名称相同，直接转换 2.3.2、属性名不相同， 可通过 @Mapping 注解进行指定转化 2.3.3、Mapper 中使用自定义的转换 2.4、多个对象转一个对象 2.5、多层对象转换（嵌套对象） 2.6、缺省值（默认值）和常量 2.7、使用java表达式进行映射 3、MapStru
Mapstruct的使用备忘【代替BeanUtils高效率属性拷贝】
最新发布
Zhaof_Notes
10-13 708
Mapstruct的使用备忘【代替BeanUtils高效率属性拷贝】
MapStruct的用法总结及示例
小蜜蜂1010的博客
06-10 3697
比dozer更好用的java对象属性映射复制工具MapStuct的用法及代码示例
MapStruct 使用
weixin_38982591的博客
01-05 430
mapstruct 是专门用来处理上面常见实体类与属性类的属性映射的, 我们只需定义 mapper 接口，mapstruct 在编译的时候就会自动的帮我们实现这个映射接口，避免了麻烦复杂的映射实现。
MapStruct使用教程2024(高级版)
码到三十五
11-04 2万+
MapStruct是一个用于Java的代码生成库，它基于注解处理器在编译时生成类型安全且高性能的对象映射代码,MapStruct可以帮助开发者减少手动编写繁琐的JavaBean之间的转换代码，提高代码的可读性和维护性。
Java编码辅助工具Mapstruct用法详解
08-25
Mapstruct的应用场景： 在项目开发中，业务分层会涉及不同类型的Bean之间需要相互转换，如PO与DTO之间，PO与VO之间等。手动编码setter/getter各个对应属性，会显得臃肿繁琐。通过Mapstruct框架可简单方便地完成这一...
Java MapStruct应用示例教程
总的来说，使用MapStruct可以极大地简化在Java应用程序中进行对象映射的工作，使得代码更加清晰、易于维护，并且通过编译时生成的映射器实现减少运行时开销。这份教程或示例将是一个很好的起点，帮助开发者掌握Map...
spring boot3+jpa+lombok+mapstruct实现的restful api例子
05-08
在本项目中，"spring boot3+jpa+lombok+mapstruct实现的restful api例子"是一个集成多种技术的示例，旨在展示如何高效地构建RESTful API服务。下面将详细介绍这些关键技术及其相互间的配合。 1. **Spring Boot 3**:...
【java】mapstruct自定义类的转换示例（csdn）————程序.pdf
12-04
在Java开发中，MapStruct是一个非常实用的代码生成库，它简化了对象之间的映射过程，尤其是当对象之间存在复杂的转换逻辑时。本示例主要介绍如何在MapStruct中自定义类转换，以便处理特定的转换需求。我们将通过分析...
mapstruct用法详解
m0_56419249的博客
12-21 838
mapstruct用法详解
丢弃掉那些BeanUtils工具类吧，MapStruct真香！！！
热门推荐
HollisChuang's Blog
08-10 2万+
在前几天的文章《为什么阿里巴巴禁止使用Apache Beanutils进行属性的copy？》中，我曾经对几款属性拷贝的工具类进行了对比。 然后在评论区有些读者反馈说MapStruct才是真的香，于是我就抽时间了解了一下MapStruct。结果我发现，这真的是一个神仙框架，炒鸡香。 这一篇文章就来简单介绍下MapStruct的用法，并且再和其他几个工具类进行一下对比。 为什么需要MapStruct ？ 首先，我们先说一下MapStruct这类框架适用于什么样的场景，为什么市面上会有这么多的类似的框架。 在软件
lombok java: 找不到符号
asp.net爱好
07-11 473
lombok java: 找不到符号
一文读懂MapStruct 1.5.5.Final
qq_27890899的博客
06-30 2147
我们在平时项目开发过程中会经常这样的情况，从数据库中查出来的PO对象中包含很多字段，但是在业务处理过程中需要处理的DTO包含PO中的部分字段，或者返回给前端的VO为DTO的部分字段，这就需要Class类转化，如果用构造器或者get()/set()方法，将会写大量冗余代码并且容易出错。面对这样的场景，采用MapStruct插件处理类转换是一个绝佳的选择。MapStruct 是一个注释处理器，用于生成类型安全、高性能和无依赖的 Bean 映射代码。
springboot项目中mapstruct简单使用（gradle、maven）
大西瓜的博客
06-08 1385
mapstruct java springboot gradle maven 2、创建convert接口 （具体在注释里） 3、使用， END
Mapstruct
蓝影铁哥的博客
12-14 1106
属性拷贝高效工具、Mapstruct神器
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值