相关推荐recommended
SpringBoot 3.1.10 整合Mybatis-plus(快速学会)
作者:mmseoamin日期:2024-04-29

目录

  • 一、简介
    • 1、什么是Mybatis-plus?
    • 2、Mybatis-plus特性
    • 二、Springboot 3 整合Mybatis-plus入门案例
      • 1、创建项目(Idea)
      • 2、引入pom依赖
      • 3、编写application.yml配置
      • 4、导入sql
      • 5、主启动类
      • 6、测试
        • entity层
        • mapper层
        • service和serviceImpl层
        • controller层
        • 三、mybatis-plus的常用注解
          • 1、@TableName
          • 2、@TableId(opens new window)
          • 3、@TableField(opens new window)
          • 四、mybatis-plus分页插件
            • 1、config的配置
            • 2、controller代码实现分页
            • 五、mybatis-plus逆向工程
              • 1、引入pom依赖
              • 2、实现代码

                一、简介

                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)

                  SpringBoot 3.1.10 整合Mybatis-plus(快速学会),在这里插入图片描述,第1张

                  Next

                  SpringBoot 3.1.10 整合Mybatis-plus(快速学会),在这里插入图片描述,第2张

                  创建成功

                  SpringBoot 3.1.10 整合Mybatis-plus(快速学会),在这里插入图片描述,第3张

                  2、引入pom依赖

                  	   
                              org.springframework.boot
                              spring-boot-starter-web
                          
                          
                          
                              com.baomidou
                              mybatis-plus-spring-boot3-starter
                              3.5.5
                          
                          
                          
                              com.mysql
                              mysql-connector-j
                          
                          
                          
                              com.alibaba
                              druid-spring-boot-starter
                              1.1.18
                          
                          
                          
                              org.projectlombok
                              lombok
                          
                          
                              org.springframework.boot
                              spring-boot-starter
                          
                          
                              org.springframework.boot
                              spring-boot-starter-freemarker
                          
                  

                  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

                  CREATE DATABASE `metest`;
                  USE `metest`;
                  DROP TABLE IF EXISTS `user`;
                  CREATE TABLE `user`  (
                    `id` bigint NOT NULL AUTO_INCREMENT COMMENT '用户id',
                    `user_name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户名',
                    `password` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户密码',
                    `nick_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户昵称',
                    `email` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户邮箱',
                    `remark` text CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL COMMENT '备注',
                    PRIMARY KEY (`id`) USING BTREE
                  ) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci ROW_FORMAT = Dynamic;
                  

                  5、主启动类

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

                  6、测试

                  entity层

                  @Data
                  public class User {
                      @TableId(type = IdType.AUTO)
                      private Long id;
                      private String userName;
                      private String password;
                      private String nickName;
                      private String email;
                      private String remark;
                      // 因为引入了lombok依赖,使用@Data注解可代替getter/setter方法
                  }
                  

                  mapper层

                  @Repository
                  public interface UserMapper extends BaseMapper {
                  }
                  

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

                  service和serviceImpl层

                  service

                  public interface UserService extends IService{
                  }
                  

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

                  serviceImpl

                  @Service
                  public class UserServiceImpl extends ServiceImpl implements UserService {
                  }
                  

                  ServiceImpl主要是IService的实现类,传入的参数为M和T。

                  M:Mapper接口类型;T:对应实体类的类型

                  解释:, T>主要是ServiceImpl中进行类型的定义,是泛型上下边界的限制,保证传入的第一个参数M(Mapper)是继承BaseMapper< T >,另一个参数是泛型T

                  controller层

                  @RestController
                  @RequestMapping("user")
                  public class UserController {
                      @Autowired
                      private UserService userService;
                      /**
                       * 获取用户列表
                       * @return
                       */
                      @GetMapping
                      public List users(){
                          List list = userService.list();
                          return list;
                      }
                      /**
                       * 根据id获取用户信息
                       * @param id
                       * @return
                       */
                      @GetMapping("{id}")
                      public User user(@PathVariable Long id){
                          User user = userService.getById(id);
                          return user;
                      }
                      /**
                       * 新增用户信息
                       * @return
                       */
                      @PostMapping
                      public boolean save() {
                          // 模拟前端传输的数据
                          User user = new User();
                          user.setUserName("zhangsan");
                          user.setPassword("123456");
                          user.setNickName("张三");
                          user.setEmail("123456@163.com");
                          user.setRemark("备注内容xxx");
                          boolean save = userService.save(user);
                          return save;
                      }
                      /**
                       * 根据id修改用户信息
                       * @return
                       */
                      @PutMapping
                      public boolean update() {
                          // 模拟前端传输的数据
                          User user = new User();
                          user.setId(1L);
                          user.setUserName("lisi");
                          user.setNickName("李四");
                          boolean save = userService.updateById(user);
                          return save;
                      }
                      /**
                       * 根据删除用户信息
                       * @return
                       */
                      @DeleteMapping("{id}")
                      public boolean delete(@PathVariable Long id){
                          return userService.removeById(id);
                      }
                  }
                  

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

                  三、mybatis-plus的常用注解

                  1、@TableName

                  • 描述:表名注解,标识实体类对应的表
                  • 使用位置:实体类
                    @Data
                    @TableName("user")
                    public class User {
                        private Long id;
                        private String userName;
                        private String password;
                        private String nickName;
                        private String email;
                        private String remark;
                    }
                    
                    属性必须指定类型默认值描述
                    valueString“”表名
                    schemaString“”schema
                    keepGlobalPrefixbooleanfalse是否保持使用全局的 tablePrefix 的值(当全局 tablePrefix 生效时)
                    resultMapString“”xml 中 resultMap 的 id(用于满足特定类型的实体类对象绑定)
                    autoResultMapbooleanfalse是否自动构建 resultMap 并使用(如果设置 resultMap 则不会进行 resultMap 的自动构建与注入)
                    excludePropertyString[]{}需要排除的属性名 @since 3.3.1

                    关于 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")
                      public class User {
                          @TableId(type = IdType.AUTO)
                          private Long id;
                          private String userName;
                          private String password;
                          private String nickName;
                          private String email;
                          private String remark;
                      }
                      
                      属性类型必须指定默认值描述
                      valueString“”主键字段名
                      typeEnumIdType.NONE指定主键类型

                      IdType

                      描述
                      AUTO数据库ID自增
                      NONE无状态,该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
                      INPUTinsert 前自行 set 主键值
                      ASSIGN_ID分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
                      ASSIGN_UUID分配 UUID,主键类型为 String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认 default 方法)
                      ID_WORKER分布式全局唯一 ID 长整型类型(please use ASSIGN_ID)
                      UUID32 位 UUID 字符串(please use ASSIGN_UUID)
                      ID_WORKER_STR分布式全局唯一 ID 字符串类型(please use ASSIGN_ID)

                      3、@TableField(opens new window)

                      • 描述:字段注解(非主键)
                      • @TableName(“sys_user”)
                        @Data
                        @TableName("user")
                        public class User {
                            @TableId(type = IdType.AUTO)
                            private Long id;
                            @TableField("user_name")
                            private String userName;
                            private String password;
                            private String nickName;
                            private String email;
                            private String remark;
                        }
                        
                        属性类型必须指定默认值描述
                        valueString“”数据库字段名
                        existbooleantrue是否为数据库表字段
                        conditionString“”字段 where 实体查询比较条件,有值设置则按设置的值为准,没有则为默认全局的 %s=#{%s},参考(opens new window)
                        updateString“”字段 update set 部分注入,例如:当在version字段上注解update=“%s+1” 表示更新时会 set version=version+1 (该属性优先级高于 el 属性)
                        insertStrategyEnumFieldStrategy.DEFAULT举例:NOT_NULLinsert into table_a(column) values (#{columnProperty})
                        updateStrategyEnumFieldStrategy.DEFAULT举例:IGNOREDupdate table_a set column=#{columnProperty}
                        whereStrategyEnumFieldStrategy.DEFAULT举例:NOT_EMPTYwhere column=#{columnProperty}
                        fillEnumFieldFill.DEFAULT字段自动填充策略
                        selectbooleantrue是否进行 select 查询
                        keepGlobalFormatbooleanfalse是否保持使用全局的 format 进行处理
                        jdbcTypeJdbcTypeJdbcType.UNDEFINEDJDBC 类型 (该默认值不代表会按照该值生效)
                        typeHandlerClassUnknownTypeHandler.class类型处理器 (该默认值不代表会按照该值生效)
                        numericScaleString“”指定小数点后保留的位数
                        关于`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,否则分页插件不生效

                        @Configuration
                        public class MybatisPlusConfig {
                            /**
                             * 添加分页插件
                             */
                            @Bean
                            public MybatisPlusInterceptor mybatisPlusInterceptor() {
                                MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
                                interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));//如果配置多个插件,切记分页最后添加
                                //interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); 如果有多数据源可以不配具体类型 否则都建议配上具体的DbType
                                return interceptor;
                            }
                        }
                        

                        2、controller代码实现分页

                            /**
                             * 分页查询用户信息
                             * @return
                             */
                            @GetMapping("page")
                            public IPage findUserByPage(){
                                // 当前页码
                                long current = 1;
                                // 每页记录数
                                long size = 5;
                                IPage page = new Page<>(current,size);
                                // 分页查询
                                page = userService.page(page);
                                return page;
                            }
                        

                        完活,现在分页也就没问题啦!

                        五、mybatis-plus逆向工程

                        1、引入pom依赖

                             
                                
                                    com.baomidou
                                    mybatis-plus-generator
                                    3.5.6
                                
                        

                        2、实现代码

                        public class MyBatisPlusGenerator {
                            public static void main(String[] args) {
                                String url = "jdbc:mysql://127.0.0.1:3306/metest"; // 自己的url
                                String username = "root"; // 自己的用户名
                                String password = "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) -> {
                                            int typeCode = metaInfo.getJdbcType().TYPE_CODE;
                                            if (typeCode == Types.SMALLINT) {
                                                // 自定义类型转换
                                                return DbColumnType.INTEGER;
                                            }
                                            return typeRegistry.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(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
                                        .execute();
                            }
                        }
                        

                        完活~~