Ce contenu n'est pas disponible dans la langue sélectionnée.
Chapter 88. MapStruct
Since Camel 3.19
Only producer is supported.
The camel-mapstruct component is used for converting POJOs using MapStruct.
88.1. Dependencies
When using mapstruct with Red Hat build of Camel Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-mapstruct-starter</artifactId> </dependency>
88.2. URI format
mapstruct:className[?options]
Where className is the fully qualified class name of the POJO to convert to.
88.3. Configuring Options
Camel components are configured on two levels:
- Component level
- Endpoint level
88.3.1. Component Level Options
The component level is the highest level. The configurations you define at this level are inherited by all the endpoints. For example, a component can have security settings, credentials for authentication, urls for network connection, and so on.
Since components typically have pre-configured defaults for the most common cases, you may need to only configure a few component options, or maybe none at all.
You can configure components with Component DSL in a configuration file (application.properties|yaml), or directly with Java code.
88.3.2. Endpoint Level Options
At the Endpoint level you have many options, which you can use to configure what you want the endpoint to do. The options are categorized according to whether the endpoint is used as a consumer (from) or as a producer (to) or used for both.
You can configure endpoints directly in the endpoint URI as path and query parameters. You can also use Endpoint DSL and DataFormat DSL as type safe ways of configuring endpoints and data formats in Java.
When configuring options, use Property Placeholders for urls, port numbers, sensitive information, and other settings.
Placeholders allows you to externalize the configuration from your code, giving you more flexible and reusable code.
88.4. Component Options
The MapStruct component supports 4 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| lazyStartProducer (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean |
| mapperPackageName (producer) | Required Package name(s) where Camel should discover Mapstruct mapping classes. Multiple package names can be separated by comma. | String | |
| autowiredEnabled (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean |
| mapStructConverter (advanced) | Autowired To use a custom MapStructConverter such as adapting to a special runtime. | MapStructMapperFinder |
88.5. Endpoint Options
The MapStruct endpoint is configured using URI syntax:
mapstruct:className
with the following path and query parameters:
88.5.1. Path Parameters (1 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
| className (producer) | Required The fully qualified class name of the POJO that mapstruct should convert to (target). | String |
88.5.2. Query Parameters (2 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
| mandatory (producer) | Whether there must exist a mapstruct converter to convert to the POJO. | true | boolean |
| lazyStartProducer (producer (advanced)) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean |
88.6. Setting up MapStruct
The camel-mapstruct component must be configured with one or more package names, for classpath scanning MapStruct Mapper classes. This is needed because the Mapper classes are to be used for converting POJOs with MapStruct.
For example, to set up two packages you can do as following:
MapstructComponent mc = context.getComponent("mapstruct", MapstructComponent.class);
mc.setMapperPackageName("com.foo.mapper,com.bar.mapper");
This can also be configured in application.properties:
camel.component.mapstruct.mapper-package-name = com.foo.mapper,com.bar.mapper
Camel will on startup scan these packages for classes which names ends with Mapper. These classes are then introspected to discover the mapping methods. These mapping methods are then registered into the Camel registry. This means that you can also use type converter to convert the POJOs with MapStruct, such as:
from("direct:foo")
.convertBodyTo(MyFooDto.class);
Where MyFooDto is a POJO that MapStruct is able to convert to/from.
88.7. Spring Boot Auto-Configuration
The component supports 5 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.mapstruct.autowired-enabled | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean |
| camel.component.mapstruct.enabled | Whether to enable auto configuration of the mapstruct component. This is enabled by default. | Boolean | |
| camel.component.mapstruct.lazy-start-producer | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | Boolean |
| camel.component.mapstruct.map-struct-converter | To use a custom MapStructConverter such as adapting to a special runtime. The option is a org.apache.camel.component.mapstruct.MapStructMapperFinder type. | MapStructMapperFinder | |
| camel.component.mapstruct.mapper-package-name | Package name(s) where Camel should discover Mapstruct mapping classes. Multiple package names can be separated by comma. | String |
