day01-MyBatis入门

作者: 刊ing | 来源:发表于2020-06-28 17:54 被阅读0次

01-MyBatisPlus简介

一、简介

官网：http://mp.baomidou.com/

参考教程：http://mp.baomidou.com/guide/

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

二、特性

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

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

强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求

支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错

支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多种数据库

支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题

支持 XML 热加载：Mapper 对应的 XML 支持热加载，对于简单的 CRUD 操作，甚至可以无 XML 启动

支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作

支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）

支持关键词自动转义：支持数据库关键词（order、key......）自动转义，还可自定义关键词

内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用

内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询

内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询

内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

内置 Sql 注入剥离器：支持 Sql 注入剥离，有效预防 Sql 注入攻击

02-MyBatisPlus入门

快速开始参考：http://mp.baomidou.com/guide/quick-start.html

测试项目： mybatis_plus

数据库：mybatis_plus

一、创建并初始化数据库

二、初始化工程

使用 Spring Initializr 快速初始化一个 Spring Boot 工程

Group：com.atguigu

Artifact：mybatis-plus

版本：2.2.1.RELEASE

三、添加依赖

1、引入依赖

spring-boot-starter、spring-boot-starter-test

添加：mybatis-plus-boot-starter、MySQL、lombok、

在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写

2、idea中安装lombok插件

setting-->plugins

四、配置

在 application.properties 配置文件中添加 MySQL 数据库的相关配置：

mysql5

#mysql数据库连接

spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus

spring.datasource.username=root

spring.datasource.password=123456

mysql8以上（spring boot 2.1）

注意：driver和url的变化

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8

spring.datasource.username=root

spring.datasource.password=123456

注意：

1、这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了 8.0版本的jdbc驱动，这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value 'ÖÐ¹ú±ê×¼Ê±¼ä' is unrecognized or represents more

2、这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息

五、编写代码

1、主类

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹

注意：扫描的包名根据实际情况修改

@SpringBootApplication

@MapperScan("com.atguigu.mybatisplus.mapper")

publicclassMybatisPlusApplication{

......

}

2、实体

创建包 entity 编写实体类 User.java（此处使用了 Lombok 简化代码）

@Data

publicclassUser{

    privateLongid;

    privateStringname;

    privateIntegerage;

    privateStringemail;

}

3、mapper

创建包 mapper 编写Mapper接口：UserMapper.java

package com.example.mpdemo.mapper;import com.baomidou.mybatisplus.core.mapper.BaseMapper;import com.example.mpdemo.entity.User;import org.springframework.stereotype.Repository;

@Repository

public interface UserMapper extends BaseMapper<User>{

}

六、开始使用

添加测试类，进行功能测试

注意：

IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。

为了避免报错，可以在 dao 层的接口上添加 @Repository 注解。

七、配置日志

查看sql输出日志

#mybatis日志

mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

03-MyBatisPlus的CRUD 接口

一、insert

1、插入操作

intresult=userMapper.insert(user);

注意：数据库插入id值默认为：全局唯一id

2、主键策略

（1）ID_WORKER

MyBatis-Plus默认的主键策略是：ID_WORKER 全局唯一ID

参考资料：分布式系统唯一ID生成方案汇总：https://www.cnblogs.com/haoxinyue/p/5208136.html

（2）自增策略

要想主键自增需要配置如下主键策略

需要在创建数据表的时候设置主键自增

实体字段中配置 @TableId(type = IdType.AUTO)

@TableId(type=IdType.AUTO)

private Longid;

要想影响所有实体的配置，可以设置全局主键配置

#全局设置主键生成策略

mybatis-plus.global-config.db-config.id-type=auto

其它主键策略：分析 IdType 源码可知

@Getter

public enum IdType{

/**

* 数据库ID自增

*/

AUTO(0),

/**

* 该类型为未设置主键类型

*/

NONE(1),

/**

* 用户输入ID

* 该类型可以通过自己注册自动填充插件进行填充

*/

INPUT(2),

/* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */

/**

* 全局唯一ID (idWorker)

*/

ID_WORKER(3),

/**

* 全局唯一ID (UUID)

*/

UUID(4),

/**

* 字符串全局唯一ID (idWorker 的字符串表示)

*/

ID_WORKER_STR(5);

private int key;

IdType(int key) {

this.key=key;

}

}

二、update

1、根据Id更新操作

注意：update时生成的sql自动是动态sql：UPDATE user SET age=? WHERE id=?

//修改操作

@Test

void updateUser() {

    User user =new User();

    user.setId(2L);

    user.setAge(120);

    int row =userMapper.updateById(user);

    System.out.println(row);

}

2、自动填充

项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。

我们可以使用MyBatis Plus的自动填充功能，完成这些字段的赋值工作：

（1）数据库表中添加自动填充字段

在User表中添加datetime类型的新的字段 create_time、update_time

（2）实体上添加注解

@TableField(fill =FieldFill.INSERT)

private Date createTime;

@TableField(fill =FieldFill.INSERT_UPDATE)

private Date updateTime;

（3）实现元对象处理器接口

注意：不要忘记添加 @Component 注解

package com.example.mpdemo.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;

import org.apache.ibatis.reflection.MetaObject;

import org.springframework.stereotype.Component;

import java.util.Date;

@Component

public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override

public void insertFill(MetaObject metaObject) {

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

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

    }

    @Override

public void updateFill(MetaObject metaObject) {

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

    }

}

3、乐观锁

主要适用场景：当要更新一条记录的时候，希望这条记录没有被别人更新，也就是说实现线程安全的数据更新

乐观锁实现方式：

取出记录时，获取当前version

更新时，带上这个version

执行更新时， set version = newVersion where version = oldVersion

如果version不对，就更新失败

（1）数据库中添加version字段

ALTER TABLE `user` ADD COLUMN version INT;

（2）实体类添加version字段

并添加 @Version 注解

@Version

@TableField(fill =FieldFill.INSERT)

private Integer version;

（3）元对象处理器接口添加version的insert默认值

package com.example.mpdemo.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;

import org.apache.ibatis.reflection.MetaObject;

import org.springframework.stereotype.Component;

import java.util.Date;

@Component

public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override

public void insertFill(MetaObject metaObject) {

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

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

        this.setFieldValByName("version",1,metaObject);

    }

    @Override

public void updateFill(MetaObject metaObject) {

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

    }

}

特别说明:

支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime

整数类型下 newVersion = oldVersion + 1

newVersion 会回写到 entity 中

仅支持 updateById(id) 与 update(entity, wrapper) 方法

在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

（4）在 MybatisPlusConfig 中注册 Bean

创建配置类

package com.example.mpdemo.config;

import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;

import org.mybatis.spring.annotation.MapperScan;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

@Configuration //配置类

@MapperScan("com.example.mpdemo.mapper") //将启动类中的删除在配置类中编写

public class MpConfig {

    /**

* 乐观锁插件

*/

@Bean

public OptimisticLockerInterceptor optimisticLockerInterceptor() {

        return new OptimisticLockerInterceptor();

    }

}

（5）测试乐观锁可以修改成功

测试后分析打印的sql语句，将version的数值进行了加1操作

//测试乐观锁

@Test

void testOptimisticLocker(){

    //根据id查询数据

User user =userMapper.selectById(1277422156430458882L);

    //修改数据

user.setName("Helen Yao");

    user.setEmail("helen@qq.com");

    //执行更新

userMapper.updateById(user);

}

三、select

1、根据id查询记录

Useruser=userMapper.selectById(1L);

2、通过多个id批量查询

完成了动态sql的foreach的功能

//多个id批量查询

@Test

void testSelectDemo1(){

List<User> users =userMapper.selectBatchIds(Arrays.asList(1L,2L,3L));

System.out.println(users);

}

3、简单的条件查询

通过map封装查询条件

@Test

public void testSelectByMap(){

    HashMapmap =new HashMap<>();

    map.put("name","Helen Yao");

    map.put("age",60);

    List users =userMapper.selectByMap(map);

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

}

注意：map中的key对应的是数据库中的列名。例如数据库user_id，实体类是userId，这时map的key需要填写user_id

4、分页

MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能

（1）创建配置类

此时可以删除主类中的 @MapperScan 扫描注解

/**

* 分页插件

*/

@Bean

public PaginationInterceptor paginationInterceptor() {

return new PaginationInterceptor();

}

（2）测试selectPage分页

测试：最终通过page对象获取相关数据

//分页查询

@Test

void testPage(){

    //1 创建page对象

//传入两个参数：当前页和每页显示记录数

Pagepage =new Page<>(1,3);

    //调用mp分页查询的方法

//调用mp分页查询过程中，底层封装

//把分页所有数据封装到page对象里面

userMapper.selectPage(page,null);

    //通过page对象获取分页数据

System.out.println(page.getCurrent());

    System.out.println(pa ge.getPages());//每页数据list集合

System.out.println(page.getSize());

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

    System.out.println(page.hasNext());

    System.out.println(page.hasPrevious());

}

控制台sql语句打印：SELECT id,name,age,email,create_time,update_time,version FROM user LIMIT 0,3

四、delete

1、根据id删除记录

//删除操作（物理删除）

@Test

void testDeleteById(){

int result =userMapper.deleteById(1L);

System.out.println(result);

}

2、批量删除

//批量删除

@Test

public void testDeleteBatchIds() {

int result =userMapper.deleteBatchIds(Arrays.asList(8,9,10));

System.out.println(result);

}

3、简单的条件查询删除

@Test

public void testDeleteByMap() {

    HashMap<String, Object> map =new HashMap<>();

    map.put("name","lucy");

    map.put("age",120);

    int result =userMapper.deleteByMap(map);

    System.out.println(result);

}

4、逻辑删除

物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据

逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录

（1）数据库中添加 deleted字段

ALTER TABLE `user` ADD COLUMN `deleted` boolean

（2）实体类添加deleted字段

并加上 @TableLogic 注解和 @TableField(fill = FieldFill.INSERT) 注解

@TableLogic //逻辑删除的注解

@TableField(fill =FieldFill.INSERT)

private Integer deleted;

（3）元对象处理器接口添加deleted的insert默认值

this.setFieldValByName("deleted",0,metaObject);

（4）application.properties 加入配置

此为默认值，如果你的默认值和mp默认的一样,该配置可无

#mybatis-plus.global-config.db-config.logic-delete-value=1

#mybatis-plus.global-config.db-config.logic-not-delete-value=0

（5）在 MybatisPlusConfig 中注册 Bean

@Bean

public ISqlInjector sqlInjector() {

return new LogicSqlInjector();

}

（6）测试逻辑删除

测试后发现，数据并没有被删除，deleted字段的值由0变成了1

测试后分析打印的sql语句，是一条update

注意：被删除数据的deleted 字段的值必须是 0，才能被选取出来执行逻辑删除的操作

/**

* 测试逻辑删除

*/

@Test

public void testLogicDelete() {

int result =userMapper.deleteById(1L);

System.out.println(result);

}

（7）测试逻辑删除后的查询

MyBatis Plus中查询操作也会自动添加逻辑删除字段的判断

/**

* 测试逻辑删除后的查询：

* 不包括被逻辑删除的记录

*/

@Test

public void testLogicDeleteSelect() {

        User user =new User();

        Listusers =userMapper.selectList(null);

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

}

测试后分析打印的sql语句，包含 WHERE deleted=0

SELECT id,name,age,email,create_time,update_time,version,deleted FROM user WHERE deleted=0

五、性能分析

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

SQL 性能执行分析,开发环境使用，超过指定时间，停止运行。有助于发现问题

1、配置插件

（1）参数说明

参数：maxTime： SQL 执行最大时长，超过自动停止运行，有助于发现问题。

参数：format： SQL是否格式化，默认false。

（2）在 MybatisPlusConfig 中配置

/**

* SQL 执行性能分析插件

* 开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长

*

*三种环境

* dev:开发环境

* test:测试环境

* prod:生产环境

*/

@Bean

@Profile({"dev","test"}) // 设置 dev test 环境开启

public PerformanceInterceptor performanceInterceptor() {

    PerformanceInterceptor performanceInterceptor =new PerformanceInterceptor();

    performanceInterceptor.setMaxTime(100);//ms，超过此处设置的ms则sql不执行

performanceInterceptor.setFormat(true);

    return performanceInterceptor;

}

（3）Spring Boot 中设置dev环境

#环境设置：dev、test、prod

spring.profiles.active=dev

可以针对各环境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties

也可以自定义环境名称：如test1、test2

2、测试

六、其它

如果想进行复杂条件查询，那么需要使用条件构造器 Wapper，涉及到如下方法

1、delete

2、selectOne

3、selectCount

4、selectList

5、selectMaps

6、selectObjs

7、update

04-MyBatisPlus条件构造器

一、wapper介绍

Wrapper ：条件构造抽象类，最顶端父类

AbstractWrapper ：用于查询条件封装，生成 sql 的 where 条件

QueryWrapper ： Entity 对象封装操作类，不是用lambda语法

UpdateWrapper ： Update 条件封装，用于Entity对象更新操作

AbstractLambdaWrapper ： Lambda 语法使用 Wrapper统一处理解析 lambda 获取 column。

LambdaQueryWrapper ：看名称也能明白就是用于Lambda语法使用的查询Wrapper

LambdaUpdateWrapper ： Lambda 更新封装Wrapper

二、AbstractWrapper

注意：以下条件构造器的方法入参中的 column 均表示数据库字段

1、ge、gt、le、lt、isNull、isNotNull

//创建QueryWrapper对象

QueryWrapper<User> wrapper =new QueryWrapper<>();

//通过QueryWrapper设置条件

//大于等于ge、大于gt、le、lt

//查询age>=30记录

//第一个参数字段名称，第二个参数设置值

wrapper.ge("age",60);

List<User> users =userMapper.selectList(wrapper);

System.out.println(users);

2、eq、ne

注意：seletOne返回的是一条实体记录，当出现多条时会报错

//eq、ne

//wrapper.eq("name","东方");

wrapper.ne("name","东方");

List<User> users =userMapper.selectList(wrapper);

System.out.println(users);

3、between、notBetween

包含大小边界

wrapper.between("age",20,60);

List<User> users =userMapper.selectList(wrapper);

System.out.println(users);

4、allEq

//allEq

Map<String,Object> map =new HashMap<>();

map.put("id",2);

map.put("name","Jack");

wrapper.allEq(map);

List<User> users =userMapper.selectList(wrapper);

System.out.println(users);

5、like、notLike、likeLeft、likeRight

selectMaps返回Map集合列表

wrapper.like("name","T");

List users =userMapper.selectList(wrapper);

System.out.println(users);

6、in、notIn、inSql、notinSql、exists、notExists

in、notIn：

notIn("age", 1, 2, 3)--->age not in (1,2,3)

inSql、notinSql：可以实现子查询

例: wrapper.inSql("id","1,2,3,4");--->wrapper.in("id",2,3,4,5);

例: inSql("id", "select id from table where id < 3")--->id in (select id from table where id < 3)

@Test

publicvoidtestSelectObjs() {

        QueryWrapper<User> queryWrapper=newQueryWrapper<>();

        //queryWrapper.in("id", 1, 2, 3);

        queryWrapper.inSql("id","select id from user where id < 3");

        List<Object>objects=userMapper.selectObjs(queryWrapper);//返回值是Object列表

        objects.forEach(System.out::println);

}

SELECT id,name,age,email,create_time,update_time,version,deleted FROM user WHERE deleted=0 AND id IN (select id from user where id < 3)

7、or、and

注意：这里使用的是 UpdateWrapper

不调用or则默认为使用 and 连

@Test

void testUpdate1(){

    User user =new User();

    user.setAge(99);

    user.setName("Andy");

    UpdateWrapperuserUpdateWrapper =new UpdateWrapper<>();

    userUpdateWrapper.like("name","h")

        .or()

        .between("age",20,40);

    int result =userMapper.update(user,userUpdateWrapper);

    System.out.println(result);

}

UPDATE user SET name=?, age=?, update_time=? WHERE deleted=0 AND name LIKE ? OR age BETWEEN ? AND ?

8、嵌套or、嵌套and

这里使用了lambda表达式，or中的表达式最后翻译成sql时会被加上圆括号

userUpdateWrapper

.like("name","h")

.or(i->i.eq("name","李白").ne("age",20));

UPDATE user SET name=?, age=?, update_time=?

WHERE deleted=0 AND name LIKE ?

OR ( name = ? AND age <> ? )

9、orderBy、orderByDesc、orderByAsc

queryWrapper.orderByDesc("id");

10、last

直接拼接到 sql 的最后

注意：只能调用一次,多次调用以最后一次为准有sql注入的风险,请谨慎使用

queryWrapper.last("limit 1");

SELECT id,name,age,email,create_time,update_time,deleted,version

FROM user WHERE deleted=0 limit 1

11、指定要查询的列

queryWrapper.select("id","name","age");

SELECT id,name,age FROM user WHERE deleted=0

12、set、setSql

最终的sql会合并 user.setAge()，以及 userUpdateWrapper.set() 和 setSql() 中的字段

userUpdateWrapper

    .like("name","h")

    .set("name","老李头")//除了可以查询还可以使用set设置修改的字段

    .setSql(" email = '123@qq.com'");//可以有子查询

UPDATE user SET age=?, update_time=?, name=?, email = '123@qq.com' WHERE deleted=0 AND name LIKE ?