Mabatis Plus 之ID生成策略控制（Auto、Input、assign_id、assign_uuid）

谁践踏了优雅 2024-03-17 09:04 33阅读 0赞

#### 文章目录 ####

*   *  知识点1：@TableId
     *  1 环境构建
     *  2 代码演示
     *   *  AUTO策略
         *   *  步骤1:设置生成策略为AUTO
             *  步骤2:删除测试数据并修改自增值
             *  步骤3:运行新增方法
         *  INPUT策略
         *   *  步骤1:设置生成策略为INPUT
             *  步骤2:添加数据手动设置ID
             *  步骤3:运行新增方法
         *  ASSIGN\_ID策略
         *   *  步骤1:设置生成策略为ASSIGN\_ID
             *  步骤2:添加数据不设置ID
             *  步骤3:运行新增方法
         *  ASSIGN\_UUID策略
         *   *  步骤1:设置生成策略为ASSIGN\_UUID
             *  步骤2:修改表的主键类型
             *  步骤3:添加数据不设置ID
             *  步骤4:运行新增方法
     *  3 ID生成策略对比
     *  4 简化配置
     *   *  模型类主键策略设置
         *  数据库表与模型类的映射关系

前面我们在新增的时候留了一个问题，就是新增成功后，主键ID是一个很长串的内容，我们更想要的是按照数据库表字段进行自增长，在解决这个问题之前，我们先来分析下ID该如何选择:

*  不同的表应用不同的id生成策略
    
     *  日志：自增（1,2,3,4，……）
     *  购物订单：特殊规则（FQ23948AK3843）
     *  外卖单：关联地区日期等信息（10 04 20200314 34 91）
     *  关系表：可省略id
     *  ……

不同的业务采用的ID生成方式应该是不一样的，那么在MP中都提供了哪些主键生成策略，以及我们该如何进行选择?

在这里我们又需要用到MP的一个注解叫`@TableId`

### 知识点1：@TableId ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@TableId</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>属性注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>模型类中用于表示主键的属性定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前类中主键属性的生成策略</td> 
  </tr> 
  <tr> 
   <td>相关属性</td> 
   <td>value(默认)：设置数据库表主键名称<br>type:设置主键属性的生成策略，值查照IdType的枚举值</td> 
  </tr> 
 </tbody> 
</table>

### 1 环境构建 ###

在构建条件查询之前，我们先来准备下环境

[Masked5 / heima\_springboot\_mybatisplus\_codes · GitCode][Masked5 _ heima_springboot_mybatisplus_codes _ GitCode]

*  创建一个SpringBoot项目
 *  pom.xml中添加对应的依赖
    
        <?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.5.0</version>
                <relativePath/> 
            </parent>
            <groupId>com.itheima</groupId>
            <artifactId>mybatisplus_03_dml</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <properties>
                <java.version>1.8</java.version>
            </properties>
            <dependencies>
        
                <dependency>
                    <groupId>com.baomidou</groupId>
                    <artifactId>mybatis-plus-boot-starter</artifactId>
                    <version>3.4.1</version>
                </dependency>
        
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter</artifactId>
                </dependency>
        
                <dependency>
                    <groupId>com.alibaba</groupId>
                    <artifactId>druid</artifactId>
                    <version>1.1.16</version>
                </dependency>
        
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <scope>runtime</scope>
                </dependency>
        
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-test</artifactId>
                    <scope>test</scope>
                </dependency>
        
                <dependency>
                    <groupId>org.projectlombok</groupId>
                    <artifactId>lombok</artifactId>
                    <version>1.18.12</version>
                </dependency>
        
            </dependencies>
        
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-maven-plugin</artifactId>
                    </plugin>
                </plugins>
            </build>
        
        </project>
 *  编写UserDao接口
    
        @Mapper
        public interface UserDao extends BaseMapper<User> {
              
        }
 *  编写模型类
    
        @Data
        @TableName("tbl_user")
        public class User {
              
            private Long id;
            private String name;
            @TableField(value="pwd",select=false)
            private String password;
            private Integer age;
            private String tel;
            @TableField(exist=false)
            private Integer online;
        }
 *  编写引导类
    
        @SpringBootApplication
        public class Mybatisplus03DqlApplication {
              
        
            public static void main(String[] args) {
              
                SpringApplication.run(Mybatisplus03DqlApplication.class, args);
            }
        
        }
 *  编写配置文件
    
        # dataSource
        spring:
          datasource:
            type: com.alibaba.druid.pool.DruidDataSource
            driver-class-name: com.mysql.cj.jdbc.Driver
            url: jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC
            username: root
            password: root
        # mp日志
        mybatis-plus:
          configuration:
            log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
 *  编写测试类
    
        @SpringBootTest
        class Mybatisplus02DqlApplicationTests {
              
        
            @Autowired
            private UserDao userDao;
            
            @Test
            void testGetAll(){
              
                List<User> userList = userDao.selectList(null);
                System.out.println(userList);
            }
        }
 *  测试
    
        @SpringBootTest
        class Mybatisplus03DqlApplicationTests {
              
        
            @Autowired
            private UserDao userDao;
        	
            @Test
            void testSave(){
              
                User user = new User();
                user.setName("黑马程序员");
                user.setPassword("itheima");
                user.setAge(12);
                user.setTel("4006184000");
                userDao.insert(user);
            }
            @Test
            void testDelete(){
              
                userDao.deleteById(1401856123925713409L)
            }
            @Test
            void testUpdate(){
              
                User user = new User();
                user.setId(3L);
                user.setName("Jock666");
                user.setVersion(1);
                userDao.updateById(user);
            }
        }
 *  最终创建的项目结构为: [mybatisplus\_03\_dml][mybatisplus_03_dml]
    
    ![1631033634879][]

### 2 代码演示 ###

#### AUTO策略 ####

##### 步骤1:设置生成策略为AUTO #####

@Data
    @TableName("tbl_user")
    public class User {
        
        @TableId(type = IdType.AUTO)
        private Long id;
        private String name;
        @TableField(value="pwd",select=false)
        private String password;
        private Integer age;
        private String tel;
        @TableField(exist=false)
        private Integer online;
    }

##### 步骤2:删除测试数据并修改自增值 #####

*  删除测试数据
    
    ![1631211291677][]
 *  因为之前生成主键ID的值比较长，会把MySQL的自动增长的值变的很大，所以需要将其调整为目前最新的id值。

![1631211080703][]

##### 步骤3:运行新增方法 #####

会发现，新增成功，并且主键id也是从5开始

![1631211383421][]

经过这三步的演示，会发现`AUTO`的作用是使用数据库ID自增，在使用该策略的时候一定要确保对应的数据库表设置了ID主键自增，否则无效。

接下来，我们可以进入源码查看下ID的生成策略有哪些?

打开源码后，你会发现并没有看到中文注释，这就需要我们点击右上角的`Download Sources`,会自动帮你把这个类的java文件下载下来，我们就能看到具体的注释内容。因为这个技术是国人制作的，所以他代码中的注释还是比较容易看懂的。

![1631211697712][]

当把源码下载完后，就可以看到如下内容:

![1631211902833][]

从源码中可以看到，除了AUTO这个策略以外，还有如下几种生成策略:

*  NONE: 不设置id生成策略
 *  INPUT:用户手工输入id
 *  ASSIGN\_ID:雪花算法生成id(可兼容数值型与字符串型)
 *  ASSIGN\_UUID:以UUID生成算法作为id生成策略
 *  其他的几个策略均已过时，都将被ASSIGN\_ID和ASSIGN\_UUID代替掉。

**拓展:**

分布式ID是什么?

*  当数据量足够大的时候，一台数据库服务器存储不下，这个时候就需要多台数据库服务器进行存储
 *  比如订单表就有可能被存储在不同的服务器上
 *  如果用数据库表的自增主键，因为在两台服务器上所以会出现冲突
 *  这个时候就需要一个全局唯一ID,这个ID就是分布式ID。

#### INPUT策略 ####

##### 步骤1:设置生成策略为INPUT #####

@Data
    @TableName("tbl_user")
    public class User {
        
        @TableId(type = IdType.INPUT)
        private Long id;
        private String name;
        @TableField(value="pwd",select=false)
        private String password;
        private Integer age;
        private String tel;
        @TableField(exist=false)
        private Integer online;
    }

\*\*注意:\*\*这种ID生成策略，需要将表的自增策略删除掉

![1631212246124][]

##### 步骤2:添加数据手动设置ID #####

@SpringBootTest
    class Mybatisplus03DqlApplicationTests {
        
    
        @Autowired
        private UserDao userDao;
    	
        @Test
        void testSave(){
        
            User user = new User();
            //设置主键ID的值
            user.setId(666L);
            user.setName("黑马程序员");
            user.setPassword("itheima");
            user.setAge(12);
            user.setTel("4006184000");
            userDao.insert(user);
        }
    }

##### 步骤3:运行新增方法 #####

如果没有设置主键ID的值，则会报错，错误提示就是主键ID没有给值:

![25ca6cbab51941589201f2a8f7f4314e.png][]

如果设置了主键ID,则数据添加成功，如下:

![1631212421137][]

#### ASSIGN\_ID策略 ####

##### 步骤1:设置生成策略为ASSIGN\_ID #####

@Data
    @TableName("tbl_user")
    public class User {
        
        @TableId(type = IdType.ASSIGN_ID)
        private Long id;
        private String name;
        @TableField(value="pwd",select=false)
        private String password;
        private Integer age;
        private String tel;
        @TableField(exist=false)
        private Integer online;
    }

##### 步骤2:添加数据不设置ID #####

@SpringBootTest
    class Mybatisplus03DqlApplicationTests {
        
    
        @Autowired
        private UserDao userDao;
    	
        @Test
        void testSave(){
        
            User user = new User();
            user.setName("黑马程序员");
            user.setPassword("itheima");
            user.setAge(12);
            user.setTel("4006184000");
            userDao.insert(user);
        }
    }

**注意**：这种生成策略，不需要手动设置ID，如果手动设置ID，则会使用自己设置的值。

##### 步骤3:运行新增方法 #####

![1631242753467][]

生成的ID就是一个Long类型的数据。

#### ASSIGN\_UUID策略 ####

##### 步骤1:设置生成策略为ASSIGN\_UUID #####

使用uuid需要注意的是，主键的类型不能是Long，而应该改成String类型

@Data
    @TableName("tbl_user")
    public class User {
        
        @TableId(type = IdType.ASSIGN_UUID)
        private String id;
        private String name;
        @TableField(value="pwd",select=false)
        private String password;
        private Integer age;
        private String tel;
        @TableField(exist=false)
        private Integer online;
    }

##### 步骤2:修改表的主键类型 #####

![1631243694870][]

主键类型设置为varchar，长度要大于32，因为UUID生成的主键为32位，如果长度小的话就会导致插入失败。

##### 步骤3:添加数据不设置ID #####

##### 步骤4:运行新增方法 #####

![1631243810974][]

接下来我们来聊一聊雪花算法:

雪花算法(SnowFlake), 是Twitter官方给出的算法实现 是用Scala写的。其生成的结果是一个64bit大小整数，它的结构如下图:

![1631243987800][]

1.  1bit,不用,因为二进制中最高位是符号位，1表示负数，0表示正数。生成的id一般都是用整数，所以最高位固定为0。
2.  41bit-时间戳，用来记录时间戳，毫秒级
3.  10bit-工作机器id，用来记录工作机器id,其中高位5bit是数据中心ID其取值范围0-31，低位5bit是工作节点ID其取值范围0-31，两个组合起来最多可以容纳1024个节点
4.  序列号占用12bit，每个节点每毫秒0开始不断累加，最多可以累加到4095，一共可以产生4096个ID

### 3 ID生成策略对比 ###

介绍了这些主键ID的生成策略，我们以后该用哪个呢?

*  NONE: 不设置id生成策略，MP不自动生成，约等于INPUT,所以这两种方式都需要用户手动设置，但是手动设置第一个问题是容易出现相同的ID造成主键冲突，为了保证主键不冲突就需要做很多判定，实现起来比较复杂
 *  AUTO:数据库ID自增,这种策略适合在数据库服务器只有1台的情况下使用,不可作为分布式ID使用
 *  ASSIGN\_UUID:可以在分布式的情况下使用，而且能够保证唯一，但是生成的主键是32位的字符串，长度过长占用空间而且还不能排序，查询性能也慢
 *  ASSIGN\_ID:可以在分布式的情况下使用，生成的是Long类型的数字，可以排序性能也高，但是生成的策略和服务器时间有关，如果修改了系统时间就有可能导致出现重复主键
 *  综上所述，每一种主键策略都有自己的优缺点，根据自己项目业务的实际情况来选择使用才是最明智的选择。

### 4 简化配置 ###

前面我们已经完成了表关系映射、数据库主键策略的设置，接下来对于这两个内容的使用，我们再讲下他们的简化配置:

#### 模型类主键策略设置 ####

对于主键ID的策略已经介绍完，但是如果要在项目中的每一个模型类上都需要使用相同的生成策略，如:

![1631245676125][]

确实是稍微有点繁琐，我们能不能在某一处进行配置，就能让所有的模型类都可以使用该主键ID策略呢?

答案是肯定有，我们只需要在配置文件中添加如下内容:

mybatis-plus:
      global-config:
        db-config:
        	id-type: assign_id

配置完成后，每个模型类的主键ID策略都将成为assign\_id.

#### 数据库表与模型类的映射关系 ####

MP会默认将模型类的类名名首字母小写作为表名使用，假如数据库表的名称都以`tbl_`开头，那么我们就需要将所有的模型类上添加`@TableName`，如:

![1631245757169][]

配置起来还是比较繁琐，简化方式为在配置文件中配置如下内容:

mybatis-plus:
      global-config:
        db-config:
        	table-prefix: tbl_

设置表的前缀内容，这样MP就会拿 `tbl_`加上模型类的首字母小写，就刚好组装成数据库的表名。

[Masked5 _ heima_springboot_mybatisplus_codes _ GitCode]: https://gitcode.net/Drifter_Galaxy/heima_springboot_mybatisplus_codes
[mybatisplus_03_dml]: https://gitcode.net/Drifter_Galaxy/heima_springboot_mybatisplus_codes/-/tree/master/mybatisplus_03_dml
[1631033634879]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/a935aee7cfec4bf4af7d70020daa5a74.png
[1631211291677]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/0277179b39e94f8e9f802c58ced6892d.png
[1631211080703]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/3ce7a0b5672a4edf9ffa37a01bea16fc.png
[1631211383421]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/5a5ab161280e431ca3e85910008122dd.png
[1631211697712]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/6466d45adcc54a23a3c2405e2ae01943.png
[1631211902833]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/eda90aa67b6d493e90517d07754a8f71.png
[1631212246124]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/249b0dcb275548daada6c1cbdf2f48c0.png
[25ca6cbab51941589201f2a8f7f4314e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/889c9035f9c54453890906ffcabe2602.png
[1631212421137]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/45e34ef7534d4cdebee04d98af679059.png
[1631242753467]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/8b407202779343d9bccd9d05ce18f798.png
[1631243694870]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/6704077324014b0fb2cc4b2a9467a32c.png
[1631243810974]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/359c8003e7654265997bf0c3a62becd7.png
[1631243987800]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/2aa0663ce8dd491abe8519493a42f5e5.png
[1631245676125]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/acaff8b10e9648b18cb7ed5c0727f643.png
[1631245757169]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/83359061a7624590afaca5eb072111a6.png