网站首页 > 技术文章正文

Springboot+MybatisPlus高效实现增删改查

nanyue 2024-10-26 11:17:30 技术文章 3 ℃

Mybatis-Plus基于mybatis做了增强，大大简化了单表CRUD操作，而且Mybatis-Plus是无侵入性的，不会影响现有项目，Mybatis-Plus提供了代码生成器，可以根据数据库表一键生成对应的service、mapper、xml文件，service和mapper提供了丰富的CRUD操作方法，xml文件也是非常简洁。

目前最新版本是3.4.1版本。

蛮看一下框架结构图，

接下去我们就以该版本来讲解下Mybati-Plus的各种用法。

本文分为以下几个部分讲解：

引入Mybatis-Plus依赖
代码生成器
配置Mybatis-Plus
CURD示例
条件构造
分页
扩展功能

一、引入Mybatis-Plus依赖

本文示例使用maven作为依赖管理，在pom.xml文件引入springboot和Mybatis-plus的依赖，使用的是最新版的mybatis-plus。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.0</version>
    <relativePath/>
</parent>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.4.1</version>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.4.1</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-freemarker</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

springboot的依赖：提供了使用springboot的能力。

mybatis-plus-generator依赖：用于生成集成Mybatis-plus的代码。

freemarker依赖：因为生成代码需要用到模板。

mysql连接依赖：用于数据库连接，生成代码和数据库操作时都需要该依赖。

二、代码生成器

Mybatis-plus代码生成器用于生成一个集成了Mybatis-plus的框架结构，一般会生成以下几个文件。

entity实体类：对应数据库中的表的实体类，有各种Mybatis-plus的注解可以使用，比如主键生成策略、逻辑删除、自动填充等。
xml文件：Mybatis的sql配置文件，对应Mapper接口。
Mapper接口：就是我们平常所说的Dao层暴露的方法所在接口，接口中的方法对应xml文件中对应的sql，封装了一些常用的增删改查方法。
service接口+service实现类：集成了Mybatis-plus的封装类，封装了一些常用的增删改查方法，默认引入了对应的Mapper。
controller类：此类并没有什么Mybatis-plus的内容，就是普通的前端请求接口控制层入口，在此引入service。

生成代码需要三个步骤：

写一个生成代码的方法
数据库建表
运行生成代码方法输入表名生成各文件

1.生成代码示例

我这里提供一个我的生成器代码示例，只要修改成你自己的包名、数据库连接，作者信息、生成路径即可。

package com.huangtl.user;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

public class CodeGenerator {
    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("程序员柳大侠");
        gc.setBaseResultMap(true);
        gc.setBaseColumnList(true);
//        gc.setSwagger2(true); //true 开启 swagger2 模式
        gc.setOpen(false);
        gc.setIdType(IdType.NONE);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.MYSQL);
        dsc.setUrl("jdbc:mysql://192.168.67.129:3306/mybatis_plus?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&serverTimezone=UTC");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("user");
        pc.setParent("com.huangtl");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        List<FileOutConfig> focList = new ArrayList<>();
        focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输入文件名称
                return projectPath + "/src/main/resources/mapper/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        mpg.setTemplate(new TemplateConfig().setXml(null));

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//        strategy.setEntityLombokModel(true); //是否为lombok模型
        strategy.setRestControllerStyle(true);
        strategy.setInclude(scanner("表名"));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        strategy.setEntityTableFieldAnnotationEnable(true);
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

你可以修改这里的配置，比如类名规则（下划线转驼峰）、id生成策略（自增、UUID等）、生成swagger注释、使用Lombok注释等。

2.数据库建表

我这里建个user表用于后面的示例,总共三个字段：id、nick_name、age

3.运行生成器代码

控制台提示输入表名时输入表名回车即可生成。

生成完整目录如下：

三、配置Mybatis-Plus

在使用Mybatis-Plus之前我们还需要进行一些配置，包括springboot启动类、数据库连接和Mybatis-Plus的配置。

1.springboot启动类：

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

2.application.yml文件：

server:
  port: 8092

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.67.129:3306/mybatis_plus?useUnicode=true&serverTimezone=Asia/Shanghai&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
    username: root
    password: root

mybatis-plus:
  mapper-locations: classpath*:mapper/**/*.xml
  #实体扫描，多个package用逗号或者分号分隔
  type-aliases-package: com.huangtl.user.entity
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

主要配置了数据库连接和mybatis-plus的扫描，dao层的Mapper扫描还需要一个配置类。

3.MybatisPlusConfig类：

package com.huangtl.user.config;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@MapperScan({"com.huangtl.user.mapper*"})
public class MybatisPlusConfig {
}

@Configuration说明是springboot的配置类。

@MapperScan指定扫描指定位置的Mapper接口。

好了，这样你就可以使用顺利使用Mybatis-Plus的代码操作数据库了，接下去看下Mybatis-Plus的使用示例。

四、CURD示例

生成的代码结构上面已经解释了，我们这里主要看下service层的类,这里包含了几乎所有的新增改查方法。

先看下service实现类。

这里主要是继承了Mybatis-Plus的一个service实现类，通过泛型的方式将Dao层Mapper类和实体类引入。增删改查方法都在该类。我们可以直接调用该父类方法操作数据库，比如根据id获取一个用户信息方法：

User byId = this.getById(1);

后面的的例子中都在UserServiceImpl中，所以都使用this关键字调用，如果需要其他类调用只需要注入该类即可。

1.新增

public void testInsert(){
    User user = new User();
    user.setNickName("程序员柳大侠");
    user.setAge(90);
    this.save(user);
}

效果：

2.修改

public User testUpdate(int id){
    User user = new User();
    user.setId(id);
    user.setNickName("柳大侠");
    user.setAge(20);
    this.updateById(user);
    return user;
}

效果：

其他修改方式：

//1.新增或修改
this.saveOrUpdate(user);

//2.lambda表达式修改
this.update(Wrappers.lambdaUpdate(User.class).set(User::getNickName,"柳大侠").eq(User::getId,id));

//3.数据库原字段修改
this.update(new UpdateWrapper<User>().set("nick_name","柳大侠").eq("id",id));

//4.批量修改
List<User> list = new ArrayList<>();
list.add(user);
this.updateBatchById(list);

3.删除

物理删除

默认都是物理删除，会删除数据库中的该条记录。

public void remove(int id){
    this.removeById(id);
}

其他方式：

//lambda表达式方式
this.remove(Wrappers.lambdaQuery(User.class).eq(User::getId,id));
//数据库原字段方式
this.remove(new QueryWrapper<User>().eq("id",id));
//批量删除
this.removeByIds(ids);

逻辑删除

逻辑删除不会删除数据库中的记录，只会修改删除标志字段。

使用方式，在字段上加上@TableLogic注解。

@TableLogic
private Integer deleted;

默认1为已删除，0为未删除。

当你调用删除方法比如removeById时不会删除记录，只会把deleted字段改为1；

你也可以配置已删除/未删除的标志值。

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置注解@TableLogic)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

4.查询

查询方式可以查询单条记录信息和多条信息，示例如下：

//单个查询
User user = this.getById(id);

//lambda表达式
User user = this.getOne(Wrappers.lambdaQuery(User.class)
                        .eq(User::getId,id));

//数据库原字段
User user = this.getOne(new QueryWrapper<User>()
                        .eq("id",id));

//查询多条记录
List ids = new ArrayList();
ids.add(1);
ids.add(2);
List<User> users = this.listByIds(ids);

//查询20岁到30岁之间的用户
List<User> users = this.list(Wrappers.lambdaQuery(User.class)
        .ge(User::getAge,20)
        .le(User::getAge,30));

//查询20岁或者30岁之间的用户
List<User> users = this.list(Wrappers.lambdaQuery(User.class)
        .eq(User::getAge,20)
        .or().eq(User::getAge,30));

//查询年龄最小的10条记录
List<User> users = this.list(Wrappers.lambdaQuery(User.class)
                             .orderByAsc(User::getAge)
                             .last("limit 10"));

可以使用func方法根据参数指定对应的sql语句：

String orderColumn = "age";
List<User> users = this.list(Wrappers.lambdaQuery(User.class)
        .func(w->{
            //如果排序列是年龄则根据年龄排序
            if("age".equals(orderColumn)){
                w.orderByAsc(User::getAge);
            }else if("nickName".equals(orderColumn)){
                //如果排序列是昵称则根据昵称排序
                w.orderByAsc(User::getNickName);
            }
        }));

五、分页

在3.4.0版本以前使用的是PaginationInterceptor，只需要在配置类中定义：

@Bean
public PaginationInterceptor paginationInterceptor() {
    PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
    return paginationInterceptor;
}

3.4.0以后使用的是MybatisPlusInterceptor：

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
    return interceptor;
}

接口写法：

@GetMapping()
public Page queryPage(@RequestBody Page page){
    page = userService.page(page, Wrappers.lambdaQuery(User.class).orderByAsc(User::getAge));
    return page;
}

这里主要使用到了userService的page方法，也是Mybatis-Plus提供的，返回的也是一个Page对象。

Page类对应的是com.baomidou.mybatisplus.extension.plugins.pagination.Page;

主要属性如下：

records：返回记录

total：总页数

size：每页显示条数

current：当前页

pages：总页数

前端请求体如下：

{
    "size":10,
    "current":1
}

一般前端只需要传size和current即可。

返回内容体如下：

{
    "records": [
        {
            "id": 2,
            "nickName": "程序员柳大侠",
            "age": 90
        }
    ],
    "total": 1,
    "size": 10,
    "current": 1,
    "orders": [],
    "optimizeCountSql": true,
    "hitCount": false,
    "countId": null,
    "maxLimit": null,
    "searchCount": true,
    "pages": 1
}

扩展分页参数

一般来讲我们需要前端传一些自定义参数，而不仅是page中的参数，那么可以这样子写。

比如我们需要多传一个maxAge最大年龄查询参数。

定义一个请求参数体继承Page类。

public class pageDto extends Page {
    private int maxAge;

    public int getMaxAge() {
        return maxAge;
    }

    public void setMaxAge(int maxAge) {
        this.maxAge = maxAge;
    }
}

定义接口使用自定义的请求体

@GetMapping("/page")
public Page queryPage(@RequestBody pageDto page){
    page = userService.page(page, Wrappers.lambdaQuery(User.class)
                            .le(User::getAge,page.getMaxAge())
                            .orderByAsc(User::getAge));
    return page;
}

前端请求参数

{
    "size":10,
    "current":1,
    "maxAge":100
}

如果不想使用上面的写法，Page也提供了许多构造函数，当前页和显示条数你可以自己定义参数，然后通过Page的构造函数new Page(...)出来，最后再调用userService.page(E page, Wrapper<T> queryWrapper)即可。

new Page(long current, long size);
new Page(long current, long size, long total);
newPage(long current, long size, boolean isSearchCount);
......

六、扩展功能

这里讲两个常用的扩展功能，分别是自动填充属性和枚举属性。

1.自动填充属性

有时候我们需要在新增或更新数据库时自动给一些字段赋值，比如新增时自动赋值创建时间，更新时自动赋值更新时间。

先写各配置类。

package com.huangtl.user.config;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;

/**
* @Description 参数填充
* @Author 程序员柳大侠
**/
@Configuration
@Component
public class MybatisMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
    }
  
    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
    }
}

定义了新增和更新填充方法，光这样还不行，你需要在实体类的字段上添加@TableField注解并指定fill属性，如下：

@TableField(value = "create_time",fill = FieldFill.INSERT)
private LocalDateTime createTime;

FieldFill.INSERT代表新增时会赋值。如果希望新增时也赋值更新时间字段，可以使用fill = FieldFill.INSERT_UPDATE 。

@TableField(value = "update_time",fill = FieldFill.INSERT_UPDATE)
private LocalDateTime updateTime;

我们来试试，给user表增加create_time和update_time字段。

执行新增方法

User user = new User();
user.setNickName("程序员柳大侠");
user.setAge(90);
this.save(user);

可以看到已经自动填充了创建时间和更新时间

我们再来执行下更新方法。

User user = new User();
user.setId(id);
user.setNickName("柳大侠");
user.setAge(20);
this.updateById(user);

需要注意的是，有部分更新方法无法自动填充，可以使用updateById方法。

2.枚举属性

有时候我们有一些字段只会出现固定的值，我们可以用枚举属性来表示，比如性别只有男女，数据库我们可能用0和1表示。

首先需要修改下配置文件，增加一个mybatis-plus.typeEnumsPackage参数，扫描你的枚举所在的包位置。

mybatis-plus:
  mapper-locations: classpath*:mapper/**/*.xml
  #实体扫描，多个package用逗号或者分号分隔
  type-aliases-package: com.huangtl.user.entity
  typeEnumsPackage: com.huangtl.user.enums
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

我们以性别属性为例，我们新增一个sex字段和枚举类。示例如下：

package com.huangtl.user.enums;

import com.baomidou.mybatisplus.annotation.EnumValue;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.HashMap;
import java.util.Map;

public enum SexEnum {
    MAN(0,"男"),
    WOMAN(1,"女"),
    ;

    SexEnum(int code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    @EnumValue
    private final int code;
    private final String desc;

    @JsonValue
    public Map result() {
        Map map = new HashMap();
        map.put("code",code);
        map.put("desc",desc);
        return map;
    }
}

@EnumValue 注解说明我们再数据库中保存的是该值。

@JsonValue 注解代表我们查询返回给前端的属性对象。

在实体类中定义sex属性（get/set方法别漏了）。

@TableField("sex")
private SexEnum sex;

我们将数据库增加一个sex字段，新增一个带sex的User。

User user = new User();
user.setNickName("程序员柳大侠");
user.setAge(90);
user.setSex(SexEnum.MAN);
this.save(user);

这里有个坑，数据库字段类型要int类型，不能用tinyint。

我们来测试下刚才的分页接口看返回的内容是什么。

{
    "records": [
        {
            "id": 3,
            "nickName": "柳大侠",
            "age": 20,
            "createTime": "2020-11-26 14:44:05",
            "updateTime": "2020-11-26 14:46:25",
            "sex": null
        },
        {
            "id": 2,
            "nickName": "程序员柳大侠",
            "age": 90,
            "createTime": null,
            "updateTime": null,
            "sex": null
        },
        {
            "id": 4,
            "nickName": "程序员柳大侠",
            "age": 90,
            "createTime": "2020-11-26 15:15:25",
            "updateTime": "2020-11-26 15:15:25",
            "sex": {
                "code": 0,
                "desc": "男"
            }
        },
        {
            "id": 5,
            "nickName": "程序员柳大侠",
            "age": 90,
            "createTime": "2020-11-26 15:16:46",
            "updateTime": "2020-11-26 15:16:46",
            "sex": {
                "code": 1,
                "desc": "女"
            }
        }
    ],
    "total": 4,
    "size": 10,
    "current": 1,
    "orders": [],
    "optimizeCountSql": true,
    "hitCount": false,
    "countId": null,
    "maxLimit": null,
    "searchCount": true,
    "pages": 1
}

可以看到我们后面新加的用户sex返回的json格式包含值和描述，这样前端展示时也不用判断0显示男、1显示女了，直接展示后端返回的内容就可以了。

总结一下

本文主要针对以下几个部分进行讲解：

引入Mybatis-Plus依赖
代码生成器
配置Mybatis-Plus
CURD示例
条件构造
分页
扩展功能

在实际使用中还是比较方便的，配合lambda表达式代码也比较优雅，还有一些功能本文并没有介绍，可以自行去查阅。

上一篇：【Mybatis实战第4天】三步搞定 Mybatis更新(update)操作
下一篇：巨坑!常见的 update 语句竟容易造成Bug

网站首页 > 技术文章 正文