springboot2.x:整合mybatis-plus

山禾说      2022-04-23     715

关键词:

简介

Mybatis-Plus是在Mybatis的基础上,国人开发的一款持久层框架。
技术分享图片
并且荣获了2018年度开源中国最受欢迎的中国软件TOP5技术分享图片
同样以简化开发为宗旨的Spring BootMybatis-Plus放在一起会产生什么样的化学反应呢?下面我们来领略一下两者配合带来的效率上的提升。

Mybatis-Plus的作用

技术分享图片
可以看到,它给我们提供了一些核心的功能:代码生成器和现成的CRUD接口以及可以结合Lambda的条件构造器使我们的代码变得足够优雅,分页的使用也是相当的方便,以及提供了不同的主键生成策略。
如果这些功能不能满足我们的需求,Mybatis-Plus还提供了丰富的插件供我们去使用,我们接下来只讲核心功能,插件的使用会在后面的文章中进行部分的讲解,感兴趣的同学可以先去看一下官方的文档

使用第一步:引入POM

首先我们需要引入POM,我在这里引用的是最新版本的:
技术分享图片
接着,如果我们需要使用代码生成器,需要引入模板引擎的依赖:
技术分享图片
到此,pom的引入就告一段落,下面我们来看一下配置文件的编写:

使用第二步:编写配置文件

这里我们使用的是application.yml作为配置文件,而非新建Spring Boot项目默认的application.properties,这里如果不会新建一个Spring Boot项目,可以去参考本系列教程的第一篇文章
技术分享图片
在这里可以进行打印SQL的配置,便于我们进行排查问题。

使用第三步:建表

技术分享图片

使用第四步:使用代码生成器

直接贴出我的代码生成器代码:

public class MpGenerator {
    public static void main(String[] args) {
        GlobalConfig config = new GlobalConfig();
        String dbUrl = "jdbc:mysql://localhost:3306/viboot?useSSL=false";
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setDbType(DbType.MYSQL)
                .setUrl(dbUrl)
                .setUsername("root")
                .setPassword("Passw0rd")
                .setDriverName("com.mysql.cj.jdbc.Driver");
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig
                .setCapitalMode(true)
                //这里结合了Lombok,所以设置为true,如果没有集成Lombok,可以设置为false
                .setEntityLombokModel(true)
                .setNaming(NamingStrategy.underline_to_camel);
        //这里因为我是多模块项目,所以需要加上子模块的名称,以便直接生成到该目录下,如果是单模块项目,可以将后面的去掉
        String projectPath = System.getProperty("user.dir") + "/viboot-mybatis-plus";
        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
            }
        };
        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名
                return projectPath + "/src/main/resources/mapper/" + "user"
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });

        cfg.setFileOutConfigList(focList);

        //设置作者,输出路径,是否重写等属性
        config.setActiveRecord(false)
                .setEnableCache(false)
                .setAuthor("viyoung")
                .setOutputDir(projectPath + "/src/main/java")
                .setFileOverride(true)
                .setServiceName("%sService");
        new AutoGenerator()
                .setGlobalConfig(config)
                .setDataSource(dataSourceConfig)
                .setStrategy(strategyConfig)
                .setTemplateEngine(new FreemarkerTemplateEngine())
                .setCfg(cfg)
                //这里进行包名的设置
                .setPackageInfo(
                        new PackageConfig()
                                .setParent("indi.viyoung.viboot.mybatis")
                                .setController("controller")
                                .setEntity("entity")
                                .setMapper("mapper")
                                .setServiceImpl("service.impl")
                                .setService("service")
                ).execute();
    }
}

下面我们来运行main方法,就可以看到生成的包:
技术分享图片
mapper包下面xml包删掉,因为我们已经在resources中生成了*mapper.xml文件。
这里需要注意,需要在SpringBoot的启动类上配置MapperScan来帮助我们去找到持久层接口的位置。
技术分享图片

使用第四步:编写查询列表进行测试

技术分享图片
没错,我们只需要写一行代码就可以获取到我们想要的列表,下面我们来访问一下
技术分享图片

IService与BaseMapper

有些人可能会好奇,为什么我们只需要在controller层中直接去调用就可以获得到列表,这是因为Mybatis-Plus给我们封装了一系列的CRUD的基础接口,在通过代码生成器生成的UserService接口实际上是继承了IService接口的,而UserServiceImpl则是继承ServiceImpl,所以就可以获取到一些基础的实现。
技术分享图片
技术分享图片
IService则给我们提供了以下方法来实现基础的CRUD:
技术分享图片
同样的,BaseMapper接口也提供了一些实现:
技术分享图片
通过这些基础的实现,我们可以完成日常中大部分的基础查询,而省去了编写Service和ServiceImpl的时间,从编码效率上来讲比起JPA更胜一筹。

条件构造器

条件构造器可以构造一些查询条件来获取我们指定的值,同时可以结合Lambda表达式来使用,下面我们直接来编写两个例子:
技术分享图片
技术分享图片

可以看到,被注释掉的部分是不使用Lambda表达式的写法,这样的写法存在魔法值,而且会由于粗心写错column的名称而导致错误,但是使用Lambda表达式就足够直观的可以看出我们是想查询出userName = ?的数据,下面,我们来运行一下,看看结果是否符合我们预期的那样

技术分享图片
当然,条件构造器的用法还有许许多多,这里就不在一一罗列,有需要的同学可以去官网查看文档

分页查询

如果我们需要分页查询数据去渲染表格,可以使用Mybatis-Plus自带的分页插件:
技术分享图片
在启动类中加入上面的代码,然后我们就可以去使用分页了:
技术分享图片
我们只需要构建一个Page对象,并初始化我们所需的页数(page)和每页数据量(pageSize),然后将其作为page()方法的参数传入即可
下面,我们来访问一下:
技术分享图片
至此,我们的Mybatis-Plus就告一段落了,谢谢您的耐心阅读,希望您有所收获~

原创文章,文笔有限,才疏学浅,文中若有不正之处,万望告知。

源码可以去github(https://github.com/viyog/viboot/)或者码云(https://gitee.com/yw18530069930/viboot)上进行下载,后续的例子都会同步更新。

公众号

技术分享图片

springboot2.x整合redis

#准备工作配置application.ymlspring:thymeleaf:#thymeleafcache:falsedatasource:#datasourcedriver-class-name:com.mysql.cj.jdbc.Driverurl:jdbc:mysql://localhost:3306/mp?useUnicode=true&characterEncoding=utf 查看详情

springboot2.x整合redis

pom文件<!--springboot中的redis依赖--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency>配置#R 查看详情

springboot2.x版本整合redis(单机/集群)(使用lettuce)

在springboot1.x系列中,其中使用的是jedis,但是到了springboot2.x其中使用的是Lettuce。此处springboot2.x,所以使用的是Lettuce。关于jedis跟lettuce的区别:Lettuce和Jedis的定位都是Redis的client,所以他们当然可以直接连接redisserver。Jedis在实现... 查看详情

springboot2.x整合rocketmq4.x

开发生产者代码第一步:创建很普通的SpringBoot项目第二步:加入相关依赖<dependency><groupId>org.apache.rocketmq</groupId><artifactId>rocketmq-client</artifactId><version>4.3.0</version></ 查看详情

springboot2.x整合solr6.x(代码片段)

第一步:pom.xml添加相关jar包依赖<projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.a 查看详情

springboot2.x整合prometheus+grafana附源码(代码片段)

图文并茂,新手入门教程,建议收藏SpringBoot2.x整合Prometheus+Grafana【附源码】附源码+视频[toc]工程简介总体框架图简介PrometheusPrometheus,是一个开源的系统监控和告警的工具包,其采用Pull方式采集时间序列的度量数据(也支持push... 查看详情

springboot2.x整合redis以及连接哨兵模式/集群模式

依赖:<!--spirngboot版本为2.x--><!--加载springbootredis包,springboot2.0中直接使用jedis或者lettuce配置连接池,默认为lettuce连接池,这里使用jedis连接池--><!--加载springbootredis包--><dependency> <groupId>org.spr 查看详情

springboot2.x开发案例之整合quartz任务管理系统

基于spring-boot2.x+quartz的CRUD任务管理系统,适用于中小项目。基于spring-boot+quartz的CRUD任务管理系统:https://gitee.com/52itstyle/spring-boot-quartz开发环境JDK1.8、Maven、Eclipse技术栈SpringBoot2.0.1、thymeleaf3.0.9、quartz2.3.0、iview、vue 查看详情

springboot2.x整合logbackslf4j

Springboot项目的pom里引入的parent<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.0.0.RELEASE</version&g 查看详情

springboot2.x整合dubbo2.7.8+nacos1.4.0

springboot安装:https://blog.neoniou.com/posts/spring-boot-nacos-dubbo/#service-consumer================================  查看详情

springboot整合thymeleaf-基于springboot2.x版本

1、为啥要用Thymeleaf模板引擎?现在不都前后端分离了么?熊dei们,别着急,我们先来谈谈为啥开始用Thymeleaf模板引擎,先照顾照顾下我们这些可爱的小白童鞋....为啥开始用Thymeleaf模板引擎?jsp她不香嘛?首先前端交给我们的页... 查看详情

springboot2.x:整合mybatis-plus

简介Mybatis-Plus是在Mybatis的基础上,国人开发的一款持久层框架。并且荣获了2018年度开源中国最受欢迎的中国软件TOP5同样以简化开发为宗旨的SpringBoot与Mybatis-Plus放在一起会产生什么样的化学反应呢?下面我们来领略一下两者配... 查看详情

消息队列介绍和springboot2.x整合rockketmqactivemq9节课

1、JMS介绍和使用场景及基础编程模型    简介:讲解什么是小写队列,JMS的基础知识和使用场景    1、什么是JMS:Java消息服务(JavaMessageService),Java平台中关于面向消息中间件的接口   2、JMS... 查看详情

springboot2.x+shiro+redis整合填坑redis只做缓存的情况

...pringBoot+shiro已经集成完毕,如果没有集成,先查阅之前的Springboot2.0集成shiro权限管理2、redis已经安装完成3、redis客户端使用Lettuce,这也是sprinboot2.0后默认的,与jedis的区别,自行百度4、json使用springboot默认的一、依赖<dependency&... 查看详情

springboot2.x整合slf4j+logback日志框架(代码片段)

目录1、Slf4j及Logback简介2、日志级别3、maven依赖3.1springboot2maven配置文件3.2普通maven项目的配置文件4、logback、springboot配置说明4.1 logback.xml 和logback-spring.xml的区别4.2logback.xml配置文件的加载机制4.3SpringBoot结合logback配置说明4.3.1logb... 查看详情

springboot2.x整合dubbo2.6.x和dubbo2.7.x

参考技术ADubbo有很长一段时间的发展史,2018年的时候不知道为什么阿里暂更了一年,之后又重新开始更新。之前一直是阿里在维护,后面阿里把它捐给了Apache基金会,由Apache来维护,2.6.x之前,maven中的包名都是alibaba,2.7.0之后... 查看详情

springboot2.x(十四):整合redis,看这一篇就够了

Redis简介Redis是一个开源的使用ANSIC语言编写、遵守BSD协议、支持网络、可基于内存亦可持久化的日志型、Key-Value数据库,并提供多种语言的API的非关系型数据库(NoSQL)。Redis的特性Redis的所有操作都是原子性的,意思就是要么成... 查看详情

springboot2.x基础教程:springboot整合mybatis附源码(代码片段)

微信号:hzy1014211086,如果你正在学习SpringBoot,可以加入我们的Spring技术交流群,共同成长文章目录一、准备数据表二、添加依赖三、配置数据源四、编写领域对象五、注解配置方式新增修改查询删除六、XML配置... 查看详情