MyBatis-Plus的基本使用

什么是MyBatis-Plus?

官网给出的解释是：MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

并且具有以下特性：

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

框架的出现就是为了简化开发，可以看到MyBatis-Plus为我们提供了一系列强大的功能，接下来跟着官方文档的脚步一步步了解。

快速开始小项目

1、创建一个相应的springboot项目。
2、导入相应的依赖

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

        <!--导入mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--导入c3p0数据库连接池-->
        <dependency>
            <groupId>com.mchange</groupId>
            <artifactId>c3p0</artifactId>
            <version>0.9.5.5</version>
        </dependency>

        <!--导入mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.3.1</version>
        </dependency>
        
	 <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>

3、创建相应的数据库以及表

//创建表
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)
);

//给表插入数据
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、配置文件（application.yml）

c3p0:
  jdbcUrl: jdbc:mysql://localhost:3306/ssm_crud?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
  user: root
  password: 14796848713
  driverClass: com.mysql.cj.jdbc.Driver

5、创建实体类

public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
    
	....省略set\get
}

6、因为使用了c3p0所以需要配置类

@Configuration
public class Config_Demo {
    @Bean(name="dataSource")
    @Qualifier(value="dataSource")//限定描述符除了能根据名字进行注入，但能进行更细粒度的控制怎么选择候选者
    @Primary//用@Primary区分主数据源
    @ConfigurationProperties(prefix="c3p0")//指定配置文件中，前缀为c3p0的属性值
    public DataSource dataSource(){
        return DataSourceBuilder.create().type(ComboPooledDataSource.class).build();//创建数据源
    }
}

7、创建Mapper类

//继承了BaseMapper<T>接口，T写的是自己的实体类对象，启动时自动解析实体表关系映射转换为 Mybatis 内部对象注入容器，同时也自带了基本的CRUD方法
@Mapper
@Repository
public interface UserMapper extends BaseMapper<User> {
}

之后通过注入对象直接调用方法就能使用。
8、测试

@SpringBootTest
public class Mybatis_plusTest {
    @Autowired
    UserMapper userMapper;
@Test
    public void QuickStartTest(){
        List<User> users = userMapper.selectList(null);
        System.out.println(users);
    }
}

结果如下：

条件构造器

在配置文件上加上mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl 可以再控制台查看执行的sql语句。

还得创建一个对象QueryWrapper<User> wrapper=new QueryWrapper<>(); 该对象提供以下方法：

因为还继承了AbstractWrapper这个抽象类，所以也拥有该类的一些方法：

下面简单介绍几个常用的：

1、allEq方法

@Test
    public void QuickStartTest(){
    QueryWrapper<User> wrapper=new QueryWrapper<>();
    Map map=new HashMap();
    map.put("name","Jack");
    map.put("age",20);
    wrapper.allEq(map);
    List<User> users = userMapper.selectList(wrapper);
    System.out.println(users);
    }

结果如下：

2、between

3、like


4、in

以上都是我从官网截取，官方文档写的很详细。

主键自增

官方给出的定义如下：

手动测试一波：
1.首先给实体类的主键字段添加注解

2.插入测试

@Test
    public void QuickStartTest(){
        User user=new User("小明",20,"123456@qq,com");
        int insert = userMapper.insert(user);
    	System.out.println(insert);
}

结果如下：

自动填充

我们创建的表中一般都要有创建时间和修改时间两个字段，当我们插入或者修改时候，总不能每次都自己手动输入值，MyBatis-Plus就提供了自动填充的功能。

1、完善我们的实体类与数据库表，加上相应的字段。
2、在实体类中加上对应的注解


3、写配置类

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {

      this.setFieldValByName("create_time",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {

        this.setFieldValByName("update_time",new Date(),metaObject);

    }
}

4、测试

@Test
    public void QuickStartTest(){
        User user=new User("喜丰年",18,"123456@qq,com");
        int insert = userMapper.insert(user);
        System.out.println(insert);
}

结果如下：

分页

1、写配置类

 @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 添加分页插件
        PaginationInnerInterceptor pageInterceptor = new PaginationInnerInterceptor();
        // 设置请求的页面大于最大页后操作，true调回到首页，false继续请求。默认false
        pageInterceptor.setOverflow(false);
        // 单页分页条数限制，默认无限制
        pageInterceptor.setMaxLimit(50l);
        // 设置数据库类型
        pageInterceptor.setDbType(DbType.MYSQL);
        interceptor.addInnerInterceptor(pageInterceptor);
        return interceptor;
    }

2、测试

@Test
    public void QuickStartTest(){
    Page<User> page=new Page<>(2,3);
    Page<User> UserPage=userMapper.selectPage(page,null);
    page.getRecords().forEach(System.out::println);
}

结果如下：

乐观锁

乐观锁实现方式：

• 取出记录时，获取当前version
• 更新时，带上这个version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果version不对，就更新失败

就是查询时查出当前的version，执行更新时先看要更新的版本是不是对的，是不是还是原来的version，如果是就更新并且把version加一，如果不是则说明该数据已经被改动过了，不安全，执行更新失败。

1、数据库表和实体类加上相应的字段与注解

2、写配置文件
刚才注册分页的组件中加入语句interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());

官方给出说明如下

3、测试

@Test
    public void QuickStartTest(){
    User user=userMapper.selectById(1);
    user.setAge(14);
    user.setName("蜘蛛侠");
    userMapper.updateById(user);
}

结果如下：

逻辑删除

所谓的逻辑删除相当于隐藏，你在删除的时候只是把它隐藏了起来，不是物理上的删除，数据库管理员还是能看见这个表单记录。

1、在数据库表和实体类加上相应的字段和注解

2、写配置文件（application.yml）

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

3、测试

@Test
    public void QuickStartTest(){
    int i = userMapper.deleteById(1);
    System.out.println(i);
}

结果如下：

再查当前用户看看

代码生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成
Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

1、添加相应的依赖

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

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

2、写配置类

public class AutoGeneatorTest {
    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();
       mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        GlobalConfig gc=new GlobalConfig();
        gc.setOutputDir(System.getProperty("user.dir") + "/src/main/java");
        gc.setAuthor("hql");
        gc.setOpen(false);
        gc.setSwagger2(true); //实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

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

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("TestModule");
        pc.setParent("ex.hql");
        pc.setService("service");
        pc.setServiceImpl("serviceImpl");
        pc.setMapper("mapper");
        pc.setController("controller");
        pc.setEntity("entity");
        mpg.setPackageInfo(pc);

        //4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user");//这里是重点，填数据库表的名字，也可以填多个表，逗号隔开
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);

        //逻辑删除配置
        strategy.setLogicDeleteFieldName("deleted");

        // 自动填充配置
        TableFill gmtCreate = new TableFill("create_time", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("update_time", FieldFill.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(); //执行
    }

3、执行结果如下：

项目结构如下：