開発の流れにおいて、きちんとトランザクション設計、リソースアクセス順序の設計がされていればデッドロックは理論上は発生しないはずなのですが、オープンソースのソフトウェア基盤なんかを使用している場合、世界中のエンジニアがバラで開発してる宿命というもあり、普通にデッドロックしたりしますｗ

デッドロックは同じタイミングでリソースを確保しにいった際に発生するものなので、リリースするまで発覚しなかったというケースもあります。

　そもそもデッドロックとは何なのかおさらい

まずは問題ないアクセスについて図を描いてみましたのでみてみてください。トランザクション＝スレッドと捉えてもらっても構いません。

（解説）上の図では各処理が同じ順番でテーブルへアクセスするため、仮に同タイミングで書き込みをしようとしてもどちらか遅れたほうが、相手の処理が終わる（＝ロック解放）のを待つだけです。

では次は問題のある処理の図です。

（解説）上の図では各処理がテーブルへアクセスする順番が逆になっています。この場合にロックと次の処理が “たすき掛け” の状態になりますので、これ以上処理は進まず停止してしまいます。問題ない処理と決定的に違うのは、待ち時間が発生するのではなく、永久にストップするという点です。

　どうすればデッドロックを無くせるのか？

これは実は非常に難しい質問だと思います。デッドロックはバグそのものですので、ソフトウェアの規模が大きくなれば大きくなるほど潜在的に増えていきます。小さいシステムならまだしも、数百万ステップに及ぶプログラムにおいて、人間ですから設計図がまちがっているかもしれませんし、プログラマーがうっかり実装を手誤ってしまうかもしれません。

個人的にはデッドロックはゼロに近づける（＝減らす）努力はできても、完全にゼロにすることはほぼ不可能であるという立場にいます。ソフトウェアにおいてバグをゼロにすることは不可能であるという考えそのものですが、少しでもデッドロックが起きないように以下のことに気を付ける必要があります。

1. トランザクションからアクセスするテーブルの順番を一貫する
2. 不必要にトランザクションを長くしない
3. 不必要に FOR UPDATE でロックを掛けない
4. 可能な限り行ロックする

以上のことに気を付けて設計、実装が出来れば限りなくデッドロックを排除できると考えます。

　それでもデッドロックが起きたときはどうすればいいのか

これは実装でカバーしましょう。トランザクションの処理にタイムアウトもしくはリトライ回数を準備しておき、どちらかの処理がロックを解放するようにします。

いかがでしたか？今日は発見が遅れがちなバグであるデッドロックについて取り上げました。あえて名前は挙げませんが世界的に有名なソフトウェアでもデッドロックは起きています。「デッドロック起こすのは初心者！」などとおごらずに慎重にプロジェクトを進めるよう常に意識したいものです。

さて、前回　MyBatis Generator の使い方 で以下の4つのファイルが自動生成されました。

・データを格納するエンティティクラス
・抽出条件を設定するサンプルクラス
・データ操作のメインとなるマッパークラス
・上のマッパークラスに紐づいた実際の SQL を書く XML ファイル

※ファイル名は DB のテーブル名が頭につきますので、みなさんは違うファイル名でも気にしないでOKです。

　1. ライブラリとデータソースの設定をする

1.  Maven もしくは Gradle から以下のライブラリを入れてください。

・mybatis
・mysql-connector-java
・commons-dbcp2

        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.2.8</version>
            <type>jar</type>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-dbcp2</artifactId>
        </dependency>

2. applicationContext.xml を以下の情報で src/main/resources/ に作成

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:context="http://www.springframework.org/schema/context"
  xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
  xsi:schemaLocation="

http://www.springframework.org/schema/beans


http://www.springframework.org/schema/beans/spring-beans-4.0.xsd


http://www.springframework.org/schema/context


http://www.springframework.org/schema/context/spring-context-4.0.xsd


http://mybatis.org/schema/mybatis-spring

    http://mybatis.org/schema/mybatis-spring.xsd">

<!-- DataSource -->
<bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource">
  <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  <property name="url" value="jdbc:mysql://localhost/car" />   //接続サーバーとMySQLスキーマ名
  <property name="username" value="root" />   //データベースのユーザー名
  <property name="password" value="" />   //接続パスワード
</bean>

<!-- SqlSessionFactory -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean" >
  <property name="dataSource" ref="dataSource" />
</bean>

<!-- Mapper -->
//↓id名は呼び出すために使う名前なので任意でOKです
<bean id="mp" class="org.mybatis.spring.mapper.MapperFactoryBean">
//↓valueには自動生成された *Mapper.java クラスをパッケージ名込みで指定してください
  <property name="mapperInterface" value="jp.gmo.myfirstspringboot.mybatis.TCarMapper" />
  <property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>

</beans>

 ※applicationContext.xml は、データベースの接続情報とマッパークラスにID名をつけて登録する設定ファイルです。

　2. データにアクセスするメインクラスを作成

今回準備したテーブルはこんな感じです。
(データベース名 car  テーブル名 t_car)

src/main/resources 配下に同パッケージ名でマッパー *.xml ファイルを配置します。
これにより、ビルド後に classファイルと同じディレクトリに入ります。

早速以下のメインクラスを作って  id, name, brand のデータを取り出してみましょう。

public class DataCaller {

    public static void main(String[] args) throws IOException {

        String resource = "src/main/resources/applicationContext.xml";
        ApplicationContext ac = new FileSystemXmlApplicationContext(resource);
        TCarMapper tcarmapper = (TCarMapper) ac.getBean("mp");

        TCar record = new TCar();
        TCarExample example = new TCarExample();
        example.setDistinct(true);
              
        ArrayList<TCar> result = (ArrayList<TCar>)tcarmapper.selectByExample(example);
        for (TCar r : result) {
            System.out.println(r.getId() + " " +r.getName() + " " + r.getBrand());
        }
    }
}

 

 

　3. MySQL テーブルからデータを取り出す

DataCaller.java メインクラスを実行します。

ちゃんとデータが取れました。

 

insert する場合はこんな感じで出来ます↓

		TCar record = new TCar();
		record.setId(6);
		record.setName("JULIETA");
		record.setBrand("ALPHA_ROMEO");
		tcarmapper.insert(record);

 

 

　おまけ： カスタマイズして SQL を作ってみる

TCarExample.java, TCarmapper.xml をカスタマイズすることでオリジナルの SQL を組み立てることができます。ここでは カラムを指定する SQL を足してみましょう。

 (TCarExample.java)

     /**
     * original
     */
    public void setColumn(String column) {
        this.column = column;
    }

 

(TCarmapper.xml )

    <!-- 
    <include refid="Base_Column_List" />
    -->
    
    <!-- original -->
    <if test="column == 'id'">
      id
    </if>
    <if test="column == 'name'">
      name
    </if>
    <if test="column == 'brand'">
      brand
    </if>
    <if test="column == null">
        <include refid="Base_Column_List" />
    </if>
    <!-- original -->

 

 (DataCaller )

public class DataCaller {

    public static void main(String[] args) throws IOException {

        String resource = "src/main/resources/applicationContext.xml";
        ApplicationContext ac = new FileSystemXmlApplicationContext(resource);
        TCarMapper tcarmapper = (TCarMapper) ac.getBean("mp");
 
        TCarExample example = new TCarExample();
        example.setColumn("name");  //originalメソッドの呼び出し
                
        ArrayList<TCar> result = (ArrayList<TCar>)tcarmapper.selectByExample(example);
        for (TCar r : result) {
            System.out.println(r.getId() + " " +r.getName() + " " + r.getBrand());
        }
    }
}

 

実行します。

name カラムだけデータが取れましたね。

いかがでしたか？今回は MyBatis の使い方をサンプルファイルを交えて解説しました。旧 iBatis として知られる MyBatis は昔からの実績や、現在でも大規模な案件で使われる安定性をもっています。個人的には Java のデファクトスタンダード O/Rマッパーとして認知されたら嬉しいなと思っています。

しかし、最初にマッパーやエンティティクラスなどを自分で書くのは非常にしんどいです。そんなとき、手っ取り早く使えるようにファイルを自動生成してくれるのが MyBatis Genarator です。とりあえずこれを使って、あとからファイルをカスタマイズして覚えていくのが良いと思います。

今回は Maven 経由で MyBatis を入れます。

　MyBatis Generator を手っ取り早くインストール

最近の Eclipse, NetBeans, IntelliJ ならどれでも Maven はすぐ使えるはずですので、pom.xml に以下を追記しましょう。

<project ...>
     ...
     <build>
       ...
       <plugins>
        ...
        <plugin>          //ここから
      	  <groupId>org.mybatis.generator</groupId>
      	  <artifactId>mybatis-generator-maven-plugin</artifactId>
          <version>1.3.0</version>
        </plugin>         //ここまで　※入れるカテゴリはpluginsの中です
        ...
      </plugins>
      ...
    </build>
    ...
  </project>

これでプラグインとしてインストールされます。

　generatorConfig.xml を配置する

この xml ファイルを元にして各ファイルが自動生成されますのでサンプルをもとに作りましょう。
作る場所はプロジェクトの resources 直下です。

プロジェクト名 > src > main > resources > generatorConfig.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
<generatorConfiguration >
  <classPathEntry location="C:\Program Files\MySQL\Connector.J 5.1\mysql-connector-java-5.1.33-bin.jar"/>
  // ↑ MySQLに接続するConnectorJのjarファイルを指定します
  <context id="context1" >
    <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/car" userId="root" password="password" />
    // ↑　ローカルのMySQLに接続するパスとDB名、それからMySQLのユーザーIDとパスを指定します
    <javaModelGenerator targetPackage="jp.cloudear.test.db" targetProject="C:\Users\masa\Documents\NetBeansProjects\project\src\main\java\" />
    <sqlMapGenerator targetPackage="jp.cloudear.test.db" targetProject="C:\Users\masa\Documents\NetBeansProjects\project\src\main\java\" />
    <javaClientGenerator targetPackage="jp.cloudear.test.db" targetProject="C:\Users\masa\Documents\NetBeansProjects\project\src\main\java\" type="XMLMAPPER" />
    // ↑  3行すべてに、MyBatisのクラスを入れたいパッケージ名と、プロジェクトのファイルパスを入れてください
    <table schema="student" tableName="classA" >
    // ↑　DB名とテーブル名を入れてください
    </table>
  </context>
</generatorConfiguration>

　いよいよファイルを自動生成する

上で作った xml ファイルを Maven から実行します。

※NetBeans の場合

pom.xml を右クリック > Mavenの実行 > ゴール > ゴール欄に
「mybatis-generator:generate」を入力してOK

生成に失敗した場合 MySQL への接続失敗の可能性が高いです。以下の点を確認してみてください。

• ローカルの MySQL に指定の ID と PW でちゃんと接続できるか
• generatorConfig.xml の Connector/Jのパス指定を間違えていないか
• generatorConfig.xml の DB名、テーブル名の指定を間違えていないか

他の IDE をご使用の方は IDE から Maven ゴールを実行する方法を調べてみてください。

　Generator によって生成されたファイルを見てみる

生成に成功するとテーブル名が先頭についた以下のような4ファイルが出来ているはずです。

1. エンティティクラス
2. クエリ条件サンプルクラス
3. マッパークラス
4. マッパー設定XMLファイル

これらを使えば簡単に DBアクセスのプログラムが作れます。generatorConfig.xml を作るのがちょっとめんどくさいかもしれませんが、仮に手動で4つのファイルを作ろうとすると10倍時間がかかりますｗ　それに比べたらだいぶ楽だと思います。

いかがでしたか？今回は MyBatis を簡単に使い始めるためのファイルを Generator を使って生成してみました。これらのファイルを使って DB操作してみると、カスタマイズして使いこなす一助になると思います。