MapStruct文档(十一)——SPI

mapstruct提供了一些列SPI,供我们自定义实现一些功能:AccessorNamingStrategy(实现自定义的get/set,获取字段名)、DefaultProvider(实现自定义的建造者)、MappingExclusionProvider(实现自定义的排除,也就是不自动映射字段)、EnumMappingStrategy(实现自定义的枚举命名)、EnumTransformationStrategy(实现自定义的枚举转换)。

要实现自定义功能要先建一个项目,可以打包成jar包,自定义的实现以上接口,在resources包下新建META-INF.services包,再新建一个文件,文件名是被继承的类的全路径(都是在org.mapstruct.ap.spi包下),文件内容为自定义类的全路径;然后在使用到的项目中的pom文件的build->plugins->configuration->annotationProcessorPaths->mapstruct-processor的path后添加一个上述新建的项目的path标签。


public class CustomEnumTransformationStrategy implements EnumTransformationStrategy {

    @Override
    public String getStrategyName() {
        return "custom";
    }

    @Override
    public String transform(String value, String configuration) {
        return value.toLowerCase() + configuration;
    }
}

org.mapstruct.ap.spi.EnumTransformationStrategy文件内容

com.haru.acfun.CustomEnumTransformationStrategy

 


public enum LevelEnum {

    ABLE(1, "完美"),
    DISABLE(2, "合格"),
    NORMAL(3, "普通"),
    FAILED(4, "不及格"),
    OK(5, "还行"),
    FINE(6, "可以");

    private Integer code;

    private String desc;

    LevelEnum(Integer code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }
}


@Mapper
public interface TestMapper {

    @EnumMapping(nameTransformationStrategy = "custom", configuration = "_status")
    DisableStatus toEnum(LevelEnum levelEnum);

}
 
@Component
public class TestMapperImpl implements TestMapper {

    @Override
    public DisableStatus toEnum(LevelEnum levelEnum) {
        if ( levelEnum == null ) {
            return null;
        }

        DisableStatus disableStatus;

        switch ( levelEnum ) {
            case ABLE: disableStatus = DisableStatus.able_status;
            break;
            case DISABLE: disableStatus = DisableStatus.disable_status;
            break;
            case NORMAL: disableStatus = DisableStatus.normal_status;
            break;
            case FAILED: disableStatus = DisableStatus.failed_status;
            break;
            case OK: disableStatus = DisableStatus.ok_status;
            break;
            case FINE: disableStatus = DisableStatus.fine_status;
            break;
            default: throw new IllegalArgumentException( "Unexpected enum constant: " + levelEnum );
        }

        return disableStatus;
    }
}

自定义的枚举转换是将枚举字段值转成小写再加上配置后缀。这样可以正常映射。

注:下文中的 *** 代表文件名中的组件名称。 # 包含: 中文-英文对照文档:【***-javadoc-API文档-中文(简体)-英语-对照版.zip】 jar包下载地址:【***.jar下载地址(官方地址+国内镜像地址).txt】 Maven依赖:【***.jar Maven依赖信息(可用于项目pom.xml).txt】 Gradle依赖:【***.jar Gradle依赖信息(可用于项目build.gradle).txt】 源代码下载地址:【***-sources.jar下载地址(官方地址+国内镜像地址).txt】 # 本文件关键字: 中文-英文对照文档,中英对照文档,java,jar包,Maven,第三方jar包,组件,开源组件,第三方组件,Gradle,中文API文档,手册,开发手册,使用手册,参考手册 # 使用方法: 解压 【***.jar中文文档.zip】,再解压其中的 【***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档为人性化翻译,精心制作,请放心使用。 ·本文档为双语同时展示,一行原文、一行译文,可逐行对照,避免了原文/译文来回切换的麻烦; ·有原文可参照,不再担心翻译偏差误导; ·边学技术、边学英语。 ·只翻译了该翻译的内容,如:注释、说明、描述、用法讲解 等; ·不该翻译的内容保持原样,如:类名、方法名、包名、类型、关键字、代码 等。 # 温馨提示: (1)为了防止解压后路径太长导致浏览器无法打开,推荐在解压时选择“解压到当前文件夹”(放心,自带文件夹,文件不会散落一地); (2)有时,一套Java组件会有多个jar,所以在下载前,请仔细阅读本篇描述,以确保这就是你需要的文件;
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值