Mybatis-Plus学习

Mybatis-Plus

官网地址

简介

Mybatis-Plus,（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。愿景：成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍

快速开始

1. 引入依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.5.0</version>
    <relativePath/>
</parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
 <!--mp依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>Latest Version</version>
<!--数据库驱动-->
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
<!-- lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

此处如果引入了mybatis-plus依赖，就不需要再引入mybatis，否则会出现依赖冲突。

2. 创建数据库/表

  • 创建库 cz

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)
);

  • 创建user表

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');

3 .编写配置文件 (application.properties)

# mysql 5 驱动不同 com.mysql.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/cz?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
# 可以向下兼容，兼容低版本
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
​
# mysql 8 需要增加时区配置
# 驱动名：com.mysql.cj.jdbc.Driver
# 时区配置：serverTimezone=GMT%2B8
​
server.port=8080
​
# 日志输出
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

4. 创建pojo,mapper对象

  • user对象

@Data  //lombok注解,生产get/set方法
@AllArgsConstructor     //全参数构造方法
@NoArgsConstructor      //无参构造方法
public class User {
    @TableId(type = IdType.ID_WORKER)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}
// @TableId(type = IdType.?)
// 1.IdType.ID_WORKER 默认生成唯一性id
// 2.IdType.AUTO 生成自增id,需要设置数据库对应字段是自增的. 
// 3.IdType.INPUT 手动输入id

  • mapper接口

/**
 * 实现基本的mapper
 */
@Repository  //代表持久层
public interface UserMapper extends BaseMapper<User> {
    //BaseMapper包含了基本你的CRUD,后续可以自己编写特殊方法
}
/**
1、使用@mapper后，不需要在spring配置中设置扫描地址，通过mapper.xml里面的namespace属性对应相关的mapper类，spring将动态的生成Bean后注入到ServiceImpl中。
2、@repository则需要在Spring中配置扫描包地址，然后生成dao层的bean，之后被注入到ServiceImpl中
*/

  • 启动类添加@MapperScan注解,扫描Mapper文件夹

@SpringBootApplication
@MapperScan(value = "com.cz.mp.mapper")//扫描mapper文件夹
public class MpApplication {
    public static void main(String[] args) {
        SpringApplication.run(MpApplication.class, args);
    }
}

 

编码讲解

简单CRUD

  • 插入方法

    void testInsert(){
       User user = new User();
       user.setName("cz");
       user.setAge(18);
       int result = user.setEmail("13347798060@163.com"); //会自动生成id,并且自动回填id
       userMapper.insert(user);
    }

  • 更新方法

    void testUpdate(){
        User user = new User();
        user.setName("cz2");
        user.setEmail("13347798060@163.com");
        user.setId(20l);
        userMapper.updateById(user);
    }//此处的更新是动态sql,传入对象实例,底层会将不为null的值更新到数据库对应的数据上.

  • 自动填充创建/更新时间

     

    在日常开发工作中，需要对业务数据做审计，需要记录创建人、创建时间、更新人、更新时间，在此之前，大部分人都是入库之前，手动设置时间为new Date(),使用Mybatis Plus后，有更优雅的处理方式。

    @TableFiled(fill = FieldFill.INSERT) //FieldFill.INSERT，标记字段在插入的时间做填充操作，具体的填充逻辑需要实现MetaObjectHandler接口定义
    private Date createTime; 
    @TableField(fill = FieldFill.INSERT_UPDATE) //FieldFill.INSERT_UPDATE，标记该字段在插入和更新的时候，都会自动填充
    private Date updateTime;
    @Component
    @Slf4j
    public class DataHandler implements MetaObjectHandler {
    ​
        //插入时自动填充
        @Override
        public void insertFill(MetaObject metaObject) {
        log.info("开始填充创建/更新时间。。。");
        this.setFieldValByName("createTime",new Date(),metaObject);//此处填充创建时间
            this.setFieldValByName("updateTime",new Date(),metaObject);//此处填充更新时间
        }
    ​
        @Override
        public void updateFill(MetaObject metaObject) {
            log.info("开始填充更新时间。。。");
            this.setFieldValByName("updateTime",new Date(),metaObject);
        }
    }

  • 查询操作

    1. 单个/批量查询

        //根据多个id查询
        @Test
        void testIds(){
           // List<User> users = userMapper.selectList(null); 查询所有数据
           // User user = userMapper.selectById(1); //单个查询
            List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
            users.forEach(System.out::println);
        }
    ​

    1. 根据map多条件查询

    //根据map多条件查询
      HashMap<String, Object> map = new HashMap<>();
      map.put("name","cz");
      List<User> users = userMapper.selectByMap(map); //查询所有名称为cz的用户

    1. 分页查询

      • 添加分页组件

          @Bean
         public MybatisPlusInterceptor mybatisPlusInterceptor() {
              //分页组件
          MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); 
             return interceptor;
         }
        ​

      • 使用分页

            //测试分页
            @Test
            void testPage(){
                Page<User> page = new Page<>(1,2);//1是页码，2是每页显示数量
                 userMapper.selectPage(page, null);//此处null指的是条件查询器
                List<User> records = page.getRecords();
                //page.getTotal(),获取数据库总数
                records.forEach(item-> System.out.println(item.getName()));
            }

    2. 删除操作

          //测试删除
          @Test
          void testPage(){
            userMapper.deleteById(1l);
            //批量删除 
             userMapper.deleteBatchIds(Arrays.asList(1, 2, 3));
             //通过map删除，删除所有名称为VAL的数据
              HashMap<String, Object> map = new HashMap<>();
              map.put("name","VAL");
              userMapper.deleteByMap(map);
          }

       

     

乐观锁处理@Version

所谓乐观锁，简单说，就是非常乐观，认为数据永远不会出问题，所以对数据操作时不会加锁。但是每次更新的时候，会判断目前要更新的数据是否是读取时所看到的数据，如果是的话，就更新，不然就更新失败。

 

 

简单说流程：

  1. 读取数据，获取版本号

  2. 更新数据，与原数据版本号对比是否一致

  3. 版本号一致，更新数据，并把版本号更新为最新的

实现方式：

  1. 数据库/实体类加上version字段，初始值为1

//乐观锁注解
@Version
private Integer version;

  1. 注册组件

@EnableTransactionManagement
@Configuration
@MapperScan(value = "com.cz.mp.mapper") //乐观锁扫描包,加在此处的话，可以把启动类的扫描去掉
public class MybatisPlusCfg {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

  1. 测试运行

​
    //测试乐观锁
@Test
void testLgLock(){
        //查询客户信息
        User user = userMapper.selectById(2);
        //修改用户信息
        user.setName("VAL");
        user.setEmail("123.qq.com");
        userMapper.updateById(user);
    }

运行结果解释：

 

 

先读取数据，获取版本号version = 1;

 

 

更新数据，只有当id相等并且版本也相等的时候，才更新成功，并把最新的版本号更新上去

条件构造器Wrapper

//测试复杂查询
void test(){
        Map<String ,String> map = new HashMap<>();
        map.put("name","VAL");
        QueryWrapper<User> queryWrapper = new QueryWrapper();
        queryWrapper
                .isNotNull("create_time") //创建时间不为null
                .ge("age",20)       //age>=20;le是<=
                .between("age",25,30)// age在25到30之间
                .allEq(map) //根据传入的map匹配
                .notLike("name","a") //姓名中不包含字符“a”
                .likeRight("name","V") //姓名以“V”结尾；likeLeft即以某个字符开头
                .inSql("id","select id from user where name = 'VAL'");//子查询，id在子查询结                                                                     果内的数据
     User user = userMapper.selectOne(queryWrapper);//相当于limit 1；
    }

其他多条件查询操作，参考https://mp.baomidou.com/guide/wrapper.html

代码生成器

  1. 导入依赖

    <!--        代码生成器依赖-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.4.1<ersion>
            </dependency>
    <!--        添加模板引擎依赖，此处导入得模板是velocity,需要与后续配置中得模板一致-->                            
            <dependency>
                <groupId>org.apache.velocity</groupId>
                <artifactId>velocity-engine-core</artifactId>
                <version>2.3<ersion>
            </dependency>

     

  1. 编写配置

    • 全局配置

    GlobalConfig gc = new GlobalConfig();
            String projectPath = System.getProperty("user.dir");
            gc.setOutputDir(projectPath + "c/main/java");
            gc.setAuthor("CZ");  //设置作者信息
            gc.setOpen(false);

    • 数据源配置

         // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://localhost:3306/cz?useUnicode=true&useSSL=false&characterEncoding=utf8");
            dsc.setSchemaName("public");    //设置初始化实体类中的字段保护级别，可以根据需求改为private
            dsc.setDriverName("com.mysql.cj.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("123456");
        //设置字段转换关系，mp默认会把数据库datetime类型转为localdatetime；
            dsc.setTypeConvert(new ITypeConvert() {
                @Override
                public IColumnType processTypeConvert(GlobalConfig globalConfig, String fieldType) {
                    String t = fieldType.toLowerCase();
                    if(t.contains("datetime")){
                        return DbColumnType.DATE;
                    }
                    //其它字段采用默认转换（非mysql数据库可以使用其它默认的数据库转换器）
                    return new MySqlTypeConvert().processTypeConvert(globalConfig,fieldType);
                }
            });

    • 包结构配置

    // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setModuleName("mp");
            pc.setParent("com.cz");

    • 模板配置

    // 如果模板引擎是 freemarker
    // String templatePath = "/templates/mapper.xml.ftl";
    // 此处模板引擎是 velocity
    String templatePath = "/templates/mapper.xml.vm";
    ​

    • 自定义配置

    // 自定义配置
            InjectionConfig cfg = new InjectionConfig() {
                @Override
                public void initMap() {
                    // to do nothing
                }
            };
    // 自定义输出配置
            List<FileOutConfig> focList = new ArrayList<>();
            // 自定义配置会被优先输出
            focList.add(new FileOutConfig(templatePath) {
                @Override
                public String outputFile(TableInfo tableInfo) {
                    // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                    return projectPath + "c/main/resources/mapper/"
                            + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
                }
            });
    ​
            cfg.setFileOutConfigList(focList);

    • 策略配置

    // 策略配置
            StrategyConfig strategy = new StrategyConfig();
            strategy.setNaming(NamingStrategy.underline_to_camel);
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
    //        strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
            strategy.setEntityLombokModel(true);//自动生成lombok
            strategy.setRestControllerStyle(true);
            // 公共父类
    //        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
            // 写于父类中的公共字段
            strategy.setSuperEntityColumns("id");
            strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
            strategy.setControllerMappingHyphenStyle(true);
            strategy.setTablePrefix("sys_");   //该设置，用来过滤表前缀,此处会把所有得表明前缀sys过滤掉
            //设置自动填充，即，生成实体类就默认添加自动填充备注
            TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);
            TableFill createTime = new TableFill("create_time", FieldFill.UPDATE);
            ArrayList<TableFill> fills = new ArrayList<>();
            fills.add(createTime);
            fills.add(updateTime);
            strategy.setTableFillList(fills);
    ​

  2. 最终代码格式

public class MyGenerator{
/**
     * <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("CZ");
        gc.setOpen(false);
        mpg.setGlobalConfig(gc);
​
        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/cz?useUnicode=true&useSSL=false&characterEncoding=utf8");
         dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
                dsc.setTypeConvert(new ITypeConvert() {
            @Override
            public IColumnType processTypeConvert(GlobalConfig globalConfig, String fieldType) {
                String t = fieldType.toLowerCase();
                if(t.contains("datetime")){
                    return DbColumnType.DATE;
                }
                //其它字段采用默认转换（非mysql数据库可以使用其它默认的数据库转换器）
                return new MySqlTypeConvert().processTypeConvert(globalConfig,fieldType);
            }
        });
        mpg.setDataSource(dsc);
​
        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("mp");
        pc.setParent("com.cz");
        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/"
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
​
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
​
        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);
​
        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix("sys_");
        TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);
        TableFill createTime = new TableFill("create_time", FieldFill.UPDATE);
        ArrayList<TableFill> fills = new ArrayList<>();
        fills.add(createTime);
        fills.add(updateTime);
        strategy.setTableFillList(fills);
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new VelocityTemplateEngine());  
        //此处，如果模板设置得是freemarker，则需要new  FreemarkerTemplateEngine()
        mpg.execute();
    }
}    

配置多数据源

  1. 引入依赖

    <!--        多数据源依赖-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
                <version>2.5.4<ersion>
            </dependency>

  1. 添加数据源配置

    #设置默认的数据源或者数据源组,默认值即为master
    spring.datasource.dynamic.primary=master
    #主库配置
    spring.datasource.dynamic.datasource.master.username=root
    spring.datasource.dynamic.datasource.master.password=123456
    spring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driver
    spring.datasource.dynamic.datasource.master.url=jdbc:mysql://localhost:3306/cz?useSSL=false&characterEncoding=utf8
    #从库配置
    spring.datasource.dynamic.datasource.slave_1.username=root
    spring.datasource.dynamic.datasource.slave_1.password=123456
    spring.datasource.dynamic.datasource.slave_1.driver-class-name=com.mysql.cj.jdbc.Driver
    spring.datasource.dynamic.datasource.slave_1.url=jdbc:mysql://localhost:3306/test?useSSL=false&characterEncoding=utf8

  2. @DS注解，切换数据源

     @DS("slave_1")
        @Override
        public void insert() {
            System.out.println("使用数据源slave_1");
            SysPlayer sysPlayer = new SysPlayer();
            sysPlayer.setName("Zed");
            sysPlayer.setAge(20);
            playerMapper.insert(sysPlayer);
    ​
        }
        
        @DS("master")
        @Override
        public void select() {
            System.out.println("查询使用默认mater数据源");
            System.out.println(playerMapper.selectById(3l));
        }

  3. 启动观察

     

     

mybatis-plus旨在简化开发，可以在日常开发过程中帮我们省去很多基本代码编写得时间！

posted @ 2021-06-08 14:18  Vicious丶Sea  阅读(78)  评论(0)    收藏  举报