SpringBoot整合Mybatis-plus代码生成器，分页查询

最新推荐文章于 2024-04-30 14:43:27 发布
最新推荐文章于 2024-04-30 14:43:27 发布
阅读量445 收藏 2
点赞数 1
分类专栏： SpringBoot 文章标签： java spring boot mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/AAAAAAAdagw/article/details/117770403
版权

简介

这篇博客主要介绍了在SpringBoot框架内，与Mybatis-plus框架的整合使用，包括代码生成器，内置分页方法，自定义多表分页查询，方便后续的代码开发。

一.Mybatis-plus框架介绍：

MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。下面简单介绍一下MP框架的主要功能：

  1. 内置代码生成器；
  2. 内置通用mapper方法，通用Service方法，使用MD框架方法可以通过少量的配置实现对单表的curd；
  3. 内置条件构造器，可以通过条件构造器生成自己需要的sql语句；
  4. 内置分页插件，可以实现对单表的分页操作，支持xml自定义分页功能；
  5. 还有一些其他功能：自定义ID生成器，Sql注入，Sql打印，乐观锁，动态表名等功能，在这里不做过多介绍，如有需求可访问MP官方文档: https://baomidou.com/guide/.；

二.SpringBoot与Mybatis-Plus的代码整合

2.1：准备工作：创建一个SpringBoot基本项目；
附上刚创建好的项目结构：
在这里插入图片描述

2.2：pom.xml文件的配置

向pom.xml文件中添加一下项目依赖。

// An highlighted block
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.lx</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.7.1</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

三.数据库表的准备

现有一张 User 表，其表结构如下：

idnameageemail
1Jone18test1@baomidou.com
2Jack20test2@baomidou.com
3Tom28test3@baomidou.com
4Sandy21test4@baomidou.com
5Billie24test5@baomidou.com

其对应的数据库 Schema 脚本如下：

DROP TABLE IF EXISTS user;

CREATE TABLE user
(
	id BIGINT(20) NOT NULL COMMENT '主键ID',
	name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
	age INT(11) NULL DEFAULT NULL COMMENT '年龄',
	email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
	PRIMARY KEY (id)
);

其对应的数据库 Data 脚本如下：

DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

四.使用代码生成器生成代码

4.1：添加代码生成器依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.1</version>
</dependency>

4.2：添加模板引擎依赖（我这里用的是freemarker）

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

4.3创建代码生成器CodeGenerator

// 演示例子，执行 main 方法控制台输入表名回车自动生成对应项目目录中
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("zj");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/demo?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        //pc.setModuleName(scanner("模块名"));
        pc.setParent("com.lx.demo");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 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) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        //strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

4.4创建调试完毕后运行main方法
在控制台打印输出：在这里插入图片描述
执行完毕后的代码结构图：
在这里插入图片描述

4.5代码调试

application.yml文件配置:

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/demo?useUnicode=true&characterEncoding=utf8&characterSetResults=utf8
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

mybatis-plus:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.lx.demo.entity

在UserController添加测试案例:

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

    @Autowired
    private UserMapper userMapper;

    @RequestMapping("/getUser")
    public User getUser(){
        return userMapper.selectById(1);
    }

}

在启动类上加上扫描mapper文件注解：

@SpringBootApplication
@MapperScan("com.lx.demo.mapper")
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

启动项目访问本地网址:127.0.0.1:8080/user/getUser
在这里插入图片描述

五.测试MP框架内置的方法

在MP框架中继承了很多的内置方法，我们可以通过这些内置方法完成对数据库单表的curd，这里演示一下使用内置方法进行单表的分页查询：

添加一个分页必须的配置文件MybatisPlusConfig：

@Configuration
public class MybatisPlusConfig {
   /**
    * 分页插件配置
    * @return
    */
   @Bean
   public MybatisPlusInterceptor mybatisPlusInterceptor() {
       MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
       interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
       return interceptor;
   }
}

控制层代码：

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

   @Autowired
   private UserMapper userMapper;

   @RequestMapping("/getIPageUser")
   public IPage<User> getIPageUser(){
       IPage<User> page = new Page<>(1,3);

       QueryWrapper<User> qw = new QueryWrapper<>();
       qw.eq("age","20");

       return userMapper.selectPage(page,qw);
   }

}

启动项目访问本地网址：127.0.0.1:8080/user/getIPageUser
在这里插入图片描述
注意：我在controller控制层，selectPage方法的两个参数Page和Wrapper，Page是用来定义当前页和每页记录数，Wrapper的赋值是由MP框架内的条件构造器组成，可以加入自己业务上的条件，具体的条件构造器的使用方法可以参考官网文档：点击跳转MP官网条件构造器

六.自定义多表的分页查询案例

添加一张关联表： Job，其表结构如下：

iduser_idjob
11teacher
21interpreter
32watcher
43star
54cook
65programmer

其对应的数据库 Schema 脚本如下：

DROP TABLE IF EXISTS job;

CREATE TABLE job
(
	id BIGINT(20) NOT NULL COMMENT '主键ID',
	user_id BIGINT(20) NULL DEFAULT NULL COMMENT '用户id',
	job VARCHAR(30) NULL DEFAULT NULL COMMENT '职业',
	PRIMARY KEY (id)
);

其对应的数据库 Data 脚本如下：

DELETE FROM job;

INSERT INTO job (id, user_id, job) VALUES
(1,1, 'teacher'),
(2,1, 'interpreter'),
(3,2, 'watcher'),
(4,3, 'star' ),
(5,4, 'cook'),
(6,5, 'programmer');

实体类Job:

@Data
public class Job implements Serializable {
    /**
     * 主键ID
     */
    private Long id;

    /**
     * 用户id
     */
    private Long userId;

    /**
     * 职业
     */
    private String job;
}

实体类User内加上：

private List<Job> job;

UserMapper:

public interface UserMapper extends BaseMapper<User> {

    /**
     * 针对多表的分页查询
     * @param page
     * @param wrapper
     * @return
     */
    IPage<User> getUserAndJob(IPage<User> page, @Param(Constants.WRAPPER) Wrapper<User> wrapper);

}

UserMapper.xml:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.lx.demo.mapper.UserMapper">

    <resultMap id="sss" type="com.lx.demo.entity.User" autoMapping="true">
        <id property="id" column="id" />
        <collection property="job" ofType="com.lx.demo.entity.Job" javaType="List"  autoMapping="true">
            <id property="id" column="jid" />
            <id property="userId" column="userId" />
            <id property="job" column="job" />
        </collection>
    </resultMap>

    <select id="getUserAndJob" resultMap="sss">
        select u.id, u.name, u.age, u.email, j.id jid, j.user_id userId, j.job
        from user u LEFT JOIN  job j on u.id = j.user_id ${ew.customSqlSegment}
    </select>

</mapper>

IUserService :

public interface IUserService extends IService<User> {
    /**
     * 针对多表的分页查询
     * @param page
     * @param wrapper
     * @return
     */
    IPage<User> getUserAndJob(IPage<User> page, @Param(Constants.WRAPPER) Wrapper<User> wrapper);
}

UserServiceImpl :

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

    @Autowired
    private UserMapper userMapper;

    @Override
    public IPage<User> getUserAndJob(IPage<User> page, Wrapper<User> wrapper) {
        return userMapper.getUserAndJob(page,wrapper);
    }
}

UserController :

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

    @Autowired
    private IUserService userService;

    @RequestMapping("/getUserAndJob")
    public IPage<User> getUserAndJob(){
        IPage<User> page = new Page<>(1,9);

        QueryWrapper<User> qw = new QueryWrapper<>();
        qw.eq("age","18");

        return userService.getUserAndJob(page,qw);
    }
}

启动项目访问本地网址：127.0.0.1:8080/user/getUserAndJob
在这里插入图片描述

这篇文档主要介绍了SpringBoot与MP框架的整合以及MP框架内的代码生成器，分页查询，自定义多表分页查询操作，如有疑问请在评论区留言。

草莓·芝士
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
MyBatis框架(三) 分页查询、代码生成器generator与mybatis
qq_44189274的博客
06-06 541
1.1 引入pageHeler依赖 1.2. 在mybatis.xml 文件中设置拦截器 注意:代码的上下顺序1.3 运行PageHeler原理:作用: 根据表生成实体类，和dao和xml映射文件。简单的CRUD。官方文档:MyBatis Generator Core – Introduction to MyBatis Generator2.1 引入generator 依赖 2.2 创建并配置 generator.xml 文件须放在项目目录下 2.3 运行 缓存是存在于内存中的临时数据
【springboot】【MybatisPlus】配置+自动代码生成+分页查询
lorogy的博客
02-05 2386
一、MyBatis配置（mybatis-plus-boot-starter） 依赖pox.xml <!-- 数据库 --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.11</
MybatisPlus实现条件查询（多表联查并实现分页）
最新发布
weixin_64701673的博客
04-30 2728
在BaseMapper中，selectPage方法的作用是执行分页查询操作。它会根据传入的分页参数和查询条件，使用数据库提供的分页查询语句（如MySQL中的limit语句）来从数据库中获取数据，然后将结果返回给IService中的page方法。2.将info表的数据查询出来，再将之前的map类数据传入infoEntities,先遍历再传入对应settingId的数据，这里使用的set方法是info实体类中自己定义的，作用为给该实体类中的关联的内容赋值，赋值完成后我们就有了需要查询的所有数据。
springboot整合mybatis-plus实现多表分页查询
weixin_42370891的博客
06-20 1万+
springboot整合mybatis-plus实现多表分页查询 1.新建一个springboot工程 2.需要导入mybatis和mybatis-plus的依赖文件 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plu...
SpringBoot集成Mybatis的使用（单表查询Demo）
m0_46628950的博客
07-05 637
SpringBoot集成Mybatis的使用（单表查询Demo）
spring boot集成mybatis-plus——Mybatis Plus 多表联查（包含分页关联查询,图文讲解）...
小白龙白龙马的博客
02-04 7608
Mybatis Plus 多表联查(包含分页关联查询,图文讲解) 更新时间 2023-01-03 21:41:38 大家好，我是小哈。 本小节中，我们将学习如何通过 Mybatis Plus 实现多表关联查询，以及分页关联查询。 表结构 本文以查询用户所下订单，来演示 Mybatis Plus 的关联查询，数据库表除了前面小节中已经定义好的用户表外，再额外创建一张订单表，然后插入一些测试数据...
mybatis-plus多表分页查询最佳实现（简单）
单筱风的博客
09-29 1万+
mybatis-plus多表分页查询最佳实践
springboot+mybatis-plus 代码生成器 CRUD 分页插件
12-21
本篇文章将详细讲解如何利用Spring Boot集成MyBatis-Plus的代码生成器以及分页插件，以实现高效开发。 首先，你需要在你的`pom.xml`文件中添加以下依赖，确保引入了MyBatis-Plus的核心启动器和代码生成器： ```xml...
SpringBoot集成MyBatis-Plus实现国产数据库适配.docx
05-20
* 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、Model 、Service 、Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用 * 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体...
SpringBoot整合MyBatis-Plus3.1教程详解
08-25
MyBatis-Plus 提供了许多有用的功能，例如代码生成、分页、性能分析等，使用 MyBatis-Plus 可以极大地提高开发效率和代码质量。 七、结语 本教程旨在帮助读者快速掌握 SpringBoot 和 MyBatis-Plus3.1 的整合和配置...
011 springboot整合mybatis-plus 首页加载热商品food评分前8的食物
04-20
集成Mybatis-Plus可以进一步提高开发效率，因为Mybatis-Plus是对Mybatis的扩展，提供了更为便捷的数据操作API，包括 CRUD 操作、条件构造器、分页查询等功能。 1. **SpringBoot集成Mybatis-Plus**： - 创建pom.xml...
009 springboot整合mybatis-plus 增删改查 ajax 登录退出accessToken
04-18
MyBatis-Plus是MyBatis的扩展，提供了更强大的CRUD操作，如一键生成Mapper、SQL等。它的优点在于简化了MyBatis的部分繁琐配置，使得数据库操作更为便捷。 3. **Ajax** Ajax（异步JavaScript和XML）是一种在不刷新...
Mybatis-plus-generator代码自动化生成工具
Jjw的博客
04-24 2253
先简单介绍一下Mybatis-plus mybatis-plus是mybatis的升级版，在 mybatis 的基础上只做增强不做改变，主要目的是简化开发、提高开发效率。它内置通用的 Mapper与 Service，仅仅通过少量配置即可实现单表大部分 简单的CRUD 操作，还有强大的条件构造器，满足各类使用需求。即使涉及到咱们最头疼的表结构调整，只要没调整业务逻辑，也可以不用手动改变代码，只需从新使用generator生成一次即可。且其可以直接丢掉xml编写sql，直接在java代码中通过wrapper编
springboot整合mybatis-plus，实现逆向工程生成代码，并实现分页
zifengye520的专栏
12-17 1048
springboot整合mybatis-plus主要步骤，并实现分页
mybatisplus实现分页效果
qq_52896771的博客
01-12 3453
1，导入依赖 <!--mybatis-plus--> <dependency><groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> </dependency> <!-- velocity 模板引擎, Mybatis Plus 代码生成器需要 --> <dependency>
mybatis-plus-genetrator逆向工程生成工具+分页插件pageHelper + 集成SpringBoot
拾信
06-20 690
github地址：https://github.com/shixin752/mybatis-plus-generator
如何使用Mybatis-plus进行分页
热门推荐
AALouisaa的博客
08-20 9万+
利用mybatis-plus进行分页！！！
（六）springboot + mybatis plus实现多表联查分页3.X版本
QingFeng-Li的博客
10-04 4万+
注明 ： 上两篇文章我们讲解了springboot+mybatis-plus对于单表的CRUD和条件构造器的使用方法，但是对于我们的实战项目中多表联查也是经常会出现的。今天我们就来说下怎么在springboot+MP模式下实现多表联查并分页。 项目源码下载位置 | gitee MP推荐使用的是一种苞米豆团队自己封装好的分页插件，也就是PaginationInterceptor分页拦截器，那么下面我...
mybatis plus 简单使用及Generator使用记录笔记
大仕忆的博客
01-22 1692
pom.xml配置文件 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.4.1</version> </dependency>
mybatis-plus 代码生成器
06-28
要使用 mybatis-plus 代码生成器，首先需要在项目中添加 mybatis-plus 依赖，然后在配置文件中指定数据库连接信息、生成代码的包路径等相关信息。在配置完成后，运行代码生成器即可自动生成基础代码。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值