DozerMapper项目中的Map属性映射技术详解

最新推荐文章于 2025-06-25 09:32:32 发布

原创最新推荐文章于 2025-06-25 09:32:32 发布 · 318 阅读

9 ·

CC 4.0 BY-SA版权

DozerMapper项目中的Map属性映射技术详解

概述

在Java对象映射工具Dozer中，Map类型的属性映射是一个强大且灵活的功能。本文将深入探讨Dozer如何处理Map与Map之间的映射、属性与Map之间的映射，以及如何在类级别实现Map属性的映射。

Map到Map的映射

Dozer能够直接处理java.util.Map之间的映射转换。当源对象和目标对象都是Map类型时，Dozer会执行以下操作：

如果目标Map已存在，Dozer会将元素添加到现有Map中
对于包含复杂类型的Map，Dozer支持深度递归映射
可以通过类型提示(hint)指定Map中元素的类型

<mapping>
    <class-a>com.example.vo.map.MapToMap</class-a>
    <class-b>com.example.vo.map.MapToMapPrime</class-b>
    <field>
        <a>standardMapWithHint</a>
        <b>standardMapWithHint</b>
        <a-hint>com.example.vo.TestObject</a-hint>
        <b-hint>com.example.vo.TestObjectPrime</b-hint>
    </field>
</mapping>

属性到Map的映射

Dozer支持将普通属性映射到Map中，这种映射方式非常适用于需要动态扩展属性的场景。

基本映射

最简单的形式是将一个基本类型属性映射到Map中：

<mapping>
    <class-a>com.example.vo.map.PropertyToMap</class-a>
    <class-b>com.example.vo.map.MapToProperty</class-b>
    <field>
        <a>stringProperty</a>
        <b>hashMap</b>
    </field>
</mapping>

在这种情况下：

Map的键将是属性名称("stringProperty")
Map的值将是属性的值

自定义键名和设置方法

可以进一步自定义Map的键名和属性的设置方法：

<field>
    <a set-method="addStringProperty2">stringProperty2</a>
    <b key="myStringProperty">hashMap</b>
</field>

这里：

set-method指定了设置属性值的特殊方法名
key属性允许自定义Map中的键名

自定义Map实现

对于非标准Map实现(不直接实现java.util.Map接口的类)，需要指定特殊的get/set方法：

<field>
    <a>stringProperty3</a>
    <b map-get-method="getValue" map-set-method="putValue" key="myCustomProperty">customMap</b>
</field>

关键点：

map-get-method和map-set-method必须明确指定
可以为自定义Map提供类型提示(b-hint)
如果未指定key，默认使用属性名作为Map键

类级别到Map的映射

Dozer还支持将整个复杂对象映射到一个Map中，这是非常强大的功能，特别适合需要将对象序列化为键值对的场景。

标准Map映射

<mapping map-id="myTestMapping">
    <class-a>com.example.vo.map.PropertyToMap</class-a>
    <class-b>java.util.Map</class-b>
    <field>
        <a set-method="addStringProperty2">stringProperty2</a>
        <b key="myStringProperty">this</b>
    </field>
    <field-exclude>
        <a>excludeMe</a>
        <b>this</b>
    </field-exclude>
</mapping>

特点：

必须指定唯一的map-id
不需要显式定义所有属性映射
可以使用field-exclude排除不需要映射的属性
this关键字表示整个Map对象

自定义Map实现映射

<mapping map-id="myCustomTestMapping">
    <class-a>com.example.vo.map.PropertyToMap</class-a>
    <class-b map-set-method="putValue" map-get-method="getValue">
      com.example.vo.map.CustomMap
    </class-b>
    <!-- 字段映射同上 -->
</mapping>

区别在于：

必须指定自定义Map的类
需要定义map-set-method和map-get-method

使用类级别映射

定义好映射后，可以通过多种方式使用：

// 示例1：对象转标准Map
PropertyToMap ptm = new PropertyToMap();
ptm.setStringProperty("stringPropertyValue");
Map map = Mapper.map(ptm, HashMap.class, "myTestMapping");

// 示例2：对象转自定义Map
CustomMap customMap = mapper.map(ptm, CustomMap.class, "myCustomTestMapping");

// 示例3：映射到现有Map实例
CustomMap custom = new CustomMap();
custom.putValue("myKey", "myValue");
Mapper.map(ptm, custom, "myCustomTestMapping");

// 示例4：反向映射(Map转对象)
Map map = new HashMap();
map.put("stringProperty", "stringPropertyValue");
PropertyToMap property = mapper.map(map, PropertyToMap.class, "myTestMapping");