Spring Boot で Mybatis を Mybatis-Plus にアップグレードする

導入

Mybatis-Plus は MyBatis をベースにした拡張ツールで、Spring Boot プロジェクトで MyBatis を使用する開発プロセスを簡素化します。Mybatis-Plusを導入することで、定型コードを大幅に削減し、より便利な機能を提供することができます。

この記事では、既存の Spring Boot プロジェクトの MyBatis フレームワークを Mybatis-Plus にアップグレードする方法を紹介します。

ステップ

ステップ 1: 依存関係を追加する

pom.xmlまず、 Mybatis-Plus 依存関係をファイルに追加します。

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>最新版本号</version>
</dependency>

必ず最新版本号Mybatis-Plus の最新の安定したバージョン番号に置き換えてください。

ステップ 2: データソースを構成する

Mybatis-Plus はデータソースと統合する必要があります。application.properties(または) ファイルを開きapplication.yml、次の内容を追加してデータソース情報を構成します。

spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/your_database_name
spring.datasource.username=your_username
spring.datasource.password=your_password

your_database_nameとyour_usernameをyour_password実際のデータベース名、ユーザー名、パスワードに置き換えてください。

ステップ 3: Mybatis-Plus を構成する

Spring Boot では、Mybatis-Plus の構成は非常に簡単です。application.properties(または) にapplication.yml次の内容を追加するだけです。

# MyBatis-Plus配置
mybatis-plus.config-location=classpath:mybatis/mybatis-config.xml

これはmybatis-config.xml、後で作成するカスタム Mybatis 構成ファイルです。

ステップ 4: Mybatis-Plus 構成ファイルを作成する

ディレクトリの下にという名前のフォルダresourcesを作成し、その中にという名前のファイルを作成します。次の内容をファイルに追加します。mybatismybatis-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="mapUnderscoreToCamelCase" value="true"/>
    </settings>
</configuration>

ここでの設定は、Mybatis-Plus のキャメルケース命名自動マッピング機能を有効にし、データベース内の下線付きフィールドを Java クラスのキャメルケース命名属性にマッピングするために使用されます。

ステップ 5: マッパーインターフェイスを再構築する

ここで、Mybatis-Plus の仕様に合わせて元の Mapper インターフェイスを変更する必要があります。Mybatis-Plus は、アノテーションベースの Mapper インターフェイスと SQL メソッドのセットを提供します。これにより、Mapper XML ファイルを手動で作成する必要がなくなります。

たとえば、元の Mapper インターフェイスは次のようになります。

public interface UserMapper {
    List<User> findAll();
    void save(User user);
    // ...
}

これを次のように変更します。

public interface UserMapper extends BaseMapper<User> {
    // 此处无需再定义findAll和save方法
    // ...
}

これを親インターフェイスとして使用すると、BaseMapper一連の CRUD 操作メソッドが自動的に提供されます。

ステップ 6: 構成を完了する

最後に、Spring Boot アプリケーションを再起動します。Mybatis-Plus は、すべての Mapper インターフェイスを自動的にスキャンしてロードします。

これで、元の Spring Boot プロジェクトの MyBatis フレームワークが Mybatis-Plus に正常にアップグレードされました。Mybatis-Plusを導入することで、より便利で効率的な開発体験をお楽しみいただけます。

この記事がお役に立てば幸いです!