mirror of
https://gitee.com/easii/mapstruct-plus.git
synced 2025-12-07 01:28:31 +08:00
87 lines
2.2 KiB
Markdown
87 lines
2.2 KiB
Markdown
---
|
||
title: 枚举转换
|
||
order: 3
|
||
category:
|
||
- 指南
|
||
description: MapStructPlus Map转为对象 map convert to class
|
||
---
|
||
|
||
## 枚举自动转换
|
||
|
||
> 当前特性从 1.2.2 开始支持
|
||
|
||
当需要进行枚举转换时（例如枚举转换为编码值，或者由编码转换为枚举），可以在目标枚举添加 `@AutoEnumMapper` 注解，
|
||
增加该注解后，在任意类型中需要转换该枚举时都可以自动转换。
|
||
|
||
使用该注解需要注意：**当前枚举必须有一个可以保证唯一的字段**，并在使用当前注解时，将该字段名，添加到注解提供的 `value` 属性中。
|
||
|
||
还有就是**枚举和使用枚举的类，要在同一个模块中**。
|
||
|
||
例如：
|
||
|
||
- 商品状态枚举（`Goods`）
|
||
|
||
```java
|
||
@Getter
|
||
@AllArgsConstructor
|
||
@AutoEnumMapper("state")
|
||
public enum GoodsStateEnum {
|
||
ENABLED(1, "启用"),
|
||
DISABLED(0, "禁用");
|
||
|
||
private final Integer state;
|
||
private final String desc;
|
||
|
||
}
|
||
```
|
||
|
||
在当前枚举中添加注解 `@AutoEnumMapper`，且指定唯一字段为 `state`。
|
||
|
||
- 商品类（`Goods`）
|
||
|
||
```java
|
||
@Data
|
||
@AutoMapper(target = GoodsVo.class, reverseConvertGenerate = false)
|
||
public class Goods {
|
||
|
||
private GoodsStateEnum state;
|
||
|
||
}
|
||
```
|
||
|
||
- 商品VO对象（`GoodsVo`）
|
||
|
||
```java
|
||
@Data
|
||
public class GoodsVo {
|
||
|
||
private Integer state;
|
||
|
||
}
|
||
```
|
||
|
||
- 测试类
|
||
|
||
```java
|
||
@Test
|
||
public void enumMapTest() {
|
||
final GoodsVo goodsVo = converter.convert(goods, GoodsVo.class);
|
||
System.out.println(goodsVo);
|
||
Assert.equals(goodsVo.getState(), goods.getState().getState());
|
||
|
||
final Goods goods2 = converter.convert(goodsVo, Goods.class);
|
||
System.out.println(goods2);
|
||
Assert.equals(goods2.getState(), GoodsStateEnum.ENABLED);
|
||
}
|
||
```
|
||
|
||
## 跨模块支持
|
||
|
||
当枚举与要使用的类型，不在同一个模块（module）中时，并不能自动转换，需要指定依赖关系。
|
||
|
||
在 `AutoMapper` 注解中，可以通过属性 `useEnums` 来指定，当前转换关系，需要依赖的枚举类列表。这些枚举需要被 `AutoEnumMapper`注解。
|
||
|
||
> 该特性从 1.4.1 开始支持
|
||
|
||
需要注意的是，当两个类在同一个模块（module）中，无需指定，可以自动转换。当前特性主要解决跨模块之间不能自动转换的问题。
|