MapStruct 是一个强大且灵活的映射框架，很好的解决有关对象转换的问题，实现了代码的简洁和性能的兼顾。MapStruct的常规用法，网上有很多教程了，本文将列举一些进阶用法，方便日常开发使用。
expression
在转化的时候，执行 java 表达式，直接看例子：
@Mapper(componentModel = "spring")
public interface MyMapper {
@Mapping(target = "createTime", expression = "java(System.currentTimeMillis())")
Target toTarget(Source source);
}转化成 target 对象时，createTime字段的值，会设置为System.currentTimeMillis()，生成的代码如下：
@Component
public class MyMapperImpl implements MyMapper {
@Override
public Target toTarget(Source source) {
Target target = new Target();
target.setCreateTime( System.currentTimeMillis() );
return target;
}
}qualifiedByName
做映射时，默认情况下，从source 字段到target 字段是直接使用 get/set，如下：
@Data
public class Source {
private String name;
}
@Data
public class Target {
private String name;
}
@Mapper(componentModel = "spring")
public interface MyMapper {
Target toTarget(Source source);
}生成的转化代码类如下：
@Component
public class MyMapperImpl implements MyMapper {
@Override
public Target toTarget(Source source) {
if ( source == null ) {
return null;
}
Target target = new Target();
// 无脑 set/get
target.setName( source.getName() );
return target;
}
}如果这种直接的 set/get 无法满足需求，比如需要把 name 转化成大写格式，那么可以使用qualifiedByName:
@Mapper(componentModel = "spring")
public interface MyMapper {
@Mapping(target = "name", source = "name", qualifiedByName = "toUpperCase")
Target toTarget(Source source);
@Named("toUpperCase")
default String toUpperCase(String value) {
// 这里写转换大写的逻辑
return value == null ? null : value.toUpperCase();
}
}生成的代码如下：
@Component
public class MyMapperImpl implements MyMapper {
@Override
public Target toTarget(Source source) {
if ( source == null ) {
return null;
}
Target target = new Target();
target.setName( toUpperCase( source.getName() ) );
return target;
}
}nullValueMappingStrategy
如果 source 为 null 时，对应的 target 的处理策略，默认是 NullValueMappingStrategy.RETURN_NULL，即 target 中对应的字段也设置为 null。
但有时候设置为 null 可能不符合我们的需求，比如 target 中有个 List ids，我们希望如果 source 中ids 为 null 时，target 的 ids 设置为空 list。这时候可以使用nullValueMappingStrategy策略中的NullValueMappingStrategy.RETURN_DEFAULT。
nullValueMappingStrategy 可以使用在某个方法上（只对该方法生效），也可以使用在类上（对类中的所有方法都生效），如下：
@Component
public class MyMapperImpl implements MyMapper {
@Override
public Target toTarget(Source source) {
if ( source == null ) {
return null;
}
Target target = new Target();
target.setName( source.getName() );
List<Integer> list = source.getIds();
if ( list != null ) {
target.setIds( new ArrayList<Integer>( list ) );
}
else {
target.setIds( null );
}
return target;
}
}指定NullValueMappingStrategy.RETURN_DEFAULT策略后：
@Mapper(componentModel = "spring",
nullValueMappingStrategy = org.mapstruct.NullValueMappingStrategy.RETURN_DEFAULT)
public interface MyMapper {
Target toTarget(Source source);
}
@Component
public class MyMapperImpl implements MyMapper {
@Override
public Target toTarget(Source source) {
Target target = new Target();
if ( source != null ) {
target.setName( toUpperCase( source.getName() ) );
List<Integer> list = source.getIds();
if ( list != null ) {
target.setIds( new ArrayList<Integer>( list ) );
}
else {
target.setIds( new ArrayList<Integer>() );
}
}
return target;
}
}可以看到，当 source 或者 source.ids 为 null 时，返回的 target 和 target.ids 都是默认的空值（空对象+空 list）。
Decorator
你可以通过创建一个 Decorator 类来对你的方法进行修饰并实现全局处理。
以下是一个例子：
public abstract class YourMapperDecorator implements YourMapper {
private final YourMapper delegate;
public YourMapperDecorator(YourMapper delegate) {
this.delegate = delegate;
}
@Override
public Target toTarget(Source source) {
Target result = delegate.toTarget(source);
if (result != null) {
if (result.getField() == null) {
result.setField("");
}
// 你可以在这里对其他字段进行同样的处理...
}
return result;
}
}然后你只需在你的 Mapper 接口上添加 @DecoratedWith 注解：
@Mapper
@DecoratedWith(YourMapperDecorator.class)
public interface YourMapper {
Target toTarget(Source source);
}这样，每次调用 toTarget 方法时，YourMapperDecorator 中的实现会被调用。在这里，你可以实现任何你想要的逻辑，例如对空字段赋予特定的默认值。
最后说一句(求关注!别白嫖！)
如果这篇文章对您有所帮助，或者有所启发的话，求一键三连：点赞、转发、在看。
关注公众号：woniuxgg，在公众号中回复：笔记 就可以获得蜗牛为你精心准备的java实战语雀笔记，回复面试、开发手册、有超赞的粉丝福利！