基于Mongodb分布式锁简单实现，解决定时任务并发执行问题 ...

前言

我们日常开发过程，会有一些定时任务的代码来统计一些系统运行数据，但是我们应用有需要部署多个实例，传统的通过配置文件来控制定时任务是否启动又太过繁琐，而且还经常出错，导致一些异常数据的产生
网上有很多分布式锁的实现方案，基于redis、zk、等有很多，但是我的就是一个用了mysql和mongo的小应用，不准备引入其他三方中间件来解决这个问题，撸一个简单的分布式锁来解决定时任务并发执行的问题,加锁操作的原子性和防死锁也都要支持，这里我使用mongodb写了AllInOne的工具类
All in one Code

先上代码

1. @Component
2. @Slf4j
3. public class MongoDBLock {
5.     private static final int DEFAULT_LOCK_TIMEOUT = 30;//锁的默认超时时间，单位秒
7.     private MongoTemplate mongoTemplate;
8.     private int lockTimeout;
10.     public MongoDBLock(MongoTemplate mongoTemplate) {
11.         this.mongoTemplate = mongoTemplate;
12.         this.lockTimeout = DEFAULT_LOCK_TIMEOUT;
13.     }
15.     /**
16.      * 尝试获取分布式锁
17.      *
18.      * @param lockKey 锁的key
19.      * @return true：获取锁成功，false：获取锁失败
20.      */
21.     private boolean acquireLock(String lockKey) {
22.         LockDocument document = new LockDocument();
23.         document.setId(lockKey);
24.         document.setExpireAt(Instant.ofEpochMilli(Instant.now().toEpochMilli() + lockTimeout * 1000));
25.         try {
26.             mongoTemplate.insert(document);
27.             return true;
28.         } catch (Exception e) {
30.         }
31.         return false;
32.     }
34.     /**
35.      * 释放分布式锁
36.      *
37.      * @param lockKey 锁的key
38.      */
39.     private void releaseLock(String lockKey) {
40.         Query query = new Query(Criteria.where("key").is(lockKey));
41.         mongoTemplate.remove(query, LockDocument.class);
42.         log.info("程序执行成功，释放分布式锁，lockKey:{}",lockKey);
43.     }
45.     /**
46.      * 分布式锁入口方法，参数lockName为锁的名称，lockKey为需要加锁的key，执行完成后自动释放锁
47.      *
48.      * @param lockKey
49.      * @param task
50.      * @param <T>
51.      * @throws Exception
52.      */
53.     public <T> void executeWithLock(String lockKey, ITask<T> task) throws Exception {
54.         boolean locked = acquireLock(lockKey);
55.         if (locked) {
56.             log.info("获取分布式锁成功，lockKey:{}",lockKey);
57.             try {
58.                 task.execute();
59.             } finally {
60.                 releaseLock(lockKey);
61.             }
62.         } else {
63.             log.warn("获取分布式锁失败，lockKey:{}", lockKey);
64.             throw new AppException("获取分布式锁失败！");
65.         }
66.     }
68.     @Data
69.     @Document(collection = "lock_collection")
70.     static class LockDocument {
71.         @Id
72.         private String id;
73.         @Indexed(expireAfterSeconds = DEFAULT_LOCK_TIMEOUT)
74.         private Instant expireAt;
75.     }
77.     @FunctionalInterface
78.     public interface ITask<T> {
79.         T execute() throws Exception;
80.     }
81. }

复制代码

调用示例

1.     @Resource
2.     MongoDBLock mongoDBLock;
4.     mongoDBLock.executeWithLock("key", () -> {
5.         // do some thing
6.         return null;
7.     });

复制代码

原理

• 使用key作为主键，利用mongodb的insert原子性保障LockDocument不会重复插入
  
• LockDocument中expireAt字段利用的mongodb索引过期机制，解决死锁问题，这里设置超时时间是30秒，并在执行完成之后会主动释放锁
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！