# d-lock-boot-starter

**Repository Path**: 88joel/d-lock-boot-starter

## Basic Information

- **Project Name**: d-lock-boot-starter
- **Description**: 适用于springboot项目快速使用的分布式锁，有zk和redis两种实现
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-06-14
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# d-lock-boot-starter

#### 介绍
适用于springboot项目快速使用的分布式锁，有zk和redis两种实现

#### 软件架构
软件架构说明


#### 使用说明

1. pom文件引入依赖


```
        <properties>
            <java.version>1.8</java.version>
            <aspectj.version>1.8.11</aspectj.version>
            <jedis.version>2.9.0</jedis.version>
            <guava.version>20.0</guava.version>
            <curator.version>2.8.0</curator.version>
            <hutool.version>4.1.1</hutool.version>
        </properties>
 
        <dependencies>
            <!-- 使用common-lock包 需要依赖 -->
            <dependency>
                <groupId>org.aspectj</groupId>
                <artifactId>aspectjweaver</artifactId>
                <version>${aspectj.version}</version>
            </dependency>
            <dependency>
                <groupId>redis.clients</groupId>
                <artifactId>jedis</artifactId>
                <version>${jedis.version}</version>
            </dependency>
            <dependency>
                <groupId>com.google.guava</groupId>
                <artifactId>guava</artifactId>
                <version>${guava.version}</version>
            </dependency>
          
            <dependency>
                <groupId>org.apache.curator</groupId>
                <artifactId>curator-recipes</artifactId>
                <version>${curator.version}</version>
                <exclusions>
                    <exclusion>
                        <groupId>com.google.guava</groupId>
                        <artifactId>guava</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>cn.hutool</groupId>
                <artifactId>hutool-all</artifactId>
                <version>${hutool.version}</version>
            </dependency>
            <dependency>
                <groupId>com.hjb</groupId>
                <artifactId>common-lock</artifactId>
                <version>1.0-SNAPSHOT</version>
                <scope>compile</scope>
            </dependency>
            
            <!-- 使用common-lock包 需要依赖 -->
        </dependencies>
```

2. springboot启动类上加入@EnableZkLock或者@EnableRedisLock注解，推荐使用zk实现的分布式锁

```
@SpringBootApplication
@EnableZkLock
class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}
```

3. 在需要加锁的方法上使用注解@Lock，
其中timeout设置锁超时时间默认为5000ms，
lockId设置锁的唯一id
errorMethodName定义锁错误的时候执行的回调方法，非必须
timeOutMethodName定义锁超时的时候执行的回调方法，非必须

```
    @Lock(timeout = 1000,lockId = "order",
        errorMethodName = "com.hjb.controller.LockController.lockError(java.lang.String)",
        timeOutMethodName = "com.hjb.controller.LockController.lockTimeOut(java.lang.String)"
    )
    @RequestMapping(value = "test", method = RequestMethod.GET)
    public Object testLockAnnotation(String id){
        //todo 需要执行的代码
    }
    public String lockTimeOut(String id){
        String msg = "业务"+id+"锁已被占用，锁占用业务处理";
        return msg;
    }
    public String lockError(String id){
        String msg = "业务"+id+"锁获取失败，锁异常业务处理";
        return msg;
    }
```