使用Redis实现分布式锁

随着软件社会经济的发展，很多软件的架构变得愈来愈复杂，共享数据的安全问题使用传统的事务，java 自带的synchronized，ReentrantLock，数据库锁已经不能满足需求了。这个时候分布式锁便应运而生，目前一般都会使用zookeeper或者Redis还有基于数据库来实现的乐观锁，来实现分布式锁。

我们公司使用的是基于Redis来实现的；

首先，为了确保分布式锁可用，我们至少要确保锁的实现同时满足以下四个条件：

1. 互斥性。在任意时刻，只有一个客户端能持有锁。
2. 不会发生死锁。即使有一个客户端在持有锁的期间崩溃而没有主动解锁，也能保证后续其他客户端能加锁。
3. 具有容错性。只要大部分的Redis节点正常运行，客户端就可以加锁和解锁。
4. 解铃还须系铃人。加锁和解锁必须是同一个客户端，客户端自己不能把别人加的锁给解了。

下面我直接大概模拟公司代码实现：

public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        MethodHandle methodHandle = (MethodHandle) handler;
        //这儿可能会是登录校验或者是权限校验，我们公司是在这儿解析方法上的注解，然后实现相关功能
        Right right = methodHandle.getClass().getAnnotation(Right.class);
        if (right == null) {
            ResultEnvelope resultEnvelope = new ResultEnvelope();
            resultEnvelope.setCode(401);
            resultEnvelope.success("暂无权限");
            response.getWriter().print(resultEnvelope);
        }
        //在这儿我们可以使用分布式锁实现对请求的控制
        //当然实际项目中的key一般为全限定类名加方法名再加用户id
        boolean result = CacheTool.setNx(methodHandle.getClass().getDeclaringClass().getName() + methodHandle.getClass().getName() + request.getRemoteUser(), UUID.randomUUID().toString(), 7);
        if (!result) {
            //直接返回
            return false;
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        //如果到这儿说明请求已经成功，可以从新设置redis中key的过期时间
        MethodHandle methodHandle = (MethodHandle) handler;
        CacheTool.pexpire(methodHandle.getClass().getDeclaringClass().getName() + methodHandle.getClass().getName() + request.getRemoteUser(), 500);
    }
}

package com.poplar.utils;

/**
 * by poplar created on 2020/1/9
 */
public class ResultEnvelope<T> {
    //响应码
    private int code;

    private T data;

    private String message;

    public ResultEnvelope() {
    }

    public ResultEnvelope(int code) {
        this.code = code;
    }

    public ResultEnvelope(int code, T data) {
        this.code = code;
        this.data = data;
    }

    public ResultEnvelope(int code, T data, String message) {
        this.code = code;
        this.data = data;
        this.message = message;
    }

    public ResultEnvelope(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public ResultEnvelope<T> success() {
        return new ResultEnvelope<T>(0);
    }

    public ResultEnvelope<T> success(T t) {
        return new ResultEnvelope<>(0, t);
    }

    public ResultEnvelope<T> success(String message) {
        return new ResultEnvelope<>(0, message);
    }

    public ResultEnvelope<T> success(int code, String message) {
        return new ResultEnvelope<>(code, message);
    }

    public ResultEnvelope<T> failure(String message) {
        return new ResultEnvelope<>(-1, message);
    }

    public ResultEnvelope<T> failure(int code, String message) {
        return new ResultEnvelope<>(code, message);
    }

    public ResultEnvelope<T> failure() {
        return new ResultEnvelope<>(-1);
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

/**
 * by poplar created on 2020/1/9
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Right {
    String[] value() default {};
}

/**
 * by poplar created on 2020/1/9
 */
public class CacheTool {

    public static boolean setNx(String key, String value, int expireSeconds) {
        Jedis jedis = new Jedis("localhost", 6379);
        //nxxx NX|XX, NX -- Only set the key if it does not already exist. XX -- Only set the keyif it already exist.
        // expx EX|PX, expire time units: EX = seconds; PX = milliseconds
        //源码对这两个参数的说明
        String result = jedis.set(key, value, "NX", "EX", expireSeconds);
        jedis.close();
        return "OK".equalsIgnoreCase(result);
    }

    public static void pexpire(String key, long expireMilliseconds) {
        Jedis jedis = new Jedis("localhost", 6379);
        jedis.pexpire(key, expireMilliseconds);
        jedis.close();
    }
}