MYBatis-Plus常用注解@TableName@TableId@TableField@TableLogic

Posted 2023-04-06 小徐敲java

1-1：@TableName

注解作用：设置实体类对应的表明

value作用：value指定数据库中的表名

如果我们不设置这个注解，我们操作的数据库的表就由BaseMapper 泛型决定（SysLog）

@TableName(value = "sys_Log")
public class SysLog 

1-2：另外的一种方法：

设置实体类所对应的表的统一前缀

我们如果不用注解也可以，比如下面的这个方式，给每个类都配置一个前缀，比如说表名是log，但他其实已经默认是sys_Log

#mybatis plus 设置
mybatis-plus:
  mapper-locations: classpath*:org/jeecg/modules/**/xml/*Mapper.xml
  # 设置mybatis-plus的全局配置
  global-config:
    # 关闭MP3.0自带的banner
    banner: false
    db-config:
      #主键类型
      id-type: ASSIGN_ID
      # 默认数据库表下划线命名
      #table-underline: true
      table-prefix: sys_

2：@TableId

作用：将属性所对应的字段指定为主键
属性名value ：指定主键的字段，要和数据库表中的属性名一致，要不然最终的查询结果是null
将数据库中的结果对此变量名进行注入
type属性：设置主键生成策略，不指定的话默认雪花算法 （数据库记得勾选自动递增）
1：AUTO(0)—使用数据库的自增策略，注意，该类型请确保数据库设置了id自增，否则无效
2：NONE(1)—不设置id生成策略
3：INPUT(2)—需要自己数据添加主键，不能为null，否则报错
4：ASSIGN_ID(3)—默认就是这个，基于雪花算法的策略生成数据id，与数据库id是否设置自增无关（如果我们自己指定了ID，便不会触发雪花算法），可兼容数值型与字符串型
5：ASSIGN_UUID(4)—以UUID生成算法作为id生成策略

2-1：id自增用法

    @TableId(value="id",type = IdType.AUTO)  //代表自增算法
    private int id;

2-2：雪花用法

    @TableId(value="id",type = IdType.ASSIGN_ID)  //代表自增算法
    private int id;

2-3：@TableField

使用注解就是对于数据库的userName字段

    @TableField(value = "userName")
    private String userName;

如果不加上面那个注解的话，就会默认两个单词中间加一个—，变成user_name数据库字段

2-3：@TableLogic

    /**
     * 逻辑删除：未删除0  1删除
     */
    @TableLogic
    private Integer delFlag;

0表示未删除状态，1表示删除状态
物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除的数据

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

使用场景：可以进行数据恢复，对删除的数据进行恢复的操作

我们对数据进行delete删除之后，我们再进行查询操作时查询不到的（这个时候不用指定deleted=0），但是数据还是存在在数据库中

同理，查询的时候也会自动加上del_falg=1的条件查询

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

文章目录

• ①. MyBatis-Plus的概述
• ②. MyBatis-Plus初始化工程
• ③. BaseMapper中的CRUD
• ④. Service CRUD接口
• ⑤. 常用注解 - @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的官方文档

②. 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, '[e-mail]'),
(2, 'Jack', 20, '[e-mail]'),
(3, 'Tom', 28, '[e-mail]'),
(4, 'Sandy', 21, '[e-mail]'),
(5, 'Billie', 24, '[e-mail]');

• ②. 添加依赖

<?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("[e-mail]");
    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("[e-mail]");
    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);
    

⑤. 常用注解 - @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

• ①. 经过以上的测试,MyBatis-Plus在实现CRUD时,会默认将id作为主键列,并在插入数据时,默认基于雪花算法的策略生成id

• ②. 若实体类和表中表示主键的不是id,而是其他字段,例如uid,MyBatis-Plus会自动识别uid为主键列吗？
  我们实体类中的属性id改为uid,将表中的字段id也改为uid,测试添加功能。程序抛出异常,Field ‘uid’ doesn’t have a default value,说明MyBatis-Plus没有将uid作为主键赋值
  

• ③. 通过@TableId解决问题
  在实体类中uid属性上通过@TableId将其标识为主键,即可成功执行SQL语句
  

• ④. @TableId的value属性

1. 若实体类中主键对应的属性为id,而表中表示主键的字段为uid,此时若只在属性id上添加注解@TableId,则抛出异常Unknown column ‘id’ in ‘field list’,即MyBatis-Plus仍然会将id作为表的主键操作,而表中表示主键的是字段uid
2. 此时需要通过@TableId注解的value属性,指定表中的主键字段,@TableId(“uid”)或@TableId(value=“uid”)
   
   

• ⑤. @TableId的type属性
  type属性用来定义主键策略,常用的主键策略:

值	描述
IdType.ASSIGN_ID(默认)	基于雪花算法的策略生成数据id,与数据库id是否设置自增无关
IdType.AUTO	使用数据库的自增策略,注意,该类型请确保数据库设置了id自增,否则无效或报错

# 配置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_
      # 配置MyBatis-Plus的主键策略
      id-type: auto

⑦. 主键增长策略 - 雪花算法

• ①. 背景

1. 需要选择合适的方案去应对数据规模的增长,以应对逐渐增长的访问压力和数据量
2. 数据库的扩展方式主要包括:业务分库、主从复制,数据库分表

• ②. 数据库分表

1. 将不同业务数据分散存储到不同的数据库服务器,能够支撑百万甚至千万用户规模的业务,但如果业务继续发展,同一业务的单表数据也会达到单台数据库服务器的处理瓶颈。例如,淘宝的几亿用户数据,如果全部存放在一台数据库服务器的一张表中,肯定是无法满足性能要求的,此时就需要对单表数据进行拆分。
2. 单表数据拆分有两种方式:垂直分表和水平分表。示意图如下:
   

• ③. 垂直分表

1. 垂直分表适合将表中某些不常用且占了大量空间的列拆分出去
2. 例如,前面示意图中的nickname和description字段,假设我们是一个婚恋网站,用户在筛选其他用户的时候,主要是用age和sex两个字段进行查询,而nickname和description两个字段主要用于展示,一般不会在业务查询中用到。description本身又比较长,因此我们可以将这两个字段独立到另外一张表中,这样在查询age和sex时,就能带来一定的性能提升

• ④. 水平分表

1. 水平分表适合表行数特别大的表,有的公司要求单表行数超过5000万就必须进行分表,这个数字可以作为参考,但并不是绝对标准,关键还是要看表的访问性能。对于一些比较复杂的表,可能超过1000万就要分表了。而对于一些简单的表,即使存储数据超过1亿行,也可以不分表。
2. 但不管怎样,当看到表的数据量达到千万级别时,作为架构师就要警觉起来,因为这很可能是架构的性能瓶颈或者隐患。
3. 水平分表相比垂直分表,会引入更多的复杂性,例如要求全局唯一的数据id该如何处理

• ⑤. 主键自增

1. 以最常见的用户ID为例,可以按照1000000 的范围大小进行分段,1 ~ 999999 放到表 1中,1000000 ~ 1999999 放到表2中,以此类推
2. 复杂点:分段大小的选取。分段太小会导致切分后子表数量过多,增加维护复杂度；分段太大可能会导致单表依然存在性能问题,一般建议分段大小在100万至2000万之间,具体需要根据业务选取合适的分段大小。
3. 优点:可以随着数据的增加平滑地扩充新的表。例如,现在的用户是100万,如果增加到1000万,只需要增加新的表就可以了,原有的数据不需要动。
4. 缺点:分布不均匀。假如按照1000万来进行分表,有可能某个分段实际存储的数据量只有1条,而另外一个分段实际存储的数据量有1000万条。

• ⑥. 取模

1. 同样以用户ID为例,假如我们一开始就规划了10个数据库表,可以简单地用user_id%10的值来表示数据所属的数据库表编号,ID为985的用户放到编号为5的子表中,ID为10086的用户放到编号为6的子表中。
2. 复杂点:初始表数量的确定。表数量太多维护比较麻烦,表数量太少又可能导致单表性能存在问题。
3. 优点:表分布比较均匀。
4. 缺点:扩充新的表很麻烦,所有数据都要重分布。

• ⑦. 雪花算法:是由Twitter公布的分布式主键生成算法,它能够保证不同表的主键的不重复性,以及相同表的主键的有序性

1. 长度共64bit(一个long型)。
2. 首先是一个符号位,1bit标识,由于long基本类型在Java中是带符号的,最高位是符号位,正数是0,负数是1,所以id一般是正数,最高位是0。
3. 41bit时间截(毫秒级),存储的是时间截的差值(当前时间截-开始时间截),结果约等于69.73年。
4. 10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID,可以部署在1024个节点)。
5. 12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生4096个ID)

适合新手的12个Mybatis-Plus常用注解

Mybatis-Plus-常用实体注解

Mybatis-plus中的常用注解

MYBatis-Plus常用注解@TableName@TableId@TableField@TableLogic

Mybatis-plus工具学习笔记---[常用注解,条件构造器,插件使用]

Mybatis-plus工具学习笔记---[常用注解,条件构造器,插件使用]