MapStruct文档（八）——高级映射选项

最新推荐文章于 2024-04-22 02:15:15 发布
最新推荐文章于 2024-04-22 02:15:15 发布
阅读量8.2k 收藏 6
点赞数 5
分类专栏： mapstruct 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sinat_32787481/article/details/110928651
版权

目录

7.1、默认值

7.2、表达式

7.2、确定映射结果的具体类型

7.4、NULL映射控制

7.4.1、源对象NULL映射

7.4.3、在更新时源对象属性NULL映射

7.4.3、何时NULL检查

7.1、默认值

可以给@Mapping的属性defaultValue设置一个值，若果源字段为空，那么目标字段就为此默认值。


@Mapper(uses = BaseMapper.class)
public interface TestMapper {

    @Mapping(target = "name", source = "name", defaultValue = "noName")
    TestBO toBO(TestPO testPO);

}
 
@Component
public class TestMapperImpl implements TestMapper {

    @Override
    public TestBO toBO(TestPO testPO) {
        if ( testPO == null ) {
            return null;
        }

        TestBO testBO = new TestBO();

        if ( testPO.getName() != null ) {
            testBO.setName( testPO.getName() );
        }expression
        else {
            testBO.setName( "noName" );
        }
        testBO.setId( testPO.getId() );
        if ( testPO.getPrice() != null ) {
            testBO.setPrice( testPO.getPrice().toString() );
        }

        return testBO;
    }
}

7.2、表达式

可以设置@Mapping的expression的值来插入一段java代码


@Mapper(uses = BaseMapper.class)
public interface TestMapper {

    @Mapping(target = "name", expression = "java(testPO.getName() + \"BO\")")
    TestBO toBO(TestPO testPO);

}
 
@Component
public class TestMapperImpl implements TestMapper {

    @Override
    public TestBO toBO(TestPO testPO) {
        if ( testPO == null ) {
            return null;
        }

        TestBO testBO = new TestBO();

        testBO.setId( testPO.getId() );
        if ( testPO.getPrice() != null ) {
            testBO.setPrice( testPO.getPrice().toString() );
        }
        if ( testPO.getCreateTime() != null ) {
            testBO.setCreateTime( new SimpleDateFormat().format( testPO.getCreateTime() ) );
        }

        testBO.setName( testPO.getName() + "BO" );

        return testBO;
    }
}

testBO.setName( testPO.getName() + "BO" )就是使用了插入的代码。

 

还可以调用用@Mapper#imports导入的类中的方法，当然也包括导入类的构造方法。


public class StringBOUtils {

    public static String toBOString(String poString) {
        return poString + "BO";
    }
}
 
@Mapper(uses = BaseMapper.class, imports = {StringBOUtils.class})
public interface TestMapper {

    @Mapping(target = "name", expression = "java(StringBOUtils.toBOString(testPO.getName()))")
    TestBO toBO(TestPO testPO);

}
 
@Component
public class TestMapperImpl implements TestMapper {

    @Override
    public TestBO toBO(TestPO testPO) {
        if ( testPO == null ) {
            return null;
        }

        TestBO testBO = new TestBO();

        testBO.setId( testPO.getId() );
        if ( testPO.getPrice() != null ) {
            testBO.setPrice( testPO.getPrice().toString() );
        }
        if ( testPO.getCreateTime() != null ) {
            testBO.setCreateTime( new SimpleDateFormat().format( testPO.getCreateTime() ) );
        }

        testBO.setName( StringBOUtils.toBOString(testPO.getName()) );

        return testBO;
    }
}

 

还可以设置@Mapping的defaultExpression设置默认表达式，在source的值为null时，调用此默认表达式代码。


@Mapper(uses = BaseMapper.class, imports = {StringBOUtils.class})
public interface TestMapper {

    @Mapping(target = "name", source = "name", defaultExpression  = "java(StringBOUtils.toBOString(testPO.getName()))")
    TestBO toBO(TestPO testPO);

}


@Component
public class TestMapperImpl implements TestMapper {

    @Override
    public TestBO toBO(TestPO testPO) {
        if ( testPO == null ) {
            return null;
        }

        TestBO testBO = new TestBO();

        if ( testPO.getName() != null ) {
            testBO.setName( testPO.getName() );
        }
        else {
            testBO.setName( StringBOUtils.toBOString(testPO.getName()) );
        }
        testBO.setId( testPO.getId() );
        if ( testPO.getPrice() != null ) {
            testBO.setPrice( testPO.getPrice().toString() );
        }
        if ( testPO.getCreateTime() != null ) {
            testBO.setCreateTime( new SimpleDateFormat().format( testPO.getCreateTime() ) );
        }

        return testBO;
    }
}

7.2、确定映射结果的具体类型

若果映射的结果是父类，又存在不同子类的映射方法，编译会报错。

此时需要使用@Mapping或@BeanMapping的resultType指定映射结果的具体类型。


@Mapper
public class BaseMapper {


    public TestSixBO createSixBO() {
        return new TestSixBO();
    }

    public TestEightBO createEightBO() {
        return new TestEightBO();
    }

}


@Mapper(uses = {BaseMapper.class})
public interface TestMapper {

    @BeanMapping(resultType = TestEightBO.class)
    BaseBO toBO(TestFourPO testFourPO);

}


@Component
public class TestMapperImpl implements TestMapper {

    @Autowired
    private BaseMapper baseMapper;

    @Override
    public BaseBO toBO(TestFourPO testFourPO) {
        if ( testFourPO == null ) {
            return null;
        }

        TestEightBO baseBO = baseMapper.createEightBO();

        baseBO.setId( testFourPO.getId() );
        baseBO.setName( testFourPO.getName() );
        baseBO.setCreateTime( testFourPO.getCreateTime() );

        return baseBO;
    }
}

7.4、NULL映射控制

7.4.1、源对象NULL映射

当映射的source对象为null时可以通过@BeanMapping、@IterableMapping、@MapMapping（优先级最高），@Mappe，@MappingConfig（优先级最低）的nullValueMappingStrategy策略来控制NULL值的映射结果。

策略值有：NullValueMappingStrategy.RETURN_NULL（默认，源为null，目标直接返回null）、NullValueMappingStrategy.RETURN_DEFAULT（返回一个对象，除填充的常量和表达式，其他字段属性为空；集合返回一个对象，size为0）。


@Mapper
public interface TestMapper {

    @IterableMapping(nullValueMappingStrategy = NullValueMappingStrategy.RETURN_DEFAULT)
    List<TestThreeBO> toBO(List<TestFivePO> testFivePO);

}
 
@Component
public class TestMapperImpl implements TestMapper {

    @Override
    public List<TestThreeBO> toBO(List<TestFivePO> testFivePO) {
        if ( testFivePO == null ) {
            return new ArrayList<TestThreeBO>();
        }

        List<TestThreeBO> list = new ArrayList<TestThreeBO>( testFivePO.size() );
        for ( TestFivePO testFivePO1 : testFivePO ) {
            list.add( testFivePOToTestThreeBO( testFivePO1 ) );
        }

        return list;
    }

    protected TestBO testPOToTestBO(TestPO testPO) {
        if ( testPO == null ) {
            return null;
        }

        TestBO testBO = new TestBO();

        testBO.setId( testPO.getId() );
        testBO.setName( testPO.getName() );
        if ( testPO.getPrice() != null ) {
            testBO.setPrice( testPO.getPrice().toString() );
        }
        if ( testPO.getCreateTime() != null ) {
            testBO.setCreateTime( new SimpleDateFormat().format( testPO.getCreateTime() ) );
        }

        return testBO;
    }

    protected TestThreeBO testFivePOToTestThreeBO(TestFivePO testFivePO) {
        if ( testFivePO == null ) {
            return null;
        }

        TestThreeBO testThreeBO = new TestThreeBO();

        testThreeBO.setTest( testPOToTestBO( testFivePO.getTest() ) );

        return testThreeBO;
    }
}

集合使用了NullValueMappingStrategy.RETURN_DEFAULT策略所以源为NULL时返回return new ArrayList<TestThreeBO>()；bean对象使用默认策略所以源为NULL时返回return null。

 

bean对象使用NullValueMappingStrategy.RETURN_DEFAULT策略，并且知道常量和表达式。


@Mapper
public interface TestMapper {

    @BeanMapping(nullValueMappingStrategy = NullValueMappingStrategy.RETURN_DEFAULT)
    @Mapping(target = "id", constant = "0L")
    @Mapping(target = "name", expression = "java(testPO.getName() + \"BO\")")
    TestBO toBO(TestPO testPO);

}
 
@Component
public class TestMapperImpl implements TestMapper {

    @Override
    public TestBO toBO(TestPO testPO) {

        TestBO testBO = new TestBO();

        if ( testPO != null ) {
            if ( testPO.getPrice() != null ) {
                testBO.setPrice( testPO.getPrice().toString() );
            }
            else {
                testBO.setPrice( testPO.getPrice() + "BO" );
            }
            if ( testPO.getCreateTime() != null ) {
                testBO.setCreateTime( new SimpleDateFormat().format( testPO.getCreateTime() ) );
            }
        }
        testBO.setId( (long) 0L );
        testBO.setName( testPO.getName() + "BO" );

        return testBO;
    }
}

7.4.3、在更新时源对象属性NULL映射

在使用@MappingTarget更新目标时，可以设置@Mapping、@BeanMapping（优先级最高），@Mapper或@MappingConfig（优先级最底）的nullValuePropertyMappingStrategy属性值，用于设置当源对象属性为null时，如何设置目标属性的值。nullValuePropertyMappingStrategy的值有：

NullValuePropertyMappingStrategy.SET_TO_DEFAULT：源属性为null，目标属性会被赋予特定的默认值。List被赋予ArrayList，Map被赋予HashMap，数组就是空数组，String是“”，基本类型或包装类是0或false，对象是空的构造方法。

NullValuePropertyMappingStrategy.IGNORE：源属性为null，忽略目标属性的设值。

NullValuePropertyMappingStrategy.SET_TO_NULL：默认，源属性是null，目标属性也是null。


@Mapper
public interface TestMapper {

    @Mapping(target = "name", nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.SET_TO_DEFAULT)
    @Mapping(target = "price", nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE)
    void toBO(TestPO testPO, @MappingTarget TestBO testBO);

}
 
@Component
public class TestMapperImpl implements TestMapper {

    @Override
    public void toBO(TestPO testPO, TestBO testBO) {
        if ( testPO == null ) {
            return;
        }

        if ( testPO.getName() != null ) {
            testBO.setName( testPO.getName() );
        }
        else {
            testBO.setName( "" );
        }
        if ( testPO.getPrice() != null ) {
            testBO.setPrice( testPO.getPrice().toString() );
        }
        testBO.setId( testPO.getId() );
        if ( testPO.getCreateTime() != null ) {
            testBO.setCreateTime( new SimpleDateFormat().format( testPO.getCreateTime() ) );
        }
        else {
            testBO.setCreateTime( null );
        }
    }
}

7.4.3、何时NULL检查

在使用@MappingTarget更新目标时，可以设置@Mapping、@BeanMapping（优先级最高），@Mapper或@MappingConfig（优先级最底）的nullValuePropertyMappingStrategy属性值，设置何时对源属性值进行null检查。nullValuePropertyMappingStrategy可选：

ON_IMPLICIT_CONVERSION：默认；包装类赋予基本类型、直接setter对象类型、类型转换后进行setter。

ALWAYS：总是进行null值检查。


@Mapper
public interface TestMapper {

    @Mapping(target = "id", nullValueCheckStrategy = ALWAYS)
    TestPO toBO(TestBO testBO);

}
 
@Component
public class TestMapperImpl implements TestMapper {

    @Override
    public TestPO toBO(TestBO testBO) {
        if ( testBO == null ) {
            return null;
        }

        TestPO testPO = new TestPO();

        if ( testBO.getId() != null ) {
            testPO.setId( testBO.getId() );
        }
        testPO.setName( testBO.getName() );
        if ( testBO.getPrice() != null ) {
            testPO.setPrice( new BigDecimal( testBO.getPrice() ) );
        }
        try {
            if ( testBO.getCreateTime() != null ) {
                testPO.setCreateTime( new SimpleDateFormat().parse( testBO.getCreateTime() ) );
            }
        }
        catch ( ParseException e ) {
            throw new RuntimeException( e );
        }

        return testPO;
    }
}

if ( testBO.getId() != null ) id进行了null检查。

文香P
关注
  • 5
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Map(Mapping 映射)集合
weixin_46058231的博客
12-04 737
java.util.Map<K,V>集合中存取元素的基本单位是：单对元素，其中类型参数如下： K - 此映射所维护的键(Key)的类型，相当于⽬录。 V - 此映射所维护的值(Value)的类型，相当于内容。 该集合中key是不允许重复的，⽽且⼀个key只能对应⼀个value。 该集合的主要实现类有：HashMap类、TreeMap类、LinkedHashMap类、Hashtable类、Properties类。 其中HashMap类的底层是采⽤哈希表进⾏数据管理的。 其中TreeMap类的底..
mapstruct-idea:IntelliJ IDEA插件，可与MapStruct一起使用
05-02
MapStruct是一个Java用于为Java Bean类生成类型安全和高性能的映射器。 要了解有关MapStruct的更多信息，请查看存储库或 特征 代码完成 完成@Mapping注释中的target和source属性（嵌套属性也可以使用） @...
map(mapping)技巧
michael_wq的博客
11-27 820
先说数据集
MapStruct系列（8）-映射器的高级用法
记录知识、锤炼自我
04-14 7488
文章目录前言1. 默认值和常量2. 表达式3. 默认表达式4. 子类映射5. 指定结果类型6. 控制“null”参数的映射结果7. 条件映射8. 异常处理 前言 在之前的案例中，我们使用@Mapping指定映射关系，接下来深入了解下映射的其他高级用法。 1. 默认值和常量 如果源属性是null ，则可以使用Mapping.defaultValue设置默认值。也可以使用Mapping.constant来设置。默认值和常量被指定为字符串值。 @Mapper(uses = StringListMapper.cla
MapStruct 代码优化利器
最新发布
weixin_45988184的博客
04-22 804
生成实现的代码时carToCarDto()方法，MapStruct将查找一个映射Date对象转换为字符串，则在DateMapper类并生成的调用asString()用于映射manufacturingDate属性。当映射bean的集合类型属性时，MapStruct将查找具有匹配参数和返回类型的集合映射方法，例如Car#passengers(类型List) 至CarDto#passengers(类型List)。不同之处在于，它允许用户编写自定义条件方法，这些方法将被调用以检查是否需要映射属性。
[MapStruct]关于Mapping的高级选项
无bug无江湖
08-29 3500
MapStruct
mybatis的mapper映射配置文件、个别场景记录
YR_112233的博客
11-30 4127
mybatis的mapper映射配置文件详解 一、常用属性标签 1、namespace的作用 在MyBatis中，Mapper中的namespace用于绑定Dao接口的，即面向接口编程。namespace属性的值要和对应的Mapper接口的全限定名保持一致 它的好处在于当使用了namespace之后就可以不用写接口实现类，业务逻辑会直接通过这个绑定寻找到相对应的SQL语句进行对应的数据处理 2、常用标签介绍 insert,update,delete,select,sql,resultMap sql:可被其它
MapStruct @Mapping注解：优雅处理映射中的Null值
FirstMrRight的博客
12-27 1923
Mapping注解是MapStruct中用于定制字段映射关系的重要工具。通过@Mapping注解，我们可以指定源对象和目标对象之间的字段映射关系，包括字段名、转换方法等信息。在处理Null值时，@Mapping注解提供了一些强大的选项，使得映射过程更加灵活和可控。除了使用默认值和设置目标对象字段为默认值之外，MapStruct还支持自定义Null值处理策略。通过在@Mapper注解中配置nullValueCheckStrategy属性，我们可以指定一个自定义的策略类，来决定在映射过程中如何处理Null值。
MapStruct：Java Bean映射的简单之道
islautao的博客
06-25 407
MapStruct是一个代码生成器，它可以根据约定优于配置的原则，大大简化Java Bean类型之间的映射实现。生成的映射代码使用普通的方法调用，因此速度快、类型安全、易于理解。MapStruct是一个优秀的Java Bean映射框架，它可以帮助我们简化映射代码的编写和维护，提高性能和可读性。如果你还没有使用过MapStruct，不妨试试看，相信你会喜欢上它的。
@mapper
l1563045的博客
08-14 139
【代码】@mapper。
推荐一款Java实体映射工具---mapstruct（csdn）————程序.pdf
12-05
MapStruct 是一个强大的Java实体映射工具，它旨在简化对象之间的转换过程，特别是在处理大量属性映射时。传统的手动设置属性或使用BeanUtils.copyProperties()方法可能会效率低下，且易出错。MapStruct通过注解...
MapStruct Java实例Demo
09-04
MapStruct是一款优秀的Java库，专为简化对象到对象映射（Object-to-Object mapping）而设计。在软件开发中，特别是在处理数据传输对象（DTO，Data Transfer Objects）时，经常需要将一个对象的属性值复制到另一个...
spring boot3+jpa+lombok+mapstruct实现的restful api例子
05-08
4. **MapStruct**: MapStruct是一个代码生成库，用于简化对象之间的映射过程。在RESTful API中，通常需要在模型对象（如DTO - Data Transfer Objects）和领域对象之间进行转换。MapStruct通过自动生成映射代码，避免...
mapstruct 对象映射详解
herionZhang的博客
11-27 8264
1、@Mapper项目编译时会生产对应实现类 2、@Mapping 用来指定属性映射的，如果两个对象的属性名相同是可以省略
深入使用MapStruct
Java技术攻略的博客
04-26 1157
自定义注解的主要作用是简化我们的配置。比如我们保存和更新时需要两个转换配置（因为复制逻辑可能不一样，比如更新时：id，createTime的属性是不能改变的），但是其他属性的赋值逻辑是一致的，那么我们就可以通过自定义注解的方式来简化这个过程。@Common@Common复制代码从测试可以看出来和配置可以得出结果：我们自定义的注解被 toSave() 和 toUpdate()继承了，数据符合我们的预期。自定义表达式是MapStruct提供的更高级和强大的功能。其可以支持你更灵活的去生成你属性的值。
MapStruct介绍和基本的功能示例
lox_J2的博客
06-01 1208
作用 在Java中用来做不同对象之间的转换（DTO，DO，BO，VO…），使用方式简单，只需要按规则写一个相关接口，甚至不需要实现（较类似于jpa的JpaRepository接口的使用方式），就能直接完成对象间的转换。以下是官方介绍(摘要)：官方文档链接 MapStruct官网 MapStruct 是一个 Java 注释处理器，用于生成类型安全的 bean 映射类。 您所要做的就是定义一个映射器接口，该接口可以声明任何您所需的映射方法。在编译期间，MapStruct 将生成此接口的实现。这个实现使用普.
MapStruct
a791812366的博客
03-22 306
MapStruct 使用场景：用于不同的pojo之间的转化 传统方式 通过get，set方式转换 @Data publci class CarDTO{ private Long id; private String name; … } @Data public class CarVO{ } 业务层代码如下： //模拟业务构造出的CarDTO对象 CarDTO carDTO = buildCarDTO(); //转换dto-vo CarVO carVO = new CarVO();
Java实体映射工具:MapStruct 的使用方法
Gzq
08-20 2862
mapstruct这个插件就是用来处理domin实体类与model类的属性映射，定义mapper接口，mapstruct就会自动的帮我们实现这个映射接口，避免了麻烦复杂的映射实现。 1 简单使用 首先需要引入的依赖如下所示： <!-- MapStruct --> <dependency> <groupId>org.mapstruct</groupId> <artifactId>mapstruct-jdk8</artif
mapstruct对象属性映射如何显示映射
06-01
在 MapStruct 中，可以使用注解 `@Mapping` 来显示地指定对象属性之间的映射关系。具体来说，可以在映射方法中使用 `@Mapping(source = "sourceField", target = "targetField")` 来表示将源对象的 `sourceField` 属性值映射到目标对象的 `targetField` 属性上。 例如，假设有两个类 `Source` 和 `Target`，它们有相同的属性名但类型不同： ```java public class Source { private int id; private String name; // getters and setters } public class Target { private long id; private String name; // getters and setters } ``` 可以使用以下 MapStruct 映射接口将 `Source` 类型的对象转换为 `Target` 类型的对象： ```java @Mapper public interface SourceTargetMapper { @Mapping(source = "id", target = "id") Target sourceToTarget(Source source); } ``` 在上面的例子中，`@Mapping(source = "id", target = "id")` 指定了 `Source` 类型的对象的 `id` 属性值映射到 `Target` 类型的对象的 `id` 属性上。这样，当调用 `sourceToTarget()` 方法时，MapStruct 会自动执行这个映射。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值