MyBatis-Plus01_简介、入门案例、BaseMapper与IService中的CRUD以及常用的注解

目录

①. MyBatis-plus简介

②. MyBatis-plus入门案例

③. BaseMapper中的CRUD

④. 通用Service的CRUD

⑤. MyBatis-plus中常用注解@TableName：

⑥. 常用注解@TableId

⑦. 雪花算法

⑧常用注解@TableField

⑨. 常用注解@TableLogic——逻辑删除专用注解

①. MyBatis-plus简介

• ①. MyBatis-Plus(简称 MP)是一个 MyBatis的增强工具,在MyBatis的基础上只做增强不做改变,为简化开发、提高效率而生。MyBatis-Plus提供了通用的mapper和service,可以在不编写任何SQL语句的情况下,快速的实现对单表的CRUD、批量、逻辑删除、分页等操作。(我们的愿景是成为MyBatis最好的搭档,就像魂斗罗中的1P、2P,基友搭配,效率翻倍)

• ②. 特性

1. 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
2. 损耗小:启动即会自动注入基本CURD,性能基本无损耗,直接面向对象操作
3. 强大的CRUD操作:内置通用Mapper、通用Service,仅仅通过少量配置即可实现单表大部分CRUD操作,更有强大的条件构造器,满足各类使用需求
4. 支持Lambda形式调用:通过Lambda表达式,方便的编写各类查询条件,无需再担心字段写错
5. 支持主键自动生成:支持多达4种主键策略(内含分布式唯一ID生成器-Sequence),可自由配置,完美解决主键问题
6. 支持ActiveRecord模式:支持ActiveRecord形式调用,实体类只需继承Model类即可进行强大的CRUD操作
7. 支持自定义全局通用操作:支持全局通用方法注入(Writeonce,useanywhere)
8. 内置代码生成器:采用代码或者Maven插件可快速生成Mapper、Model、Service、Controller层代码,支持模板引擎,更有超多自定义配置等您来使用
9. 内置分页插件:基于MyBatis物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通List查询
10. 分页插件支持多种数据库:支持MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer等多种数据库
11. 内置性能分析插件:可输出SQL语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询
12. 内置全局拦截插件:提供全表delete、update操作智能分析阻断,也可自定义拦截规则,预防误操作

• ③. 支持的数据库

MySQL,Oracle,DB2,H2,HSQL,SQLite,PostgreSQL,SQLServer,Phoenix,Gauss ,ClickHouse,Sybase,OceanBase,Firebird,Cubrid,Goldilocks,csiidb
达梦数据库,虚谷数据库,人大金仓数据库,南大通用(华库)数据库,南大通用数据库,神通数据库,瀚高数据库

• ④. 框架结构

        从扫描实体类开始,通过反射技术将实体类中的属性进行抽取,抽取后来分析当前表和实体类之间的关系,以及通过反射技术抽取出来的实体类中的属性与当前字段的关系,根据调用的方法,来生成相对应的SQL语句,将SQL语句注入到mybatis的容器中

•  ⑤. 官方文档

②. MyBatis-plus入门案例

• ①. 创建一张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, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');

• ②. 添加依赖

 
        
            org.springframework.boot
            spring-boot-starter
        

        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        
            com.baomidou
            mybatis-plus-boot-starter
            3.5.1
        
        
        
            mysql
            mysql-connector-java
            5.1.49
        
        
        
            org.projectlombok
            lombok
            1.18.8
        
    

• ③. 在application.yml中配置数据源信息并添加日志以便于查看sql语句

spring:
  datasource:
    #数据源信息，默认就是Hikari
    type: com.zaxxer.hikari.HikariDataSource
    #配置连接数据库的信息
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus?userSSL=false
    username: root
    password: 
#mybatis-plus日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

1、驱动类driver-class-name

spring boot 2.0 （内置 jdbc5 驱动），驱动类使用：

driver-class-name : com.mysql.jdbc.Driver

spring boot 2.1 及以上（内置 jdbc8 驱动），驱动类使用：

driver-class-name: com.mysql.cj.jdbc.Driver

否则运行测试用例的时候会有 WARN 信息

2、连接地址url

MySQL5.7 版本的 url ：

jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false

MySQL8.0 版本的 url ：

jdbc:mysql://localhost:3306/mybatis_plus?

serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false

否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is unrecognized or

represents more

• ④. 为启动类添加mapper包扫描 

@SpringBootApplication
@MapperScan("com.songqiao.mybatisplus.mapper")
public class MybatisplusApplication {
    public static void main(String[] args){
        SpringApplication.run(MybatisplusApplication.class, args);
    }
}

• ⑤. 添加实体类与数据库字段映射(此处使用了 Lombok (opens new window) 简化代码)

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Integer isDeleted;
}

• ⑥. 编写mapper包下的UserMapper接口使其继承MyBatis-plus提供的模板mapper：BaseMapper

@Mapper
public interface UserMapper extends BaseMapper {
}

⑦. 添加测试类进行测试

@SpringBootTest
class MybatisPlusApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @DisplayName("查询全部")
    @Test
    public void testSelectList(){
        //通过条件构造器查询一个list集合，无条件设置null为参数
        List users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

③. BaseMapper中的CRUD

①. 新增：int insert(T entity)

最终执行的结果,所获取的id为147575498278871312,这是因为MyBatis-Plus在实现插入数据时,会默认基于雪花算法的策略生成id

    @DisplayName("新增测试")
    @Test
    //INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
    public void testInsert(){
        User user=new User(null,"桥哥",23,"[email protected]",null);
        int i = userMapper.insert(user);
        System.out.println("受影响的行数:"+i);
        System.out.println("id:"+user.getId());
    }

②. 删除：

根据id删除：int deleteById(Serializable id);

根据map中设置的条件删除：int deleteByMap(@Param(“cm”) Map columnMap);

通过多个id实现批量删除：int deleteBatchIds(@Param("cm") Collection idList);

    @DisplayName("多种删除方式:id删除，条件删除、批量删除")
    @Test
    public void testDelete(){

        //DELETE FROM user WHERE id=?
        int delete = userMapper.deleteById(1659152120739282946L);
        System.out.println(delete);

        // DELETE FROM user WHERE name = ? AND age = ?
        Map map=new HashMap<>();
        map.put("name","张三");
        map.put("age",23);
        int byMap = userMapper.deleteByMap(map);
        System.out.println(byMap);

        //DELETE FROM user WHERE id IN ( ? , ? )
        List numbers = Arrays.asList(8L, 9L,10L);
        int batchIds = userMapper.deleteBatchIds(numbers);
        System.out.println(batchIds);
    }

③. 修改：int updateById(@Param("cm") T entity);

@DisplayName("修改方法")
    @Test
    public void testUpdate(){
        //根据id修改用户信息
        // UPDATE user SET name=?, email=? WHERE id=?
        User user=new User();
        user.setId(3L);
        user.setName("龙城桥少");
        user.setEmail("[email protected]");
        int updateById = userMapper.updateById(user);
        System.out.println(updateById);
    }

④. 查询：

根据id查询：T selectById(Serializable id);

根据多个id查询：List selectBatchIds(@Param("c") Collection idList);

根据map条件查询：List selectByMap(@Param("c") Map columnMap);

查询全部：List selectList(@Param("c") Wrapper queryWrapper);

    @DisplayName("查询的各种方式")
    @Test
    public void testSelect(){
        //根据id查询用户信息
        User user = userMapper.selectById(3L);
        System.out.println(user);
        //根据多个id批量查询
        //SELECT id,name,age,email FROM user WHERE id IN ( ? , ? )
        List longs = Arrays.asList(3L, 4L);
        List list = userMapper.selectBatchIds(longs);
        list.forEach(System.out::println);
        //根据map条件查询
        // SELECT id,name,age,email FROM user WHERE name = ?
        Map map=new HashMap<>();
        map.put("name","龙城桥少");
        List list1 = userMapper.selectByMap(map);
        System.out.println(list1);
        //通过条件构造器查询一个list集合，无条件设置null为参数
        //SELECT id,name,age,email,is_deleted FROM t_user
        List users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

④. 通用Service的CRUD

• ①. 通用Service CRUD封装IService (opens new window)接口,进一步封装CRUD采用get查询单行remove删除list查询集合page分页 前缀命名方式区分Mapper层避免混淆
• ②. 泛型T为任意实体对象
• ③. 建议如果存在自定义通用Service方法的可能,请创建自己的IBaseService继承Mybatis-Plus提供的基类
• ④. 对象 Wrapper 为 条件构造器
• ⑤. 查看IService接口和ServiceImpl实现类

/**
* UserService继承IService模板提供的基础功能
*/
public interface UserService extends IService {
}

/**
* ServiceImpl实现了IService，提供了IService中基础功能的实现
* 若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现
*/
@Service
public class UserServiceImpl extends ServiceImpl implements UserService {
}

• ⑥. 查询记录条数与批量添加功能

    @Autowired
    UserService userService;

    @DisplayName("查询记录数")
    @Test
    public void testGetCount(){
        //SELECT COUNT( * ) FROM user WHERE (name LIKE ?)
        QueryWrapper wrapper=new QueryWrapper<>();
        wrapper.like("name","桥");
        long count = userService.count(wrapper);
        System.out.println("总记录数："+count);
    }

    @DisplayName("批量添加")
    @Test
    public void testInsertMore(){
        List list=new ArrayList<>();
        for (int i = 0; i <=10 ; i++) {
            User user=new User();
            user.setName("wsq"+i);
            user.setAge(20+i);
            list.add(user);
        }
        boolean b = userService.saveBatch(list);
        System.out.println(b);
    }

• ⑦. IService中的查询方法：

// 查询所有
List list();
// 查询列表
List list(Wrapper queryWrapper);
// 查询（根据ID 批量查询）
Collection listByIds(Collection idList);
//listByIds底层还是调用的this.getBaseMapper().selectBatchIds(idList);方法
// 查询（根据 columnMap 条件）
Collection listByMap(Map columnMap);
// 查询所有列表
List> listMaps();
// 查询列表
List> listMaps(Wrapper queryWrapper);
// 查询全部记录
List