复述的分布式锁组件,简单方便快捷接入使项目拥有分布式锁

  

spring-boot-klock-starter

基于复述的分布式锁spring-boot起动器组件,使得项目拥有分布式锁能力变得异常简单,支持弹簧引导,和spirng mvc等春天相关项目

快速开始

印刷面积引导项目接入

添加锁起动器组件依赖

 & lt; dependency>
  & lt; groupId> cn.keking
  & lt; artifactId> spring-boot-klock-starter
  & lt; version> 1.3 -release
  & lt;/dependency>
  2. application.properties配置复述,链接:spring.klock.address=127.0.0.1:6379 

3。在需要加分布式锁的方法上,添加注解@Klock,如:

复述的分布式锁组件,简单方便快捷接入使项目拥有分布式锁


支持锁指定的业务键,如同一个方法ID入参相同的加锁,其他的放行。业务关键的获取支持?,具体使用方式如下

复述的分布式锁组件,简单方便快捷接入使项目拥有分布式锁


spring mvc项目接入

其他步骤和弹簧启动步骤一样,只需要spring-xx。xml配置中添加KlockAutoConfiguration类扫描即可,如:

 & lt;上下文:component-scan基础包=皁rg.springframework.boot.autoconfigure.klock.KlockAutoConfiguration”/祝辞

使用参数说明

配置参数说明

 spring.klock。地址:复述,链接地址
  spring.klock。密码:复述,密码
  spring.klock。数据库:复述,数据索引
  spring.klock。waitTime:获取锁最长阻塞时间(默认:60,单位:秒)
  spring.klock。leaseTime:已获取锁后自动释放时间(默认:60,单位:秒)
  spring.klock.cluster-server。节点地址:复述,集群配置如127.0.0.1:7000,127.0.0.1:7001 127.0.0.1:7002
  spring.klock。地址和spring.klock.cluster-server。节点地址选其一即可

@Klock注解参数说明

 @Klock可以标注四个参数,作用分别如下
  名称:锁的名字,对应复述的关键值。默认为:类名+方法名
  lockType:锁的类型,目前支持(可重入锁,公平锁,读写锁)。默认为:公平锁
  waitTime:获取锁最长等待时间。默认为:60年代,同时也可通过spring.klock.waitTime统一配置
  leaseTime:获得锁后,自动释放锁的时间。默认为:60年代,同时也可通过spring.klock.leaseTime统一配置
  lockTimeoutStrategy:加锁超时的处理策略,可配置为不做处理,快速失败,阻塞等待的处理策略,默认策略为不做处理
  customLockTimeoutStrategy:自定义加锁超时的处理策略,需指定自定义处理的方法的方法名,并保持入参一致。
  releaseTimeoutStrategy:释放锁时,持有的锁已超时的处理策略,可配置为不做处理,快速失败的处理策略,默认策略为不做处理
  customReleaseTimeoutStrategy:自定义释放锁时,需指定自定义处理的方法的方法名,并保持入参一致。

锁超时说明

因为基于复述,实现分布式锁,如果使用不当,会在以下场景下遇到锁超时的问题:

复述的分布式锁组件,简单方便快捷接入使项目拥有分布式锁


加锁超时处理策略(LockTimeoutStrategy):

<李>

NO_OPERATION不做处理,继续执行业务逻辑

<李>

FAIL_FAST快速失败,会抛出KlockTimeoutException

<李>

KEEP_ACQUIRE阻塞等待,一直阻塞,直到获得锁,但在太多的尝试后,会停止获取锁并报错,此时很有可能是发生了死锁。

<李>

自定义(customLockTimeoutStrategy)需指定自定义处理的方法的方法名,并保持入参一致,指定自定义处理方法后,会覆盖上述三种策略,且会拦截业务逻辑的运行。

释放锁时超时处理策略(ReleaseTimeoutStrategy):

<李>

NO_OPERATION不做处理,继续执行业务逻辑

<李>

FAIL_FAST快速失败,会抛出KlockTimeoutException

<李>

自定义(customReleaseTimeoutStrategy)需指定自定义处理的方法的方法名,并保持入参一致,指定自定义处理方法后,会覆盖上述两种策略,执行自定义处理方法时,业务逻辑已经执行完毕,会在方法返回前和抛出异常前执行。

希望使用者清楚的意识到,如果没有对加锁超时进行有效的设置,那么设置释放锁时超时处理策略是没有意义的。

复述的分布式锁组件,简单方便快捷接入使项目拥有分布式锁