MyBatisのfetchSizeが効かない問題の原因と解決策💻

はじめに (対象読者・この記事でわかること)

この記事は、JavaとMyBatisを使用したWebアプリケーション開発を担当している方、特に大量データの取得パフォーマンス改善に悩んでいる方を対象としています。

この記事を読むことで、MyBatisでfetchSizeが効かない問題の原因を理解し、適切な設定方法を学ぶことができます。具体的には、データベース接続プールとの関係性や、MyBatisの設定方法、JDBCの仕組みに関する知識を深め、実際のアプリケーションでfetchSizeを正しく適用するための具体的な手順がわかります。

多くの開発者が遭遇するこの問題を解決し、アプリケーションのパフォーマンスを向上させるための実践的な知識を提供します。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。

• Javaの基本的な知識
• MyBatisの基本的な使い方
• SQLとデータベースの基本知識
• MavenやGradleのビルドツールの基本的な知識

MyBatisのfetchSizeとは

MyBatisのfetchSizeは、JDBCのStatementオブジェクトに設定されるFetch Sizeのことで、データベースから一度に取得する行数を制御するパラメータです。大量のデータを扱う際に、fetchSizeを適切に設定することで、メモリ使用量を抑えつつパフォーマンスを向上させることができます。

しかし、実際の開発現場ではMyBatisで設定したfetchSizeが期待通りに機能せず、全件取得されてしまうという問題が発生することがあります。この問題は、単なる設定ミスではなく、MyBatisの動作原理やデータベース接続プールとの関係性を理解しないと解決が難しい場合があります。

fetchSizeが効かない原因と解決策

原因1：データベースドライバの対応状況

まず確認すべきは、使用しているデータベースドライバがfetchSizeに対応しているかどうかです。一部のドライバではfetchSizeの設定が無視される場合があります。

解決策： 使用しているデータベースドライバがfetchSizeに対応しているか確認し、対応していない場合は別のドライバへの乗り換えを検討します。例えば、MySQLの場合は最新のConnector/Jを使用することでfetchSizeが正しく機能します。

原因2：データベース接続プールの設定問題

データベース接続プール（例：HikariCP、DBCPなど）によっては、fetchSizeの設定が上書きされてしまう場合があります。特に、接続プールが内部でStatementオブジェクトをキャッシュしている場合、設定したfetchSizeが保持されません。

解決策： データベース接続プールの設定を確認し、fetchSizeが保持されるように設定します。HikariCPを使用している場合は、以下のように設定します。

Properties

# HikariCPの設定例
spring.datasource.hikari.connection-init-sql=SET default_fetch_size=100

また、接続プールの実装によっては、以下のように接続URLにパラメータを追加する必要があります。

Properties

# MySQLの場合
spring.datasource.url=jdbc:mysql://localhost:3306/mydb?useServerPrepStmts=true&useServerPrepStmts=true&rewriteBatchedStatements=true&cachePrepStmts=true&useLocalSessionState=true&rewriteBatchedStatements=true&cacheResultSetMetadata=true&cacheServerConfiguration=true&elideSetAutoCommits=true&maintainTimeStats=false&useServerPrepStmts=true&useLocalSessionState=true&rewriteBatchedStatements=true&cacheResultSetMetadata=true&cacheServerConfiguration=true&elideSetAutoCommits=true&maintainTimeStats=false&useServerPrepStmts=true&useLocalSessionState=true&rewriteBatchedStatements=true&cacheResultSetMetadata=true&cacheServerConfiguration=true&elideSetAutoCommits=true&maintainTimeStats=false&defaultFetchSize=100

原因3：MyBatisのマッパー設定不足

MyBatisでfetchSizeを有効にするには、マッパーXMLファイルまたはアノテーションで明示的に設定する必要があります。設定が不足している場合、fetchSizeは適用されません。

解決策： マッパーXMLファイルの要素にfetchSize属性を設定します。

Xml

<select id="selectLargeData" fetchSize="1000" resultType="com.example.entity.LargeData">
    SELECT * FROM large_data_table
</select>

または、アノテーションを使用する場合は以下のように設定します。

Java

@FetchSize(1000)
@Select("SELECT * FROM large_data_table")
List<LargeData> selectLargeData();

原因4：トランザクションの範囲問題

fetchSizeは、トランザクションが開始されている範囲でのみ有効になります。トランザクションの範囲外でクエリを実行すると、fetchSizeの設定は無視されます。

解決策： データ取得処理をトランザクション内で実行するようにコードを修正します。

Java

@Transactional
public List<LargeData> getLargeData() {
    return largeDataMapper.selectLargeData();
}

原因5：JDBCの自動コミットモード

JDBCの自動コミットモードが有効になっている場合、fetchSizeの設定が正しく機能しないことがあります。

解決策： 自動コミットモードを無効にして、明示的にコミットまたはロールバックを行うようにします。

Java

@Autowired
private DataSource dataSource;

public List<LargeData> getLargeDataWithManualCommit() {
    Connection connection = null;
    try {
        connection = dataSource.getConnection();
        connection.setAutoCommit(false);

        // fetchSizeが設定されたステートメントを作成
        PreparedStatement statement = connection.prepareStatement(
            "SELECT * FROM large_data_table", 
            ResultSet.TYPE_FORWARD_ONLY, 
            ResultSet.CONCUR_READ_ONLY
        );
        statement.setFetchSize(1000);

        ResultSet resultSet = statement.executeQuery();
        // 結果セットの処理...

        connection.commit();
        return convertToEntityList(resultSet);
    } catch (SQLException e) {
        if (connection != null) {
            try {
                connection.rollback();
            } catch (SQLException ex) {
                // ロールバック失時の処理
            }
        }
        throw new RuntimeException("データ取得に失敗しました", e);
    } finally {
        if (connection != null) {
            try {
                connection.setAutoCommit(true); // 元の状態に戻す
                connection.close();
            } catch (SQLException e) {
                // クローズ失敗時の処理
            }
        }
    }
}

その他の考慮事項

データベース側の設定

データベース側でも、fetchSizeの設定に影響を受けるパラメータが存在します。MySQLの場合は、defaultFetchSizeセッション変数が影響します。

Sql

-- セッション変数の確認
SHOW VARIABLES LIKE 'default_fetch_size';

-- セッション変数の設定
SET SESSION default_fetch_size = 1000;

パフォーマンスモニタリング

fetchSizeの設定が適切かどうかは、実際のパフォーマンスを計測して確認する必要があります。JConsoleやVisualVMなどのツールを使用して、メモリ使用量やGCの動作を監視しながら最適なfetchSizeを見つけましょう。

キャッシュとの関係

MyBatisのキャッシュが有効になっている場合、fetchSizeの設定が無視される可能性があります。特に、セカンドレベルキャッシュは全件取得を前提としているため、大量データの取得時はキャッシュを無効にすることを検討します。

まとめ

本記事では、MyBatisでfetchSizeが効かず全件取得されてしまう問題の原因と解決策について解説しました。

• fetchSizeが効かない主な原因は、データベースドライバの対応状況、データベース接続プールの設定問題、MyBatisのマッパー設定不足、トランザクションの範囲問題、JDBCの自動コミットモードなど
• 解決策として、適切なドライバの選択、接続プールの設定、マッパーでのfetchSizeの明示的設定、トランザクション内での実行、自動コミットモードの無効化などがある
• さらにデータベース側の設定確認やパフォーマンスモニタリングも重要

この記事を通して、読者はMyBatisで大量データを効率的に取得するための具体的な手法を学ぶことができたはずです。今後は、データベースのチューニングやアプリケーションのパフォーマンス改善についても記事にする予定です。

参考資料

• MyBatis公式ドキュメント - Result Maps
• MySQL Connector/J ドキュメント
• HikariCP 設定ドキュメント
• JDBC fetchSizeの仕組みと効果