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

时间:2016-08-06 18:18:17

标签: spring mapstruct

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

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

这适用于Mapstruct-1.0吗?

5 个答案:

答案 0 :(得分:16)

正如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);

}

答案 1 :(得分:7)

从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的{​​{1}}类,而不是直接传递MyService。可以在此“上下文”类上实现MyService方法:@AfterMapping保持映射逻辑远离查找逻辑。在MapStruct example repository中检出此示例。

答案 2 :(得分:6)

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

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

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

答案 3 :(得分:5)

我正在使用Mapstruct 1.3.1,发现使用decorator可以轻松解决此问题。

示例:

@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。

答案 4 :(得分:0)

除了上面的答案外,还有什么值得补充的是,在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);

}