Chapter 237. MyBatis Bean Component

Available as of Camel version 2.22

The mybatis-bean: component allows you to query, insert, update and delete data in a relational database using MyBatis bean annotations.

This component can only be used as a producer. If you want to consume from MyBatis then use the regular mybatis component.

Maven users will need to add the following dependency to their pom.xml for this component: 

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-mybatis</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

This component will by default load the MyBatis SqlMapConfig file from the root of the classpath with the expected name of SqlMapConfig.xml.
If the file is located in another location, you will need to configure the configurationUri option on the MyBatisComponent component.

237.1. Options

The MyBatis Bean component supports 3 options, which are listed below.

NameDescriptionDefaultType

sqlSessionFactory (advanced)

To use the SqlSessionFactory

 

SqlSessionFactory

configurationUri (producer)

Location of MyBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath

SqlMapConfig.xml

String

resolveProperty Placeholders (advanced)

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

true

boolean

The MyBatis Bean endpoint is configured using URI syntax: 

mybatis-bean:beanName:methodName

with the following path and query parameters:

237.1.1. Path Parameters (2 parameters):

NameDescriptionDefaultType

beanName

Required Name of the bean with the MyBatis annotations. This can either by a type alias or a FQN class name.

 

String

methodName

Required Name of the method on the bean that has the SQL query to be executed.

 

String

237.1.2. Query Parameters (4 parameters):

NameDescriptionDefaultType

executorType (producer)

The executor type to be used while executing statements. simple - executor does nothing special. reuse - executor reuses prepared statements. batch - executor reuses statements and batches updates.

SIMPLE

ExecutorType

inputHeader (producer)

User the header value for input parameters instead of the message body. By default, inputHeader == null and the input parameters are taken from the message body. If outputHeader is set, the value is used and query parameters will be taken from the header instead of the body.

 

String

outputHeader (producer)

Store the query result in a header instead of the message body. By default, outputHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time.

 

String

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

237.2. Spring Boot Auto-Configuration

The component supports 4 options, which are listed below.

NameDescriptionDefaultType

camel.component.mybatis-bean.configuration-uri

Location of MyBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath

SqlMapConfig.xml

String

camel.component.mybatis-bean.enabled

Whether to enable auto configuration of the mybatis-bean component. This is enabled by default.

 

Boolean

camel.component.mybatis-bean.resolve-property-placeholders

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

true

Boolean

camel.component.mybatis-bean.sql-session-factory

To use the SqlSessionFactory. The option is a org.apache.ibatis.session.SqlSessionFactory type.

 

String

237.3. Message Headers

Camel will populate the result message, either IN or OUT with a header with the statement used:

HeaderTypeDescription

CamelMyBatisResult

Object

The response returned from MtBatis in any of the operations. For instance an INSERT could return the auto-generated key, or number of rows etc.

237.4. Message Body

The response from MyBatis will only be set as the body if it’s a SELECT statement. That means, for example, for INSERT statements Camel will not replace the body. This allows you to continue routing and keep the original body. The response from MyBatis is always stored in the header with the key CamelMyBatisResult.

237.5. Samples

For example if you wish to consume beans from a JMS queue and insert them into a database you could do the following: 

from("activemq:queue:newAccount")
  .to("mybatis-bean:AccountService:insertBeanAccount");

Notice we have to specify the bean name and method name, as we need to instruct Camel which kind of operation to invoke.

Where AccountService is the type alias for the bean that has the MyBatis bean annotations. You can configure type alias in the SqlMapConfig file: 

    <typeAliases>
        <typeAlias alias="Account" type="org.apache.camel.component.mybatis.Account"/>
        <typeAlias alias="AccountService" type="org.apache.camel.component.mybatis.bean.AccountService"/>
    </typeAliases>
On the `AccountService` bean you can declare the MyBatis mappins using annotations as shown:
public interface AccountService {

    @Select("select ACC_ID as id, ACC_FIRST_NAME as firstName, ACC_LAST_NAME as lastName"
        + ", ACC_EMAIL as emailAddress from ACCOUNT where ACC_ID = #{id}")
    Account selectBeanAccountById(@Param("id") int no);

    @Select("select * from ACCOUNT order by ACC_ID")
    @ResultMap("Account.AccountResult")
    List<Account> selectBeanAllAccounts();

    @Insert("insert into ACCOUNT (ACC_ID,ACC_FIRST_NAME,ACC_LAST_NAME,ACC_EMAIL)"
        + " values (#{id}, #{firstName}, #{lastName}, #{emailAddress})")
    void insertBeanAccount(Account account);

}