クイックスタート

簡単なデモを通して、MyBatis-Plus の強力な機能を説明します。前提知識は以下の通りです：

Java 開発環境と対応した IDE を所有している
Spring Bootを熟知している
Maven または Gradleを熟知している

1つの User テーブルがあり、以下のような構造となっています：

id	name	age	email
1	Jone	18	test1@baomidou.com
2	Jack	20	test2@baomidou.com
3	Tom	28	test3@baomidou.com
4	Sandy	21	test4@baomidou.com
5	Billie	24	test5@baomidou.com

対応するデータベース Schema スクリプトは以下の通りです：

DROP TABLE IF EXISTS `user`;

CREATE TABLE `user`
(
    id BIGINT NOT NULL COMMENT '主键ID',
    name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
    age INT NULL DEFAULT NULL COMMENT '年龄',
    email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
    PRIMARY KEY (id)
);

対応するデータベース Data スクリプトは以下の通りです：

DELETE FROM `user`;

INSERT INTO `user` (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

プロジェクトの新規作成

空の Spring Boot プロジェクトを作成し、H2 データベースを導入して結合テストを行います。

依存関係の追加

MyBatis-Plus Starter への依存関係を追加します

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.11</version>
</dependency>

implementation 'com.baomidou:mybatis-plus-boot-starter:3.5.11'

Spring Boot3

Maven
Gradle

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-spring-boot3-starter</artifactId>
    <version>3.5.11</version>
</dependency>

implementation 'com.baomidou:mybatis-plus-spring-boot3-starter:3.5.11'

設定

application.yml 設定ファイルに、H2 データベース関連の設定を追加します：

# DataSource Config
spring:
  datasource:
    driver-class-name: org.h2.Driver
    username: root
    password: test
  sql:
    init:
      schema-locations: classpath:db/schema-h2.sql
      data-locations: classpath:db/data-h2.sql

上記の設定は、どの Spring Boot プロジェクトでも共通して使用されるデータベース接続情報です。もし MySQL など他のデータベースを使用している場合は、対応する設定内容を変更する必要があります。

Spring Boot の起動クラスに @MapperScan アノテーションを追加し、Mapper フォルダをスキャンします：

@SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

コーディング

エンティティクラス User.java を作成します：

@Data
@TableName("`user`")
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

Mapper インターフェース UserMapper.java を作成します：

public interface UserMapper extends BaseMapper<User> {

}

使用開始

テストクラスを追加して、機能テストを行います：

@SpringBootTest
public class SampleTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        List<User> userList = userMapper.selectList(null);
        Assert.isTrue(5 == userList.size(), "");
        userList.forEach(System.out::println);
    }

}

コンソール出力結果：

User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)

まとめ

以上の数ステップで、User テーブルの CRUD 機能を実装することができました。XML ファイルさえ書く必要はありません！

これらの手順から分かるように、MyBatis-Plus の導入はとても簡単で、starter 依存関係を追加し、簡単な設定を行うだけで使用できます。

しかし、MyBatis-Plus の強みはこれだけではありません。MyBatis-Plus のより強力な機能を詳しく知りたい方は、このまま読み進めてください！

Power by Astro Starlight | Sponsored by JetBrains