Spring Boot 集成MyBatis-Plus

Spring Boot 集成 MyBatis-Plus 教程

在现代开发中，Spring Boot 和 MyBatis-Plus 是一对非常流行的组合。MyBatis-Plus 是一个基于 MyBatis 的增强工具，提供了简化 CRUD 操作和增强功能的能力，可以显著提高开发效率。本文将详细介绍如何在 Spring Boot 中集成 MyBatis-Plus，并提供一些代码示例。

1. 项目准备

首先，我们需要创建一个 Spring Boot 项目。可以使用 Spring Initializr（https://start.spring.io/）来快速生成项目。在生成项目时，请选择以下依赖：

• Spring Web
• Spring Data JPA
• MyBatis-Plus
• MySQL Driver （如果你使用的是 MySQL 数据库）

2. Maven 依赖

在生成的 pom.xml 中添加 MyBatis-Plus 的依赖：

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

确保你的 Spring Boot 和 MyBatis-Plus 版本兼容。

3. 数据库配置

接下来，在 application.yml 中配置数据库连接：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/your_database_name?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
    username: your_username
    password: your_password
  mybatis-plus:
    global-config:
      db-config:
        id-type: auto    # 主键策略, 这里采用自增

请将 your_database_name、your_username 和 your_password 替换为你的实际数据库信息。

4. 创建实体类

接下来，我们需要定义一个实体类。例如，我们可以创建一个 User 类表示用户信息：

package com.example.demo.entity;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName("user") // 数据库表名
public class User {
    @TableId(type = IdType.AUTO) // 自增主键
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

5. 创建 Mapper 接口

然后，我们需要创建一个 Mapper 接口，用于与数据库进行交互：

package com.example.demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends BaseMapper<User> {
    // 这里可以定义其他自定义查询方法
}

6. 创建 Service 和 Controller

接下来，我们创建一个 Service 类来处理业务逻辑：

package com.example.demo.service;

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

import java.util.List;

@Service
public class UserService {
    @Autowired
    private UserMapper userMapper;

    public List<User> getAllUsers() {
        return userMapper.selectList(null); // 获取所有用户
    }

    public void addUser(User user) {
        userMapper.insert(user); // 插入用户
    }
}

然后，创建一个 Controller 来处理 HTTP 请求：

package com.example.demo.controller;

import com.example.demo.entity.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<User> getAllUsers() {
        return userService.getAllUsers();
    }

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

7. 启动应用程序

完成以上步骤后，你可以启动 Spring Boot 应用程序。通过 http://localhost:8080/users 进行 GET 请求可以获取所有用户，通过 POST 请求可以添加新用户。

8. 测试

可以使用 Postman 或其他工具测试 API。在 Postman 中发送一个 POST 请求，Body 选择 raw 格式，JSON 方式发送用户数据，如：

{
    "name": "John Doe",
    "age": 30,
    "email": "john.doe@example.com"
}

总结

通过以上步骤，我们成功地在 Spring Boot 中集成了 MyBatis-Plus。MyBatis-Plus 提供了丰富的功能来简化数据库操作，使得开发更为高效。希望本教程能够帮助你快速上手 Spring Boot 和 MyBatis-Plus 的集成。