起步：Spring Boot 整合 MyBatis Dynamic SQL

后端

2023-12-04 16:34:18

拥抱 ORM，领略 MyBatis Dynamic SQL 的魅力

在软件开发的世界里，ORM（对象关系映射）作为一项成熟的技术，深受开发者的喜爱，它通过提供一种对象与数据库之间映射关系的机制，帮助开发者用面向对象的方式来操作数据库，让代码变得更加简洁和可维护。

在众多的 ORM 框架中，MyBatis Dynamic SQL 凭借其强大的动态 SQL 构建能力脱颖而出。它允许开发者在运行时构建 SQL 语句，从而提高代码的灵活性和可重用性。

如果你正在寻找一种 ORM 框架来处理复杂的数据库操作，那么 MyBatis Dynamic SQL 是一个不错的选择。

携手同行，开启 Spring Boot 与 MyBatis Dynamic SQL 的邂逅

在开始之前，请确保您已经安装了 Spring Boot 和 MyBatis Dynamic SQL。有关安装步骤，请参考官方文档。

导入必要的依赖

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-dynamic-sql</artifactId>
    <version>2.2.1</version>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

配置数据源

在 application.properties 文件中，配置数据源信息：

spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=password

编写 MyBatis Dynamic SQL 配置文件

在 src/main/resources 目录下，创建 mybatis-dynamic-sql-config.xml 文件，并添加以下内容：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.demo.mapper.UserMapper">
  <dataSource type="POOLED">
    <property name="url" value="${spring.datasource.url}"/>
    <property name="username" value="${spring.datasource.username}"/>
    <property name="password" value="${spring.datasource.password}"/>
  </dataSource>
</mapper>

编写 Java 代码

在 src/main/java 目录下，创建 UserMapper.java 文件，并添加以下内容：

import com.example.demo.model.User;
import org.mybatis.dynamic.sql.select.render.SelectStatementProvider;
import org.mybatis.dynamic.sql.util.SqlBuilder;
import org.springframework.stereotype.Repository;

import static org.mybatis.dynamic.sql.select.SelectDSL.select;

@Repository
public interface UserMapper {

    SelectStatementProvider selectById(Integer id);

}

实现 MyBatis Dynamic SQL 接口

在 src/main/java 目录下，创建 UserMapperImpl.java 文件，并添加以下内容：

import com.example.demo.model.User;
import com.example.demo.mapper.UserMapper;
import org.mybatis.dynamic.sql.select.render.SelectStatementProvider;
import org.mybatis.dynamic.sql.util.SqlBuilder;
import org.springframework.stereotype.Repository;

import static org.mybatis.dynamic.sql.select.SelectDSL.select;

@Repository
public class UserMapperImpl implements UserMapper {

    @Override
    public SelectStatementProvider selectById(Integer id) {
        return select(User.ID, User.NAME, User.AGE)
                .from(User.USER)
                .where(User.ID, SqlBuilder.isEqualTo(id))
                .build()
                .render();
    }

}

测试 MyBatis Dynamic SQL

在 src/test/java 目录下，创建 UserMapperTest.java 文件，并添加以下内容：

import com.example.demo.model.User;
import com.example.demo.mapper.UserMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import static org.junit.jupiter.api.Assertions.assertEquals;

@SpringBootTest
public class UserMapperTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelectById() {
        User user = userMapper.selectById(1).get(0);
        assertEquals("John Doe", user.getName());
        assertEquals(25, user.getAge());
    }

}