MyBatis | Spring Bootとの連携

DBテーブル

test_table

id	value
1	hoge
2	fuga
3	piyo

フォルダ構成

├── build.gradle
├── src/main/
│   └── java/
│   └── sample/mybatis/springboot/
│       └── Main.java
│       └── TestTableMapper.java
└── resources/
    └── application.properties
    └── mybatis-config.xml
    └── TestTableMapper.xml

ソースコード

build.gradle

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'org.springframework.boot:spring-boot-gradle-plugin:1.3.1.RELEASE'
    }
}

apply plugin: 'java'
apply plugin: 'spring-boot'

sourceCompatibility = '1.8'
targetCompatibility = '1.8'
compileJava.options.encoding = 'UTF-8'

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.springframework.boot:spring-boot-starter'
    // MyBatisのSpring Boot用依存ライブラリファイルを含める。
    compile 'org.mybatis.spring.boot:mybatis-spring-boot-starter:1.0.0'
    compile 'mysql:mysql-connector-java:5.1.38'
}

application.properties

# MyBatis設定ファイルをロードする。
mybatis.config=mybatis-config.xml

# データソースを設定する。
spring.datasource.url=jdbc:mysql://localhost/test
spring.datasource.username=test
spring.datasource.password=test
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
 <!-- データソース管理はSpring Bootで行うため、ここには記述しない。 -->
  <mappers>
    <mapper resource="TestTableMapper.xml"/>
  </mappers>
</configuration>

TestTableMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="sample.mybatis.springboot.TestTableMapper">

  <select id="selectTest" resultType="map">
    select * from test_table
  </select>
</mapper>

TestTableMapper.java

package sample.mybatis.springboot;

import java.util.List;
import java.util.Map;

public interface TestTableMapper {

    List<Map<String, Object>> selectTest();
}

Main.java

package sample.mybatis.springboot;

import java.io.IOException;

import org.mybatis.spring.SqlSessionTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

@SpringBootApplication
public class Main {

    public static void main(String[] args) throws IOException {
        try (ConfigurableApplicationContext ctx = SpringApplication.run(Main.class, args)) {
            Main m = ctx.getBean(Main.class);
            m.method();
        }
    }

    @Autowired
    private SqlSessionTemplate sqlSession;
    @Autowired
    private TestTableMapper mapper;

    public void method() throws IOException {
        System.out.println("[SqlSessionTemplate]");
        this.sqlSession
            .selectList("sample.mybatis.springboot.TestTableMapper.selectTest")
            .forEach(System.out::println);

        System.out.println("[TestTableMapper]");
        this.mapper
            .selectTest()
            .forEach(System.out::println);
    }
}

実行結果

[SqlSessionTemplate]
{id=1, value=hoge}
{id=2, value=fuga}
{id=3, value=piyo}

[TestTableMapper]
{id=1, value=hoge}
{id=2, value=fuga}
{id=3, value=piyo}

説明

Spring BootでMyBatisを使用する場合は、mybatis-spring-boot-starterを依存関係に追加する。
次に、Spring Boot設定ファイル（application.properties）でmybatis.configという名前によりMyBatis設定ファイルを指定する。
データソースはSpring Bootが管理するため、Spring Bootの設定に記述し、MyBatis側には別途記述しない。
SqlSessionにアクセスするには、SqlSessionTemplateを@Autowiredで注入すればよい。
- SqlSessionTemplateのAPIはSqlSessionと同じである。
- SqlSessionと異なりスレッドセーフであるため、他のスレッドやDAOで使用しても問題ない。
Mapperインターフェースを定義しておくと、@Autowiredで注入できる。
- Springにスキャンされる場所にインターフェースを置いておく必要がある。
- Mainクラスに@MapperScanでアノテーションを付けると、すべてのパッケージのMapperインターフェースを検索できる。例: @MapperScan("foo.bar")
- こちらもスレッドセーフなインスタンスが注入されるため、他のスレッドやDAOで使用しても問題ない。