Java中MapStruct转换实体的步骤实现

<!-- mapstruct 核心依赖 -->
<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>
​
<!-- 若用 lombok，需确保 mapstruct 能识别 lombok 生成的 getter/setter -->
<dependency>
    <groupid>org.projectlombok</groupid>
    <artifactid>lombok</artifactid>
    <version>1.18.30</version>
    <scope>provided</scope>
</dependency>
​
<!-- lombok 与 mapstruct 兼容依赖（java 11+ 可能需要） -->
<dependency>
    <groupid>org.projectlombok</groupid>
    <artifactid>lombok-mapstruct-binding</artifactid>
    <version>0.2.0</version>
    <scope>provided</scope>
</dependency>

// 数据库实体（pojo）
@data
@noargsconstructor
@allargsconstructor
public class userentity {
    private long id;          // 主键
    private string username;  // 用户名（字段名：username）
    private integer age;      // 年龄（int 类型）
    private localdate birth;  // 生日（localdate 类型）
    private string phone;     // 手机号
}
​
// 前端传输对象（dto）
@data
@noargsconstructor
@allargsconstructor
public class userdto {
    private long userid;      // 主键（字段名：userid，与实体 id 对应）
    private string name;      // 用户名（字段名：name，与实体 username 对应）
    private string age;       // 年龄（string 类型，与实体 int 对应）
    private string birth;     // 生日（string 类型，格式：yyyy-mm-dd）
    private string phonenum;  // 手机号（字段名：phonenum，与实体 phone 对应）
}

import org.mapstruct.mapper;
import org.mapstruct.mapping;
import org.mapstruct.mappings;
import org.mapstruct.factory.mappers;
​
// 关键注解：componentmodel="spring" → spring 管理该映射器
@mapper(componentmodel = "spring", imports = {localdate.class, datetimeformatter.class})
public interface userconvert {
​
    // 方式 1：spring 依赖注入用（无需手动创建实例）
    // 方式 2：非 spring 环境用（手动获取实例）
    // userconvert instance = mappers.getmapper(userconvert.class);
​
    /**
     * dto → 实体（核心映射方法）
     * @mapping：指定字段映射规则（字段名不一致、类型转换、格式转换）
     */
    @mappings({
        // dto 的 userid → 实体的 id（字段名不一致）
        @mapping(source = "userid", target = "id"),
        // dto 的 name → 实体的 username（字段名不一致）
        @mapping(source = "name", target = "username"),
        // dto 的 age（string）→ 实体的 age（int）：自动类型转换（mapstruct 内置支持）
        @mapping(source = "age", target = "age"),
        // dto 的 birth（string）→ 实体的 birth（localdate）：自定义格式转换
        @mapping(
            source = "birth",
            target = "birth",
            dateformat = "yyyy-mm-dd" // 指定日期格式
        ),
        // dto 的 phonenum → 实体的 phone（字段名不一致）
        @mapping(source = "phonenum", target = "phone")
    })
    userentity dtotoentity(userdto userdto);
​
    /**
     * 实体 → dto（反向映射，字段名对应规则与正向一致）
     * 可复用正向映射规则，用 @inheritinverseconfiguration 简化
     */
    @inheritinverseconfiguration(name = "dtotoentity")
    @mapping(
        source = "birth",
        target = "birth",
        dateformat = "yyyy-mm-dd" // 反向转换也需指定日期格式
    )
    userdto entitytodto(userentity userentity);
​
    /**
     * 自定义转换逻辑（如特殊格式处理、复杂计算）
     * 若 mapstruct 内置转换不满足，可定义默认方法（default）
     */
    default integer stringtoage(string agestr) {
        if (agestr == null || agestr.trim().isempty()) {
            return 0; // 空值默认 0
        }
        try {
            return integer.parseint(agestr.trim());
        } catch (numberformatexception e) {
            return 0; // 格式错误默认 0
        }
    }
​
    // 反向转换：integer → string
    default string agetostring(integer age) {
        return age == null ? "" : string.valueof(age);
    }
}

// 自动生成的实现类（spring 管理）
@component
public class userconvertimpl implements userconvert {
​
    @override
    public userentity dtotoentity(userdto userdto) {
        if (userdto == null) {
            return null;
        }
        userentity userentity = new userentity();
        userentity.setid(userdto.getuserid());
        userentity.setusername(userdto.getname());
        // 调用自定义的 stringtoage 方法转换类型
        userentity.setage(stringtoage(userdto.getage()));
        // 自动按指定格式转换 string → localdate
        if (userdto.getbirth() != null) {
            userentity.setbirth(localdate.parse(userdto.getbirth(), datetimeformatter.ofpattern("yyyy-mm-dd")));
        }
        userentity.setphone(userdto.getphonenum());
        return userentity;
    }
​
    @override
    public userdto entitytodto(userentity userentity) {
        // 类似正向转换逻辑，自动处理字段映射和类型转换
    }
​
    // 自动生成自定义方法的调用逻辑...
}

@service
public class userservice {
​
    @autowired
    private userconvert userconvert; // 注入 mapstruct 映射器
​
    public void adduser(userdto userdto) {
        // 1. dto → 实体（自动完成字段映射和类型转换）
        userentity userentity = userconvert.dtotoentity(userdto);
        
        // 2. 存入数据库（假设用 mybatis 操作）
        // usermapper.insert(userentity);
        
        system.out.println("转换后的实体：" + userentity);
    }
​
    public userdto getuserbyid(long id) {
        // 1. 从数据库查询实体
        userentity userentity = new userentity(id, "张三", 25, localdate.of(2000, 1, 1), "13800138000");
        
        // 2. 实体 → dto（反向转换）
        userdto userdto = userconvert.entitytodto(userentity);
        
        return userdto;
    }
}

// 测试 dto → 实体
userdto dto = new userdto(1l, "张三", "25", "2000-01-01", "13800138000");
userentity entity = userconvert.dtotoentity(dto);
// 输出：userentity(id=1, username=张三, age=25, birth=2000-01-01, phone=13800138000)
​
// 测试实体 → dto
userentity entity = new userentity(1l, "张三", 25, localdate.of(2000, 1, 1), "13800138000");
userdto dto = userconvert.entitytodto(entity);
// 输出：userdto(userid=1, name=张三, age=25, birth=2000-01-01, phonenum=13800138000)

@mapper(componentmodel = "spring")
public interface userconvert {
    // 单个对象映射（已定义）
    userentity dtotoentity(userdto dto);
    userdto entitytodto(userentity entity);
​
    // 集合映射（自动生成，无需手动写实现）
    list<userentity> dtolisttoentitylist(list<userdto> dtolist);
    set<userdto> entitysettodtoset(set<userentity> entityset);
}

// 示例：枚举转换
public enum genderenum {
    male(1, "男"), female(2, "女");
    // getter/setter/静态方法...
}
​
// dto 中 gender 是 string 类型（"男"/"女"），实体中是 genderenum
@mapping(
    source = "gender",
    target = "gender",
    qualifiedbyname = "genderstrtoenum" // 指定自定义转换方法
)
userentity dtotoentity(userdto dto);
​
// 自定义枚举转换方法（用 @named 标识）
@named("genderstrtoenum")
default genderenum genderstrtoenum(string genderstr) {
    if ("男".equals(genderstr)) return genderenum.male;
    if ("女".equals(genderstr)) return genderenum.female;
    return null;
}

@mapper(componentmodel = "spring")
public interface userconvert {
​
    @autowired
    userservice userservice; // 注入 spring 服务
​
    @mapping(
        source = "userid",
        target = "deptid",
        qualifiedbyname = "getdeptidbyuserid" // 调用注入的服务
    )
    userentity dtotoentity(userdto dto);
​
    @named("getdeptidbyuserid")
    default long getdeptidbyuserid(long userid) {
        // 调用业务服务获取部门id（复杂逻辑）
        return userservice.getdeptidbyuserid(userid);
    }
}

// 日期格式
@mapping(source = "birth", target = "birth", dateformat = "yyyy-mm-dd hh:mm:ss")
// 数字格式（如保留2位小数）
@mapping(source = "amount", target = "amount", numberformat = "#.00")
userentity dtotoentity(userdto dto);