sequence-spring-boot-starter

唯一序列生成器 starter

介紹

說明

工程提供擴(kuò)展接口(擴(kuò)展點(diǎn))：

         接口->com.javacoo.sequence.client.api.Sequence

基于xkernel 提供的SPI機(jī)制，結(jié)合SpringBoot注解 ConditionalOnBean,ConditionalOnProperty實(shí)現(xiàn)。

類關(guān)系圖

Sequence.png

項(xiàng)目結(jié)構(gòu)

sequence-spring-boot-starter
 └── src
    ├── main  
    │   ├── java  
    │   │   └── com.javacoo 
    │   │   ├────── sequence
    │   │   │         ├──────client
    │   │   │         │         ├── api
    │   │   │         │         │     ├── client
    │   │   │         │         │     │      └── Sequence 唯一編碼生成服務(wù)
    │   │   │         │         │     ├── config
    │   │   │         │         │            └── SequenceConfig 唯一編碼生成服務(wù)配置
    │   │   │         │         └── internal 接口內(nèi)部實(shí)現(xiàn)
    │   │   │         │               ├── redis
    │   │   │         │               │      └── RedisSequenceImpl 唯一編碼生成服務(wù)redis實(shí)現(xiàn)
    │   │   │         │               ├── snowflake
    │   │   │         │                      ├── SnowflakeConfig 配置類
    │   │   │         │                      └── SnowflakeSequenceImpl 唯一編碼生成服務(wù)雪花算法實(shí)現(xiàn)
    │   │   │         └──────starter
    │   │   │                   ├── SequenceAutoConfiguration 自動(dòng)配置類
    │   │   │                   └── SequenceHolder 鎖接口對(duì)象持有者
    │   └── resource  
    │       ├── META-INF
    │             └── ext
    │                  └── internal
    │                          └── com.javacoo.sequence.client.api.Sequence
    └── test  測(cè)試

如何使用

pom依賴：

<dependency>
   <groupId>com.javacoo</groupId>
   <artifactId>sequence-spring-boot-starter</artifactId>
   <version>1.0.0</version>
</dependency>

配置參數(shù)，如果使用默認(rèn)實(shí)現(xiàn)，則無需配置，如要擴(kuò)展則需要，配置如下：

#sequence是否可用,默認(rèn)可用
sequence.enabled = true
#sequence實(shí)現(xiàn)，默認(rèn)內(nèi)部實(shí)現(xiàn)
sequence.impl = default

使用，如：


@Resource
private Sequence sequence;

sequence.generate("APPLY","GJJ")

SPI擴(kuò)展

基于xkernel 提供的SPI機(jī)制，擴(kuò)展非常方便，大致步驟如下：

實(shí)現(xiàn)唯一編碼生成服務(wù)接口：如 com.xxxx.xxxx.MySequencempl
配置唯一編碼生成服務(wù)接口：
- 在項(xiàng)目resource目錄新建包->META-INF->services
- 創(chuàng)建com.javacoo.sequence.client.api.Sequence文件，文件內(nèi)容：實(shí)現(xiàn)類的全局限定名，如：
```
mySequence=com.xxxx.xxxx.MySequencempl
```
- 修改配置文件，添加如下內(nèi)容:
```
#sequence實(shí)現(xiàn)，默認(rèn)內(nèi)部實(shí)現(xiàn)
sequence.impl = mySequence
```

默認(rèn)實(shí)現(xiàn)

1、唯一編碼生成服務(wù)接口：

/**
 * 唯一編碼生成服務(wù)
 * <li></li>
 *
 * @author: duanyong
 * @since: 2021/4/28 10:27
 */
@Spi(SequenceConfig.DEFAULT_IMPL)
public interface Sequence {
    /**
     * 生成申請(qǐng)?zhí)?     * <li></li>
     * @author duanyong
     * @date 2021/4/28 10:31
     * @param module: 模塊
     * @param prefix: 前綴
     * @return: java.lang.String 唯一編碼
     */
    String generate(String module,String prefix);
}

2、實(shí)現(xiàn)唯一編碼生成服務(wù)接口，如默認(rèn)實(shí)現(xiàn)：

/**
 * 唯一編碼生成服務(wù)
 * <li>基于redis</li>
 *
 * @author: duanyong
 * @since: 2021/4/28 10:32
 */
@Slf4j
public class RedisSequenceImpl implements Sequence {
    /**緩存KEY前綴*/
    private static final String CACHE_KEY_PREFIX = "KEY:JAVACOO-APPLICATION:%s";
    /**時(shí)間格式*/
    private static final String FORMAT = "yyyyMMdd";
    /**redis模板*/
    @Resource
    private RedisTemplate redisTemplate;
    /**
     * 生成唯一編碼
     * <li></li>
     *
     * @param module: 模塊
     * @param prefix : 前綴
     * @author duanyong
     * @date 2021/4/28 10:31
     * @return: java.lang.String 唯一編碼
     */
    @Override
    public String generate(String module,String prefix) {
        log.info("開始生成唯一編碼,模塊:{},前綴:{}",module,prefix);
        String seq = doGenerate(String.format(CACHE_KEY_PREFIX, module), String.format("%s_", prefix),FORMAT);
        log.info("生成唯一編碼結(jié)束:{}",seq);
        return seq;
    }

    /**
     * 執(zhí)行生成唯一編碼
     * <li></li>
     * @author duanyong
     * @date 2021/4/28 10:53
     * @param key: 鍵
     * @param prefix: 前綴
     * @param format: 格式化
     * @return: java.lang.String 唯一編碼
     */
    private String doGenerate(String key, String prefix, String format) {
        Calendar calendar = Calendar.getInstance();
        calendar.set(Calendar.HOUR_OF_DAY, 23);
        calendar.set(Calendar.MINUTE, 59);
        calendar.set(Calendar.SECOND, 59);
        calendar.set(Calendar.MILLISECOND, 999);
        //設(shè)置過期時(shí)間，這里設(shè)置為當(dāng)天的23:59:59
        Date expireDate = calendar.getTime();
        //返回當(dāng)前redis中的key的最大值
        Long seq = generateSeq(key, expireDate);
        //獲取當(dāng)天的日期，格式為yyyyMMdd
        String date = new SimpleDateFormat(format).format(expireDate);
        //生成八為的序列號(hào)，如果seq不夠八位，seq前面補(bǔ)0，
        //如果seq位數(shù)超過了八位，那么無需補(bǔ)0直接返回當(dāng)前的seq
        String sequence = StringUtils.leftPad(seq.toString(), 8, "0");
        if (prefix == null) {
            prefix = "";
        }
        //拼接業(yè)務(wù)編號(hào)
        String seqNo = prefix + date + sequence;
        log.info("KEY:{}, 序列號(hào)生成:{}, 過期時(shí)間:{}", key, seqNo, String.format("%tF %tT ", expireDate, expireDate));
        return seqNo;
    }
    /**
     * 生成序列號(hào)
     * <li></li>
     * @author duanyong
     * @date 2021/4/28 10:50
     * @param key: 鍵
     * @param expireTime: 過期時(shí)間
     * @return: long 序列號(hào)
     */
    private long generateSeq(String key, Date expireTime) {
        try{
            //RedisAtomicLong為原子類，根據(jù)傳入的key和redis鏈接工廠創(chuàng)建原子類
            RedisAtomicLong counter = new RedisAtomicLong(key,redisTemplate.getConnectionFactory());
            //設(shè)置過期時(shí)間
            counter.expireAt(expireTime);
            //返回redis中key的值
            return counter.incrementAndGet();
        }catch (Exception e){
            log.error("生成序列號(hào)異常:",e);
            String no = StringUtils.right(String.valueOf(System.currentTimeMillis()),4)+ (Math.round((Math.random()+1) * 1000));
            log.info("異常后生成序列號(hào):{}",no);
            return Long.parseLong(no);
        }
    }

}

3、雪花算法配置

**
 * 雪花算法配置
 * <li></li>
 *
 * @author: duanyong
 * @since: 2021/5/21 14:56
 */
@ConfigurationProperties(prefix = SequenceConfig.PREFIX+SnowflakeConfig.PREFIX)
public class SnowflakeConfig {
    /** 前綴 */
    public static final String PREFIX = ".snowflake";
    /** 工作機(jī)器ID,默認(rèn)值*/
    public static final long DEFAULT_WORKER_ID = 0L;
    /** 數(shù)據(jù)中心ID:,默認(rèn)值*/
    public static final long DEFAULT_DATACENTER_ID= 0L;
    /** 工作機(jī)器ID(0~31) */
    private long workerId = DEFAULT_WORKER_ID;

    /** 數(shù)據(jù)中心ID(0~31) */
    private long datacenterId = DEFAULT_DATACENTER_ID;

    public long getWorkerId() {
        return workerId;
    }

    public void setWorkerId(long workerId) {
        this.workerId = workerId;
    }

    public long getDatacenterId() {
        return datacenterId;
    }

    public void setDatacenterId(long datacenterId) {
        this.datacenterId = datacenterId;
    }
}

4、唯一編碼生成服務(wù),基于Twitter_Snowflake,算法實(shí)現(xiàn)來自網(wǎng)絡(luò)

/**
 * 唯一編碼生成服務(wù)
 * <li>基于Twitter_Snowflake</li>
 * <li>算法實(shí)現(xiàn)來自網(wǎng)絡(luò)</li>
 * SnowFlake的結(jié)構(gòu)如下(每部分用-分開):<br>
 * 0 - 0000000000 0000000000 0000000000 0000000000 0 - 00000 - 00000 - 000000000000 <br>
 * 1位標(biāo)識(shí)，由于long基本類型在Java中是帶符號(hào)的，最高位是符號(hào)位，正數(shù)是0，負(fù)數(shù)是1，所以id一般是正數(shù)，最高位是0<br>
 * 41位時(shí)間截(毫秒級(jí))，注意，41位時(shí)間截不是存儲(chǔ)當(dāng)前時(shí)間的時(shí)間截，而是存儲(chǔ)時(shí)間截的差值（當(dāng)前時(shí)間截 - 開始時(shí)間截)
 * 得到的值），這里的的開始時(shí)間截，一般是我們的id生成器開始使用的時(shí)間，由我們程序來指定的（如下下面程序IdWorker類的startTime屬性）。41位的時(shí)間截，可以使用69年，年T = (1L << 41) / (1000L * 60 * 60 * 24 * 365) = 69<br>
 * 10位的數(shù)據(jù)機(jī)器位，可以部署在1024個(gè)節(jié)點(diǎn)，包括5位datacenterId和5位workerId<br>
 * 12位序列，毫秒內(nèi)的計(jì)數(shù)，12位的計(jì)數(shù)順序號(hào)支持每個(gè)節(jié)點(diǎn)每毫秒(同一機(jī)器，同一時(shí)間截)產(chǎn)生4096個(gè)ID序號(hào)<br>
 * 加起來剛好64位，為一個(gè)Long型。<br>
 * SnowFlake的優(yōu)點(diǎn)是，整體上按照時(shí)間自增排序，并且整個(gè)分布式系統(tǒng)內(nèi)不會(huì)產(chǎn)生ID碰撞(由數(shù)據(jù)中心ID和機(jī)器ID作區(qū)分)，并且效率較高，經(jīng)測(cè)試，SnowFlake每秒能夠產(chǎn)生26萬(wàn)ID左右。
 * @author: duanyong
 * @since: 2021/5/21 14:30
 */
@Slf4j
public class SnowflakeSequenceImpl implements Sequence {
    /** 開始時(shí)間截 (2015-01-01) */
    private final long twepoch = 1420041600000L;

    /** 機(jī)器id所占的位數(shù) */
    private final long workerIdBits = 5L;

    /** 數(shù)據(jù)標(biāo)識(shí)id所占的位數(shù) */
    private final long datacenterIdBits = 5L;

    /** 支持的最大機(jī)器id，結(jié)果是31 (這個(gè)移位算法可以很快的計(jì)算出幾位二進(jìn)制數(shù)所能表示的最大十進(jìn)制數(shù)) */
    private final long maxWorkerId = -1L ^ (-1L << workerIdBits);

    /** 支持的最大數(shù)據(jù)標(biāo)識(shí)id，結(jié)果是31 */
    private final long maxDatacenterId = -1L ^ (-1L << datacenterIdBits);

    /** 序列在id中占的位數(shù) */
    private final long sequenceBits = 12L;

    /** 機(jī)器ID向左移12位 */
    private final long workerIdShift = sequenceBits;

    /** 數(shù)據(jù)標(biāo)識(shí)id向左移17位(12+5) */
    private final long datacenterIdShift = sequenceBits + workerIdBits;

    /** 時(shí)間截向左移22位(5+5+12) */
    private final long timestampLeftShift = sequenceBits + workerIdBits + datacenterIdBits;

    /** 生成序列的掩碼，這里為4095 (0b111111111111=0xfff=4095) */
    private final long sequenceMask = -1L ^ (-1L << sequenceBits);

    /** 工作機(jī)器ID(0~31) */
    private long workerId;

    /** 數(shù)據(jù)中心ID(0~31) */
    private long datacenterId;

    /** 毫秒內(nèi)序列(0~4095) */
    private long sequence = 0L;

    /** 上次生成ID的時(shí)間截 */
    private long lastTimestamp = -1L;

    @Autowired
    private SnowflakeConfig snowflakeConfig;

    @PostConstruct
    public void init() {
        if (snowflakeConfig.getWorkerId() > maxWorkerId || snowflakeConfig.getWorkerId() < 0) {
            throw new IllegalArgumentException(String.format("worker Id can't be greater than %d or less than 0", maxWorkerId));
        }
        if (snowflakeConfig.getDatacenterId() > maxDatacenterId || snowflakeConfig.getDatacenterId() < 0) {
            throw new IllegalArgumentException(String.format("datacenter Id can't be greater than %d or less than 0", maxDatacenterId));
        }
        this.workerId = snowflakeConfig.getWorkerId();
        this.datacenterId = snowflakeConfig.getDatacenterId();
    }
    /**
     * 生成申請(qǐng)?zhí)?     * <li></li>
     *
     * @param module : 模塊
     * @param prefix : 前綴
     * @author duanyong
     * @date 2021/4/28 10:31
     * @return: java.lang.String 唯一編碼
     */
    @Override
    public String generate(String module, String prefix) {
        log.info("Snowflake開始生成唯一編碼,前綴:{}",prefix);
        String seq = String.format("%s_", prefix)+nextId();
        log.info("Snowflake生成唯一編碼結(jié)束:{}",seq);
        return seq;
    }
    /**
     * 獲得下一個(gè)ID (該方法是線程安全的)
     * @return SnowflakeId
     */
    private synchronized long nextId() {
        long timestamp = timeGen();

        //如果當(dāng)前時(shí)間小于上一次ID生成的時(shí)間戳，說明系統(tǒng)時(shí)鐘回退過這個(gè)時(shí)候應(yīng)當(dāng)拋出異常
        if (timestamp < lastTimestamp) {
            throw new RuntimeException(
                String.format("Clock moved backwards.  Refusing to generate id for %d milliseconds", lastTimestamp - timestamp));
        }

        //如果是同一時(shí)間生成的，則進(jìn)行毫秒內(nèi)序列
        if (lastTimestamp == timestamp) {
            sequence = (sequence + 1) & sequenceMask;
            //毫秒內(nèi)序列溢出
            if (sequence == 0) {
                //阻塞到下一個(gè)毫秒,獲得新的時(shí)間戳
                timestamp = tilNextMillis(lastTimestamp);
            }
        }
        //時(shí)間戳改變，毫秒內(nèi)序列重置
        else {
            sequence = 0L;
        }

        //上次生成ID的時(shí)間截
        lastTimestamp = timestamp;

        //移位并通過或運(yùn)算拼到一起組成64位的ID
        return ((timestamp - twepoch) << timestampLeftShift)
            | (datacenterId << datacenterIdShift)
            | (workerId << workerIdShift)
            | sequence;
    }

    /**
     * 阻塞到下一個(gè)毫秒，直到獲得新的時(shí)間戳
     * @param lastTimestamp 上次生成ID的時(shí)間截
     * @return 當(dāng)前時(shí)間戳
     */
    protected long tilNextMillis(long lastTimestamp) {
        long timestamp = timeGen();
        while (timestamp <= lastTimestamp) {
            timestamp = timeGen();
        }
        return timestamp;
    }

    /**
     * 返回以毫秒為單位的當(dāng)前時(shí)間
     * @return 當(dāng)前時(shí)間(毫秒)
     */
    protected long timeGen() {
        return System.currentTimeMillis();
    }
}

5、Sequence接口對(duì)象持有者

/**
 * Sequence接口對(duì)象持有者
 * <li></li>
 * @author duanyong
 * @date 2021/5/21 9:26
 */
public class SequenceHolder {
    /** Sequence對(duì)象*/
    static Sequence sequence;

    public static Optional<Sequence> getSequence() {
        return Optional.ofNullable(sequence);
    }
}

6、自動(dòng)配置。

/**
 * 自動(dòng)配置類
 * <li></li>
 *
 * @author: duanyong
 * @since: 2021/5/21 9:19
 */
@Slf4j
@Configuration
@EnableConfigurationProperties(value = SequenceConfig.class)
@ConditionalOnClass(Sequence.class)
@ConditionalOnProperty(prefix = SequenceConfig.PREFIX, value = SequenceConfig.ENABLED, matchIfMissing = true)
public class SequenceAutoConfiguration {
    @Autowired
    private SequenceConfig sequenceConfig;
    @Bean
    @ConditionalOnMissingBean(Sequence.class)
    public Sequence createSequence() {
        log.info("初始化唯一編碼生成器,實(shí)現(xiàn)類名稱:{}",sequenceConfig.getImpl());
        SequenceHolder.sequence = ExtensionLoader.getExtensionLoader(Sequence.class).getExtension(sequenceConfig.getImpl());
        log.info("初始化唯一編碼生成器成功,實(shí)現(xiàn)類:{}",SequenceHolder.sequence);
        return SequenceHolder.sequence;
    }
}

一些信息

路漫漫其修遠(yuǎn)兮,吾將上下而求索
碼云：https://gitee.com/javacoo
QQ群：164863067
作者/微信：javacoo
郵箱：xihuady@126.com

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九欧美,1769亚洲,黄色成人av

唯一序列生成器 starter

唯一序列生成器 starter

sequence-spring-boot-starter

介紹

說明

類關(guān)系圖

項(xiàng)目結(jié)構(gòu)

如何使用

SPI擴(kuò)展

默認(rèn)實(shí)現(xiàn)

一些信息

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九 欧美,1769亚洲,黄色成人av

唯一序列生成器 starter

sequence-spring-boot-starter

介紹

說明

類關(guān)系圖

項(xiàng)目結(jié)構(gòu)

如何使用

SPI擴(kuò)展

默認(rèn)實(shí)現(xiàn)

一些信息

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九欧美,1769亚洲,黄色成人av