devkuma – MyBatis

MyBatis | MyBatisとは

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

MyBatisは、SQLとJavaオブジェクトを接続する永続化フレームワークです。

以前はiBATISという名前でApacheプロジェクトの一つとして開発されていました。しかし2010年6月にApacheソフトウェア財団での開発が終了し、現在はMyBatisという名前で開発されています。

SQL文を完全に制御したい場合に便利です。

参考サイト

http://www.mybatis.org/mybatis-3/ko/

MyBatis | 設定ファイル

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

MyBatis | 実行されるSQLをログに出力

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

logbackの依存関係を追加すると、DEBUGレベルでSQLが出力される。

build.gradle

compile 'ch.qos.logback:logback-classic:1.1.3'

ログ出力

18:10:01.123 [main] DEBUG sample.mybatis.selectTest - ==>  Preparing: select * from test_table where id=? and id=? 
18:10:01.151 [main] DEBUG sample.mybatis.selectTest - ==> Parameters: 1(Integer), 1(Integer)
18:10:01.165 [main] DEBUG sample.mybatis.selectTest - <==      Total: 1

実行されたSQLとバインドされたパラメータが出力されている。

実行されたSQLステートメントID（sample.mybatis.selectTest）がロガー名になっているため、ステートメントIDを使ってログ出力を制御できる。

MyBatis

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

MyBatisは、オブジェクト指向言語であるJavaのリレーショナルデータベースプログラミングをより簡単にする開発フレームワークです。ここでは基本的な使い方について説明します。

MyBatis SELECT検索

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

データ検索であるSELECTについて説明する。

MyBatis | 検索結果を任意のJavaオブジェクトにマッピング

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

MyBatis | INSERT登録

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

データ登録であるINSERTについて説明する。

MyBatis | UPDATEによる変更

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

変更前のDBテーブル

test_table

id	value
1	hoge
2	fuga
3	piyo

ソースコード

TestTable.java

package sample.mybatis;

public class TestTable {
    private int id;
    private String value;

    public TestTable(int id, String value) {
        this.id = id;
        this.value = value;
    }
}

sample_mapper.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">

  <update id="updateTest">
    update test_table
       set value = #{value}
     where id = #{id}
  </update>
</mapper>

Main.java

package sample.mybatis;

import java.io.InputStream;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class Main {

    public static void main(String[] args) throws Exception {
        try (InputStream in = Main.class.getResourceAsStream("/mybatis-config.xml")) {
            SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);

            try (SqlSession session = factory.openSession()) {
                TestTable table = new TestTable(1, "update");

                session.insert("sample.mybatis.updateTest", table);
                session.commit();
            }
        }
    }
}

実行結果

[DEBUG] s.m.updateTest  - ==>  Preparing: update test_table set value = ? where id = ? 
[DEBUG] s.m.updateTest  - ==> Parameters: update(String), 1(Integer)
[DEBUG] s.m.updateTest  - <==    Updates: 1

test_table

id	value
1	update
2	fuga
3	piyo

説明

<update>タグでUPDATEを定義できる。

MyBatis | DELETE削除

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

削除前のDBテーブル

test_table

id	value
1	hoge
2	fuga
3	piyo

ソースコード

TestTable.java

package sample.mybatis;

public class TestTable {
    private int id;
    private String value;

    public TestTable(int id) {
        this.id = id;
    }
}

sample_mapper.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">

  <delete id="deleteTest">
    delete from test_table where id = #{id}
  </delete>
</mapper>

Main.java

package sample.mybatis;

import java.io.InputStream;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class Main {

    public static void main(String[] args) throws Exception {
        try (InputStream in = Main.class.getResourceAsStream("/mybatis-config.xml")) {
            SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);

            try (SqlSession session = factory.openSession()) {
                TestTable table = new TestTable(2);

                session.insert("sample.mybatis.deleteTest", table);
                session.commit();
            }
        }
    }
}

実行結果

[DEBUG] s.m.deleteTest  - ==>  Preparing: delete from test_table where id = ? 
[DEBUG] s.m.deleteTest  - ==> Parameters: 2(Integer)
[DEBUG] s.m.deleteTest  - <==    Updates: 1

test_table

id	value
1	hoge
3	piyo

説明

<delete>タグでDELETE文を定義できる。

MyBatis | バッチ更新

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

デフォルトでは、SQLを実行するたびにPreparedStatementを作成し、SQLをデータベースへ送信している。

更新件数が多い場合、これは非常に効率が悪い。

MyBatisでは設定により、PreparedStatementの再利用とバッチ更新が可能である。

基本動作

ソースコード

sample_mapper.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">

  <insert id="insertTest">
    insert into test_table (value) values (#{value})
  </insert>
</mapper>

Main.java

package sample.mybatis;

import java.io.InputStream;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class Main {

    public static void main(String[] args) throws Exception {
        try (InputStream in = Main.class.getResourceAsStream("/mybatis-config.xml")) {
            SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);

            try (SqlSession session = factory.openSession()) {
                for (int i=0; i<3; i++) {
                    TestTable t = new TestTable("value-" + i);
                    int updateCount = session.insert("sample.mybatis.insertTest", t);
                    System.out.println("updateCount = " + updateCount);
                }

                session.commit();
            }
        }
    }
}

3回繰り返してINSERTを実行するように実装している。

実行結果

[DEBUG] s.m.insertTest  - ==>  Preparing: insert into test_table (value) values (?) 
[DEBUG] s.m.insertTest  - ==> Parameters: value-0(String)
[DEBUG] s.m.insertTest  - <==    Updates: 1
updateCount = 1
[DEBUG] s.m.insertTest  - ==>  Preparing: insert into test_table (value) values (?) 
[DEBUG] s.m.insertTest  - ==> Parameters: value-1(String)
[DEBUG] s.m.insertTest  - <==    Updates: 1
updateCount = 1
[DEBUG] s.m.insertTest  - ==>  Preparing: insert into test_table (value) values (?) 
[DEBUG] s.m.insertTest  - ==> Parameters: value-2(String)
[DEBUG] s.m.insertTest  - <==    Updates: 1
updateCount = 1

説明

毎回PreparedStatementが作成され、SQLが送信されている。

PreparedStatementを再利用する

ソースコード

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>
  <settings>
    <setting name="defaultExecutorType" value="REUSE"/>
  </settings>

  ...
</configuration>

実行結果

[DEBUG] s.m.insertTest  - ==>  Preparing: insert into test_table (value) values (?) 
[DEBUG] s.m.insertTest  - ==> Parameters: value-0(String)
[DEBUG] s.m.insertTest  - <==    Updates: 1
updateCount = 1
[DEBUG] s.m.insertTest  - ==> Parameters: value-1(String)
[DEBUG] s.m.insertTest  - <==    Updates: 1
updateCount = 1
[DEBUG] s.m.insertTest  - ==> Parameters: value-2(String)
[DEBUG] s.m.insertTest  - <==    Updates: 1
updateCount = 1

説明

設定ファイルでdefaultExecutorTypeにREUSEを設定する。
PreparedStatementは1回だけ作成される。
SQLの送信は毎回行われている。

バッチ実行

ソースコード

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>
  <settings>
    <setting name="defaultExecutorType" value="BATCH"/>
  </settings>

  ...
</configuration>

実行結果

[DEBUG] s.m.insertTest  - ==>  Preparing: insert into test_table (value) values (?) 
[DEBUG] s.m.insertTest  - ==> Parameters: value-0(String)
updateCount = -2147482646
[DEBUG] s.m.insertTest  - ==> Parameters: value-1(String)
updateCount = -2147482646
[DEBUG] s.m.insertTest  - ==> Parameters: value-2(String)
updateCount = -2147482646

説明

defaultExecutorTypeをBATCHにすると、一括更新される。
SQLの送信は最後にまとめて行われる。
そのため、更新件数は取得できない。

SqlSessionを取得するときに指定する

バッチ更新するかどうかの設定は、SqlSessionを取得するときの引数で指定できる。

import org.apache.ibatis.session.ExecutorType;

...

SqlSession session = factory.openSession(ExecutorType.BATCH);

openSession()の引数にExecutorTypeを渡して指定できる。ここで指定した条件は設定ファイルより優先される。

MyBatis | Mapper

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

これまでは、SqlSessionにStatement IDとパラメータを直接渡す方法でSQLを実行してきた。

MyBatisには、これとは別にMapperという仕組みも用意されている。Mapperを使用すると、SqlSessionを直接使用する形式より安全になる。

基本的には、このMapperを使用する方法のほうがよい。マッピングファイルが自動的にMapper単位になるため、管理もしやすくなる。

MyBatis | 動的SQL

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

条件に合ったSQLを動的に生成できる。

MyBatis | プログラムでSQLを動的に生成

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

MyBatisには、アノテーションを使用してSQLを定義する方法が用意されている。

しかし、文字列連結でSQLを組み立てる場合、カンマ区切りやAND、ORの区切りなど、注意すべき細かな点がいくつもある。

MyBatisは、そのような面倒な部分を隠すAPIを提供している。

ソースコード

sample_mapper.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.TestTableMapper"> <!-- namespaceにMapperを指定 -->
</mapper>

TestTableMapper.java

package sample.mybatis;

import java.util.List;

import org.apache.ibatis.annotations.SelectProvider;

// Mapperインターフェースとして作成する
public interface TestTableMapper {
    // @SelectProviderでSQLを生成するクラスメソッドを設定する
    @SelectProvider(type=TestTableSqlProvider.class, method="getSelectTestSql")
    List<TestTable> selectTest();
}

TestTableSqlProvider.java

package sample.mybatis;

import org.apache.ibatis.jdbc.SQL;

// SQLを生成するクラス
public class TestTableSqlProvider {

    // SQLを生成するメソッド
    public String getSelectTestSql() {
        // SQLクラスを使用してSQLを生成する。
        SQL sql = new SQL() {{ // 匿名クラスを作成
            SELECT("id, hoge_value");
            SELECT("fuga_value");
            SELECT("piyo_value");
            FROM("test_table");
        }};

        return sql.toString();
    }
}

Main.java

package sample.mybatis;

import java.io.InputStream;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class Main {

    public static void main(String[] args) throws Exception {
        try (InputStream in = Main.class.getResourceAsStream("/mybatis-config.xml")) {
            SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);

            try (SqlSession session = factory.openSession()) {
                TestTableMapper mapper = session.getMapper(TestTableMapper.class);
                mapper.selectTest();
            }
        }
    }
}

実行結果

[DEBUG] s.m.T.selectTest - ==>  Preparing: SELECT id, hoge_value, fuga_value, piyo_value FROM test_table WHERE (hoge_value is not null) 
[DEBUG] s.m.T.selectTest - ==> Parameters:

説明

Mapperのメソッドに@SelectProviderでアノテーションを指定する。
- typeにはSQLを生成するクラスを指定し、methodにはSQLを生成するメソッド名を指定する。
- INSERTまたはUPDATEには@InsertProviderと@UpdateProviderがある。
SQLの生成にはorg.apache.ibatis.jdbc.SQLクラスを使用する。
SQLクラスを匿名クラスとしてnewし、インスタンス初期化ブロックでSELECT()とFROM()メソッドを使用してSQLを生成する。
- 各引数にはSQLの項目を文字列で渡す。
- このとき、カンマ区切りなどは必要に応じて追加される。
生成されたSQLインスタンスのtoString()メソッドで、生成したSQLを文字列として取得できる。

プログラムでSQLを動的に生成
- 各メソッドの使い方について

MyBatis | Spring Bootとの連携

kc@example.com (kc kim) — Sun, 01 Oct 2017 07:57:27 +0900

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で使用しても問題ない。