SpringBoot整合Mybatisplus

Mybatis-Plus 实战教程

1.什么是Mybatis-Plus

1.1 什么是mybatis-plus

官网:https://www.mybatis-plus.com/guide/

MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。

SpringBoot整合Mybatisplus_第1张图片

1.2 官方愿景

SpringBoot整合Mybatisplus_第2张图片

1.3 特性

  • 无侵入只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
  • 损耗小启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
  • 强大的 CRUD 操作内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求
  • 支持 Lambda 形式调用通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
  • 支持主键自动生成支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解决主键问题
  • 支持 ActiveRecord 模式支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大的 CRUD 操作
  • 支持自定义全局通用操作支持全局通用方法注入( Write once, use anywhere )
  • 内置代码生成器采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用
  • 内置分页插件基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通 List 查询
  • 分页插件支持多种数据库支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
  • 内置性能分析插件可输出 Sql 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询
  • 内置全局拦截插件提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作

1.4 支持数据库

  • mysql 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver

1.5 框架结构

SpringBoot整合Mybatisplus_第3张图片

从图中我们可以看出,使用mybatis-plus可以自动起别名,完成java对象与数据库中记录的映射,以及自动创建CRUD,无需再去创建mapper配置文件了。


2. 快速入门

2.1 创建springboot项目

SpringBoot整合Mybatisplus_第4张图片

SpringBoot整合Mybatisplus_第5张图片

1.引入依赖

 <dependency>
   <groupId>com.baomidougroupId>
   <artifactId>mybatis-plus-boot-starterartifactId>
   <version>3.2.0version>
dependency>
  • 注意:不需要在引入mybatis的相关依赖,只引入这一个即可,当然数据库相关的驱动还的显式引入

因为要连接数据库,所以我们需要引入mysql、druid等依赖,下面是项目中所有的依赖

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-webartifactId>
dependency>

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-devtoolsartifactId>
    <scope>runtimescope>
    <optional>trueoptional>
dependency>
<dependency>
    <groupId>mysqlgroupId>
    <artifactId>mysql-connector-javaartifactId>
    <scope>runtimescope>
dependency>
<dependency>
    <groupId>org.projectlombokgroupId>
    <artifactId>lombokartifactId>
    <optional>trueoptional>
dependency>
<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-testartifactId>
    <scope>testscope>
dependency>

<dependency>
    <groupId>com.baomidougroupId>
    <artifactId>mybatis-plus-boot-starterartifactId>
    <version>3.2.0version>
dependency>

<dependency>
    <groupId>com.alibabagroupId>
    <artifactId>druidartifactId>
    <version>1.1.19version>
dependency>

为了防止创建maven过慢,我们可以使用阿里巴巴的镜像

<repositories>
    <repository>
        <id>aliyun-reposid>
        <url>http://maven.aliyun.com/nexus/content/groups/public/url>
        <snapshots>
            <enabled>falseenabled>
        snapshots>
    repository>
repositories>
<pluginRepositories>
    <pluginRepository>
        <id>aliyun-pluginid>
        <url>http://maven.aliyun.com/nexus/content/groups/public/url>
        <snapshots>
            <enabled>falseenabled>
        snapshots>
    pluginRepository>
pluginRepositories>

2.在入口类加入注解

@SpringBootApplication
@MapperScan("com.baizhi.dao")    // 扫描dao接口所在的包
public class SpringbootMybatisplusApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootMybatisplusApplication.class, args);
    }

}

3.编写配置文件

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatisplus?characterEncoding=UTF-8
spring.datasource.username=root
spring.datasource.password=root

logging.level.root=info
logging.level.com.baizhi.dao=debug

2.2 创建数据库以及表结构

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) DEFAULT NULL,
  `age` int(11) DEFAULT NULL,
  `bir` timestamp NULL DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

SET FOREIGN_KEY_CHECKS = 1;

2.3 开发实体类

实体类是什么,mybatisplus就会去数据库中找相同名字的表

@Data               //lombok的注解用来生成get set 等相关方法
@AllArgsConstructor //有参构造
@NoArgsConstructor  //无参构造
@ToString           //toString方法
@Accessors(chain = true) // 不写默认为false,当该值为 true 时,对应字段的 setter 方法调用后,会返回当前对象。
public class User {
    private String id;
    private String name;
    private Integer age;
    private Date bir;
}

2.4 开发mapper通用实现

import com.baomidou.mybatisplus.core.mapper.BaseMapper; //提供了各种CRUD方法
// 使用mybatisplus的接口增强功能
public interface UserDAO extends BaseMapper<User> { 
    // 方法不够的话在DAO接口中写方法,然后写相应的mapper配置文件对其做实现
    // 如果官网提供的方法不够用的话,可以在这里自己写方法并写相应的mapper配置文件即可
}

2.5 测试

@Autowired
private UserDAO userDAO;
@Test
void contextLoads() {
  List<User> users = userDAO.selectList(null);
  System.out.println(users);
}

3.常用注解说明

  • @TableName
  • @TableId
  • @TableField

3.1 @TableName注解

  • 描述:用来将实体对象与数据库表名完成映射
  • 修饰范围: 用在类上
  • 常见属性:
    • value: String类型,指定映射的表名
    • resultMap: String类型,用来指定XML配置中resultMap的id值

3.2 @TableId注解

  • 描述主键注解

  • 当前对象的哪个属性对应数据库的主键

  • 修饰范围:用在属性上

  • 常见属性:

    • value: String类型,指定实体类中与表中对应的主键列名
    • type: 枚举类型,指定主键生成类型
      • type属性写枚举类 IdType.AUTO

    SpringBoot整合Mybatisplus_第6张图片

3.3 @TableField

  • 描述字段注解(非主键)
  • 修饰范围:用在属性上
  • 常用属性:
    • value: String类型,用来指定对应的数据库表中的字段名
    • el: String类型,映射为原生 #{ ... } 逻辑,相当于写在 xml 里的 #{ ... } 部分 3.0不存在
    • exist
      • 如果对象中某一个属性不是数据库表中的字段,我们可以加上这个属性,以免将它作为数据库的列而产生错误
      • boolean是否为数据库表字段 true代表是数据库字段,false代表不是

@Data               //lombok的注解用来生成get set 等相关方法
@AllArgsConstructor //有参构造
@NoArgsConstructor  //无参构造
@ToString           //toString方法
@Accessors(chain = true) // 不写默认为false,当该值为 true 时,对应字段的 setter 方法调用后,会返回当前对象。
@TableName("tuser")  // 指定数据库中与该对象对应的表的名称
public class User {
    @TableId(value = "id", type = IdType.AUTO)  // 指定该属性与表中的主键字段对应,value不写表中字段为属性名
    private String id;
    @TableField     // 指定该属性与表中哪个字段对应,value属性写字段名,不写表示字段名与属性名一致
    private String name;
    @TableField     // 指定该属性与表中哪个字段对应,value属性写字段名,不写表示字段名与属性名一致
    private Integer age;
    @TableField     // 指定该属性与表中哪个字段对应
    private Date bir;

    @TableField(exist = false)   // 指定该属性不与表中字段对应
    private String aaa;
}

4.常用方法

4.1 查询方法

selectList方法中的参数是用来帮我们做条件查询的,如果为参数为null代表查询所有数据

  • 查询所有

    @Test
    public void testFindAll(){
      List<User> users = userDAO.selectList(null);
      users.forEach(user-> System.out.println("user = " + user));
    }
    
  • 根据主键查询一个

    @Test
    public void testFindOne(){
      User user = userDAO.selectById("1");
      System.out.println("user = " + user);
    }
    
  • 条件查询

    //条件查询
    //泛型里面写实体对象
    @Test
    public void testFind(){
      QueryWrapper<User> queryWrapper = new QueryWrapper<>();
      // 第一个字段应该写数据库中表的字段名
      queryWrapper.eq("age",23);//设置等值查询,查询age等于23的
      //queryWrapper.lt("age",23);//设置小于查询
      //queryWrapper.ge("age",23);//小于等于查询 gt 大于  ge 大于等于
      List<User> users = userDAO.selectList(queryWrapper);
      users.forEach(user-> System.out.println(user));
    }
    
  • 模糊查询

    @Test
    public void testFindAll(){
      QueryWrapper<User> queryWrapper = new QueryWrapper<>();
      // like  %?%   内容中包含对应的值就可以了
      // likeLeft %? 以···结尾的查询
      // likeRight ?% 以···开头的查询
     	// queryWrapper.like("username","小");
      queryWrapper.likeRight("username","小");
      List<User> users = userDAO.selectList(queryWrapper);
      users.forEach(user-> System.out.println("user = " + user));
    }
    
    • like 相当于 %?%
    • likeLeft 相当于 %?
    • likeRight 相当于 ?%

4.2 添加方法

  • ​ 添加方法

    @Test
    public void testSave(){
      User entity = new User();
      entity.setAge(23).setName("小明明").setBir(new Date());
      userDAO.insert(entity);
    }
    

4.3 修改方法

  • 基于id修改

    @Test
    public void testUpdateById(){
      User user = userDAO.selectById("1");
      user.setAge(24);
      userDAO.updateById(user);
    }
    

    基于条件修改

    @Test
    public void testUpdate(){
      User user = new User();
      user.setName("小陈陈");
      QueryWrapper<User> updateWrapper = new QueryWrapper<>();
      updateWrapper.eq(true,"age",23); // 修改age为23的记录
      userDAO.update(user, updateWrapper); // 修改age为23的记录的name修改为百知教育
    }
    

4.4 删除方法

  • 基于id删除

    @Test
    public void testDeleteById(){
      userDAO.deleteById("3");
    }
    
  • 基于条件删除

    @Test
    public void testDelete(){
      QueryWrapper<User> wrapper = new QueryWrapper<>();
      wrapper.lambda().gt("age",23);  // 删除年龄大于
      wrapper.lambda().eq(true,User::getAge,23);
      userDAO.delete(wrapper);
    }
    

5.Mybatis-Plus分页查询

分页查询的原理就是在查询之后加上分页的拦截,所以我们要实现在工厂中注册拦截器类,所以我们实现需要创建一个 MybatisPlusConfig 类。

0.预先配置

  • 注意:使用分页查询必须设置mybatis-plus提供的分页插件(配置),才能实现分页效果

    @EnableTransactionManagement     // 支持事务管理
    @Configuration                   // 代表这是一个配置类
    @MapperScan("com.baizhi.dao")    // 扫描dao接口所在的包
    public class MybatisPlusConfig {
        // 分页的拦截器对象
        @Bean
        public PaginationInterceptor paginationInterceptor() {
            PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
            return paginationInterceptor;
        }
    }
    
    

    注意事项:目前分页查询仅仅支持单表查询,不能在表连接时使用分页插件

1.分页查询

  • 非条件分页查询

    // 分页查询
    @Test
    public void testFindPage(){
      // 参数1:当前页从第几页开始  参数2:当前页显示几条记录
      // 不传参的话当前页从第1页开始,当前页显示10条记录
      IPage<User> page = new Page<>(1, 2);
      IPage<User> userIPage = userDAO.selectPage(page, null);
      // 获取总记录数
      System.out.println("总记录数:" + userIPage.getTotal());
      // 获取指定条件的记录
      userIPage.getRecords().forEach(user -> System.out.println("user = " + user));
    }
    
  • 带条件分页查询

    @Test
    public void testFindAll(){
      QueryWrapper<User> queryWrapper = new QueryWrapper<>();
      queryWrapper.eq("age",23);
      IPage<User> page = new Page<>(1,2);
      page = userDAO.selectPage(page, queryWrapper);
      page.getRecords().forEach(user-> System.out.println("user = " + user));
    }
    

6. Mybatis-Plus多数据源配置

引言

为了确保数据库产品的稳定性,很多数据库拥有双机热备功能。也就是,第一台数据库服务器,是对外提供增删改业务的生产服务器;第二台数据库服务器,主要进行读的操作。·

注意:这里我并没有讲解关于主从同步的配置,只是讲了关于多数据源切换的配置,读写分离配置

SpringBoot整合Mybatisplus_第7张图片

6.1 引入dynamic-datasource-spring-boot-starter依赖

<dependency>
    <groupId>com.baomidougroupId>
    <artifactId>dynamic-datasource-spring-boot-starterartifactId>
    <version>3.0.0version>
dependency>

6.2 配置数据源

使用多数据源的话就不需要原来application.properties中的dataSource配置了,使用下面的配置即可

spring.datasource.primary=master  #指定默认数据源

spring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.dynamic.datasource.master.url=jdbc:mysql://localhost:3306/mybatis-plus?characterEncoding=UTF-8
spring.datasource.dynamic.datasource.master.username=root
spring.datasource.dynamic.datasource.master.password=root

spring.datasource.dynamic.datasource.slave_1.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.dynamic.datasource.slave_1.url=jdbc:mysql://localhost:3306/mybatisplus-1?characterEncoding=UTF-8
spring.datasource.dynamic.datasource.slave_1.username=root
spring.datasource.dynamic.datasource.slave_1.password=root

6.3 创建多个数据库模拟不同mysql服务

一个mybatisplus数据库,一个是mybatisplus-1数据库

6.4 @DS注解

  • 作用: 用来切换数据源的注解
  • 修饰范围: 方法上和类上同时存在则方法注解优先于类上注解
  • Value属性: 切换数据源名称(不是数据库名称,是application.propertis配置文件中的,比如:master、slave_1等)
  • 不使用这个注解的话默认就是master

6.5 开发业务层

  • 业务接口

    public interface UserService{
        List<User> findAll();
        void save(User user);
    }
    
  • 业务实现类

    @Service
    @Transactional
    public class UserServiceImpl implements UserService {
    
        @Autowired
        private UserDAO userDAO;
    
        @Override
      	@DS("slave_1")
        public List<User> findAll() {
            return userDAO.selectList(null);
        }
    
        @Override
        public void save(User user) {
            userDAO.insert(user);
        }
    }
    

6.6 测试结果

package com.baizhi;

import com.baizhi.entity.User;
import com.baizhi.service.UserService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Date;

@SpringBootTest
public class TestUserService {

    
    @Autowired
    private UserService userService;
    
    @Test
    public void testFindAll(){
        userService.findAll().forEach(user-> System.out.println("user = " + user));
    }

    @Test
    public void testSave(){
        User user = new User();
        user.setName("aaa").setAge(23).setBir(new Date());
        userService.save(user);
    }
}

你可能感兴趣的:(Mybatis,后端,java,数据库,mysql,mybatisplus)