首页手记 MyBatis-Plus资料入门教程

MyBatis-Plus资料入门教程

标签：

Java 设计模式数据库

概述

MyBatis-Plus是一款强大的MyBatis增强工具，提供了便捷的功能和高级特性，如CRUD操作简化、分页查询和条件构造器等，旨在简化开发流程，提高开发效率。本文将详细介绍MyBatis-Plus的核心设计理念、快速入门指南、常用注解与标签以及高级功能，帮助开发者更好地理解和应用MyBatis-Plus。

MyBatis-Plus简介

1.1 MyBatis与MyBatis-Plus的关系

MyBatis是一个优秀的持久层框架，它简化了数据库操作的复杂性，允许开发者使用简单的SQL映射文件来操作数据库。MyBatis-Plus是MyBatis的一个增强工具，它在不改变MyBatis核心代码的情况下，对MyBatis进行了大量扩展和增强，提供了更多便捷的功能和特性。MyBatis-Plus在原有的基础上增加了CRUD操作的简化、分页查询、条件构造器、数据库自增主键、乐观锁等高级功能，使得开发者可以更加高效地进行数据库操作。

1.2 MyBatis-Plus的主要特性

MyBatis-Plus提供了以下主要特性，这些特性使得数据库操作更加便捷和高效：

CRUD操作简化：提供了大量的内置CRUD操作方法，使得开发者可以快速实现数据库操作。
分页查询：内置了分页插件，可以方便地进行分页查询，减少开发者的繁琐操作。
条件构造器：提供了条件构造器，支持链式操作，方便地构建复杂的查询条件。
数据库自增主键：支持数据库自增主键的自定义逻辑。
乐观锁：内置了乐观锁插件，支持分布式锁，可以轻松实现分布式环境下的数据一致性。
逻辑删除：提供了逻辑删除功能，支持软删除和恢复。
数据权限：支持数据权限控制，可以按需控制数据的访问范围。
性能优化：内置了缓存插件，可以提升应用性能。

1.3 MyBatis-Plus的核心设计理念

MyBatis-Plus的核心设计理念是简化开发流程，提高开发效率。具体体现在以下几个方面：

简化开发流程：MyBatis-Plus提供了大量的内置方法，可以快速实现数据库操作，减少了开发者编写SQL的繁琐工作。
提高开发效率：内置的分页插件、条件构造器等功能，可以快速完成复杂的功能，提升开发效率。
易于维护：MyBatis-Plus通过注解和配置的方式进行开发，使得代码结构清晰，易于维护。
扩展性：MyBatis-Plus基于MyBatis进行扩展，可以方便地与各种插件和工具集成，提高系统的灵活性和扩展性。

快速入门

2.1 Maven依赖配置

要使用MyBatis-Plus，首先需要在项目的pom.xml文件中配置对应的依赖。具体的依赖配置如下所示：

<dependencies>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.4.3</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.23</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

2.2 创建数据库连接

在Spring Boot项目中，需要在application.yml文件中配置数据库连接信息。下面是一个简单的配置示例：

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

2.3 配置MyBatis-Plus

在Spring Boot项目中，配置MyBatis-Plus相对简单，只需要在application.yml文件中进行配置即可。例如：

mybatis-plus:
  configuration:
    # 设置数据库方言，例如 MySQL
    dialect: mysql
    # 设置显示 SQL 语句
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

2.4 第一个简单的CRUD操作

接下来，我们通过一个简单的CRUD操作示例来快速入门MyBatis-Plus。这里我们创建一个简单的User实体类，并进行基本的增删改查操作。

实体类定义

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;

@TableName("user")
public class User {
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    @TableField("name")
    private String name;

    @TableField("age")
    private Integer age;

    @TableField("create_time")
    private Date createTime;

    @TableField("deleted")
    @TableLogic
    private Boolean deleted;

    public User() {}

    public User(String name, Integer age, Date createTime, Boolean deleted) {
        this.name = name;
        this.age = age;
        this.createTime = createTime;
        this.deleted = deleted;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    public Boolean getDeleted() {
        return deleted;
    }

    public void setDeleted(Boolean deleted) {
        this.deleted = deleted;
    }
}

自动创建Mapper接口

MyBatis-Plus提供了自动创建Mapper接口的功能，我们只需要定义一个接口，并继承BaseMapper即可。例如：

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;

public interface UserMapper extends BaseMapper<User> {
}

CRUD操作

接下来，我们编写简单的CRUD操作方法：

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import org.springframework.stereotype.Service;

@Service
public class UserService extends ServiceImpl<UserMapper, User> {
    public void addUser(User user) {
        this.save(user);
    }

    public User getUserById(Long id) {
        return this.getById(id);
    }

    public void updateUser(User user) {
        this.updateById(user);
    }

    public void deleteUser(Long id) {
        this.removeById(id);
    }
}

测试CRUD操作

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class DemoRunner implements CommandLineRunner {
    @Autowired
    private UserService userService;

    @Override
    public void run(String... args) throws Exception {
        // 添加用户
        User user = new User("张三", 25, new Date(), false);
        userService.addUser(user);

        // 查询用户
        User userById = userService.getUserById(user.getId());
        System.out.println(userById);

        // 更新用户
        user.setName("张三丰");
        userService.updateUser(user);

        // 删除用户
        userService.deleteUser(user.getId());
    }
}

以上代码演示了如何使用MyBatis-Plus进行基本的CRUD操作。

实体类与Mapper接口

3.1 定义实体类

实体类是MyBatis-Plus操作数据库的基础，通过实体类可以映射数据库中的表结构。MyBatis-Plus提供了丰富的注解来定义实体类，例如@TableName用于指定映射的表名，@TableId用于指定主键字段等。

示例代码

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.util.Date;

@TableName("user")
public class User {
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    @TableField("name")
    private String name;

    @TableField("age")
    private Integer age;

    @TableField("create_time")
    private Date createTime;

    @TableField("deleted")
    @TableLogic
    private Boolean deleted;

    public User() {}

    public User(String name, Integer age, Date createTime, Boolean deleted) {
        this.name = name;
        this.age = age;
        this.createTime = createTime;
        this.deleted = deleted;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    public Boolean getDeleted() {
        return deleted;
    }

    public void setDeleted(Boolean deleted) {
        this.deleted = deleted;
    }
}

3.2 自动创建Mapper接口

MyBatis-Plus通过继承BaseMapper接口，可以自动创建对应的Mapper接口。这样，我们不需要手动编写Mapper接口中的方法，MyBatis-Plus会自动提供一系列的CRUD操作方法。

示例代码

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;

public interface UserMapper extends BaseMapper<User> {
}

3.3 自定义Mapper接口方法

MyBatis-Plus允许我们自定义Mapper接口中的方法，以满足特定的需求。自定义方法可以通过添加注解来实现，例如@Select、@Insert等。

示例代码

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;

public interface UserMapper extends BaseMapper<User> {
    @Select("SELECT * FROM user WHERE name = #{name}")
    User selectByName(String name);

    @Select("SELECT * FROM user WHERE age > #{minAge} AND age < #{maxAge}")
    List<User> selectByAgeRange(Integer minAge, Integer maxAge);
}

常用注解与标签

4.1 实体类注解

在实体类中，MyBatis-Plus提供了多种注解来定义实体类的字段和表结构。下面是一些常用的实体类注解：

@TableName：指定表名。
@TableId：指定主键字段。
@TableField：指定字段的其他属性，例如插入时是否为空、更新时是否为空等。
@TableLogic：指定逻辑删除字段。
@TableField(exist = false)：指定字段不参与数据库表的创建。

示例代码

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.util.Date;

@TableName("user")
public class User {
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    @TableField("name")
    private String name;

    @TableField("age")
    private Integer age;

    @TableField("create_time")
    private Date createTime;

    @TableField("deleted")
    @TableLogic
    private Boolean deleted;

    public User() {}

    public User(String name, Integer age, Date createTime, Boolean deleted) {
        this.name = name;
        this.age = age;
        this.createTime = createTime;
        this.deleted = deleted;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    public Boolean getDeleted() {
        return deleted;
    }

    public void setDeleted(Boolean deleted) {
        this.deleted = deleted;
    }
}

4.2 映射标签

MyBatis-Plus提供了一系列的XML映射标签来控制SQL语句的生成和执行。例如，<if>标签用于条件判断，<foreach>标签用于循环遍历等。

示例代码

<select id="selectByCondition" resultType="com.example.demo.entity.User">
    SELECT * FROM user
    <if test="name != null">
        WHERE name = #{name}
    </if>
    <if test="age != null">
        AND age = #{age}
    </if>
</select>

4.3 Mapper方法注解

MyBatis-Plus提供了多种Mapper方法注解，用于定义SQL语句的执行类型。例如，@Select、@Insert、@Update、@Delete等。

示例代码

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;

public interface UserMapper extends BaseMapper<User> {
    @Select("SELECT * FROM user WHERE name = #{name}")
    User selectByName(String name);

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

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

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

高级功能介绍

5.1 条件构造器

条件构造器是MyBatis-Plus提供的一个强大的工具，用于构建复杂的查询条件。通过链式调用来组合多个条件，方便地生成复杂的SQL语句。

示例代码

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import org.springframework.stereotype.Service;

@Service
public class UserService extends ServiceImpl<UserMapper, User> {
    public Page<User> getUsersByCondition(Integer pageIndex, Integer pageSize, String name, Integer age) {
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        if (name != null) {
            queryWrapper.eq("name", name);
        }
        if (age != null) {
            queryWrapper.eq("age", age);
        }
        return this.page(new Page<>(pageIndex, pageSize), queryWrapper);
    }
}

5.2 Lambda查询

Lambda查询是MyBatis-Plus提供的另一种构建查询条件的方式。通过Lambda表达式，可以更加简洁地构建复杂的查询条件。

示例代码

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import org.springframework.stereotype.Service;
import java.util.List;

@Service
public class UserService extends ServiceImpl<UserMapper, User> {
    public List<User> getUsersByLambda(String name, Integer age) {
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        if (name != null) {
            queryWrapper.lambda().eq(User::getName, name);
        }
        if (age != null) {
            queryWrapper.lambda().eq(User::getAge, age);
        }
        return this.list(queryWrapper);
    }
}

5.3 自定义SQL

MyBatis-Plus允许我们编写自定义的SQL语句，以满足特定的需求。自定义SQL可以通过@Select、@Insert、@Update、@Delete等注解来定义。

示例代码

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;

public interface UserMapper extends BaseMapper<User> {
    @Select("SELECT * FROM user WHERE age > #{minAge} AND age < #{maxAge}")
    List<User> selectByAgeRange(Integer minAge, Integer maxAge);

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

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

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

常见问题与解决方案

6.1 运行时常见异常

在使用MyBatis-Plus过程中，可能会遇到一些常见的运行时异常，例如SQL执行错误、数据库连接问题等。

示例代码

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import org.springframework.stereotype.Service;

@Service
public class UserService extends ServiceImpl<UserMapper, User> {
    public User getUserById(Long id) throws Exception {
        try {
            return this.getById(id);
        } catch (Exception e) {
            e.printStackTrace();
            throw new Exception("Failed to get user by id");
        }
    }
}

6.2 解决方案与技巧

遇到运行时异常时，可以按照以下步骤进行排查和解决：

检查SQL语句：确保SQL语句正确无误，没有语法错误。
检查数据库连接：确保数据库连接信息正确，数据库服务正常运行。
查看日志信息：查看日志信息，寻找异常的具体原因。
增加异常处理：增加适当的异常处理逻辑，避免程序崩溃。

示例代码

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import org.springframework.stereotype.Service;

@Service
public class UserService extends ServiceImpl<UserMapper, User> {
    public User getUserById(Long id) throws Exception {
        try {
            return this.getById(id);
        } catch (Exception e) {
            e.printStackTrace();
            throw new Exception("Failed to get user by id");
        }
    }
}

6.3 常见配置误区

在配置MyBatis-Plus时，可能会出现一些常见的配置误区，例如配置错误导致功能失效、配置冲突等。

示例代码

mybatis-plus:
  configuration:
    dialect: mysql
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    auto-mapped: false
    cache-enabled: false

配置错误示例

mybatis-plus:
  configuration:
    dialect: oracle
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

在上述配置中，数据库方言配置错误，将MySQL误配置为Oracle，会导致数据库连接失败。

配置冲突示例

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    log-impl: org.apache.ibatis.logging.jdbc.JdbcLogger

在上述配置中，log-impl配置了两次，会导致配置冲突。

通过以上步骤，可以有效地避免配置误区，确保MyBatis-Plus的正常运行。

总结

本文通过详细介绍MyBatis-Plus的基本概念、快速入门、实体类与Mapper接口、常用注解与标签、高级功能以及常见问题与解决方案，帮助开发者快速掌握MyBatis-Plus的核心特性和使用方法。希望读者能够通过本文的介绍，更好地理解和应用MyBatis-Plus，在实际项目中提高开发效率和代码质量。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

繁花如伊

手记
篇

粉丝

39

获赞与收藏

295

关注作者，订阅最新文章

相关文章推荐

mybatis-plus的使用 ------ 入门

MyBatis-Plus

【九月打卡】第8天 mybatis-plus入门

【学习打卡】第1天MyBatis-Plus入门

MyBatis-Plus | 最简单的查询操作教程（Lambda）

阅读免费教程

Java并发工具

23个小节 19133 310

Java 并发原理入门教程

26个小节 38736 565

Java 入门教程

50个小节 339380 3141

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空

MyBatis-Plus资料入门教程

MyBatis-Plus简介

1.1 MyBatis与MyBatis-Plus的关系

1.2 MyBatis-Plus的主要特性

1.3 MyBatis-Plus的核心设计理念

快速入门

2.1 Maven依赖配置

2.2 创建数据库连接

2.3 配置MyBatis-Plus

2.4 第一个简单的CRUD操作

实体类与Mapper接口

3.1 定义实体类

3.2 自动创建Mapper接口

3.3 自定义Mapper接口方法

常用注解与标签

4.1 实体类注解

4.2 映射标签

4.3 Mapper方法注解

高级功能介绍

5.1 条件构造器

5.2 Lambda查询

5.3 自定义SQL

常见问题与解决方案

6.1 运行时常见异常

6.2 解决方案与技巧

6.3 常见配置误区

总结

相关文章推荐

阅读免费教程