Merge pull request #27 from mapstruct/issue21-implicit-cyclical-dependency

Issue21 implicit cyclical dependency

Author: Chessray

annotations/src/main/java/org/mapstruct/extensions/spring/SpringMapperConfig.java

@@ -37,4 +37,12 @@
      * @return The bean name for the Spring {@link org.springframework.core.convert.ConversionService}.
      */
     String conversionServiceBeanName() default "";
+
+    /**
+     * To set if the Lazy annotation will be added to the
+     * ConversionService's usage in the ConversionServiceAdapter.  Defaults to true.
+     *
+     * @return true to add the Lazy annotation
+     */
+    boolean lazyAnnotatedConversionServiceBean() default true;
 }

docs/src/docs/asciidoc/chapter-3-mapper-as-converter.asciidoc

@@ -55,7 +55,7 @@ The generated Adapter class will look like this:
 public class ConversionServiceAdapter {
   private final ConversionService conversionService;
 
-  public ConversionServiceAdapter(final ConversionService conversionService) {
+  public ConversionServiceAdapter(@Lazy final ConversionService conversionService) {
     this.conversionService = conversionService;
   }
 

examples/simple-springboot/build.gradle

@@ -0,0 +1,15 @@
+plugins {
+    id "org.springframework.boot" version "2.4.4"
+    id "io.spring.dependency-management" version "1.0.11.RELEASE"
+}
+
+dependencies {
+    annotationProcessor project(":extensions")
+    implementation project(":examples:model")
+    implementation project(":annotations")
+
+    implementation 'org.mapstruct:mapstruct:1.4.0.Final'
+    annotationProcessor 'org.mapstruct:mapstruct-processor:1.4.0.Final'
+    implementation 'org.springframework.boot:spring-boot-starter'
+    testImplementation 'org.springframework.boot:spring-boot-starter-test:2.4.4'
+}

examples/simple-springboot/src/main/java/org/mapstruct/extensions/spring/example/boot/Start.java

@@ -0,0 +1,37 @@
+package org.mapstruct.extensions.spring.example.boot;
+
+import org.mapstruct.extensions.spring.example.Car;
+import org.mapstruct.extensions.spring.example.CarDto;
+import org.mapstruct.extensions.spring.example.SeatConfiguration;
+import org.mapstruct.extensions.spring.example.SeatMaterial;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.boot.CommandLineRunner;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.annotation.Bean;
+
+@SpringBootApplication
+public class Start {
+    public static void main(String[] args) {
+        SpringApplication.run(Start.class, args);
+    }
+
+    private static final Logger log = LoggerFactory.getLogger(Start.class);
+
+    @Bean
+    public CommandLineRunner commandLineRunner(ApplicationContext ctx, ConversionServiceAdapter adapter) {
+        return args -> {
+            final SeatConfiguration seatConf = new SeatConfiguration();
+            seatConf.setSeatMaterial(SeatMaterial.FABRIC);
+            final Car car = new Car();
+            car.setMake("make");
+            car.setSeatConfiguration(seatConf);
+
+            log.info("map start");
+            final CarDto carDto = adapter.mapCarToCarDto(car);
+            log.info(carDto.toString());
+        };
+    }
+}

examples/simple-springboot/src/main/java/org/mapstruct/extensions/spring/example/boot/config/ConverterConfig.java

@@ -0,0 +1,32 @@
+package org.mapstruct.extensions.spring.example.boot.config;
+
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.ListableBeanFactory;
+import org.springframework.boot.convert.ApplicationConversionService;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.convert.ConversionService;
+import org.springframework.core.convert.converter.Converter;
+import org.springframework.format.support.DefaultFormattingConversionService;
+import org.springframework.format.support.FormattingConversionService;
+
+@Configuration
+public class ConverterConfig {
+    private final ListableBeanFactory beanFactory;
+
+    public ConverterConfig(ListableBeanFactory beanFactory) {
+        this.beanFactory = beanFactory;
+    }
+
+    /**
+     * without spring-boot-starter-web, no custom mappers will be added automatically;
+     * register manually we register manually all our {@link Converter}
+     */
+    @Bean
+    public ConversionService conversionService() {
+        LoggerFactory.getLogger(ConverterConfig.class).info("ConversionService bean init");
+        final FormattingConversionService service = new DefaultFormattingConversionService();
+        ApplicationConversionService.addBeans(service, this.beanFactory);
+        return service;
+    }
+}

examples/simple-springboot/src/main/java/org/mapstruct/extensions/spring/example/boot/mappers/CarMapper.java

@@ -0,0 +1,13 @@
+package org.mapstruct.extensions.spring.example.boot.mappers;
+
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.extensions.spring.example.Car;
+import org.mapstruct.extensions.spring.example.CarDto;
+import org.springframework.core.convert.converter.Converter;
+
+@Mapper(config = MapperSpringConfig.class)
+public interface CarMapper extends Converter<Car, CarDto> {
+    @Mapping(target = "seats", source = "seatConfiguration")
+    CarDto convert(Car car);
+}

examples/simple-springboot/src/main/java/org/mapstruct/extensions/spring/example/boot/mappers/MapperSpringConfig.java

@@ -0,0 +1,10 @@
+package org.mapstruct.extensions.spring.example.boot.mappers;
+
+import org.mapstruct.MapperConfig;
+import org.mapstruct.extensions.spring.SpringMapperConfig;
+import org.mapstruct.extensions.spring.example.boot.ConversionServiceAdapter;
+
+@MapperConfig(componentModel = "spring", uses = ConversionServiceAdapter.class)
+@SpringMapperConfig(conversionServiceAdapterPackage = "org.mapstruct.extensions.spring.example.boot")
+public interface MapperSpringConfig {
+}

examples/simple-springboot/src/main/java/org/mapstruct/extensions/spring/example/boot/mappers/SeatConfigurationMapper.java

@@ -0,0 +1,14 @@
+package org.mapstruct.extensions.spring.example.boot.mappers;
+
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.extensions.spring.example.SeatConfiguration;
+import org.mapstruct.extensions.spring.example.SeatConfigurationDto;
+import org.springframework.core.convert.converter.Converter;
+
+@Mapper(config = MapperSpringConfig.class)
+public interface SeatConfigurationMapper extends Converter<SeatConfiguration, SeatConfigurationDto> {
+    @Mapping(target = "seatCount", source = "numberOfSeats")
+    @Mapping(target = "material", source = "seatMaterial")
+    SeatConfigurationDto convert(SeatConfiguration seatConfiguration);
+}

examples/simple-springboot/src/main/java/org/mapstruct/extensions/spring/example/boot/mappers/WheelMapper.java

@@ -0,0 +1,13 @@
+package org.mapstruct.extensions.spring.example.boot.mappers;
+
+import org.mapstruct.Mapper;
+import org.mapstruct.extensions.spring.example.Wheel;
+import org.mapstruct.extensions.spring.example.WheelDto;
+import org.mapstruct.extensions.spring.example.boot.mappers.MapperSpringConfig;
+import org.springframework.core.convert.converter.Converter;
+
+@Mapper(config = MapperSpringConfig.class)
+public interface WheelMapper extends Converter<Wheel, WheelDto> {
+    @Override
+    WheelDto convert(Wheel source);
+}

examples/simple-springboot/src/main/java/org/mapstruct/extensions/spring/example/boot/mappers/WheelsDtoListMapper.java

@@ -0,0 +1,15 @@
+package org.mapstruct.extensions.spring.example.boot.mappers;
+
+import org.mapstruct.Mapper;
+import org.mapstruct.extensions.spring.example.WheelDto;
+import org.mapstruct.extensions.spring.example.Wheels;
+import org.mapstruct.extensions.spring.example.boot.mappers.MapperSpringConfig;
+import org.springframework.core.convert.converter.Converter;
+
+import java.util.List;
+
+@Mapper(config = MapperSpringConfig.class)
+public interface WheelsDtoListMapper extends Converter<List<WheelDto>, Wheels> {
+    @Override
+    Wheels convert(List<WheelDto> source);
+}