MybatisPlus入门

缺乏、安全感 2022-12-17 04:22 142阅读 0赞

## 什么是MybatisPlus？ ##

Mybatis是中国开发的一款基于mybatis优化的框架，具有非常好的应用场景， 荣获【 2019 年度开源中国最受欢迎的软件，开发工具类 TOP 1 】，它的开发理念是：为简化开发而生。目的是为了成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。官网链接：https://baomidou.com/

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70_pic_center]

### 特性 ###

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

## 使用步骤 ##

### 1.导入依赖 ###

<dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.0.5</version>
     </dependency>

### 2.定义持久层 ###

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import com.gzgs.mybatis_plus.domain.User;
    import org.apache.ibatis.annotations.Mapper;
    
    @Mapper
    public interface UserMapper extends BaseMapper<User> {
        //无需再写任何代码
    }

完成这个之后可以看到，和以往使用mybatis相比，它实在是太方便了，我们不再需要书写持久层的大部分代码。

### 3.简单查询 ###

//测试查询
    @Test
    void testFindbyId(){
        User user = userMapper.selectById(1);
        System.out.println(user);
    }
    //测试批量查询
    @Test
    void test(){
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 5, 6));
        users.forEach(System.out::println);
    }
    //使用map进行查询
    @Test
    void testselectbyMap(){
        Map map=new HashMap();
        map.put("name","张三");
        List list = userMapper.selectByMap(map);
        list.forEach(System.out::println);
    
    }

### 4.分页查询 ###

MybatisPlus为我们提供了一款分页查询的插件，想要使用这个分页查询，只需要如下几步。

#### 1、配置拦截器组件即可 ####

// 分页插件
    @Bean
    public PaginationInterceptor paginationInterceptor() {
    	return new PaginationInterceptor();
    }

#### 2、直接使用Page对象即可 ####

// 测试分页查询
    @Test
    public void testPage(){
    	// 参数一：当前页
    	// 参数二：页面大小
    	// 使用了分页插件之后，所有的分页操作也变得简单的！
    	Page<User> page = new Page<>(2,5);
    	userMapper.selectPage(page,null);
    	page.getRecords().forEach(System.out::println);
    	System.out.println(page.getTotal());
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70_pic_center 1]

### 性能分析插件 ###

性能分析拦截器，用于输出每条 SQL 语句及其执行时间，MP也提供性能分析插件，如果超过这个时间就停止运行！我们可以使用这个性能分析插件来判断那些sql语句需要进行优化。

#### 1、导入插件 ####

/**
    * SQL执行效率插件
    */
    @Bean
    @Profile({"dev","test"})// 设置 dev test 环境开启，保证我们的效率
    public PerformanceInterceptor performanceInterceptor() {
    	PerformanceInterceptor performanceInterceptor = new
    	PerformanceInterceptor();
    	performanceInterceptor.setMaxTime(100); // ms设置sql执行的最大时间，如果超过了则不
    	执行
    	performanceInterceptor.setFormat(true); // 是否格式化代码
    	return performanceInterceptor;
    }

#### 2、在配置文件中配置 ####

#设置开发环境
    spring.profiles.active=dev

#### 3、直接使用 ####

@Test
    void contextLoads() {
    	// 参数是一个 Wrapper ，条件构造器，这里我们先不用 null
    	// 查询全部用户
    	List<User> users = userMapper.selectList(null);
    	users.forEach(System.out::println);
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70_pic_center 2]

### 代码生成器 ###

MybatisPlus为我们提供了一款代码生成器AutoGenerator ，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

package com.gzgs.mybatis_plus.domain;
    
    import com.baomidou.mybatisplus.annotation.DbType;
    import com.baomidou.mybatisplus.annotation.FieldFill;
    import com.baomidou.mybatisplus.annotation.IdType;
    import com.baomidou.mybatisplus.generator.AutoGenerator;
    import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
    import com.baomidou.mybatisplus.generator.config.GlobalConfig;
    import com.baomidou.mybatisplus.generator.config.PackageConfig;
    import com.baomidou.mybatisplus.generator.config.StrategyConfig;
    import com.baomidou.mybatisplus.generator.config.po.TableFill;
    import com.baomidou.mybatisplus.generator.config.rules.DateType;
    import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
    
    import java.util.ArrayList;
    
    import static com.mysql.cj.conf.PropertyKey.serverTimezone;
    
    public class AutoEncoding {
        public static void main(String[] args) {
            // 需要构建一个 代码自动生成器 对象
            AutoGenerator mpg = new AutoGenerator();
            // 配置策略
            // 1、全局配置
            GlobalConfig gc = new GlobalConfig();
            String projectPath = System.getProperty("user.dir");
            gc.setOutputDir(projectPath + "/src/main/java");
            gc.setAuthor("sdl");
            gc.setOpen(false);
            gc.setFileOverride(false); // 是否覆盖
            gc.setServiceName("Service"); // 去Service的I前缀
            gc.setIdType(IdType.ID_WORKER);
            gc.setDateType(DateType.ONLY_DATE);
            gc.setSwagger2(true);
            mpg.setGlobalConfig(gc);
            //2、设置数据源
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL = false&useUnicode=true&characterEncoding=utf-8&serverTimezone = GMT%2B8");
                    dsc.setDriverName("com.mysql.cj.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("111111");
            dsc.setDbType(DbType.MYSQL);
            mpg.setDataSource(dsc);
            //3、包的配置
            PackageConfig pc = new PackageConfig();
            pc.setModuleName("test");
            pc.setParent("com.gzgs");
            pc.setEntity("entity");
            pc.setMapper("mapper");
            pc.setService("service");
            pc.setController("controller");
            mpg.setPackageInfo(pc);
            //4、策略配置
            StrategyConfig strategy = new StrategyConfig();
            strategy.setInclude("user"); // 设置要映射的表名
            strategy.setNaming(NamingStrategy.underline_to_camel);
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
            strategy.setEntityLombokModel(true); // 自动lombok；
            strategy.setLogicDeleteFieldName("deleted");
            // 自动填充配置
            TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
            TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
            ArrayList<TableFill> tableFills = new ArrayList<>();
            tableFills.add(gmtCreate);
            tableFills.add(gmtModified);
            strategy.setTableFillList(tableFills);
            // 乐观锁
            strategy.setVersionFieldName("version");
            strategy.setRestControllerStyle(true);
            strategy.setControllerMappingHyphenStyle(true); //localhost:8080/hello_id_2
            mpg.setStrategy(strategy);
            mpg.execute(); //执行
    
        }
    }

#### 点击运行之后即可生成代码！！ ####

完整学习笔记已上传自码云：https://gitee.com/sun-dalin/mybatis\_plus.git

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/69ba06dfc40c4d0c959aeac6e0b3a13a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/b537022c28464291b5716112f2e68442.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/2c320aefdc764bae8509cf13a5c0293b.png