Mapstruct - 如何在Generated Mapper类中注入spring依赖项

Question

我需要在生成的mapper实现中注入一个spring服务类,以便我可以通过它来使用它

   @Mapping(target="x", expression="java(myservice.findById(id))")"

这适用于Mapstruct-1.0吗？

Answer 1

正如brettanomyces所评论的那样,如果不在表达式之外的映射操作中使用该服务,则不会注入该服务.

我发现这一点的唯一方法是:

• 将我的mapper接口转换为抽象类
• 在抽象类中注入服务
• 使其受到保护,以便抽象类的"实现"具有访问权限

我正在使用CDI,但它应该与Spring相同:

@Mapper(
        unmappedTargetPolicy = org.mapstruct.ReportingPolicy.IGNORE,
        componentModel = "spring",
        uses = {
            // My other mappers...
        })
public abstract class MyMapper {

    @Autowired
    protected MyService myService;

    @Mappings({
        @Mapping(target="x", expression="java(myservice.findById(obj.getId())))")
    })
    public abstract Dto myMappingMethod(Object obj);

}

Answer 2

除了上面的答案之外，值得补充的是，在 mapstruct 映射器中有更干净的使用 spring 服务的方法，它更适合“关注点分离”的设计理念，称为“限定符”。作为奖励，可以轻松在其他映射器中重用。为简单起见，我更喜欢这里提到的命名限定符http://mapstruct.org/documentation/stable/reference/html/#selection-based-on-qualifiers 示例是：

import org.mapstruct.Named;
import org.springframework.stereotype.Component;

@Component
public class EventTimeQualifier {

    private EventTimeFactory eventTimeFactory; // ---> this is the service you want yo use

    public EventTimeQualifier(EventTimeFactory eventTimeFactory) {
        this.eventTimeFactory = eventTimeFactory;
    }

    @Named("stringToEventTime")
    public EventTime stringToEventTime(String time) {
        return eventTimeFactory.fromString(time);
    }

}

这是您在映射器中使用它的方式：

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;

@Mapper(componentModel = "spring", uses = EventTimeQualifier.class)
public interface EventMapper {

    @Mapping(source = "checkpointTime", target = "eventTime", qualifiedByName = "stringToEventTime")
    Event map(EventDTO eventDTO);

}

Answer 3

我使用的是 Mapstruct 1.3.1，我发现使用装饰器很容易解决这个问题。

例子：

@Mapper(unmappedTargetPolicy = org.mapstruct.ReportingPolicy.IGNORE,
 componentModel = "spring")
@DecoratedWith(FooMapperDecorator.class)
public interface FooMapper {

    FooDTO map(Foo foo);
}

public abstract class FooMapperDecorator implements FooMapper{

    @Autowired
    @Qualifier("delegate")
    private FooMapper delegate;

    @Autowired
    private MyBean myBean;

    @Override
    public FooDTO map(Foo foo) {

        FooDTO fooDTO = delegate.map(foo);

        fooDTO.setBar(myBean.getBar(foo.getBarId());

        return fooDTO;
    }
}

Mapstruct 将生成 2 个类并将扩展 FooMapperDecorator 的 FooMapper 标记为@Primary bean。

Answer 4

如果将Spring声明为组件模型并添加对以下类型的引用,则应该可以myservice:

@Mapper(componentModel="spring", uses=MyService.class)
public interface MyMapper { ... }

该机制旨在提供对生成代码调用的其他映射方法的访问,但您也应该能够以这种方式在表达式中使用它们.只需确保使用服务引用使用生成字段的正确名称.

Answer 5

从1.2开始,这可以通过@AfterMapping和@Context的组合来解决..像这样:

@Mapper(componentModel="spring")
public interface MyMapper { 

   @Mapping(target="x",ignore = true)
   // other mappings
   Target map( Source source, @Context MyService service);

   @AfterMapping
   default void map( @MappingTarget Target.X target, Source.ID source, @Context MyService service) {
        target.set( service.findById( source.getId() ) );
   }
 }

该服务可以作为上下文传递.

一个更好的解决方案是使用一个@Context包裹MyService而不是MyService直接传递的类.@AfterMapping可以在此"上下文"类上实现一种方法:void map( @MappingTarget Target.X target, Source.ID source )保持映射逻辑不受查找逻辑的影响.在MapStruct 示例存储库中查看此示例.