Mybatis UUID应用详解

发布时间：2023-05-21

一、UUID概述

UUID是一种由网络通用唯一标识符（Universally Unique Identifier）的缩写，是由一组32位数字的十六进制数所构成。其核心思想是通过网络传输来确保唯一性，即使全球范围内的标识符不会重复。一般情况下，有32位字符，被表示成8-4-4-12的形式，其中4组数分别表示时间戳、计算机代码、随机位、全局唯一标识符。UUID的生成是基于时间、节点标识、序列号三维组合的，因此理论上不存在重复的风险。在Java生态系统中，最常用的UUID实现无疑就是java.util.UUID类了。

二、Mybatis中的UUID应用

在Mybatis框架中，UUID作为主键生成策略广泛被运用。Mybatis提供了两种主键生成方式：数据库自增ID和UUID，而前者需要保证在数据库服务器上需要单独声明主键域为自增长型，否则无法正常生成。因此，UUID的生成策略被广泛应用于分布式环境下的主键生成。

三、Mybatis UUID生成方式

Mybatis中使用UUID作为主键生成策略，需要在Mapper.xml的insert节点中使用java.util.UUID的randomUUID()静态方法来为主键赋值。下面是一个示例：

<insert id="insertUser" parameterType="User">
  <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String"/>
  INSERT INTO user (
      id,
      name,
      age,
      address
  ) VALUES (
      #{id},
      #{name},
      #{age},
      #{address}
  )
</insert>

在这个伪代码中，selectKey元素可以设置两个属性：keyProperty和resultType。其中keyProperty属性是JavaBean在数据库中主键的名称，resultType属性是把UUID生成的字符串设置给JavaBean主键的属性类型。

四、Mybatis UUID性能优化

虽然UUID理论上不会重复，但是使用UUID作为主键生成策略时，在大量数据插入的情况下，也会存在性能瓶颈。此时，我们需要对Mybatis的UUID生成策略进行优化，提高性能。常用优化方式如下：

  • 使用JDBC批量操作：将多个INSERT操作合并成一个批量INSERT操作，减少通信开销，提高性能。
  • 使用Mybatis插件：使用Mybatis插件可以对UUID生成策略进行动态代理，拦截Executor的query和update方法，实现自定义的UUID生成方式。
  • 缓存UUID：对UUID进行缓存，减少生成UUID的次数，提高性能。

五、Mybatis插件示例

以下示例仅供参考，具体可根据实际情况进行修改：

public class UUIDInterceptor implements Interceptor {
    private static final String SELECT_PREFIX = "__select_uuid";
    private static final String UPDATE_PREFIX = "__update_uuid";
    private final Cache<UUID, Object> uuidCache = new SynchronizedCache<>(new LruCache<>(1024));
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object[] args = invocation.getArgs();
        String statement = ((MappedStatement) args[0]).getId();
        Object parameter = args[1];
        BoundSql boundSql = ((MappedStatement) args[0]).getBoundSql(parameter);
        String sql = boundSql.getSql().toLowerCase(Locale.CHINA);
        if (StringUtils.isNotBlank(sql) && (sql.trim().startsWith("insert") || sql.trim().startsWith("update"))) {
            if (StringUtils.isNotBlank(statement) && statement.trim().toLowerCase(Locale.CHINA).startsWith(UPDATE_PREFIX)) {
                // update语句中，不能替换主键
                return invocation.proceed();
            }
            Field idField = ReflectionUtils.findField(parameter.getClass(), "id");
            if (idField == null) {
                return invocation.proceed();
            }
            ReflectionUtils.makeAccessible(idField);
            Object idValue = idField.get(parameter);
            // 如果id已经被赋值了，则不需要再生成
            if (StringUtils.isNotBlank(String.valueOf(idValue))) {
                return invocation.proceed();
            }
            UUID uuid = UUID.randomUUID();
            if (StringUtils.isNotBlank(statement) && statement.trim().toLowerCase(Locale.CHINA).startsWith(SELECT_PREFIX)) {
                uuidCache.put(uuid, null);
            }
            idField.set(parameter, uuid.toString().replaceAll("-", ""));
        }
        return invocation.proceed();
    }
    @Override
    public Object plugin(Object target) {
        if (target instanceof Executor) {
            return Plugin.wrap(target, this);
        } else {
            return target;
        }
    }
    @Override
    public void setProperties(Properties properties) {
    }
}

上述示例是一个简单的UUID生成器拦截器实现，用于拦截Executor的query和update方法并提供自定义的UUID生成策略。由于该示例仅供参考，实际使用时需要结合实际业务需求进行改进。

推荐文章