Spring Boot集成MyBatis操作数据库超详细步骤含代码

前言

在Java开发领域，MyBatis作为轻量级持久层框架中的佼佼者，凭借其灵活性和SQL可控性，特别适合需要复杂数据库操作的应用场景。当它与Spring Boot结合时，数据操作体验变得更加流畅。接下来，我们将一步步讲解如何在Spring Boot项目中集成MyBatis，并实现最基本的增删改查功能。从依赖配置入手，到实体类、Mapper接口、Service层和Controller层的搭建，最终形成一个清晰、可用的分层应用结构。

1. 项目依赖配置

要在Spring Boot项目中集成MyBatis，第一步需要在pom.xml中添加相关依赖。推荐使用mybatis-spring-boot-starter，它可以快速完成集成，同时配合MySQL驱动mysql-connector-java，即可解决数据库连接问题。

1.1 引入MyBatis和数据库驱动依赖

在pom.xml中，添加以下依赖配置：

    
    
        org.mybatis.spring.boot
        mybatis-spring-boot-starter
        2.2.0
    
    
    
        mysql
        mysql-connector-java
        runtime
    

1.2 数据源配置

依赖添加完成后，接下来需要在application.properties中配置数据库连接信息。这一步的目的是让MyBatis知道连接哪个数据库以及如何连接。这里我们配置了数据库URL、用户名、密码以及其他连接参数。

spring.datasource.url=jdbc:mysql://localhost:3306/testdb?useSSL=false&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# 指定MyBatis的Mapper XML文件位置
mybatis.mapper-locations=classpath:mapper/*.xml

2. 创建数据库映射实体类

MyBatis通过实体类来映射数据库表结构。以User表为例，我们需要创建一个实体类User，用于表示用户信息，包含ID、用户名、邮箱等字段。

在com.example.demo.model包下创建User类，使其与数据库中的用户表字段一一对应。该类包含属性以及对应的getter和setter方法。

package com.example.demo.model;

public class User {
    private Long id;
    private String username;
    private String email;

    // Getter 和 Setter 方法
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
}

3. 创建Mapper层接口

Mapper层是MyBatis与数据库交互的核心部分。通过Mapper接口定义数据操作方法，并直接在注解中编写SQL语句，即可实现增删改查功能。

在com.example.demo.mapper包下创建UserMapper接口，并添加@Mapper注解。该接口中定义的方法，MyBatis会自动实现对应的SQL操作。

package com.example.demo.mapper;

import com.example.demo.model.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

import java.util.List;

@Mapper
public interface UserMapper {

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

    @Select("SELECT * FROM user WHERE id = #{id}")
    User findById(Long id);
}

可以看到，findAll()用于查询所有用户，findById()则根据ID查询特定用户的信息。

4. 创建Service层

Service层主要负责封装业务逻辑。通过这一层，可以将数据库操作与业务需求分离，使代码更加清晰、易于维护。

4.1 定义Service接口

在com.example.demo.service包下创建UserService接口，定义获取所有用户和根据ID查询用户的方法：

package com.example.demo.service;

import com.example.demo.model.User;

import java.util.List;

public interface UserService {
    List getAllUsers();
    User getUserById(Long id);
}

4.2 实现Service接口

接着在com.example.demo.service.impl包下创建UserServiceImpl类，实现UserService接口。使用@Service注解声明它是一个服务类，并通过@Autowired注入UserMapper，从而调用Mapper中的方法完成数据库操作。

package com.example.demo.service.impl;

import com.example.demo.mapper.UserMapper;
import com.example.demo.model.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public List getAllUsers() {
        return userMapper.findAll();
    }

    @Override
    public User getUserById(Long id) {
        return userMapper.findById(id);
    }
}

此处，UserServiceImpl将Mapper中的数据库操作进一步封装，使Controller层可以更专注于接口设计和请求处理。

5. 创建Controller层

Controller层是前端与后端交互的入口，负责接收客户端请求、调用Service层的业务逻辑，并将结果返回给客户端。这里我们使用Spring MVC的@RestController注解创建控制器。

在com.example.demo.controller包下创建UserController类，用于处理与用户相关的HTTP请求。通过@Autowired注入UserService，然后定义接口方法，实现获取用户列表和根据ID查询用户的功能。

package com.example.demo.controller;

import com.example.demo.model.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

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

    @Autowired
    private UserService userService;

    @GetMapping
    public List getAllUsers() {
        return userService.getAllUsers();
    }

    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        return userService.getUserById(id);
    }
}

以上代码定义了两个接口：

• getAllUsers()：获取所有用户信息。
• getUserById(Long id)：根据用户ID获取特定用户信息。

6. 运行和测试项目

完成以上步骤后，即可启动项目测试接口，验证功能是否按预期运行。

6.1 启动项目

直接运行Spring Boot项目的主类DemoApplication中的main方法，应用程序即可启动。

6.2 测试接口

使用Postman等工具测试API接口。例如，发送GET请求到http://localhost:8080/users，即可获取所有用户信息；发送GET请求到http://localhost:8080/users/{id}，则可获取指定用户的信息。

7. 总结

本文详细介绍了在Spring Boot中集成MyBatis的完整流程：从项目依赖配置、实体类、Mapper接口的创建，到Service层和Controller层的开发，最终实现了数据库的基本操作。这种结构化的分层设计使项目代码清晰易读，业务逻辑与数据操作各司其职，维护和扩展更加方便。MyBatis与Spring Boot的结合，确实是实现数据持久化操作的高效组合，希望本指南能帮助大家更好地掌握这两者的集成方式。