PIG 整合 Lock4j 实现分布式锁

lock4j 分布式锁使用演示

Lock4j 简介

Lock4j 是一个分布式锁组件，其提供了多种不同的支持以满足不同性能和环境的需求。立志打造一个简单但富有内涵的分布式锁组件。

主要特性

多种执行器支持（Redis、Redisson、Zookeeper）
注解式使用，简单易用
支持 SpEL 表达式
可自定义锁key生成器和失败策略
支持手动上锁解锁

快速开始

添加依赖

在项目的 pom.xml 文件中添加 Lock4j 依赖：

<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>lock4j-redis-template-spring-boot-starter</artifactId>
  <version>2.2.5</version>
</dependency>

配置 Redis 连接

确保 Redis 连接信息配置正确，以下为默认配置位置

spring:
  data:
    redis:
      host: pig-redis

使用 @Lock4j 注解

在需要分布式锁的方法上添加 @Lock4j 注解：

@Service
public class DemoService {

    // 默认获取锁超时3秒，30秒锁过期
    @Lock4j
    public void simple() {
        // do something
    }
}

配置说明

全局属性配置

配置全局默认参数

配置全局默认的获取锁超时时间和锁过期时间：

lock4j:
  acquire-timeout: 3000 # 默认值3s，可不设置
  expire: 30000 # 默认值30s，可不设置
  primary-executor: com.baomidou.lock.executor.RedisTemplateLockExecutor # 默认redisson>redisTemplate>zookeeper，可不设置
  lock-key-prefix: lock4j # 锁key前缀, 默认值lock4j，可不设置

acquire-timeout 参数说明

expire 参数说明

高级特性

可在方法级指定使用某种执行器，若自己实现的需要提前注入到Spring：

@Service
public class DemoService {

    // 可在方法级指定使用某种执行器
    @Lock4j(executor = RedissonLockExecutor.class)
    public Boolean test() {
        return "true";
    }
}

可在方法级指定使用某种执行器，若自己实现的需要提前注入到Spring：

@Service
public class DemoService {

    // 可在方法级指定使用某种执行器
    @Lock4j(executor = RedissonLockExecutor.class)
    public Boolean test() {
        return "true";
    }
}

默认的锁key生成器为 com.baomidou.lock.DefaultLockKeyBuilder：

@Component
public class MyLockKeyBuilder extends DefaultLockKeyBuilder {

    @Override
    public String buildKey(MethodInvocation invocation, String[] definitionKeys) {
        String key = super.buildKey(invocation, definitionKeys);
        // do something
        return key;
    }
}

默认的锁获取失败策略为 com.baomidou.lock.DefaultLockFailureStrategy：

@Component
public class MyLockFailureStrategy implements LockFailureStrategy {

    @Override
    public void onLockFailure(String key, long acquireTimeout, int acquireCount) {
        // write my code
    }
}

支持编程式的锁操作：

@Service
public class ProgrammaticService {
    @Autowired
    private LockTemplate lockTemplate;

    public void programmaticLock(String userId) {
        // 各种查询操作 不上锁
        // ...
        
        // 获取锁
        final LockInfo lockInfo = lockTemplate.lock(userId, 30000L, 5000L, RedissonLockExecutor.class);
        if (null == lockInfo) {
            throw new RuntimeException("业务处理中,请稍后再试");
        }
        
        // 获取锁成功，处理业务
        try {
            System.out.println("执行简单方法1 , 当前线程:" + Thread.currentThread().getName() + " , counter：" + (counter++));
        } finally {
            // 释放锁
            lockTemplate.releaseLock(lockInfo);
        }
        // 结束
    }
}

在实际项目中，建议优先使用注解方式，手动上锁主要用于复杂业务场景下的精细化控制。

Lock4j 官方文档

查看 Lock4j 的完整文档和最新版本信息

Redis 配置

了解 PIG 系统中 Redis 的详细配置

♥️ 获取支持

遇到问题？

如果您在使用过程中遇到任何问题、有功能建议或需求，请点击此卡片前往 Gitee 仓库提交 Issue。

PIG 整合 Redisson 实现接口幂等 PIG 整合多级缓存提高性能

On this page

Lock4j 简介
快速开始
配置说明
全局属性配置
高级特性
相关链接
♥️ 获取支持

部署指南

二次开发

后端开发

前端开发

集成能力

PIG 整合 Lock4j 实现分布式锁

Lock4j 简介

主要特性

快速开始

配置说明

全局属性配置

高级特性

相关链接

Lock4j 官方文档

Redis 配置

♥️ 获取支持

遇到问题？

部署指南

二次开发

后端开发

前端开发

集成能力

​Lock4j 简介

主要特性

​快速开始

​配置说明

​全局属性配置

​高级特性

​相关链接

Lock4j 官方文档

Redis 配置

​♥️ 获取支持

遇到问题？

Lock4j 简介

快速开始

配置说明

全局属性配置

高级特性

相关链接

♥️ 获取支持