MyBatis ifとは？動的SQLにおける重要性

重要ポイント

• 動的SQLは条件に応じてクエリを組み立てる強力な機能
• if要素は最も基本的かつ重要な動的SQL要素
• 適切な使用で保守性とパフォーマンスを両立

動的SQLの基礎知識とif要素の役割

動的SQLは、条件に応じてSQL文を動的に組み立てるMyBatisの核となる機能です。中でもif要素は、以下の特徴を持つ最も基本的な制御要素です：

主要な動的SQL要素：

基本的な使用例：

<!-- 説明: 基本的なif要素の使用例 -->
<select id="findUsers" resultType="User">
    SELECT * FROM users
    <where>
        <!-- 注意: null判定は必ず実施する -->
        <if test="name != null and name != ''">
            AND name LIKE #{name}
        </if>
        <!-- 注意: 数値型のパラメータのnull判定 -->
        <if test="age != null">
            AND age >= #{age}
        </if>
    </where>
</select>

if要素がなぜ必要なのか？具体的なユースケース

1. 検索条件の動的生成

// 説明: 検索条件を動的に組み立てる実装例
public class UserSearchService {
    private final UserMapper userMapper;

    public List<User> searchUsers(String name, Integer age) {
        // 注意: パラメータの事前検証
        Map<String, Object> params = new HashMap<>();
        if (StringUtils.hasText(name)) {
            params.put("name", "%" + name + "%");
        }
        if (age != null && age > 0) {
            params.put("age", age);
        }
        return userMapper.findUsers(params);
    }
}

2. データ更新時の制御

<!-- 説明: 更新項目を動的に制御する実装例 -->
<update id="updateUser">
    UPDATE users
    <set>
        <!-- 注意: 更新項目の選択的な設定 -->
        <if test="name != null">name = #{name},</if>
        <if test="email != null">email = #{email},</if>
        updated_at = CURRENT_TIMESTAMP
    </set>
    WHERE id = #{id}
</update>

3. バッチ処理での条件分岐

<!-- 説明: バッチ処理での条件分岐の例 -->
<update id="batchUpdateUsers">
    UPDATE users
    <set>
        status = 
        <!-- 注意: ステータス更新の条件分岐 -->
        <if test="lastLoginDate == null">'INACTIVE'</if>
        <if test="lastLoginDate != null">'ACTIVE'</if>,
        updated_at = CURRENT_TIMESTAMP
    </set>
    WHERE id = #{id}
</update>

このように、if要素は単なる条件分岐以上の役割を果たし、SQLの動的生成において中心的な機能を提供しています。続くセクションでは、より実践的な使用方法とベストプラクティスについて解説していきます。

MyBatis ifの基本的な使い方と文法

重要ポイント

• test属性では必ず二重イコール（==）を使用する
• null判定は確実に行う
• 文字列比較では空文字チェックも忘れずに

if要素の基本構文と条件式の書き方

基本構文

<!-- 説明: if要素の基本構文 -->
<if test="条件式">
    SQLの一部
</if>

条件式の基本パターン

<!-- 説明: よく使用される条件式パターン -->
<select id="findUsers" resultType="User">
    SELECT * FROM users
    <where>
        <!-- 注意: 数値の比較 -->
        <if test="age != null and age >= 20">
            AND is_adult = true
        </if>

        <!-- 注意: 文字列の比較（null と 空文字をチェック） -->
        <if test="name != null and name != ''">
            AND name LIKE CONCAT('%', #{name}, '%')
        </if>

        <!-- 注意: 真偽値の比較 -->
        <if test="isActive != null and isActive">
            AND status = 'ACTIVE'
        </if>
    </where>
</select>

test属性で使用可能な演算子と式

比較演算子一覧

論理演算子の使用例

<!-- 説明: 論理演算子を使用した条件式 -->
<select id="searchProducts" resultType="Product">
    SELECT * FROM products
    <where>
        <!-- 注意: AND条件の組み合わせ -->
        <if test="category != null and price != null">
            AND category = #{category}
            AND price <= #{price}
        </if>

        <!-- 注意: OR条件の組み合わせ -->
        <if test="status == 'NEW' or status == 'SALE'">
            AND status IN ('NEW', 'SALE')
        </if>

        <!-- 注意: 複雑な条件の組み合わせ -->
        <if test="(type == 'PREMIUM' and price >= 10000) or (type == 'NORMAL' and price >= 5000)">
            AND is_featured = true
        </if>
    </where>
</select>

よくある文法ミスと対処法

1. 比較演算子のミス

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

<!-- 間違った実装例 -->

<if test="status = 'ACTIVE'"> <!-- 代入演算子を使用している -->

AND status = #{status}

</if>

<!-- 正しい実装例 -->

<if test="status == 'ACTIVE'"> <!-- 比較演算子を使用 -->

AND status = #{status}

</if>

<!-- 間違った実装例 --> <if test="status = 'ACTIVE'"> <!-- 代入演算子を使用している --> AND status = #{status} </if> <!-- 正しい実装例 --> <if test="status == 'ACTIVE'"> <!-- 比較演算子を使用 --> AND status = #{status} </if>

<!--  間違った実装例 -->
<if test="status = 'ACTIVE'">  <!-- 代入演算子を使用している -->
    AND status = #{status}
</if>

<!--  正しい実装例 -->
<if test="status == 'ACTIVE'">  <!-- 比較演算子を使用 -->
    AND status = #{status}
</if>

2. null安全性への考慮不足

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

<!-- 間違った実装例 -->

<if test="name.length() > 0"> <!-- NullPointerExceptionの危険 -->

AND name LIKE #{name}

</if>

<!-- 正しい実装例 -->

<if test="name != null and name.length() > 0"> <!-- null安全な実装 -->

AND name LIKE #{name}

</if>

<!-- 間違った実装例 --> <if test="name.length() > 0"> <!-- NullPointerExceptionの危険 --> AND name LIKE #{name} </if> <!-- 正しい実装例 --> <if test="name != null and name.length() > 0"> <!-- null安全な実装 --> AND name LIKE #{name} </if>

<!--  間違った実装例 -->
<if test="name.length() > 0">  <!-- NullPointerExceptionの危険 -->
    AND name LIKE #{name}
</if>

<!--  正しい実装例 -->
<if test="name != null and name.length() > 0">  <!-- null安全な実装 -->
    AND name LIKE #{name}
</if>

3. 条件の優先順位の誤り

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

<!-- 間違った実装例 -->

<if test="type == 'A' or type == 'B' and status == 'ACTIVE'">

<!-- AND演算子が優先され、意図しない動作になる -->

</if>

<!-- 正しい実装例 -->

<if test="(type == 'A' or type == 'B') and status == 'ACTIVE'">

<!-- 括弧で優先順位を明確に指定 -->

</if>

<!-- 間違った実装例 --> <if test="type == 'A' or type == 'B' and status == 'ACTIVE'"> <!-- AND演算子が優先され、意図しない動作になる --> </if> <!-- 正しい実装例 --> <if test="(type == 'A' or type == 'B') and status == 'ACTIVE'"> <!-- 括弧で優先順位を明確に指定 --> </if>

<!--  間違った実装例 -->
<if test="type == 'A' or type == 'B' and status == 'ACTIVE'">
    <!-- AND演算子が優先され、意図しない動作になる -->
</if>

<!--  正しい実装例 -->
<if test="(type == 'A' or type == 'B') and status == 'ACTIVE'">
    <!-- 括弧で優先順位を明確に指定 -->
</if>

実装時のチェックリスト

• [ ] 比較演算子は == を使用しているか
• [ ] null判定を適切に行っているか
• [ ] 文字列比較時は空文字チェックも行っているか
• [ ] 複雑な条件は括弧で優先順位を明確にしているか
• [ ] 数値比較の型は適切か
• [ ] SQLインジェクション対策として #{}を使用しているか

このセクションで説明した基本文法と注意点を押さえることで、より安全で保守性の高いMyBatisの実装が可能になります。

実践的なMyBatis if活用術7選

重要ポイント

• 各パターンは実務での使用頻度が高いものを厳選
• パフォーマンスと保守性を考慮した実装例を提供
• 実際のプロジェクトですぐに活用可能な形で提供

1. 検索条件の動的生成パターン

// 説明: 検索条件を保持するDTOクラス
@Data
public class UserSearchCondition {
    private String name;
    private Integer ageFrom;
    private Integer ageTo;
    private List<String> statusList;
    private LocalDate registeredDateFrom;
    private LocalDate registeredDateTo;

    // 注意: バリデーションメソッドの追加
    public boolean isValid() {
        if (ageFrom != null && ageTo != null && ageFrom > ageTo) {
            return false;
        }
        if (registeredDateFrom != null && registeredDateTo != null 
            && registeredDateFrom.isAfter(registeredDateTo)) {
            return false;
        }
        return true;
    }
}

<!-- 説明: 動的な検索条件のMapper実装 -->
<select id="searchUsers" resultType="User" parameterType="UserSearchCondition">
    SELECT 
        u.id,
        u.name,
        u.age,
        u.status,
        u.registered_date
    FROM 
        users u
    <where>
        <!-- 注意: LIKE検索時のワイルドカード -->
        <if test="name != null and name != ''">
            AND u.name LIKE CONCAT('%', #{name}, '%')
        </if>
        <!-- 注意: 範囲検索の実装 -->
        <if test="ageFrom != null">
            AND u.age >= #{ageFrom}
        </if>
        <if test="ageTo != null">
            AND u.age <= #{ageTo}
        </if>
        <!-- 注意: IN句の動的生成 -->
        <if test="statusList != null and !statusList.isEmpty()">
            AND u.status IN
            <foreach item="status" collection="statusList"
                     open="(" separator="," close=")">
                #{status}
            </foreach>
        </if>
        <!-- 注意: 日付範囲検索 -->
        <if test="registeredDateFrom != null">
            AND DATE(u.registered_date) >= #{registeredDateFrom}
        </if>
        <if test="registeredDateTo != null">
            AND DATE(u.registered_date) <= #{registeredDateTo}
        </if>
    </where>
    ORDER BY u.id DESC
</select>

2. 更新項目の選択的設定パターン

// 説明: 更新情報を保持するDTOクラス
@Data
public class UserUpdateRequest {
    private Long id;
    private String name;
    private String email;
    private String phoneNumber;
    private Address address;  // 注意: 複合オブジェクト

    @Data
    public static class Address {
        private String postalCode;
        private String prefecture;
        private String city;
        private String street;
    }
}

<!-- 説明: 選択的更新のMapper実装 -->
<update id="updateUser" parameterType="UserUpdateRequest">
    UPDATE users
    <set>
        <!-- 注意: 基本情報の更新 -->
        <if test="name != null">name = #{name},</if>
        <if test="email != null">email = #{email},</if>
        <if test="phoneNumber != null">phone_number = #{phoneNumber},</if>

        <!-- 注意: 複合オブジェクトの処理 -->
        <if test="address != null">
            <if test="address.postalCode != null">
                postal_code = #{address.postalCode},
            </if>
            <if test="address.prefecture != null">
                prefecture = #{address.prefecture},
            </if>
            <if test="address.city != null">
                city = #{address.city},
            </if>
            <if test="address.street != null">
                street = #{address.street},
            </if>
        </if>

        updated_at = CURRENT_TIMESTAMP
    </set>
    WHERE id = #{id}
</update>

3. 複数条件の組み合わせパターン

// 説明: 複合条件を扱うDTOクラス
@Data
public class OrderSearchCriteria {
    private String orderStatus;
    private BigDecimal minAmount;
    private BigDecimal maxAmount;
    private List<String> paymentMethods;
    private boolean includeExpired;
    private UserRole userRole;  // 権限による条件分岐用

    public enum UserRole {
        ADMIN, MANAGER, OPERATOR
    }
}

<!-- 説明: 複雑な条件分岐のMapper実装 -->
<select id="findOrders" resultType="Order">
    SELECT 
        o.id,
        o.order_number,
        o.status,
        o.amount,
        o.created_at
    FROM 
        orders o
    <where>
        <!-- 注意: 権限による条件分岐 -->
        <choose>
            <when test="criteria.userRole == 'ADMIN'">
                <!-- 管理者は全件参照可能 -->
            </when>
            <when test="criteria.userRole == 'MANAGER'">
                AND o.department_id = #{currentDepartmentId}
            </when>
            <otherwise>
                AND o.created_by = #{currentUserId}
            </otherwise>
        </choose>

        <!-- 注意: ステータスと金額による絞り込み -->
        <if test="criteria.orderStatus != null">
            AND o.status = #{criteria.orderStatus}
        </if>
        <if test="criteria.minAmount != null">
            AND o.amount >= #{criteria.minAmount}
        </if>
        <if test="criteria.maxAmount != null">
            AND o.amount <= #{criteria.maxAmount}
        </if>

        <!-- 注意: 支払方法による絞り込み -->
        <if test="criteria.paymentMethods != null and !criteria.paymentMethods.isEmpty()">
            AND o.payment_method IN
            <foreach item="method" collection="criteria.paymentMethods"
                     open="(" separator="," close=")">
                #{method}
            </foreach>
        </if>

        <!-- 注意: 有効期限切れの除外/包含 -->
        <if test="!criteria.includeExpired">
            AND (o.expired_at IS NULL OR o.expired_at > CURRENT_TIMESTAMP)
        </if>
    </where>
    ORDER BY o.created_at DESC
</select>

4. NULL値の適切な処理パターン

// 説明: NULL値を扱うための条件クラス
@Data
public class ProductSearchCriteria {
    private String name;
    private String category;
    private Boolean isDiscontinued;  // 三値論理
    private NullablePrice price;     // NULL可能な価格

    @Data
    public static class NullablePrice {
        private BigDecimal value;
        private boolean includeNull;  // NULL値を含めるかどうか
    }
}

<!-- 説明: NULL値を考慮したMapper実装 -->
<select id="searchProducts" resultType="Product">
    SELECT * FROM products p
    <where>
        <!-- 注意: 通常の検索条件 -->
        <if test="criteria.name != null and criteria.name != ''">
            AND p.name LIKE CONCAT('%', #{criteria.name}, '%')
        </if>

        <!-- 注意: カテゴリまたはNULL -->
        <if test="criteria.category != null">
            AND (p.category = #{criteria.category} 
                 <if test="criteria.includeNullCategory">
                     OR p.category IS NULL
                 </if>
            )
        </if>

        <!-- 注意: 三値論理の処理 -->
        <if test="criteria.isDiscontinued != null">
            AND p.is_discontinued = #{criteria.isDiscontinued}
        </if>

        <!-- 注意: NULL可能な価格の処理 -->
        <if test="criteria.price != null">
            <choose>
                <when test="criteria.price.includeNull">
                    AND (p.price = #{criteria.price.value} OR p.price IS NULL)
                </when>
                <otherwise>
                    AND p.price = #{criteria.price.value}
                    AND p.price IS NOT NULL
                </otherwise>
            </choose>
        </if>
    </where>
    ORDER BY p.id
</select>

5. 日付範囲指定パターン

// 説明: 日付範囲を扱うDTOクラス
@Data
public class DateRangeCondition {
    private LocalDateTime startDate;
    private LocalDateTime endDate;
    private DateRangeType rangeType;

    public enum DateRangeType {
        INCLUSIVE,      // 開始日と終了日を含む
        EXCLUSIVE,      // 開始日と終了日を含まない
        START_INCLUSIVE, // 開始日のみ含む
        END_INCLUSIVE   // 終了日のみ含む
    }

    // 注意: 日付範囲の妥当性チェック
    public boolean isValid() {
        if (startDate == null || endDate == null) {
            return false;
        }
        return !startDate.isAfter(endDate);
    }
}

<!-- 説明: 日付範囲検索のMapper実装 -->
<select id="findByDateRange" resultType="Event">
    SELECT * FROM events e
    <where>
        <!-- 注意: 日付範囲の動的生成 -->
        <if test="range != null and range.startDate != null">
            <choose>
                <when test="range.rangeType == 'INCLUSIVE' or range.rangeType == 'START_INCLUSIVE'">
                    AND e.event_date >= #{range.startDate}
                </when>
                <otherwise>
                    AND e.event_date > #{range.startDate}
                </otherwise>
            </choose>
        </if>
        <if test="range != null and range.endDate != null">
            <choose>
                <when test="range.rangeType == 'INCLUSIVE' or range.rangeType == 'END_INCLUSIVE'">
                    AND e.event_date <= #{range.endDate}
                </when>
                <otherwise>
                    AND e.event_date < #{range.endDate}
                </otherwise>
            </choose>
        </if>

        <!-- 注意: タイムゾーンの考慮 -->
        AND e.event_date AT TIME ZONE 'UTC' 
            AT TIME ZONE #{userTimezone} >= CURRENT_TIMESTAMP
    </where>
    ORDER BY e.event_date
</select>

6. IN句の動的生成パターン

// 説明: IN句で使用する条件を扱うDTOクラス
@Data
public class BatchSearchCondition<T> {
    private List<T> includeItems;    // IN句に含める項目
    private List<T> excludeItems;    // NOT IN句に含める項目
    private Integer maxItemCount;     // 最大件数制限

    // 注意: バリデーションメソッド
    public boolean isValid() {
        if (includeItems == null || includeItems.isEmpty()) {
            return false;
        }
        // 注意: パフォーマンスを考慮した上限チェック
        if (maxItemCount != null && includeItems.size() > maxItemCount) {
            return false;
        }
        return true;
    }
}

// 説明: 複数条件を組み合わせた検索用DTO
@Data
public class ProductBatchSearchRequest {
    private BatchSearchCondition<Long> productIds;
    private BatchSearchCondition<String> categories;
    private BatchSearchCondition<String> tags;
    private boolean includePriceInfo;  // 価格情報を含めるかどうか
    private boolean includeStockInfo;  // 在庫情報を含めるかどうか
}

<!-- 説明: IN句を使用した動的クエリのMapper実装 -->
<select id="findProductsByBatchCondition" resultType="Product">
    SELECT 
        p.id,
        p.name,
        p.category,
        <!-- 注意: 動的なカラム選択 -->
        <if test="request.includePriceInfo">
            p.price,
            p.discount_rate,
        </if>
        <if test="request.includeStockInfo">
            p.stock_quantity,
            p.reserved_quantity,
        </if>
        p.updated_at
    FROM 
        products p
    <!-- 注意: タグ情報の結合 -->
    <if test="request.tags != null and !request.tags.includeItems.isEmpty()">
        INNER JOIN product_tags pt ON p.id = pt.product_id
    </if>
    <where>
        <!-- 注意: 商品IDによる絞り込み -->
        <if test="request.productIds != null and !request.productIds.includeItems.isEmpty()">
            p.id IN
            <foreach item="id" collection="request.productIds.includeItems"
                     open="(" separator="," close=")">
                #{id}
            </foreach>
        </if>

        <!-- 注意: 除外する商品ID -->
        <if test="request.productIds != null and !request.productIds.excludeItems.isEmpty()">
            AND p.id NOT IN
            <foreach item="id" collection="request.productIds.excludeItems"
                     open="(" separator="," close=")">
                #{id}
            </foreach>
        </if>

        <!-- 注意: カテゴリによる絞り込み -->
        <if test="request.categories != null and !request.categories.includeItems.isEmpty()">
            AND p.category IN
            <foreach item="category" collection="request.categories.includeItems"
                     open="(" separator="," close=")">
                #{category}
            </foreach>
        </if>

        <!-- 注意: タグによる絞り込み -->
        <if test="request.tags != null and !request.tags.includeItems.isEmpty()">
            AND pt.tag_name IN
            <foreach item="tag" collection="request.tags.includeItems"
                     open="(" separator="," close=")">
                #{tag}
            </foreach>
            <!-- 注意: タグの重複を除去 -->
            GROUP BY p.id, p.name, p.category
            <if test="request.includePriceInfo">
                , p.price, p.discount_rate
            </if>
            <if test="request.includeStockInfo">
                , p.stock_quantity, p.reserved_quantity
            </if>
            , p.updated_at
        </if>
    </where>
    ORDER BY p.id
</select>

7. ページング処理との組み合わせパターン

// 説明: ページング情報を扱うDTOクラス
@Data
public class PageRequest {
    private Integer page;      // ページ番号（0ベース）
    private Integer size;      // ページサイズ
    private String sortField;  // ソートフィールド
    private SortDirection sortDirection;  // ソート方向

    public enum SortDirection {
        ASC, DESC
    }

    // 注意: デフォルト値の設定
    @Builder.Default
    private Integer maxPageSize = 100;  // 最大ページサイズ

    // 注意: バリデーションメソッド
    public boolean isValid() {
        if (page == null || page < 0) return false;
        if (size == null || size <= 0 || size > maxPageSize) return false;
        if (sortField != null && !ALLOWED_SORT_FIELDS.contains(sortField)) return false;
        return true;
    }

    // 注意: OFFSET値の計算
    public long getOffset() {
        return (long) page * size;
    }
}

// 説明: 検索条件付きページング用DTO
@Data
public class ProductSearchPageRequest {
    private String keyword;
    private List<String> categories;
    private PriceRange priceRange;
    private PageRequest pageRequest;

    @Data
    public static class PriceRange {
        private BigDecimal min;
        private BigDecimal max;
    }
}

<!-- 説明: ページング処理を含むMapper実装 -->
<select id="findProductsWithPaging" resultType="Product">
    <!-- 注意: WITH句で共通条件を定義 -->
    WITH filtered_products AS (
        SELECT 
            p.id,
            p.name,
            p.category,
            p.price,
            p.created_at
        FROM 
            products p
        <where>
            <!-- 注意: キーワード検索 -->
            <if test="request.keyword != null and request.keyword != ''">
                AND (
                    p.name ILIKE CONCAT('%', #{request.keyword}, '%')
                    OR p.description ILIKE CONCAT('%', #{request.keyword}, '%')
                )
            </if>

            <!-- 注意: カテゴリフィルタ -->
            <if test="request.categories != null and !request.categories.isEmpty()">
                AND p.category IN
                <foreach item="category" collection="request.categories"
                         open="(" separator="," close=")">
                    #{category}
                </foreach>
            </if>

            <!-- 注意: 価格範囲フィルタ -->
            <if test="request.priceRange != null">
                <if test="request.priceRange.min != null">
                    AND p.price >= #{request.priceRange.min}
                </if>
                <if test="request.priceRange.max != null">
                    AND p.price <= #{request.priceRange.max}
                </if>
            </if>
        </where>
    )
    SELECT *
    FROM filtered_products
    <!-- 注意: 動的なソート条件 -->
    <choose>
        <when test="request.pageRequest.sortField != null">
            ORDER BY 
            ${request.pageRequest.sortField} 
            ${request.pageRequest.sortDirection}
        </when>
        <otherwise>
            ORDER BY id DESC
        </otherwise>
    </choose>
    <!-- 注意: ページング処理 -->
    LIMIT #{request.pageRequest.size}
    OFFSET #{request.pageRequest.offset}
</select>

<!-- 注意: 総件数取得用のクエリ -->
<select id="countFilteredProducts" resultType="long">
    SELECT COUNT(*)
    FROM products p
    <where>
        <!-- 注意: 検索条件は上記と同じ -->
        <if test="request.keyword != null and request.keyword != ''">
            AND (
                p.name ILIKE CONCAT('%', #{request.keyword}, '%')
                OR p.description ILIKE CONCAT('%', #{request.keyword}, '%')
            )
        </if>
        <if test="request.categories != null and !request.categories.isEmpty()">
            AND p.category IN
            <foreach item="category" collection="request.categories"
                     open="(" separator="," close=")">
                #{category}
            </foreach>
        </if>
        <if test="request.priceRange != null">
            <if test="request.priceRange.min != null">
                AND p.price >= #{request.priceRange.min}
            </if>
            <if test="request.priceRange.max != null">
                AND p.price <= #{request.priceRange.max}
            </if>
        </if>
    </where>
</select>

トラブルシューティング

重要ポイント

• エラーの原因は大きく「構文エラー」「ロジックエラー」「パフォーマンス問題」に分類される
• ログ設定を適切に行うことでデバッグが容易になる
• 実行計画の確認が性能改善の鍵となる

よくあるエラーと解決方法

1. 構文エラーの対処

OGNL式の構文エラー

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

<!-- エラーパターン1: 代入演算子の誤用 -->

<if test="status = 'ACTIVE'"> <!-- コンパイルエラー -->

AND status = #{status}

</if>

<!-- 正しい実装 -->

<if test="status == 'ACTIVE'"> <!-- 比較演算子を使用 -->

AND status = #{status}

</if>

<!-- エラーパターン2: メソッド呼び出しの誤り -->

<if test="list.size > 0"> <!-- NullPointerException の危険 -->

AND id IN ...

</if>

<!-- 正しい実装 -->

<if test="list != null and !list.isEmpty()"> <!-- 安全なチェック -->

AND id IN ...

</if>

<!-- エラーパターン1: 代入演算子の誤用 --> <if test="status = 'ACTIVE'"> <!-- コンパイルエラー --> AND status = #{status} </if> <!-- 正しい実装 --> <if test="status == 'ACTIVE'"> <!-- 比較演算子を使用 --> AND status = #{status} </if> <!-- エラーパターン2: メソッド呼び出しの誤り --> <if test="list.size > 0"> <!-- NullPointerException の危険 --> AND id IN ... </if> <!-- 正しい実装 --> <if test="list != null and !list.isEmpty()"> <!-- 安全なチェック --> AND id IN ... </if>

<!--  エラーパターン1: 代入演算子の誤用 -->
<if test="status = 'ACTIVE'">  <!-- コンパイルエラー -->
    AND status = #{status}
</if>

<!--  正しい実装 -->
<if test="status == 'ACTIVE'">  <!-- 比較演算子を使用 -->
    AND status = #{status}
</if>

<!--  エラーパターン2: メソッド呼び出しの誤り -->
<if test="list.size > 0">  <!-- NullPointerException の危険 -->
    AND id IN ...
</if>

<!--  正しい実装 -->
<if test="list != null and !list.isEmpty()">  <!-- 安全なチェック -->
    AND id IN ...
</if>

SQLエラーの防止

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

<!-- エラーパターン: カンマの扱い -->

<update id="updateUser">

UPDATE users SET

<if test="name != null">

name = #{name}, <!-- 最後のカンマが問題に -->

</if>

<if test="email != null">

email = #{email}, <!-- 最後のカンマが問題に -->

</if>

updated_at = CURRENT_TIMESTAMP

</update>

<!-- 正しい実装 -->

<update id="updateUser">

UPDATE users

<set>

<if test="name != null">name = #{name},</if>

<if test="email != null">email = #{email},</if>

updated_at = CURRENT_TIMESTAMP

</set>

WHERE id = #{id}

</update>

<!-- エラーパターン: カンマの扱い --> <update id="updateUser"> UPDATE users SET <if test="name != null"> name = #{name}, <!-- 最後のカンマが問題に --> </if> <if test="email != null"> email = #{email}, <!-- 最後のカンマが問題に --> </if> updated_at = CURRENT_TIMESTAMP </update> <!-- 正しい実装 --> <update id="updateUser"> UPDATE users <set> <if test="name != null">name = #{name},</if> <if test="email != null">email = #{email},</if> updated_at = CURRENT_TIMESTAMP </set> WHERE id = #{id} </update>

<!--  エラーパターン: カンマの扱い -->
<update id="updateUser">
    UPDATE users SET
    <if test="name != null">
        name = #{name},   <!-- 最後のカンマが問題に -->
    </if>
    <if test="email != null">
        email = #{email}, <!-- 最後のカンマが問題に -->
    </if>
    updated_at = CURRENT_TIMESTAMP
</update>

<!--  正しい実装 -->
<update id="updateUser">
    UPDATE users
    <set>
        <if test="name != null">name = #{name},</if>
        <if test="email != null">email = #{email},</if>
        updated_at = CURRENT_TIMESTAMP
    </set>
    WHERE id = #{id}
</update>

エラー対応チェックリスト

デバッグのコツとログ確認方法

1. ログ設定

# application.properties
# 基本的なMyBatisのログ設定
mybatis.configuration.log-impl=org.apache.ibatis.logging.slf4j.Slf4jImpl
logging.level.your.package.mapper=DEBUG

# 詳細なSQLログ
logging.level.org.apache.ibatis=TRACE

2. デバッグ用ユーティリティクラス

// 説明: SQLデバッグ用ユーティリティ
@Slf4j
public class MyBatisDebugUtil {
    // 説明: 生成されたSQLをログ出力
    public static void logGeneratedSql(SqlSession sqlSession, 
                                     String mapperId, 
                                     Object parameter) {
        try {
            Configuration configuration = sqlSession.getConfiguration();
            MappedStatement ms = configuration.getMappedStatement(mapperId);
            BoundSql boundSql = ms.getBoundSql(parameter);

            log.debug("=== Generated SQL ===");
            log.debug(boundSql.getSql());
            log.debug("=== Parameters ===");
            log.debug(parameter.toString());

            // 説明: バインドパラメータの出力
            List<ParameterMapping> paramMappings = boundSql.getParameterMappings();
            for (ParameterMapping mapping : paramMappings) {
                String property = mapping.getProperty();
                Object value = ExpressionEvaluator.getValue(property, parameter);
                log.debug("{} = {}", property, value);
            }
        } catch (Exception e) {
            log.error("SQL logging failed", e);
        }
    }

    // 説明: エラー発生時のコンテキスト情報出力
    public static void logErrorContext(Exception e, 
                                     String mapperId, 
                                     Object parameter) {
        log.error("=== Error Context ===");
        log.error("Mapper ID: {}", mapperId);
        log.error("Parameter: {}", parameter);
        log.error("Exception: ", e);
    }
}

3. デバッグ手順

1. エラーの特定

try {
    List<User> users = userMapper.findByCondition(condition);
} catch (Exception e) {
    MyBatisDebugUtil.logErrorContext(e, "UserMapper.findByCondition", condition);
    throw e;
}

2. SQL実行計画の確認

-- 説明: 実行計画の確認
EXPLAIN ANALYZE
SELECT * FROM users
WHERE status = 'ACTIVE'
AND age >= 20
ORDER BY created_at DESC;

パフォーマンス低下時の改善ポイント

1. 実行計画の分析

// 説明: 実行計画を取得するユーティリティ
@Slf4j
public class QueryPlanUtil {
    public static void analyzeQueryPlan(DataSource dataSource, 
                                      String sql, 
                                      Map<String, Object> params) {
        try (Connection conn = dataSource.getConnection()) {
            String explainSql = "EXPLAIN ANALYZE " + sql;
            try (PreparedStatement stmt = conn.prepareStatement(explainSql)) {
                // パラメータのバインド
                for (Map.Entry<String, Object> param : params.entrySet()) {
                    stmt.setObject(param.getKey(), param.getValue());
                }

                try (ResultSet rs = stmt.executeQuery()) {
                    while (rs.next()) {
                        log.info("Query Plan: {}", rs.getString(1));
                    }
                }
            }
        } catch (SQLException e) {
            log.error("Failed to analyze query plan", e);
        }
    }
}

2. パフォーマンス改善チェックリスト

インデックス最適化

-- 説明: 複合インデックスの作成
CREATE INDEX idx_users_status_age ON users(status, age);

-- 説明: B-tree以外のインデックス検討
CREATE INDEX idx_users_name_gin ON users USING gin (name gin_trgm_ops);

クエリの最適化

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

<!-- 非効率なクエリ -->

<select id="findUsers">

SELECT * FROM users u

LEFT JOIN departments d ON u.department_id = d.id

LEFT JOIN user_profiles up ON u.id = up.user_id

<where>

<if test="name != null">

AND LOWER(u.name) LIKE LOWER(CONCAT('%', #{name}, '%'))

</if>

</where>

</select>

<!-- 最適化されたクエリ -->

<select id="findUsers">

SELECT u.id, u.name, u.email

FROM users u

<where>

<if test="name != null">

AND u.name ILIKE #{name} || '%'

</if>

</where>

ORDER BY u.id

LIMIT #{pageSize} OFFSET #{offset}

</select>

<!-- 非効率なクエリ --> <select id="findUsers"> SELECT * FROM users u LEFT JOIN departments d ON u.department_id = d.id LEFT JOIN user_profiles up ON u.id = up.user_id <where> <if test="name != null"> AND LOWER(u.name) LIKE LOWER(CONCAT('%', #{name}, '%')) </if> </where> </select> <!-- 最適化されたクエリ --> <select id="findUsers"> SELECT u.id, u.name, u.email FROM users u <where> <if test="name != null"> AND u.name ILIKE #{name} || '%' </if> </where> ORDER BY u.id LIMIT #{pageSize} OFFSET #{offset} </select>

<!--  非効率なクエリ -->
<select id="findUsers">
    SELECT * FROM users u
    LEFT JOIN departments d ON u.department_id = d.id
    LEFT JOIN user_profiles up ON u.id = up.user_id
    <where>
        <if test="name != null">
            AND LOWER(u.name) LIKE LOWER(CONCAT('%', #{name}, '%'))
        </if>
    </where>
</select>

<!--  最適化されたクエリ -->
<select id="findUsers">
    SELECT u.id, u.name, u.email
    FROM users u
    <where>
        <if test="name != null">
            AND u.name ILIKE #{name} || '%'
        </if>
    </where>
    ORDER BY u.id
    LIMIT #{pageSize} OFFSET #{offset}
</select>

パフォーマンス改善戦略

1. クエリの最適化
   • 必要最小限のカラム取得
   • 適切なインデックス使用
   • LIKE検索の最適化
   • 結果セットの制限
2. キャッシュ戦略
   • MyBatisの2次キャッシュ設定
   • アプリケーションレベルのキャッシュ
   • キャッシュの有効期限設定
3. バッチ処理の最適化
   • 適切なバッチサイズ設定
   • トランザクション管理
   • 一括INSERT/UPDATE処理

まとめ：MyBatis ifの実践的な活用に向けて

本記事で解説した重要ポイント

1. 基本的な使い方とベストプラクティス

• if要素は動的SQLの基本となる制御構文
• 常にnull判定を行い、安全な実装を心がける
• 比較演算子は==を使用し、文法エラーを防ぐ
• フォーマットとインデントを整理し、可読性を確保

2. 実践的な実装パターン

習得すべき7つのパターン

1. 検索条件の動的生成パターン
2. 更新項目の選択的設定パターン
3. 複数条件の組み合わせパターン
4. NULL値の適切な処理パターン
5. 日付範囲指定パターン
6. IN句の動的生成パターン
7. ページング処理との組み合わせパターン

3. パフォーマンス最適化のポイント

4. トラブルシューティングの要点

• 適切なログ設定でデバッグを効率化
• 実行計画の確認で性能問題を特定
• エラーパターンを理解し、予防的に対処

実践のためのチェックリスト

開発時のチェックポイント

• [ ] DTOクラスでの適切なバリデーション実装
• [ ] SQLインジェクション対策の実施
• [ ] パフォーマンスを考慮したクエリ設計
• [ ] 適切なエラーハンドリングの実装
• [ ] コードの可読性向上対策

運用時のチェックポイント

• [ ] ログ設定の最適化
• [ ] 性能モニタリングの実施
• [ ] インデックスの定期的な見直し
• [ ] クエリ実行計画の確認
• [ ] キャッシュ戦略の評価

次のステップ

1. 基礎の強化
   • MyBatisの公式ドキュメント参照
   • 動的SQLの他の要素の学習
   • SQLパフォーマンスチューニングの深掘り
2. 実装の改善
   • 既存コードへのベストプラクティス適用
   • パフォーマンス最適化の実施
   • ユニットテストの拡充
3. 応用的な取り組み
   • カスタムタイプハンドラーの作成
   • 独自のプラグイン開発
   • より複雑な動的SQL実装への挑戦

最後に

MyBatis ifの適切な使用は、保守性が高く、パフォーマンスの良いデータアクセス層の実装に不可欠です。本記事で解説した実装パターンやベストプラクティスを基に、プロジェクトの要件に応じた最適な実装を目指してください。

また、常に以下の点を意識することで、より良い実装を実現できます：

• 型安全性の確保
• パフォーマンスとの両立
• コードの可読性維持
• 適切なエラーハンドリング
• 効果的なテスト戦略

これらの知識と実践を組み合わせることで、より堅牢なアプリケーション開発が可能となります。