release branch 1.1.0

README.md

@@ -1,6 +1,6 @@
 # 项目简介
 
-为 java 设计的锁。
+[lock](https://github.com/houbb/lock) 为 java 设计的分布式锁。
 
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.houbb/lock/badge.svg)](http://mvnrepository.com/artifact/com.github.houbb/lock)
 [![Build Status](https://www.travis-ci.org/houbb/lock.svg?branch=master)](https://www.travis-ci.org/houbb/lock?branch=master)
@@ -8,15 +8,15 @@
 
 ## 目的
 
+- 开箱即用，支持注解式和过程式调用 
+
 - 基于 redis 的分布式锁
 
 - 整合 spring
 
 - 整合 spring-boot
 
-- 开箱即用，支持注解。
-
-- 支持多种 redis 的声明方式
+- 支持多种 redis 的整合方式
 
 # 变更日志
 
@@ -36,7 +36,7 @@ maven 3.x+
 <dependency>
     <groupId>com.github.houbb</groupId>
     <artifactId>lock-core</artifactId>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
 </dependency>
 ```
 
@@ -45,22 +45,36 @@ maven 3.x+
 基于本地 redis 的测试案例。
 
 ```java
-ILock lock = LockBs.newInstance()
-        .init();
-
-String key = "ddd";
-try {
-    // 加锁
-    lock.tryLock(key);
-    System.out.println("业务处理");
-} catch (Exception e) {
-    throw new RuntimeException(e);
-} finally {
-    // 释放锁
-    lock.unlock(key);
+public void helloTest() {
+    ILock lock = LockBs.newInstance();
+    String key = "ddd";
+    try {
+        // 加锁
+        lock.tryLock(key);
+        System.out.println("业务处理");
+    } catch (Exception e) {
+        throw new RuntimeException(e);
+    } finally {
+        // 释放锁
+        lock.unlock(key);
+    }
 }
 ```
 
+### 配置化
+
+为了便于拓展，LockBs 的配置支持自定义：
+
+```java
+LockBs.newInstance()
+        .id(Ids.uuid32())   //id 生成策略
+        .cache(JedisRedisServiceFactory.pooled("127.0.0.1", 6379)) //缓存策略
+        .lockSupport(new RedisLockSupport())    // 锁实现策略
+        .lockKeyFormat(new LockKeyFormat())     // 针对 key 的格式化处理策略
+        .lockReleaseFailHandler(new LockReleaseFailHandler())   //释放锁失败处理
+        ;
+```
+
 # 整合 spring
 
 ## maven 引入
@@ -69,7 +83,7 @@ try {
 <dependency>
     <groupId>com.github.houbb</groupId>
     <artifactId>lock-spring</artifactId>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
 </dependency>
 ```
 
@@ -87,9 +101,58 @@ public class SpringConfig {
 }
 ```
 
+`EnableLock` 注解说明，和引导类对应：
+
+```java
+public @interface EnableLock {
+
+    /**
+     * 唯一标识生成策略
+     * @return 结果
+     * @since 1.1.0
+     */
+    String id() default "lockId";
+
+    /**
+     * 缓存实现策略 bean 名称
+     *
+     * 默认引入 redis-config 中的配置
+     *
+     * @return 实现
+     * @since 1.1.0
+     */
+    String cache() default "springRedisService";
+
+    /**
+     * 加锁 key 格式化策略
+     * @return 策略
+     * @since 1.2.0
+     */
+    String lockKeyFormat() default "lockKeyFormat";
+
+    /**
+     * 锁释放失败处理类
+     * @return 结果
+     * @since 1.2.0
+     */
+    String lockReleaseFailHandler() default "lockReleaseFailHandler";
+
+}
+```
+
+其中 `springRedisService` 使用的是 [redis-config](https://github.com/houbb/redis-config) 中的实现。
+
+redis 的配置信息如下：
+
+| 配置 | 说明 | 默认值
+|:---|:---|:----|
+| redis.address | redis 地址 | 127.0.0.1 |
+| redis.port | redis 端口 | 6379 |
+| redis.password | redis 密码 | |
+
 ### 使用 LockBs
 
-我们可以直接 `LockBs` 的引导类。
+我们可以直接 `LockBs` 的引导类，这种适合一些更加灵活的场景。
 
 ```java
 @ContextConfiguration(classes = SpringConfig.class)
@@ -124,7 +187,7 @@ public class SpringServiceRawTest {
 
 当然，我们可以在方法上直接指定注解 `@Lock`，使用更加方便。
 
-支持 SPEL 表达式。
+直接使用，AOP 切面生效即可。
 
 ```java
 @Service
@@ -140,9 +203,44 @@ public class UserService {
 }
 ```
 
-直接使用，AOP 切面生效即可。
+`@Lock` 属性说明，value 用于指定 key，支持 SPEL 表达式。
 
-# springboot 整合
+其他属性，和引导类的方法参数一一对应。
+
+```java
+public @interface Lock {
+
+    /**
+     * 缓存的 key 策略，支持 SpEL
+     * @return 结果
+     */
+    String value() default "";
+
+    /**
+     * 时间单位
+     * @return 单位
+     * @since 1.2.0
+     */
+    TimeUnit timeUnit() default TimeUnit.SECONDS;
+
+    /**
+     * 等待锁时间
+     * @return 等待锁时间
+     * @since 1.2.0
+     */
+    long waitLockTime() default 10;
+
+    /**
+     * 业务加锁时间
+     * @return 加锁时间
+     * @since 1.2.0
+     */
+    long lockTime() default 60;
+
+}
+```
+
+# spring boot 整合
 
 ## maven 引入
 
@@ -150,7 +248,7 @@ public class UserService {
 <dependency>
     <groupId>com.github.houbb</groupId>
     <artifactId>lock-springboot-starter</artifactId>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
 </dependency>
 ```
 
@@ -164,5 +262,4 @@ public class UserService {
 
 持有锁的线程可以多次获取锁
 
-- [x] 分布式锁注解支持
-
+- [x] 分布式锁注解支持