MyBatisでDockerコンテナのMySQLに接続してみました。

目次

環境

  • JDK 12 (OpenJDK)
  • Apache Maven 3.6.1
  • MyBatis 3.5.1
  • MySQL 8.0.15

データベースはDockerでMySQLの環境構築で作成したものを使用します。

プロジェクトの作成

Mavenでプロジェクトを作成します。

mvn archetype:generate \
  -DarchetypeArtifactId=maven-archetype-quickstart \
  -DinteractiveMode=false \
  -DgroupId=learning.mybatis \
  -DartifactId=mybatis-app

依存関係の追加

pom.xmlを編集し、MyBatisとMySQLのコネクタを依存関係を追加します。

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>3.5.1</version>
</dependency>
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>8.0.15</version>
</dependency>

JDK 12を使うため、pom.xmlに以下のパラメーターを追加します。

<properties>
  <maven.compiler.source>12</maven.compiler.source>
  <maven.compiler.target>12</maven.compiler.target>
</properties>

MyBatisの設定ファイルを作成

src/mainにresourcesディレクトリを作成し、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>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost/world"/>
        <property name="username" value="root"/>
        <property name="password" value="mysql"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="learning/mybatis/data/CityMapper.xml"/>
  </mappers>
</configuration>

Mapper XMLファイルの作成

続いてmybatis-config.xmlのmapper要素で定義したCityMapper.xmlを作成します。 ファイルを作成するディレクトリの階層は以下のようにします。

resources
├── learning
│   └── mybatis
│       └── data
│           └── CityMapper.xml
└── mybatis-config.xml

CityMapper.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="learning.mybatis.data.CityMapper">
  <select id="selectCity" resultType="learning.mybatis.model.City">
    select * from city where id = #{ID}
  </select>
</mapper>

Mapperクラスの作成

Mapper XMLファイルのnamespaceで定義したとおりにMapperクラスを作成します。 select要素のid属性で定義した値をメソッド名にします。

package learning.mybatis.data;

import learning.mybatis.model.City;

public interface CityMapper {

  public City selectCity(int ID);
}

データ格納用クラスの作成

テーブルから取得したデータを格納するためのクラスを作成します。
テーブルのカラムは以下のようになっているので、

mysql> desc city;
+-------------+----------+------+-----+---------+----------------+
| Field       | Type     | Null | Key | Default | Extra          |
+-------------+----------+------+-----+---------+----------------+
| ID          | int(11)  | NO   | PRI | NULL    | auto_increment |
| Name        | char(35) | NO   |     |         |                |
| CountryCode | char(3)  | NO   | MUL |         |                |
| District    | char(20) | NO   |     |         |                |
| Population  | int(11)  | NO   |     | 0       |                |
+-------------+----------+------+-----+---------+----------------+

テーブルのカラム名、属性に合わせてフィールドを定義します。

package learning.mybatis.model;

public class City {
  public int ID;
  public String name;
  public String countryCode;
  public String district;
  public int population;
}

実行クラスの作成

以下のデータを取得するよう実装していきます。

mysql> select * from city where ID=1;
+----+-------+-------------+----------+------------+
| ID | Name  | CountryCode | District | Population |
+----+-------+-------------+----------+------------+
|  1 | Kabul | AFG         | Kabol    |    1780000 |
+----+-------+-------------+----------+------------+
package learning.mybatis;

import java.io.IOException;
import java.io.InputStream;

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

import learning.mybatis.data.CityMapper;
import learning.mybatis.model.City;

public class SimpleSelectApp {

  public static void main (String[] args) {
    try {
      InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
      SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
      SqlSession session = sqlSessionFactory.openSession();

      CityMapper mapper = session.getMapper(CityMapper.class);
      City result = mapper.selectCity(1);
      System.out.println("City [ID=" + result.ID + ", Name=" + result.name + 
              ", CountryCode=" + result.countryCode + ", District=" + result.district + 
              ", Population=" + result.population + "]");

      session.close();
    } catch (IOException e) {
      e.printStackTrace();
    }
  }
}

実行結果

テーブルから該当のIDのデータが取得され、コンソールに以下のように出力されます。

City [ID=1, Name=Kabul, CountryCode=AFG, District=Kabol, Population=1780000]