MyBatis-Plus01_概述初始化工程BaseMapper和Service中的CRUD常用注解

Posted 所得皆惊喜

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了MyBatis-Plus01_概述初始化工程BaseMapper和Service中的CRUD常用注解相关的知识，希望对你有一定的参考价值。

文章目录

①. 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, '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');

  • ②. 添加依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.8.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.xiaozhi.mybatisplus</groupId>
    <artifactId>study_mybatisplus</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>study_mybatisplus</name>
    <description>mybatisplus的学习</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
        <!--导入mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.17</version>
        </dependency>
        <!--简化实体类,用@Data代替getset方法-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.8</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
  • ③. 在application.yml配置数据源信息
spring:
  datasource:
    # 数据库选择8,要使用com.mysql.cj.jdbc.Driver
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/mybatis_plus?serverTimezone=CTT&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true
    username: root
    password: root
# 配置mybatis-plus的日志信息
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  • ④. 在Spring Boot启动类中添加@MapperScan注解,扫描Mapper文件夹:
@SpringBootApplication
//扫描mapper接口所在的包
@MapperScan("com.xiaozhi.mybatisplus.mapper")
public class StudyMybatisplusApplication 
    public static void main(String[] args) 
        SpringApplication.run(StudyMybatisplusApplication.class, args);
  • ⑤. 写实体类 User.java(此处使用了 Lombok (opens new window) 简化代码)
@Data
public class User 
    private Long id;
    private String name;
    private Integer age;
    private String email;
  • ⑥. 编写Mapper包下的 UserMapper接口
public interface UserMapper extends BaseMapper<User>
  • ⑦. 添加测试类,进行功能测试:
@SpringBootTest
@RunWith(SpringRunner.class)
@Slf4j
public class StudyMybatisplusApplicationTests 
    //这里的userMapper飘红了,我们可以在mapper.UserMapper添加注解(Repository)
    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() 
        System.out.println(("----- selectAll method test ------"));
        List<User> userList = userMapper.selectList(null);
        //Assert.assertEquals(5, userList.size());
        userList.forEach(System.out::println);

③. BaseMapper中的CRUD

  • ①. 新增:int insert(T entity)
    最终执行的结果,所获取的id为1475754982694199298,这是因为MyBatis-Plus在实现插入数据时,会默认基于雪花算法的策略生成id
@Test
public void testInsert()
    //实现新增用户信息
    //INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
    User user = new User();
    //user.setId(100L);
    user.setName("张三");
    user.setAge(23);
    user.setEmail("zhangsan@qq.com");
    int result = userMapper.insert(user);
    System.out.println("result:"+result);
    System.out.println("id:"+user.getId());
  • ②. 根据id、map、批量删除
  1. 通过id删除用户信息:int deleteById(T entity)
  2. 根据map集合中所设置的条件删除用户信息:int deleteByMap(@Param("cm") Map<String, Object> columnMap)
  3. 通过多个id实现批量删除:int deleteBatchIds(@Param("coll") Collection<?> idList)
@Test
public void testDelete()
    //通过id删除用户信息
    //DELETE FROM user WHERE id=?
    /*int result = userMapper.deleteById(1492767055210991617L);
    System.out.println("result:"+result);*/
    //根据map集合中所设置的条件删除用户信息
    //DELETE FROM user WHERE name = ? AND age = ?
    /*Map<String, Object> map = new HashMap<>();
    map.put("name", "张三");
    map.put("age", 23);
    int result = userMapper.deleteByMap(map);
    System.out.println("result:"+result);*/
    //通过多个id实现批量删除
    //DELETE FROM user WHERE id IN ( ? , ? , ? )
    List<Long> list = Arrays.asList(1L, 2L, 3L);
    int result = userMapper.deleteBatchIds(list);
    System.out.println("result:"+result);
  • ③. 修改:int updateById(@Param("et") T entity)
@Test
public void testUpdate()
    //修改用户信息
    //UPDATE user SET name=?, email=? WHERE id=?
    User user = new User();
    user.setId(4L);
    user.setName("李四");
    user.setEmail("lisi@qq.com");
    int result = userMapper.updateById(user);
    System.out.println("result:"+result);
  • ④. 查询:根据id、map、批量查询
  1. T selectById(Serializable id)
  2. List<T> selectByMap(@Param("cm") Map<String, Object> columnMap)
  3. List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> idList)
  4. List<T> selectList(@Param("ew") Wrapper<T> queryWrapper)
@Test
public void testSelect()
    //通过id查询用户信息
    //SELECT id,name,age,email FROM user WHERE id=?
    /*User user = userMapper.selectById(1L);
    System.out.println(user);*/
    //根据多个id查询多个用户信息
    //SELECT id,name,age,email FROM user WHERE id IN ( ? , ? , ? )
    /*List<Long> list = Arrays.asList(1L, 2L, 3L);
    List<User> users = userMapper.selectBatchIds(list);
    users.forEach(System.out::println);*/
    //根据map集合中的条件查询用户信息
    //SELECT id,name,age,email FROM user WHERE name = ? AND age = ?
    /*Map<String, Object> map = new HashMap<>();
    map.put("name", "Jack");
    map.put("age", 20);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);*/
    //查询所有数据
    //SELECT id,name,age,email FROM user
    List<User> users = userMapper.selectList(null);
    users.forEach(System.out::println);
    /*Map<String, Object> map = userMapper.selectMapById(1L);
    System.out.println(map);*/
  • ⑤. 测试自定义查询
  1. mapper-locations的位置默认在mapper/**/*.xml下面,如果文件放在resource的mapper文件夹下,可以不在application.yaml中配置

④. Service CRUD接口

  • ①. 通用Service CRUD封装IService (opens new window)接口,进一步封装CRUD采用get查询单行remove删除list查询集合page分页 前缀命名方式区分Mapper层避免混淆

  • ②. 泛型T为任意实体对象

  • ③. 建议如果存在自定义通用Service方法的可能,请创建自己的IBaseService继承Mybatis-Plus提供的基类

  • ④. 对象 Wrapper 为 条件构造器

  • ⑤. 查看IService接口和ServiceImpl实现类

public interface IService<T> 


// 这里的M表示的UserMapper,这里的T表示的是实体类对象User
public class ServiceImpl<M extends BaseMapper<T>, T> implements IService<T> 
    protected Log log = LogFactory.getLog(this.getClass());
    @Autowired
    protected M baseMapper;


//UserService继承了IService,表示拥有了IService中的方法
//ServiceImpl是IService的实现类
public interface UserService extends IService<User> 

// UserServiceImpl 继承 UserService后会报错,因为没有继承IService中的所有方法
// 这里采用继承ServiceImpl来实现IService的所有方法
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService

  • ⑥. 使用IService中的方法进行操作
@SpringBootTest
@RunWith(SpringRunner.class)
@Slf4j
public class MyBatisPlusServiceTest 

    @Autowired
    private UserService userService;

    @Test
    public void testGetCount()
        //查询总记录数
        //SELECT COUNT( * ) FROM user
        long count = userService.count();
        System.out.println("总记录数:"+count);
    

    @Test
    public void testInsertMore()
        //批量添加
        //INSERT INTO user ( id, name, age ) VALUES ( ?, ?, ? )
        List<User> list = new ArrayList<>();
        for (int i = 1; i <= 10; i++) 
            User user = new User();
            user.setName("tang"+i);
            user.setAge(20+i);
            list.add(user);
        
        boolean b = userService.saveBatch(list);
        System.out.println(b);
  • ⑦. 详解IService中的list方法
类型参数名描述
Wrapper<T>queryWrapper实体对象封装操作类 QueryWrapper
Collection<? extends Serializable>idList主键ID列表
Map<String, Object>columnMap表字段 map 对象
Function<? super Object, V>mapper转换函数
// 查询所有
List<T> list();
// 查询列表
List<T> list(Wrapper<T> queryWrapper);
// 查询（根据ID 批量查询）
Collection<T> listByIds(Collection<? extends Serializable> idList);
//listByIds底层还是调用的this.getBaseMapper().selectBatchIds(idList);方法
// 查询（根据 columnMap 条件）
Collection<T> listByMap(Map<String, Object> columnMap);
// 查询所有列表
List<Map<String, Object>> listMaps();
// 查询列表
List<Map<String, Object>> listMaps(Wrapper<T> queryWrapper);
// 查询全部记录
List<Object> listObjs();
// 查询全部记录
<V> List<V> listObjs(Function<? super Object, V> mapper);
// 根据 Wrapper 条件，查询全部记录
List<Object> listObjs(Wrapper<T> queryWrapper);
// 根据 Wrapper 条件，查询全部记录
<V> List<V> listObjs(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);
  • ⑧. 详解IService中的save方法
类型参数名描述
Tentity实体对象
Collection<T>entityentityList实体对象集合
intbatchSize插入批次数量
// 插入一条记录（选择字段，策略插入）
boolean save(T entity);
// 插入（批量）
boolean saveBatch(Collection<T> entityList);
// 插入（批量）
boolean saveBatch(Collection<T> entityList, int batchSize);

⑤. 常用注解 - @TableName

  • ①. 经过以上的测试,在使用MyBatis-Plus实现基本的CRUD时,我们并没有指定要操作的表,只是在Mapper接口继承BaseMapper时,设置了泛型User,而操作的表为user表
    由此得出结论,MyBatis-Plus在确定操作的表时,由BaseMapper的泛型决定,即实体类型决定,且默认操作的表名和实体类型的类名一致

  • ②. 问题:若实体类类型的类名和要操作的表的表名不一致,会出现什么问题？
    我们将表user更名为t_user,测试查询功能,程序抛出异常,Table ‘mybatis_plus.user’ doesn’t exist,因为现在的表名为t_user,而默认操作的表名和实体类型的类名一致,即user表

  • ③. 通过@TableName解决问题

  • ④. 通过全局配置解决问题
    在开发的过程中,我们经常遇到以上的问题,即实体类所对应的表都有固定的前缀,例如t_或tbl_此时,可以使用MyBatis-Plus提供的全局配置,为实体类所对应的表名设置默认的前缀,那么就不需要在每个实体类上通过

# 配置mybatis-plus的日志信息
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  # classpath:/mapper/**/*.xml 只扫描自己的路径下
  mapper-locations:
    classpath: /mapper/**/*.xml
  # 配置MyBatis-Plus操作表的默认前缀
  global-config:
    db-config:
      table-prefix: t_

⑥. 常用注解 - @TableId