SpringBoot整合MyBatis Plus实现基本CRUD与高级功能

更新时间：2024年02月06日 09:37:37 作者：IT·陈寒

Spring Boot是一款用于快速构建Spring应用程序的框架,而MyBatis Plus是MyBatis的增强工具,本文将详细介绍如何在Spring Boot项目中整合MyBatis Plus,并展示其基本CRUD功能以及高级功能的实现方式,需要的朋友可以参考下

1. 引言

Spring Boot是一款用于快速构建Spring应用程序的框架，而MyBatis Plus是MyBatis的增强工具，提供了许多方便实用的功能，包括基本CRUD操作、自动填充、乐观锁、逻辑删除等。本文将详细介绍如何在Spring Boot项目中整合MyBatis Plus，并展示其基本CRUD功能以及高级功能的实现方式。

2. 项目搭建与依赖配置

首先，确保你已经搭建好了Spring Boot项目。接下来，我们需要添加MyBatis Plus的依赖。

2.1 添加MyBatis Plus依赖

在pom.xml文件中添加以下依赖：

<!-- MyBatis Plus -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3</version>
</dependency>

2.2 配置数据源与MyBatis Plus

在application.properties或application.yml中配置数据库连接信息和MyBatis Plus的相关配置：

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/testdb?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
    username: your_username
    password: your_password

mybatis-plus:
  mapper-locations: classpath:mapper/**/*.xml
  global-config:
    db-config:
      id-type: auto
  configuration:
    map-underscore-to-camel-case: true

以上配置中，mapper-locations指定了MyBatis Plus的XML映射文件路径，map-underscore-to-camel-case表示数据库字段采用下划线命名，而Java实体类采用驼峰命名。

3. 实现基本CRUD功能

3.1 创建实体类

假设我们有一个实体类User，对应数据库中的user表：

import com.baomidou.mybatisplus.annotation.*;
import lombok.Data;

import java.util.Date;

@Data
@TableName("user")
public class User {

    @TableId(type = IdType.AUTO)
    private Long id;

    private String username;

    private String password;

    private Integer age;

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @TableLogic
    private Integer deleted;
}

在上述实体类中，使用了@TableName注解指定了对应的数据库表名，@TableId表示主键，@TableField用于自动填充，@TableLogic表示逻辑删除字段。

3.2 创建Mapper接口

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends BaseMapper<User> {
}

MyBatis Plus提供了BaseMapper接口，通过继承该接口，即可获得常见的CRUD功能，无需手动编写SQL。

3.3 实现Service层

import com.baomidou.mybatisplus.extension.service.IService;

public interface UserService extends IService<User> {
}

创建一个UserService接口，继承自IService，该接口提供了常用的Service层方法。

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}

创建UserServiceImpl类，实现UserService接口，并继承自ServiceImpl，实现了其中的方法。

3.4 控制器实现

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

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

    @Autowired
    private UserService userService;

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

    @GetMapping("/list")
    public List<User> listUsers() {
        return userService.list();
    }

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

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

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

以上代码中，通过注入UserService实现了基本的CRUD操作的接口。

4. 高级功能实现

4.1 自动填充功能

MyBatis Plus提供了自动填充功能，通过@TableField注解的fill属性来指定填充的时机，常用的值有FieldFill.INSERT和FieldFill.INSERT_UPDATE。

@TableField(fill = FieldFill.INSERT)
private Date createTime;

@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

上述代码中，createTime字段在插入时自动填充，updateTime字段在插入和更新时自动填充。

4.2 乐观锁功能

MyBatis Plus支持乐观锁的实现，通过@Version注解在实体类的版本字段上添加乐观锁。

@Version
private Integer version;

在更新时，MyBatis Plus会自动检测版本字段，如果版本号不匹配，则更新失败。

4.3 逻辑删除功能

MyBatis Plus提供了逻辑删除的功能，通过@TableLogic注解在实体类的逻辑删除字段上添加逻辑删除标记。

@TableLogic
private Integer deleted;

在进行逻辑删除操作时，MyBatis Plus会更新这个字段的值，而不是物理删除记录。

5. 拓展：MyBatis Plus的其他功能

除了上述介绍的功能外，MyBatis Plus还提供了许多其他强大的功能，如条件构造器、分页查询、性能分析、多租户支持等。以下简单介绍一些常用的功能：

5.1 条件构造器

MyBatis Plus的条件构造器可以轻松构建复杂的查询条件：

LambdaQueryWrapper<User> wrapper = Wrappers.<User>lambdaQuery()
    .eq(User::getUsername, "admin")
    .like(User::getPassword, "pass");
List<User> userList = userService.list(wrapper);

5.2 分页查询

MyBatis Plus支持简单的分页查询：

IPage<User> page = new Page<>(1, 10);
IPage<User> userPage = userService.page(page, null);
List<User> userList = userPage.getRecords();

5.3 性能分析

MyBatis Plus提供了性能分析插件，可以方便地查看SQL执行情况：

# application.yml
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

通过配置log-impl属性，可以将SQL输出到控制台，方便调试与优化。

6. 总结

通过本文的介绍，我们学习了如何在Spring Boot项目中整合MyBatis Plus，并实现了基本的CRUD功能以及高级功能如自动填充、乐观锁、逻辑删除等。MyBatis Plus的强大功能极大地简化了数据库操作，提高了开发效率。在实际项目中，根据具体需求，我们可以更深入地了解MyBatis Plus提供的各种功能，以更好地应对复杂的业务场景。希望通过本文的学习，读者能够更加熟练地使用Spring Boot和MyBatis Plus进行项目开发。

以上就是SpringBoot整合MyBatis Plus实现基本CRUD与高级功能的详细内容，更多关于SpringBoot整合MyBatis Plus的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

mybatis <foreach>标签动态增删改查方式
这篇文章主要介绍了mybatis <foreach>标签动态增删改查方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-03-03
springboot整合xxl-job的实现示例
本文主要介绍了springboot整合xxl-job的实现示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-06-06
java之如何定义USB接口
这篇文章主要介绍了java之如何定义USB接口问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-05-05
java虚拟机学习高级篇
在本篇文章里小编给大家整理了关于java虚拟机学习高级篇的相关内容，有兴趣的朋友们跟着学习参考下。
2019-06-06
浅析Java内存模型与垃圾回收
下面小编就为大家带来一篇浅析Java内存模型与垃圾回收。小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧，祝大家游戏愉快哦
2016-05-05
logback EvaluatorFilter实现同时记录多个level级别的日志
这篇文章主要介绍了logback EvaluatorFilter实现同时记录多个level级别的日志方法详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-11-11
java mybatis框架实现多表关系查询功能
这篇文章主要介绍了java mybatis框架实现多表关系查询,基于Maven框架的整体设计 —— 一多一的关系，文中通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-10-10
详解Android系统中的root权限获得原理
这篇文章主要介绍了详解Android系统中的Root权限获得原理,安卓基于Linux,所以原理也相当于Linux中的root用户,需要的朋友可以参考下
2015-08-08
Java线程实现时间动态显示
这篇文章主要为大家详细介绍了Java线程实现时间动态显示，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-04-04
java 中匿名内部类的实例详解
这篇文章主要介绍了java 中匿名内部类的实例详解的相关资料,这里提供实例来帮助大家学习理解这部分内容，需要的朋友可以参考下
2017-09-09