一、简介

1、什么是Mybatis-plus?

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

官网: https://baomidou.com/

2、Mybatis-plus特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

二、Springboot 3 整合Mybatis-plus入门案例

1、创建项目(Idea)

Next

创建成功

2、引入pom依赖

<dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-web</artifactId>        </dependency>        <!--引入mybatisPlus依赖-->        <dependency>            <groupId>com.baomidou</groupId>            <artifactId>mybatis-plus-spring-boot3-starter</artifactId>            <version>3.5.5</version>        </dependency>        <!--mysql-->        <dependency>            <groupId>com.mysql</groupId>            <artifactId>mysql-connector-j</artifactId>        </dependency>        <!--引durid數據源-->        <dependency>            <groupId>com.alibaba</groupId>            <artifactId>druid-spring-boot-starter</artifactId>            <version>1.1.18</version>        </dependency>        <!--lombok-->        <dependency>            <groupId>org.projectlombok</groupId>            <artifactId>lombok</artifactId>        </dependency>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter</artifactId>        </dependency>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-freemarker</artifactId>        </dependency>

3、编写application.yml配置

由于个人习惯用yml格式配置，将配置文件application.properties后缀改为了yml

spring:application:name:mybatis-plus-demo  datasource:type:com.alibaba.druid.pool.DruidDataSource    username:root   # 这里替换成自己的用户名password:123456# 这里替换成自己的密码driver-class-name:com.mysql.cj.jdbc.Driver    url:jdbc:mysql://localhost/metest# mybatis-plus配置mybatis-plus:configuration:log-impl:org.apache.ibatis.logging.stdout.StdOutImpl  #日志map-underscore-to-camel-case:true#开启驼峰命名

4、导入sql

CREATEDATABASE`metest`;USE`metest`;DROPTABLEIFEXISTS`user`;CREATETABLE`user`(`id`bigintNOTNULLAUTO_INCREMENTCOMMENT'用户id',`user_name`varchar(50)CHARACTERSETutf8mb4 COLLATEutf8mb4_0900_ai_ci NULLDEFAULTNULLCOMMENT'用户名',`password`varchar(50)CHARACTERSETutf8mb4 COLLATEutf8mb4_0900_ai_ci NULLDEFAULTNULLCOMMENT'用户密码',`nick_name`varchar(255)CHARACTERSETutf8mb4 COLLATEutf8mb4_0900_ai_ci NULLDEFAULTNULLCOMMENT'用户昵称',`email`varchar(255)CHARACTERSETutf8mb4 COLLATEutf8mb4_0900_ai_ci NULLDEFAULTNULLCOMMENT'用户邮箱',`remark`textCHARACTERSETutf8mb4 COLLATEutf8mb4_0900_ai_ci NULLCOMMENT'备注',PRIMARYKEY(`id`)USINGBTREE)ENGINE=InnoDBCHARACTERSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci ROW_FORMAT =Dynamic;

5、主启动类

@SpringBootApplication// 替换为自己的mapper路径@MapperScan(basePackages ="com.dm.mybatisplus.mapper")publicclassMybatisPlusDemoApplication{ publicstaticvoidmain(String[]args){ SpringApplication.run(MybatisPlusDemoApplication.class,args);}}

6、测试

entity层

@DatapublicclassUser{ @TableId(type =IdType.AUTO)privateLongid;privateStringuserName;privateStringpassword;privateStringnickName;privateStringemail;privateStringremark;// 因为引入了lombok依赖，使用@Data注解可代替getter/setter方法}

mapper层

@RepositorypublicinterfaceUserMapperextendsBaseMapper<User>{ }

BaseMapper类是 MyBatis-Plus 框架中的一个核心接口，用于提供基本的 CRUD（创建、读取、更新、删除）操作的方法定义。它通过继承 MyBatis 的 Mapper 接口并扩展了一些常用的数据库操作方法，使得开发人员可以更加便捷地进行数据访问层的开发，无需手动编写对应的 SQL 语句。泛型为实体类

service和serviceImpl层

service

publicinterfaceUserServiceextendsIService<User>{ }

IService主要是集成了一些通用的服务方法，和普通的Service接口一样。

serviceImpl

@Servicepublic class UserServiceImpl extends ServiceImpl<UserMapper,User> implements UserService { }

ServiceImpl主要是IService的实现类，传入的参数为M和T。
M：Mapper接口类型；T：对应实体类的类型
解释：<M extends BaseMapper< T >, T>主要是ServiceImpl中进行类型的定义，是泛型上下边界的限制，保证传入的第一个参数M（Mapper）是继承BaseMapper< T >，另一个参数是泛型T

controller层

@RestController@RequestMapping("user")publicclassUserController{ @AutowiredprivateUserServiceuserService;/**     * 获取用户列表     * @return     */@GetMappingpublicList<User>users(){ List<User>list =userService.list();returnlist;}/**     * 根据id获取用户信息     * @param id     * @return     */@GetMapping("{ id}")publicUseruser(@PathVariableLongid){ Useruser =userService.getById(id);returnuser;}/**     * 新增用户信息     * @return     */@PostMappingpublicbooleansave(){ // 模拟前端传输的数据Useruser =newUser();user.setUserName("zhangsan");user.setPassword("123456");user.setNickName("张三");user.setEmail("123456@163.com");user.setRemark("备注内容xxx");booleansave =userService.save(user);returnsave;}/**     * 根据id修改用户信息     * @return     */@PutMappingpublicbooleanupdate(){ // 模拟前端传输的数据Useruser =newUser();user.setId(1L);user.setUserName("lisi");user.setNickName("李四");booleansave =userService.updateById(user);returnsave;}/**     * 根据删除用户信息     * @return     */@DeleteMapping("{ id}")publicbooleandelete(@PathVariableLongid){ returnuserService.removeById(id);}}

好了，以上就是springboot整合mybatis-plus的一些简单的CRUD。

三、mybatis-plus的常用注解

1、@TableName

• 描述：表名注解，标识实体类对应的表
• 使用位置：实体类

@Data@TableName("user")publicclassUser{ privateLongid;privateStringuserName;privateStringpassword;privateStringnickName;privateStringemail;privateStringremark;}

关于 autoResultMap 的说明：

MP 会自动构建一个 resultMap 并注入到 MyBatis 里（一般用不上），请注意以下内容：

因为 MP 底层是 MyBatis，所以 MP 只是帮您注入了常用 CRUD 到 MyBatis 里，注入之前是动态的（根据您的 Entity 字段以及注解变化而变化），但是注入之后是静态的（等于 XML 配置中的内容）。

而对于 typeHandler 属性，MyBatis 只支持写在 2 个地方:

1、定义在 resultMap 里，作用于查询结果的封装
2、定义在 insert 和 update 语句的 #{ property} 中的 property 后面（例：#{ property,typehandler=xxx.xxx.xxx}），并且只作用于当前 设置值
除了以上两种直接指定 typeHandler 的形式，MyBatis 有一个全局扫描自定义 typeHandler 包的配置，原理是根据您的 property 类型去找其对应的 typeHandler 并使用。

2、@TableId(opens new window)

• 描述：主键注解
• 使用位置：实体类主键字段

@Data@TableName("user")publicclassUser{ @TableId(type =IdType.AUTO)privateLongid;privateStringuserName;privateStringpassword;privateStringnickName;privateStringemail;privateStringremark;}

IdType

3、@TableField(opens new window)

• 描述：字段注解（非主键）
• @TableName(“sys_user”)

@Data@TableName("user")publicclassUser{ @TableId(type =IdType.AUTO)privateLongid;@TableField("user_name")privateStringuserName;privateStringpassword;privateStringnickName;privateStringemail;privateStringremark;}

关于`jdbcType`和`typeHandler`以及`numericScale`的说明:numericScale只生效于 update 的 sql. jdbcType和typeHandler如果不配合@TableName#autoResultMap = true一起使用,也只生效于 update 的 sql. 对于typeHandler如果你的字段类型和 set 进去的类型为equals关系,则只需要让你的typeHandler让 Mybatis 加载到即可,不需要使用注解

四、mybatis-plus分页插件

1、config的配置

使用mybatis-plus的分页时，必须配置MybatisPlusConfig，否则分页插件不生效

@ConfigurationpublicclassMybatisPlusConfig{ /**     * 添加分页插件     */@BeanpublicMybatisPlusInterceptormybatisPlusInterceptor(){ MybatisPlusInterceptorinterceptor =newMybatisPlusInterceptor();interceptor.addInnerInterceptor(newPaginationInnerInterceptor(DbType.MYSQL));//如果配置多个插件,切记分页最后添加//interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); 如果有多数据源可以不配具体类型 否则都建议配上具体的DbTypereturninterceptor;}}

2、controller代码实现分页

/**     * 分页查询用户信息     * @return     */@GetMapping("page")publicIPage<User>findUserByPage(){ // 当前页码longcurrent =1;// 每页记录数longsize =5;IPage<User>page =newPage<>(current,size);// 分页查询page =userService.page(page);returnpage;}

完活，现在分页也就没问题啦！

五、mybatis-plus逆向工程

1、引入pom依赖

<!--mybatis-plus代码生成器-->        <dependency>            <groupId>com.baomidou</groupId>            <artifactId>mybatis-plus-generator</artifactId>            <version>3.5.6</version>        </dependency>

2、实现代码

publicclassMyBatisPlusGenerator{ publicstaticvoidmain(String[]args){ Stringurl ="jdbc:mysql://127.0.0.1:3306/metest";// 自己的urlStringusername ="root";// 自己的用户名Stringpassword ="123456";// 自己的密码FastAutoGenerator.create(url,username,password).globalConfig(builder ->{ builder.author("java动脉")// 作者.commentDate("yyyy-MM-dd hh:mm:ss").dateType(DateType.TIME_PACK).disableOpenDir().enableSwagger()// 开启 swagger 模式.outputDir(System.getProperty("user.dir")+"/src/main/java");// 指定输出目录}).dataSourceConfig(builder ->builder.typeConvertHandler((globalConfig,typeRegistry,metaInfo)->{ inttypeCode =metaInfo.getJdbcType().TYPE_CODE;if(typeCode ==Types.SMALLINT){ // 自定义类型转换returnDbColumnType.INTEGER;}returntypeRegistry.getColumnType(metaInfo);})).packageConfig(builder ->{ builder.parent("com.dm.plus")// 设置父包名.moduleName("system")// 设置父包模块名.pathInfo(Collections.singletonMap(OutputFile.mapper.xml,System.getProperty("user.dir")+"/src/main/resources/mapper"));// 设置mapperXml生成路径}).strategyConfig(builder ->{ builder.addInclude("user")// 设置需要生成的表名.addTablePrefix("t_","c_");// 设置过滤表前缀}).templateEngine(newFreemarkerTemplateEngine())// 使用Freemarker引擎模板，默认的是Velocity引擎模板.execute();}}

完活~~