開箱即用（out-of-box）的Redis序列號生成器，不用再寫任何程式碼，你值得擁有
阿新 • • 發佈：2019-04-21
先看整體效果
把簡單的東西“傻瓜化”是軟體開發追求的目標之一。請看下圖：
左邊是在 application.yml 裡配置了3個生成器，右邊可以直接注入到程式碼中使用，注意，不用寫任何程式碼。這酸爽。
下面請看效果：
上面是3個生成器生成的第一個序號。哎吆，還不錯哦。
慢慢學會分析
序列號大家都非常熟悉，無非就是一個初始值、步長，有時還有最大值。這只是最基本的資訊，還可以按需新增其他的。
很容易抽象出一個介面，如下程式碼：
/*** 序列號生成器* @author lixinjie* @since 2019-04-04*/public interface SnGenerator {/**名稱，根據實際情況使用*/String getName();/**註冊到容器中的bean名稱*/String getBeanName();/**初始值*/long getInitNum();/**步長*/long getStep();/**獲取下一個序列號*/long nextNum();/**最大值*/long getMaxNum();}
剩下的就是下面這三個問題了：
-
介面有了之後，自然就是基於Redis的實現了，這是遇到第一個問題。
-
還需要根據配置動態向容器中註冊bean定義，這是第二個問題。
-
自然需要從配置檔案中讀出這些配置資訊，供上一步使用，這是第三個問題。
再來學會實現
介面實現時主要用到Redis的INCRBY命令，這是個原子命令。即使你有多個節點，每個節點有多個執行緒同時來呼叫，也是OK的。
而且key不存在時，首次呼叫時還會將key設定為0。這樣帶來的好處就是，程式不用考慮key是否存在，直接呼叫自增就可以了。
唯一不爽的就是key只會被設定為0，如果初始值不是從0開始的，就真有些不爽，最簡單的辦法就是在程式中把初始值作為偏移量疊加上去。
當然還有另一個辦法，就是主動設定key的初始值。因為存在併發，自然要使用SETNX命令。這樣已經完全OK，但還是會有人在心理上覺得不安全。那就在應用啟動階段執行該命令，此時肯定不會有呼叫的。請看下面原始碼：
/*** 基於Redis的實現* @author lixinjie* @since 2019-04-04*/public class RedisSnGenerator implements SnGenerator {@Autowiredprivate StringRedisTemplate stringRedisTemplate;private String name;private String beanName;private long initNum;private long step;private long maxNum;public RedisSnGenerator(String name, String beanName, long initNum, long step, long maxNum) {this.name = name;this.beanName = beanName;this.initNum = initNum;this.step = step;this.maxNum = maxNum;}@PostConstructpublic void init() {if (!stringRedisTemplate.hasKey(getName())) {stringRedisTemplate.opsForValue().setIfAbsent(getName(), String.valueOf(getInitNum()));}}@Overridepublic String getName() {return name;}public String getBeanName() {return beanName;}@Overridepublic long getInitNum() {return initNum;}@Overridepublic long getStep() {return step;}@Overridepublic long nextNum() {return stringRedisTemplate.opsForValue().increment(getName(), getStep());}@Overridepublic long getMaxNum() {return maxNum;}}
要動態註冊bean定義，Spring框架提供了專用介面，BeanDefinitionRegistryPostProcessor：
public interface BeanDefinitionRegistryPostProcessor extends BeanFactoryPostProcessor {/*** @param registry the bean definition registry used by the application context* @throws org.springframework.beans.BeansException in case of errors*/void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException;}
它是一個bean工廠後處理器，應用啟動時框架會自動檢測並應用該型別的實現類。
要使用配置檔案中的內容，Spring框架提供了專門的介面，EnvironmentAware：
public interface EnvironmentAware extends Aware {/*** Set the {@code Environment} that this component runs in.*/void setEnvironment(Environment environment);}
它是一個Aware介面，應用啟動時框架會自動檢測該型別的介面並把你需要的給你set進去。
這塊原始碼有點多，我們就只看兩部分吧。下面是從配置檔案中讀出配置資訊的：
private SnGeneInfo[] parseSnGeneInfos() {String prefix = "sngenerator";String[] generators = environment.getProperty(prefix + ".generators", String[].class);SnGeneInfo[] infos = new SnGeneInfo[generators.length];for (int i = 0; i < generators.length; i++) {infos[i] = buildSnGeneInfo(prefix, generators[i]);}return infos;}private SnGeneInfo buildSnGeneInfo(String prefix, String generator) {return new SnGeneInfo(prefix + ":" + generator,environment.getProperty(prefix + "." + generator + ".bean-name"),environment.getProperty(prefix + "." + generator + ".init-num", long.class),environment.getProperty(prefix + "." + generator + ".step", long.class),environment.getProperty(prefix + "." + generator + ".max-num", long.class));}
下面是註冊bean定義的：
@Overridepublic void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {SnGeneInfo[] geneInfos = parseSnGeneInfos();System.out.println(logInfo(geneInfos));for (SnGeneInfo geneInfo : geneInfos) {BeanDefinitionBuilder bdb = BeanDefinitionBuilder.genericBeanDefinition(RedisSnGenerator.class);bdb.addConstructorArgValue(geneInfo.getKeyName());bdb.addConstructorArgValue(geneInfo.getBeanName());bdb.addConstructorArgValue(geneInfo.getInitNum());bdb.addConstructorArgValue(geneInfo.getStep());bdb.addConstructorArgValue(geneInfo.getMaxNum());registry.registerBeanDefinition(geneInfo.getBeanName(), bdb.getBeanDefinition());}}
需要很多序列的話？
如果需要非常多的序列生成器的話，上面的方法不可取。可以採用“分組”序列生成器，每一組內可以有足夠多的序列，且組與組之間互不影響。
下面請看使用方法，還是一樣的簡單：
下面請看效果：
每一組內部的key，就是上面的f1/f2/f3等，不用配置，程式按需直接傳入即可。
此時獲取下一個序列號的方法需要帶一個引數，就是用來傳這個key的。它是基於Redis的雜湊（Hash）實現的。
/*** 分組序列號生成器* @author lixinjie* @since 2019-04-04*/public interface GroupSnGenerator {/**名稱，根據實際情況使用*/String getName();/**註冊到容器中的bean名稱*/String getBeanName();/**初始值*/long getInitNum();/**步長*/long getStep();/**獲取下一個序列號*/long nextNum(String identifier);/**最大值*/long getMaxNum();}
此時也會遇到給hashkey設定初始值的問題，肯定和上面不一樣，請閱讀原始碼吧。
/*** 基於Redis的實現* @author lixinjie* @since 2019-04-04*/public class RedisGroupSnGenerator implements GroupSnGenerator {private Map<String, Boolean> existHashKeys = new ConcurrentHashMap<>();@Autowiredprivate StringRedisTemplate stringRedisTemplate;private String name;private String beanName;private long initNum;private long step;private long maxNum;public RedisGroupSnGenerator(String name, String beanName, long initNum, long step, long maxNum) {this.name = name;this.beanName = beanName;this.initNum = initNum;this.step = step;this.maxNum = maxNum;}@PostConstructpublic void init() {if (!stringRedisTemplate.hasKey(getName())) {stringRedisTemplate.opsForHash().putIfAbsent(getName(), "flag", String.valueOf(getInitNum()));}}@Overridepublic String getName() {return name;}public String getBeanName() {return beanName;}@Overridepublic long getInitNum() {return initNum;}@Overridepublic long getStep() {return step;}@Overridepublic long nextNum(String identifier) {if (!existHashKeys.containsKey(identifier)) {stringRedisTemplate.opsForHash().putIfAbsent(getName(), identifier, String.valueOf(getInitNum()));existHashKeys.putIfAbsent(identifier, Boolean.TRUE);}return stringRedisTemplate.opsForHash().increment(getName(), identifier, getStep());}@Overridepublic long getMaxNum() {return maxNum;}