SpringBoot中KeyGenerator生成的主键如何自定义规则？

Question

在SpringBoot项目中，使用KeyGenerator生成主键时，如何自定义规则以满足业务需求？默认的KeyGenerator生成的主键基于方法签名和参数值，可能无法满足复杂业务场景下的唯一性或可读性要求。例如，需要生成类似“ORD20241001001”这种包含前缀、日期和序号的订单号作为主键。此时，可以通过实现自定义KeyGenerator接口，重写generate方法，结合业务逻辑（如时间戳、序列号或特定前缀）生成符合规则的主键。此外，还需注意与数据库设计的兼容性，避免主键冲突或超出长度限制。如何优雅地实现这一需求，并确保高并发环境下的唯一性？

Answer 1

1. 问题背景与分析

在Spring Boot项目中，默认的KeyGenerator生成主键是基于方法签名和参数值，这种方式简单高效，但在复杂业务场景下可能无法满足需求。例如，订单号需要包含前缀、日期和序号（如“ORD20241001001”），这就要求我们实现自定义规则。

以下是实现这一需求时需要考虑的关键点：

• 如何设计符合业务逻辑的主键格式？
• 如何确保高并发环境下的唯一性？
• 如何与数据库设计保持兼容性？

2. 自定义KeyGenerator实现步骤

为了生成符合规则的主键，我们需要实现自定义KeyGenerator接口，并重写generate方法。以下是一个基本实现步骤：

1. 创建一个类实现org.springframework.cache.interceptor.KeyGenerator接口。
2. 重写generate方法，结合业务逻辑生成主键。
3. 将该类注入到Spring容器中并配置使用。

2.1 示例代码

import org.springframework.cache.interceptor.KeyGenerator;
import java.lang.reflect.Method;

public class CustomKeyGenerator implements KeyGenerator {
    @Override
    public Object generate(Object target, Method method, Object... params) {
        // 假设业务逻辑为：ORD + 当前日期 + 序号
        String prefix = "ORD";
        String date = java.time.LocalDate.now().format(java.time.format.DateTimeFormatter.ofPattern("yyyyMMdd"));
        int sequence = getNextSequence(); // 获取下一个可用序列号
        return prefix + date + String.format("%03d", sequence);
    }

    private synchronized int getNextSequence() {
        // 实现获取序列号逻辑，可存储在Redis或数据库中
        return 1; // 示例返回固定值
    }
}

3. 高并发环境下的唯一性保证

在高并发环境下，确保主键唯一性至关重要。可以通过以下方式实现：

方案	优点	缺点
数据库自增列	简单易用，天然支持唯一性	无法直接嵌入业务逻辑
分布式ID生成器（如Snowflake算法）	高效生成全局唯一ID	需额外维护服务
Redis原子操作	支持复杂的业务逻辑	依赖外部系统

3.1 使用Redis实现序列号管理

通过Redis的INCR命令可以轻松实现高并发环境下的序列号管理。

import redis.clients.jedis.Jedis;

public class RedisSequenceManager {
    private Jedis jedis;

    public RedisSequenceManager(String host, int port) {
        this.jedis = new Jedis(host, port);
    }

    public int getNextSequence(String key) {
        return Integer.parseInt(jedis.incr(key));
    }
}

4. 数据库设计兼容性

在设计主键时，还需注意数据库字段长度限制和数据类型。例如，MySQL VARCHAR类型字段需要设置足够长度以容纳完整主键字符串。

4.1 Mermaid流程图示例

以下是主键生成的整体流程：

sequenceDiagram
    participant Application
    participant Redis
    participant Database
    Application->>Redis: 获取当前日期和序列号
    Redis-->>Application: 返回序列号
    Application->>Database: 插入新记录
    Database-->>Application: 确认插入成功