Spring Boot整合MyBatis与单元测试的实践之旅

后端

2023-09-14 15:33:33

Spring Boot 中无缝整合 MyBatis 和单元测试

在软件开发中，单元测试扮演着不可或缺的角色，它能够帮助我们快速揪出代码中的漏洞，提升软件的可靠性和质量。此外，单元测试还能加深我们对代码逻辑的理解，让我们在后续的维护和拓展中游刃有余。

在 Spring Boot 中，我们可以借助 MyBatis 来操纵数据库，这是一个出色的 ORM 框架，它能轻而易举地将对象映射到数据库表，从而简化数据库操作流程。

在这篇教程中，我们将手把手地带你领略如何在 Spring Boot 项目中集成 MyBatis，以及如何使用 JUnit 编写单元测试来检验 Spring Boot 应用程序。

前提条件

在踏上征程之前，请确保你的电脑上已安装以下软件：

JDK 1.8 或更高版本
Maven
Spring Boot CLI
MySQL 数据库

创建 Spring Boot 项目

首先，使用 Spring Boot CLI 创建一个新的 Spring Boot 项目：

spring init mybatis-demo

添加 MyBatis 依赖

接下来，我们需要在项目中添加 MyBatis 的依赖：

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.9</version>
</dependency>

配置 MyBatis

在项目的配置文件 application.properties 中，需要配置 MyBatis 的连接信息：

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

创建实体类

接下来，我们需要创建一个实体类来映射数据库表：

@Entity
@Table(name = "user")
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    private Integer age;

    // 省略 getter 和 setter 方法
}

创建 MyBatis Mapper 接口

接下来，我们需要创建一个 MyBatis Mapper 接口来定义对数据库的操作：

public interface UserMapper {

    @Select("SELECT * FROM user")
    List<User> findAll();

    @Insert("INSERT INTO user(name, age) VALUES (#{name}, #{age})")
    void insert(User user);

    @Update("UPDATE user SET name = #{name}, age = #{age} WHERE id = #{id}")
    void update(User user);

    @Delete("DELETE FROM user WHERE id = #{id}")
    void delete(Long id);
}

创建 Service 层

接下来，我们需要创建一个 Service 层来封装业务逻辑：

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public List<User> findAll() {
        return userMapper.findAll();
    }

    public void insert(User user) {
        userMapper.insert(user);
    }

    public void update(User user) {
        userMapper.update(user);
    }

    public void delete(Long id) {
        userMapper.delete(id);
    }
}

创建 Controller 层

接下来，我们需要创建一个 Controller 层来处理 HTTP 请求：

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping
    public List<User> findAll() {
        return userService.findAll();
    }

    @PostMapping
    public void insert(@RequestBody User user) {
        userService.insert(user);
    }

    @PutMapping
    public void update(@RequestBody User user) {
        userService.update(user);
    }

    @DeleteMapping("/{id}")
    public void delete(@PathVariable Long id) {
        userService.delete(id);
    }
}

编写单元测试

最后，我们需要编写单元测试来检验 Spring Boot 应用程序：

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceTests {

    @Autowired
    private UserService userService;

    @Test
    public void findAll() {
        List<User> users = userService.findAll();
        Assert.assertNotNull(users);
        Assert.assertEquals(0, users.size());
    }

    @Test
    public void insert() {
        User user = new User();
        user.setName("张三");
        user.setAge(18);
        userService.insert(user);

        List<User> users = userService.findAll();
        Assert.assertNotNull(users);
        Assert.assertEquals(1, users.size());
    }

    @Test
    public void update() {
        User user = new User();
        user.setId(1L);
        user.setName("李四");
        user.setAge(20);
        userService.update(user);

        List<User> users = userService.findAll();
        Assert.assertNotNull(users);
        Assert.assertEquals(1, users.size());
        Assert.assertEquals("李四", users.get(0).getName());
        Assert.assertEquals(20, users.get(0).getAge());
    }

    @Test
    public void delete() {
        userService.delete(1L);

        List<User> users = userService.findAll();
        Assert.assertNotNull(users);
        Assert.assertEquals(0, users.size());
    }
}