開箱即用(out-of-box)的Redis序列號生成器,不用再寫任何代碼,你值得擁有


 

先看整體效果

 


把簡單的東西“傻瓜化”是軟件開發追求的目標之一。請看下圖:

 


左邊是在 
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 {
@Autowired private 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; } @PostConstruct public void init() { if (!stringRedisTemplate.hasKey(getName())) { stringRedisTemplate.opsForValue().setIfAbsent(getName(), String.valueOf(getInitNum())); } }
@Override public String getName() { return name; }
public String getBeanName() { return beanName; }
@Override public long getInitNum() { return initNum; }
@Override public long getStep() { return step; }
@Override public long nextNum() { return stringRedisTemplate.opsForValue().increment(getName(), getStep()); }
@Override public 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定義的:

 @Override public 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<>(); @Autowired private 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; } @PostConstruct public void init() { if (!stringRedisTemplate.hasKey(getName())) { stringRedisTemplate.opsForHash().putIfAbsent(getName(), "flag", String.valueOf(getInitNum())); } }
@Override public String getName() { return name; }
public String getBeanName() { return beanName; }
@Override public long getInitNum() { return initNum; }
@Override public long getStep() { return step; }
@Override public 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()); }
@Override public long getMaxNum() { return maxNum; }
}

源碼地址:https://github.com/coding-new-talking/cnt-springboot.git

 

 

 

(END)

 

編程新說,本號由工作10年

架構師維護,洞察技術本質,

生動幽默有趣,歡迎關注!


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM