MapStruct属性拷贝工具

博主：本当迷
发布时间：2023 年 02 月 01 日
2481 次浏览
暂无评论
3832字数
分类： springboot

## 前言

MapStruct的作用是 **两个对象的属性进行拷贝**，这个工具的性能很高，值得学习并在项目中使用。Map是一种代码生成器，它极大地简化了基于”约定大于配置“方法的JavaBean类型之间的映射的实现。生成的映射代码使用纯方法调用，因此快速、类型安全易于理解。**还有诸如其他的工具比如：BeanUtils也可以用于对象属性拷贝，但是它是浅拷贝，在性能测试中没有MapStruct好。**

## 引入依赖

```xml
<dependencies>
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>1.4.1.Final</version>
        </dependency>
        
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct-jdk8</artifactId>
            <version>1.4.1.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>
                    <encoding>UTF-8</encoding>
                    
                    <annotationProcessorPaths>
                        <path>
                            <groupId>org.mapstruct</groupId>
                            <artifactId>mapstruct-processor</artifactId>
                            <version>1.2.0.Final</version>
                        </path>
                    </annotationProcessorPaths>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.1.7.RELEASE</version>
            </plugin>
        </plugins>
    </build>

```

## 具体使用：

假设我们有两个类需要互相转换，分别是User、UserDto，类定义如下：

### User

```java
package com.example.demo.domain;

import java.io.Serializable;

/**
 * 
 * @TableName user
 */

public class User implements Serializable {
  
    /**
     * 姓名
     */
    private String name;
  
    public String getName() {
        return name;
    }

public void setName(String name) {
        this.name = name;
    }

@Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                '}';
    }
}
```

### UserDto

```java
package com.example.demo.Dto;

/**
 * @code Description
 * @code author 本当迷
 * @code date 2023/1/31-12:10
 */

public class UserDto {
    private String username;
    private String password;

public String getUsername() {
        return username;
    }

public void setUsername(String username) {
        this.username = username;
    }

public String getPassword() {
        return password;
    }

public void setPassword(String password) {
        this.password = password;
    }

@Override
    public String toString() {
        return "UserDto{" +
                "username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

```

然后我们需要定义一个转换接口

### 定义User转换UserDto接口

```java
package com.example.demo.converter;

import com.example.demo.Dto.UserDto;
import com.example.demo.domain.User;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;

/**
 * @code Description
 * @code author 本当迷
 * @code date 2023/1/31-12:39
 */
@Mapper
public interface UserRoleMapper {

/**
    * 获取该类自动生成的实现类的实例
    * 接口中的属性都是 public static final 的
    * 方法都是public abstract 的
    */
   UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class);

/**
    * 这个方法就是用于实现对象属性复制的方法
    *
    * @Mapping 用来定义属性复制规则
    *              source 指定源对象属性
    *              target 指定目标对象属性
    *
    * @param user 这个参数就是源对象，也就是需要被复制的对象
    * @return 返回的是目标对象，就是最终的结果对象
    */
   @Mappings({
           @Mapping(source = "name", target = "username"),
           @Mapping(target = "password", source = "")
   })
  UserDto do2dto(User user);

}

```

### 转换测试

```java
 @Test
    void contextLoads() {
        final User user = new User();
        user.setName("本当迷");
        final UserDto userDto = UserRoleMapper.INSTANCES.do2dto(user);
        System.out.println("user DTO: " + userDto);
    }
```

### 效果：

![](https://www.bdmcom.cn/usr/uploads/2023/02/1537345132.png)

最后修改：2023 年 02 月 01 日

如果文章有用，请随意打赏。

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

评论 *

私密评论

名称 *

🎲

邮箱 *

地址

车牌吉凶
擅长什么就继续做什么，不要轻易转行
车牌吉凶
程序员想要多赚钱，还得自己做项目做运营
1
555
小新
krqxtm25479CG-文章很不错，感谢作者！https:...
cm
666

MapStruct属性拷贝工具

本当迷 • 2023 年 02 月 01 日

## 前言

## 引入依赖

```

## 具体使用：

假设我们有两个类需要互相转换，分别是User、UserDto，类定义如下：

### User

```java
package com.example.demo.domain;

import java.io.Serializable;

/**
 * 
 * @TableName user
 */

public class User implements Serializable {
  
    /**
     * 姓名
     */
    private String name;
  
    public String getName() {
        return name;
    }

public void setName(String name) {
        this.name = name;
    }

@Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                '}';
    }
}
```

### UserDto

```java
package com.example.demo.Dto;

/**
 * @code Description
 * @code author 本当迷
 * @code date 2023/1/31-12:10
 */

public class UserDto {
    private String username;
    private String password;

public String getUsername() {
        return username;
    }

public void setUsername(String username) {
        this.username = username;
    }

public String getPassword() {
        return password;
    }

public void setPassword(String password) {
        this.password = password;
    }

@Override
    public String toString() {
        return "UserDto{" +
                "username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

```

然后我们需要定义一个转换接口

### 定义User转换UserDto接口

```java
package com.example.demo.converter;

/**
 * @code Description
 * @code author 本当迷
 * @code date 2023/1/31-12:39
 */
@Mapper
public interface UserRoleMapper {

}

```

### 转换测试

### 效果：

![](https://www.bdmcom.cn/usr/uploads/2023/02/1537345132.png)

MapStruct属性拷贝工具

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

【修仙之路】JAVA学习路线

对于异或运算的初步认识与auto用法

【JAVA经典例题】生产者/消费者问题

最近某音挺火的代码实现爱心形状

再见Swagger！拥抱smart-doc无侵入生成接口文档

【电脑软件】Pr2022版

ps-初识软件界面

Eureka注册中心之搭建eureka-server和eureka-client

内网穿透教程

ps-选区工具

MapStruct属性拷贝工具

发表评论 取消回复 使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

MapStruct属性拷贝工具

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款