侧边栏壁纸
博主头像
威风博主等级

九万里风鹏正举,风休住,蓬舟吹取三山去。

  • 累计撰写 38 篇文章
  • 累计创建 23 个标签
  • 累计收到 0 条评论

目 录CONTENT

文章目录

MyBatisPlus

威风
2020-09-15 / 0 评论 / 0 点赞 / 141 阅读 / 13,181 字 / 正在检测是否收录...
温馨提示:
本文最后更新于 2022-04-10,若内容或图片失效,请留言反馈。部分素材来自网络,若不小心影响到您的利益,请联系我们删除。

MyBatisPlus

需要的基础:Mybatis Spring SpringMVC

为什么要学? MybatisPlus可以解决我们大量的工作的时间

JPA tk-mapper MyBatisPlus

简介

是什么?

官网 https://mp.baomidou.com/ Mybatis Plus , 简化Mybatis!

img

img

特性

  • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑

  • 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作

  • 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求,以后简单的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. 导入对应的依赖

  2. 研究依赖如何配置

  3. 代码如何编写

  4. 提高扩展技术能力

步骤

  1. 创建数据库 mybatis_plus
  2. 创建user表
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)
);
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');

-- 真实开发中,version(乐观锁) , deleted(逻辑删除) , gmt_create , gem_modified
  1. 编写项目,初始化项目 使用Spring boot初始化

img

img

  1. 导入依赖
        <!--导入数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--Lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--导入Mybatis-plus-->
        <!--Mybatis-plus并不是spring boot官方的-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>
  1. 说明: 我们使用mybatis-plus 可以节省我们大量的代码,尽量不要同时导入mybatis和mybatis-plus!
  2. 连接数据库! 这一步和mybatis相同!
# 主要 MySQL 5 和 MySQL 8 有不同点  这里使用的是MySQL 8 *** 代表数据库地址
spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://127.0.0.1:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
    driver-class-name: com.mysql.cj.jdbc.Driver
  1. 传统方式 pojo-dao (连接mybatis,配置mapper.xml 文件) -service-controller
  2. 使用了mybatis-plus之后
    • pojo
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {
    /**
     * 主键ID
     */
    private Long id;

    /**
     * 姓名
     */
    private String name;

    /**
     * 年龄
     */
    private Integer age;

    /**
     * 邮箱
     */
    private String email;

    private static final long serialVersionUID = 1L;
}
    • mapper接口
/**在对应的mapper实现基本的接口
 * @author 卫风
 * @date 2020/5/26 17:08
 */
@Repository  //代表持久层
public interface UserMapper extends BaseMapper<User> {
    //所有的CRUD 操作已经完成了
    //你不用像以前一样配置一大堆文件了!

}
    • 注意要在主启动类上去扫描我们的mapper包下的所有接口
@MapperScan("com.apt.mapper")  //扫描我们的mapper文件夹
    • 使用 , 在测试类中测试
@SpringBootTest
class MybatisPlusApplicationTests {
    //继承了baseMapper 所有的方法都来自父类 我们也可以编写自己的扩展方法
    @Autowired
    private UserMapper userMapper;

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

}
    • 结果 和基本项目结构
      img

思考问题?

      1. SQL谁帮我们写的? MyBatis-Plus
      2. 方法哪里来的? MyBatis-Plus 都写好了

配置日志

我们所有的sql现在是不可见的,我们希望知道它是怎末执行的,所以我们必须要看日志!

#配置日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

img

配置完日志后,后面的学习就需要注意这个自动生成的SQL ,就会喜欢上Mybatis-Plus!

CRUD 扩展

Insert 插入

    //测试插入
    @Test
    void testInsert(){
        User user = new User();
        user.setName("卫风");
        user.setAge(18);
        user.setEmail("1783246945@qq.com");
        int insert = userMapper.insert(user);   //帮我们自动生成id

        System.out.println(insert);  //受影响的行数

        System.out.println(user);    //发现id会自动回填
	}

img

数据库插入的默认值为: 全局的唯一id

主键生成策略

默认ID : IdType.ID_WORKER 全局唯一id

分布式系统唯一id 生成 : https://www.cnblogs.com/haoxinyue/p/5208136.html

雪花算法 :

snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0 可以保证几乎全球唯一!

主键自增

我们需要配置主键自增:

  1. 实体类字段上 @TableId(type = IdType.AUTO)
  2. 数据库字段一定要是自增!

img

  1. 再次测试插入即可!
    img

其余的源码解释

public enum IdType {
    AUTO(0),  		 //数据库id自增
    NONE(1),  		 //未设置主键
    INPUT(2),		 //手动输入
    ID_WORKER(3),	 //默认的全局唯一id
    UUID(4),		 //全局唯一id uuid
    ID_WORKER_STR(5);//ID_WORKER 字符串表示法
}

更新操作

    @Test
    void testUpdate(){
        User user = new User();
        //通过条件自动拼接动态sql
        user.setName("卫风--test");
        user.setId(1265218753394700291L);
        user.setEmail("1783246@qq.com");

        //注意 updateById 但是参数是一个对象
        int i = userMapper.updateById(user);
        System.out.println(i);
    }

img

所有的sql都是自动帮你动态配置的!

自动填充

创建时间 修改时间 ! 这些个操作都是自动化完成的,我们不希望手动更新!

阿里巴巴开发手册: 所有的数据库表 : gmt_create,gmt_modified 几乎所有的表都要配置上! 而且要自动化!

方式一 : 数据库级别(工作中不允许你修改数据库)

  1. 在表中新增字段 create_time ,update_time

img

  1. 测试插入方法,我们需要先把实体类同步
private Date creatTime;

private Date updateTime;
  1. 再次更新查看结构即可

img

方式二 : 代码级别

  1. 第一个删除数据库的默认值,更新操作!
    img
  2. 实体类的字段上属性上增加注解
/**
 * 字段添加填充内容
 */
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
  1. 编写处理器来处理
/**一定不要忘记把处理器加到IOC容器中!
 * @author 卫风
 * @date 2020/5/26 19:05
 */
@Component
@Slf4j
public class MyMetaObjectHandLer implements MetaObjectHandler {

    /**
     * 插入元对象字段填充(用于插入时对公共字段的填充)
     *
     * @param metaObject 元对象
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill .....");
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

    /**
     * 更新元对象字段填充(用于更新时对公共字段的填充)
     *
     * @param metaObject 元对象
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start insert fill .....");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}
  1. 测试插入
  2. 测试更新,观察时间即可!
    img

乐观锁

在面试过程中,我们经常会被问到乐观锁,悲观锁!

乐观锁: 顾名思义十分乐观,它总认为不会出现问题,无论干什么都不去上锁! 如果出现问题,再次更新值测试

悲观锁: 顾名思义十分悲观,它认为总是出现问题,无论干什么都会上锁! 再去操作!

乐观锁机制

乐观锁实现方式:

  • 取出记录时,获取当前version

  • 更新时,带上这个version

  • 执行更新时, set version = newVersion where version = oldVersion

  • 如果version不对,就更新失败

乐观锁 : 1 先查询,获得版本号 version = 1 
--a
update user set name = 'update',version = version+1 where id = 2 and version = 1
--b 线程抢先完成, 这个时候 version = 2 ,会导致 a  修改失败

测试一下mybatis-plus乐观锁插件

  1. 给数据库增加字段!
    img
  2. 我们实体类加对应的字段
@Version //乐观锁注解
private Integer version;
  1. 注册组件
/**
 * @author 卫风
 * @date 2020/5/26 20:55
 */
@EnableTransactionManagement
@Configuration  //配置类
@MapperScan("com.apt.mapper")  //扫描我们的mapper文件夹
public class MyBatisPlusConfig {
    /**
     * 注册乐观锁插件
     * @return
     */
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}
  1. 测试一下!
    //测试乐观锁成功
    @Test
    public void testOptimisticLockerInterceptor1(){
        //1 . 查询用户信息
        User user = userMapper.selectById(1L);
        //2 修改用户信息
        user.setName("卫风");
        user.setEmail("1783246945@qq.com");
        //3. 执行更新操作
        userMapper.updateById(user);

    }

    //测试乐观锁失败
    @Test
    public void testOptimisticLockerInterceptor2(){
        //1 . 查询用户信息
        User user = userMapper.selectById(1L);
        //2 修改用户信息
        user.setName("卫风11");
        user.setEmail("1783246945@qq.com");
        //模拟另外一个线程执行了插队操作
        User user1 = userMapper.selectById(1L);
        user1.setName("卫风22");
        user1.setEmail("1783246945@qq.com");
        userMapper.updateById(user1);
        
        //3. 执行更新操作  如果没有乐观锁 就会覆盖查到线程的值
        userMapper.updateById(user);

    }
  1. img

查询操作

/**
 * 测试查询
 */
@Test
void testSelectById(){
    User user = userMapper.selectById(1L);
    System.out.println(user);
}

/**
 * 测试批量查询!
 */
@Test
void testSelectByBathId(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2,3));

    users.forEach(System.out::println);
    
}

/**
 * 按条件查询map
 */
@Test
void testSelectByBatchIds(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","卫风");
    map.put("age",3);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分页查询

分页在网站使用的十分之多!

  1. 原始的 limit 进行分页

  2. pageHelper第三方插件

  3. mybatis-plus内置了分页插件

如何使用!

  1. 配置拦截器组件即可!
//分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
	return new PaginationInterceptor();
}
  1. 直接使用page对象即可!
/**
 *测试分页查询
 */
@Test
void testPage(){
    // 参数一 : 当前页
    // 参数二 : 页面大小
    // 使用了分页插件之后,所有的分页操作也变得简单了!

    Page<User> page = new Page<>(2,5);
    userMapper.selectPage(page,null);

    page.getRecords().forEach(System.out::println);

    System.out.println(page.getTotal());
}

删除操作

  1. 根据id删除记录
/**
 * 测试删除
 */
@Test
void testDeleteById(){
    userMapper.deleteById(1265218753394700291L);
}

/**
 * 通过id批量删除
 */
@Test
void testDeleteId(){
    userMapper.deleteBatchIds(Arrays.asList(1265218753394700296L,1265218753394700295L,1265218753394700294L));
}

/**
 * 通过map删除
 */
@Test
void testDeleteMap(){
    HashMap<String , Object> map = new HashMap<>();
    map.put("name","卫风");

    userMapper.deleteByMap(map);
}

我们在工作中遇到的逻辑删除!

逻辑删除

物理删除 : 从数据库中直接移除

逻辑删除 : 在数据库中没有被移除,而是通过一个变量来让他失效!

管理员可以查看被删除的记录!防止数据的丢失,类似于回收站!

测试一下 :

  1. 在数据库中增加一个deleted 字段
    img
  2. 实体类中增加属性
/**
 * 逻辑删除
 */
@TableLogic
private  Integer deleted;
  1. 配置!
/**
 * 逻辑删除组件
 * @return
 */
@Bean
public ISqlInjector sqlInjector(){
    return new LogicSqlInjector();
}
# 配置逻辑删除
mybatis-plus:
  global-config:
    db-config:
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
    1. 测试一下删除
      img
      记录依旧在数据库 但是值却已经变了
      img
      img
      以上的所有CRUD操作及其扩展操作 ,我们都必须精通掌握! 会大大提高你的工作和写项目的效率!

性能分析插件

我们平时的开发中,会遇到一些慢sql,测试! druid....

作用 : 性能分析拦截器,用于输出每条 SQL 语句及其执行时间

MP也提供性能分析插件,如果超过这个时间就停止运行!

  1. 导入插件
/**
 * SQL执行效率插件
 */
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {

    PerformanceInterceptor interceptor = new PerformanceInterceptor();
    //  ms 设置sql执行的最大时间  如果超过则不执行

    interceptor.setMaxTime(100);
    //是否会格式化
    interceptor.setFormat(true);
    return interceptor;
}
  1. 记住,要做spring boot中配置环境为 dev 或者 test!
  2. 测试使用
@Test
void contextLoads() {
    //参数是一个Wrapper ,条件构造器 ,这里我们先用 null 查询全部用户
    List<User> users = userMapper.selectList(null);
    users.forEach(System.out::println);
}
  1. 只要超过规定的时间就会抛出异常!
    img

使用性能分析插件可以帮助我们提高效率!

条件构造器

十分重要 : Wrapper

我们写一下复杂的sql就可以使用他来替代!

img

  1. 测试一
@Test
void contextLoads(){
    //查询name不为空的用户, 并且邮箱不为空的用户,年龄大于等于12
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper
            .isNotNull("name")
            .isNotNull("email")
            .ge("age",12);
    userMapper.selectList(wrapper).forEach(System.out::println);
}
  1. 测试二
@Test
void test2(){
    //查询名字 卫风
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","卫风");
    //查询一个数据 , 出现多个数据使用list 或者 map
    userMapper.selectOne(wrapper);
}
  1. 测试三
@Test
void test3(){
    //查询年龄在20~30 岁之间的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age",20,30);
    //查询一个数据 , 出现多个数据使用list 或者 map
    Integer integer = userMapper.selectCount(wrapper);
    System.out.println(integer);

}
  1. 测试四
@Test
void test4(){
    //模糊查询
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //名字中不包含e的  以t开头的
    wrapper.notLike("name","e")
            .likeRight("email","t");
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);

}
  1. img
  2. 测试五
@Test
void test5(){
    //模糊查询
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //id 在子查询中查出来
    wrapper.inSql("id","select id from user where id < 3");
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);

}
  1. img

    1. 测试六
@Test
void test6(){

    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //通过id进行排序 desc 降序  asc  升序
    wrapper.orderByDesc("id");
    List<User> maps = userMapper.selectList(wrapper);
    maps.forEach(System.out::println);
}

img

其余的看官方文档练习即可

代码生成器

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

    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("卫风");
        //是否打开输出目录
        gc.setOpen(false);
        //去Service的I前缀
        gc.setServiceName("%sService");
        //实体属性 Swagger2 注解
        gc.setSwagger2(true);
        //是否覆盖
        gc.setFileOverride(false);
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://rm-2ze13vnm5ppw8xllvho.mysql.rds.aliyuncs.com:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("caoweifeng");
        dsc.setPassword("_RUKVaSYwLwkN7G");
        //设置数据库类型
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();

       	//父包名。如果为空,将下面子包名必须写全部, 否则就只需写子包名
        pc.setParent("com.apt");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);


        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        //设置要映射的表名  参数可以为多个
        strategy.setInclude("user");
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //开启lombok注解
        strategy.setEntityLombokModel(true);
        //设置逻辑删除
        strategy.setLogicDeleteFieldName("deleted");

        //设置自动填充配置  国际命名 规范是  创建时间 : gmt_create  修改时间 : gmt_modified
        TableFill createTime = new TableFill("create_time", FieldFill.INSERT);
        TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(createTime);
        tableFills.add(updateTime);
        strategy.setTableFillList(tableFills);
        //乐观锁
        strategy.setVersionFieldName("version");
		 strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);
        //strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
       // mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

这样就可以自动生成代码 其他的根据自己情况修改即可 注意 他这个会生成在项目路径下

img

img

可能会报一下错误

img

原因mp默认的模板引擎是 velocity

导入对应的依赖即可 注意 你的模板引擎如果设置为别的 导入对应的依赖即可 官网有详细的自定义模板引擎方法 参考即可

0

评论区