JeecgBoot框架中实现表主键自增的增强方案

背景介绍

在JeecgBoot框架中，默认情况下通过online表单功能创建的表会使用UUID作为主键类型。这种设计虽然能保证全局唯一性，但在某些业务场景下并不理想，特别是当业务需要更直观、更易读的数字自增ID时。本文将介绍如何在JeecgBoot框架中通过Java增强功能实现表主键的自增特性。

问题分析

JeecgBoot框架的online表单功能默认生成String类型的UUID主键，这带来了几个问题：

1. 可读性差：UUID是一串无意义的字符，不利于人工识别和记忆
2. 排序不便：UUID无法按自然顺序排序
3. 业务需求：某些业务场景需要连续的数字ID

解决方案

我们可以利用JeecgBoot提供的CgformEnhanceJavaInter接口来实现插入数据时的主键自增功能。该接口允许开发者在数据插入前后执行自定义逻辑。

实现原理

1. 创建一个实现CgformEnhanceJavaInter接口的类
2. 在execute方法中查询当前表的最大ID值
3. 将最大ID值加1后设置为新记录的ID
4. 通过配置指定哪些表需要此功能

核心代码实现

@Component("CgformEnhanceInsertSetId")
public class CgformEnhanceInsertSetId implements CgformEnhanceJavaInter {

    // 定义需要自增ID的表名映射
    private static final Map<String, Integer> predefinedMap;

    // 静态初始化块，配置需要自增ID的表
    static {
        predefinedMap = new HashMap<>();
        predefinedMap.put("库名.表名", 1); // 对应online表单开发中设置的"表名"
        // 可以添加更多需要自增ID的表
    }

    @Autowired
    private JdbcTemplate jdbcTemplate; 

    @Override
    public void execute(String tableName, JSONObject json) throws BusinessException {
        // 检查当前表是否配置了自增ID
        if(predefinedMap.containsKey(tableName)) {
            // 查询当前表的最大ID值
            String sql = "SELECT COALESCE(MAX(id), 0) FROM " + tableName;
            Long maxId = jdbcTemplate.queryForObject(sql, Long.class);

            if (maxId != null) {
                // 设置新记录的ID为最大ID+1
                json.put("id", ++maxId);
            }
        }
    }
}

实现细节解析

1. 表名映射配置：通过predefinedMap静态变量配置需要自增ID的表，键为表名，值可以是任意整数（这里用作标记）

2. 最大ID查询：使用JdbcTemplate执行SQL查询当前表的最大ID值，COALESCE函数确保当表为空时返回0

3. ID自增逻辑：将查询到的最大ID值加1后设置为新记录的ID

4. 线程安全考虑：在高并发环境下，这种实现可能存在并发问题，需要根据业务场景评估是否需要额外处理

扩展与优化

1. 分布式环境支持：在分布式系统中，可以考虑使用分布式ID生成器如雪花算法

2. 性能优化：对于高频插入的表，可以缓存当前最大ID值，减少数据库查询

3. 异常处理：增强异常处理逻辑，确保在表结构变更等情况下系统能正常处理

4. 配置化：可以将表名映射配置移到配置文件中，实现更灵活的配置

使用建议

1. 此方案适用于中小型系统或并发不高的场景

2. 对于核心业务表，建议评估并发风险并考虑使用更健壮的ID生成方案

3. 在分库分表场景下，需要采用其他ID生成策略

4. 实施前应充分测试，确保与现有业务逻辑兼容

通过这种增强实现，开发者可以在保持JeecgBoot框架原有功能的同时，灵活地满足业务对自增ID的需求，平衡了框架规范与业务实际需要之间的矛盾。