对象OID组件概述

业务需求

在数据持久化时，业务上通常需要生成全局唯一的对象标识ID，在应用水平扩展时，多个JVM中生成的唯一标识保证不冲突。传统的UUID能保证唯一性，但在数据量很大之后，数据查询效率会下降，所以需要一种能保证全局唯一并且可以保证读写效率的对象标识生成方案。

解决方案

iuap的对象OID组件提供唯一标识生成的统一封装，包括普通的UUID、基于Redis的自增ID、基于Snowflake算法和UAPOID算法的唯一ID。组件提供统一接口对OID进行生成，通过配置的方式实现ID生成策略的切换，同时可以扩展自定义的ID生成方案。

在基于Redis自增时，支持为不同模块设置不同的ID起始值；基于Snowflake算法通过日期、机器信息、顺序号等共同组成一个唯一ID；基于UAPOID算法通过Schema、顺序号（包括0-9和a-z）等生成唯一ID，同时利用本地缓存和数据库机制实现高效和高可用。

功能说明

1. 支持对象唯一ID的多种生成策略：
   • UUID；
   • 基于Redis的自增ID；
   • 基于Snowflake算法的自增ID；
   • 基于UAPOID算法的自增ID；
     
2. 支持扩展自定义ID生成策略；

整体设计

依赖环境

iuap-oid组件支持多种ID生成方式，如UUID、Redis自增、snowflake，UAPOID等，部分依赖Jedis的2.6和数据库驱动。组件的依赖配置如下：

<dependency>
  <groupId>com.yonyou.iuap</groupId>
  <artifactId>iuap-oid</artifactId>
  <version>${iuap.modules.version}</version>
</dependency>

类型说明

• uuid 原生的UUID生成方式
• redis 采用Redis自增方式，可以设置自增的初始值和模块
• snowflake 根据Twitter的算法修改，需要保证workerid唯一
• uapoid 延用原UAP中唯一标识生成算法，依赖数据库，需要初始化表
• custom 客户自定义的ID生成方式

使用说明

配置方式

配置maven依赖

<dependency>
    <groupId>com.yonyou.iuap</groupId>
    <artifactId>iuap-oid</artifactId>
    <version>${iuap.modules.version}</version>
</dependency>

${iuap.modules.version} 为在pom.xml中定义的需要引入组件的version。

配置属性文件

在属性配置文件中，加入oid的使用类型配置

#idtype=uuid
#idtype=redis
#idtype=snowflake
idtype=uapoid
#idproviderclass=com.yonyou.iuap.persistence.oid.CustomIdProvider

idtype为需要使用的ID生成类型，目前包括UUID、redis自增、snowflake、uapoid几种类型

redis自增主键

使用redis自增主键时候，需要配置redis对应的文件，请参考cache组件

<bean id="redisPool" class="com.yonyou.iuap.cache.redis.RedisPoolFactory"
    scope="prototype" factory-method="createJedisPool">
    <constructor-arg value="${redis.url}" />
</bean>

<bean id="jedisTemplate" class="org.springside.modules.nosql.redis.JedisTemplate">
    <constructor-arg ref="redisPool"></constructor-arg>
</bean> 

属性文件中配置示例如下：

#属性文件
redis.url=direct://172.20.6.48:6379?poolSize=50&poolName=mypool

idtype=redis

#可以设置特殊模块自增起始值
IUAP_PRIMARY_MYMODULE_START_VALUE=10000

UAPOID方式

使用uapoid类型时候，连接数据库，并初始化数据表，stepSize可根据项目指定，为每次取到本地JVM中自增ID的范围

 <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
    <property name="dataSource" ref="dataSource"></property>
</bean>    

<bean id="uapOidJdbcService" class="com.yonyou.iuap.persistence.oid.UapOidJdbcService">
    <!--生产态配置项目中使用的jdbcTemplate和Datasource即可-->
    <property name="jdbcTemplate" ref="jdbcTemplate" />
    <property name="stepSize" value="5000" />
</bean>

注意:建表和初始化sql语句请参考示例工程，最终生成的为20位的字符串，前八位为用户指定的schema名。

如果是基于iuap-jdbc组件使用id生成，可以在实体类上配置注解(iuap-jdbc的注解)的方式，选择类型，示例如下：

@Entity
@Table(name="good_demo")
public class GoodJdbcDemo extends BaseEntity{

    private static final long serialVersionUID = -3773469861533388458L;

    @Id
        @Column(name = "productid")
        //注意，strategy应配置为UAPOID，module一般为8位的字符串（在多租户方案中，moudle对应需要存储的8位schema名称）
        @GeneratedValue(strategy=Stragegy.UAPOID,moudle="gooddemo")
        private String productid;

    ... ...
}

其中的strategy为id的生成策略，请参考Stragegy的枚举值，和idtype基本保持一致。

snowflake方式

使用snowflake的方式，需要保证workerid一致

此种方式使用有限制，需要在启动Tomcat时候指定系统属性，ID生成时候会使用到系统属性，如下：

String workerIdStr = System.getProperty(OID_WORKID);
if (workerIdStr == null) {
    workerIdStr = System.getenv(OID_WORKID);
}

注意，此场景适用在同一台机器或同一个docker容器中启动单个Tomcat或Java应用，否则可能无法保证workerid不唯一。

custom方式

组件支持以扩展的方式生成自定义的主键，需要自行实现IOidProvider，配置方式如下：

idtype=custom
idproviderclass=com.yonyou.iuap.persistence.oid.CustomIdProvider

更多API操作和配置方式，请参考对应的示例工程(DevTool/examples/example_iuap_oid)

API接口

• IDGenerator