Java分布式锁之数据库方式实现

之前的文章《Java分布式锁实现》中列举了分布式锁的3种实现方式，分别是基于数据库实现，基于缓存实现和基于zookeeper实现。三种实现方式各有可取之处，本篇文章就详细讲解一下Java分布式锁之基于数据库的实现方式，也是最简单最易理解的实现方式。

首先，先来阐述下“锁”的概念，锁作为一种安全防御工具，既能上锁防止别人打开，又能让持有钥匙的人打开锁，这是锁的基本功能。那再来说一下“分布式锁”，分布式锁是在分布式系统(多个独立运行系统)内的锁，相对来说，这把锁的安全级别以及作用范围更大，所以从设计上就要考虑更多东西。

现在来说，怎么基于数据库实现这把分布式锁。其实说白了就是，把锁作为数据资源存入数据库，当持有这把锁的访问者来决定是否开锁。

以下详细讲解了在多个应用服务里，怎样用数据库去实现分布式锁。

结合案例：

1.客户app取出交易（同一个客户在某一个时间点只能对某种资产做取现操作）

2.交易重试补偿（交易过程服务宕机，扫描重试补偿）

一、数据库的设计

数据库锁表的表结构如下：

field	type	comment
ID	bigint	主键
OUTER_SERIAL_NO	varchar	流水号
CUST_NO	char	客户号
SOURCE_CODE	varchar	锁操作
THREAD_NO	varchar	线程号
STATUS	char	锁状态
REMARK	varchar	备注
CREATED_AT	timestamp	创建时间
UPDATED_AT	timestamp	更新时间

作为锁的必要属性有5个：系统流水号，客户号，锁操作，线程号和锁状态，下面来解释一下每种属性

流水号：锁的具体指向，比如可以是产品，可以是交易流水号（后面会说到交易同步锁、交易补偿锁的使用方式）

客户号：客户的唯一标识

锁操作：客户的某种操作，比如客户取现操作，取现补偿重试操作

线程号：当前操作线程的线程号，比如取当前线程的uuid

锁状态：P处理中，F失败，Y成功

二、代码设计

代码的目录结构如下：

主要贴一下锁操作的核心代码实现：

锁接口定义：DbLockManager.java

/**
 * 锁接口 br
 * 
 * @Author fugaoyang
 *
 */
public interface DbLockManager 
    /**
     * 加锁
     */
    boolean lockString outerSerialNo, String custNo, LockSource 
    /**
     * 解锁
     */
    void unLockString outerSerialNo, String custNo, LockSource source, LockStatus targetStatus

View Code

锁接口实现类：DbLockManagerImpl.java

/**
 * 
 * 数据库锁实现br
 * 
 * @author fugaoyang
 *
 */
@Service
public class DbLockManagerImpl implements DbLockManager 
    private final Logger LOG  LoggerFactory.getLoggerthis.getClass
    @Autowired
    private DbSyncLockMapper lockMapper
    @Transactional
    public boolean lockString outerSerialNo, String custNo, LockSource  
        boolean isLock  
        TradeSyncLock lock  null
        try 
            lock  lockMapper.findouterSerialNo, custNo, source.getCode
             null  lock 
                lock  new TradeSyncLock
                createLocklock, outerSerialNo, custNo, 
                int num  lockMapper.insertlock
                 num   
                    isLock  
                LOG.infoThreadLogUtils.getLogPrefix + , custNo, source.getCode
                 isLock
            // 根据交易类型进行加锁
            isLock  switchSynsLocklock, 
            LOG.infoThreadLogUtils.getLogPrefix + , custNo, source.getCode
         catch Exception e 
            LOG.errorThreadLogUtils.getLogPrefix +  + custNo, e
         isLock
    @Transactional
    public void unLockString outerSerialNo, String custNo, LockSource source, LockStatus targetStatus 
        try 
            TradeSyncLock lock  lockMapper.findouterSerialNo, custNo, source.getCode
             null  lock 
                lockMapper.updatelock.getId, targetStatus.getName, LockStatus.P.getName,
                        ThreadLogUtils.getCurrThreadUuid, ThreadLogUtils.getCurrThreadUuid
            LOG.infoThreadLogUtils.getLogPrefix + , custNo, source.getCode
         catch Exception e 
            LOG.errorThreadLogUtils.getLogPrefix + , custNo, e
    /**
     * 匹配加锁
     */
    private boolean switchSynsLockTradeSyncLock lock, LockSource  
        boolean isLock  
        switch source 
         WITHDRAW:
            isLock  tradeSynsLocklock
         WITHDRAW_RETRY:
            isLock  retrySynsLocklock
        default:
         isLock
    /**
     * 交易同步锁
     */
    private boolean tradeSynsLockTradeSyncLock lock 
        // 处理中的不加锁，即不执行交易操作
         LockStatus.P.getName.equalslock.getStatus 
        int num  lockMapper.updatelock.getId, LockStatus.P.getName, LockStatus.S.getName,
                ThreadLogUtils.getCurrThreadUuid, null
         num   
    /**
     * 补偿同步锁
     */
    private boolean retrySynsLockTradeSyncLock lock 
        // 处理中或处理完成的不加锁，即不执行补偿操作
         LockStatus.P.getName.equalslock.getStatus  LockStatus.S.getName.equalslock.getStatus 
        int num  lockMapper.updatelock.getId, LockStatus.P.getName, LockStatus.F.getName,
                ThreadLogUtils.getCurrThreadUuid, null
         num   
    private void createLockTradeSyncLock lock, String outerSerialNo, String custNo, LockSource  
        lock.setOuterSerialNoouterSerialNo
        lock.setCustNocustNo
        lock.setSourceCodesource.getCode
        lock.setThreadNoThreadLogUtils.getCurrThreadUuid
        lock.setStatusLockStatus.P.getName
        lock.setRemarksource.getDesc

View Code

获取当前线程号以及打印uuid工具类ThreadLogUtils.Java

/**
 * 
 * 线程处理br
 * 
 * @author fugaoyang
 *
 */
public class ThreadLogUtils 
    private static ThreadLogUtils instance  null
    private  
        setInstancethis
    // 初始化标志
    private static final Object __noop  new Object
    private static ThreadLocalObject __flag  new InheritableThreadLocalObject 
        @Override
        protected Object  
             null
    // 当前线程的UUID信息，主要用于打印日志；
    private static ThreadLocalString currLogUuid  new InheritableThreadLocalString 
        @Override
        protected String  
             UUID.randomUUID.toString/* .toUpperCase */
    private static ThreadLocalString currThreadUuid  new ThreadLocalString 
        @Override
        protected String  
             UUIDGenerator.getUuid
    public static void clearBoolean isNew 
         isNew 
            currLogUuid.remove
            __flag.remove
            currThreadUuid.remove
    public static String  
         isInitialized 
            throw new IllegalStateException
         currLogUuid.get
    public static String  
         currThreadUuid.get
    public static void  
        currThreadUuid.remove
    public static String  
         isInitialized 
          + getCurrLogUuid + 
    private static boolean  
         __flag.get  null
    /**
     * 初始化上下文，如果已经初始化则返回false，否则返回truebr/
     *
     * @return
     */
    public static boolean  
         isInitialized 
        __flag.set__noop
    private static void setInstanceThreadLogUtils instance 
        ThreadLogUtils.instance  instance
    public static ThreadLogUtils  
         instance