mapstruct-plus/docs/guide/configuration.md
linpeilie 34fa59d985 1.2.3
- MapStructPlus 版本由 1.5.3.Final 升级为 1.5.5.Final
- 增加自定义 ConvertMapperAdapter 和 MapConvertMapperAdapter 类名和包名的功能
- 生成的转换接口,自动接入自定义转换接口
2023-04-24 16:21:56 +08:00

2.2 KiB
Raw Blame History

title, order, category, description
title order category description
配置项 6
指南
MapStructPlus MapStructPlus配置项 configuration

MapStructPlus 提供了多个配置项,来指定生成转换接口时的一些行为。

使用方式

在需要进行配置的模块中,新建配置类,在该类上面增加注解:@MapperConfig,在一个模块中,只能有一个有该注解的类。

例如:

@MapperConfig(adapterClassName = "DemoConvertMapperAdapter",
    adapterPackage = "io.github.linpeilie.adapter",
    mapAdapterClassName = "DemoMapConvertMapperAdapter")
public class MapStructPlusConfiguration {
}

配置项

mapperPackage

  • 说明:生成的 Mapper 转换接口的包名
  • 类型String
  • 默认值:默认生成在要转换的类同包名下

unmappedSourcePolicy

  • 说明:当来源类中没有对应属性时的策略,默认忽略
  • 类型ReportingPolicy
  • 可选项
    • IGNORE:忽略
    • WARN:打印警告日志
    • ERROR:抛出异常
  • 默认值IGNORE

unmappedTargetPolicy

  • 说明:当目标类中没有对应属性时的策略,默认忽略
  • 类型ReportingPolicy
  • 可选项
    • IGNORE:忽略
    • WARN:打印警告日志
    • ERROR:抛出异常
  • 默认值IGNORE

builder

  • 说明构造者模式配置MapStruct 与 lombok 的 builder 一起使用时,会丢失父类属性,所以这里将默认使用构造者模式关闭
  • 类型Builder
  • 支持配置项
    • buildMethod:构造器创建要构建类型时的构造方法
    • disableBuilder:打开/关闭构造器,如果关闭,则只使用常规的 getters/setters
  • 默认值
    • buildMethodbuild
    • disableBuildertrue

adapterPackage

since 1.2.3

  • 说明ConvertAdapterClass 和 MapConvertMapperAdapter 的包名
  • 类型String
  • 默认值io.github.linpeilie

adapterClassName

since 1.2.3

  • 说明ConvertAdapterClass 类名
  • 类型String
  • 默认值ConvertMapperAdapter

mapAdapterClassName

since 1.2.3

  • 说明MapConvertMapperAdapter 类名
  • 类型String
  • 默认值MapConvertMapperAdapter