Node.js 版本文件锁方法简介

 我们平时在集群环境的时候加锁常常使用redis，如果就单pod实例某个操作想加锁再操作的话，不是用redis，可以考虑使用文件锁。

通常我们需要把nodejs的api文档放一下，这样方便查找一些api

File system | Node.js v14.18.0 Documentation

一、File文件加锁

1、open版本

一开始通过百度回发现使用fs的open方法进行加锁。

var fs = require("fs");

fs.open("test.txt","wx",function(err,fp){
 if(err) return console.error(err);
 // 这里面可以进行我们的操作
 fs.close(fp);
});

这里面的

'wx': Like 'w' but fails if the path exists.

在open调用中，第二个参数中所包含的’x’,指的就是要以独占的方式打开指定文件, 如果指定文件已经被别的进程或线程打开了，那么if(err)的判断成立，函数就会直接打印错误信息并返回。

利用隔离标志实现文件的原子操作有一个缺陷，并不是所有的平台都会支持该标志，例如要读取网络硬盘上的文件，那么该标志很可能会被忽略掉。因此使用隔离标志读取跨平台的文件时，隔离作用很可能会失效。

为了弥补这个缺陷，更好的办法是使用目录来实现文件锁。mkdir是标准的POSIX系统调用，根据标准，它的实现必须是原子性的。任何支持该调用的平台都必须保证它执行的原子性，利用这个特性来构建文件锁的话，代码就能得到很好的跨平台支持，即使是读取网络文件，也能保证文件的一致性不会被破坏。接下来我们看看，如何在NodeJS中使用mkdir实现文件锁。

2、mkdir版本的

下面方法是ts的，基于node14的。如果是node版本比较低的话，需要修改mkdir等方法为promise的。

import * as path from "path";
var fs_promise = require("fs/promises");
const { mkdir, writeFile, unlink, rmdir } = fs_promise;

const LOCAL_PB_LOCK_PATH = path.resolve(__dirname, `../config.lock`);

class Lock {
    static hasLock = false;

    public async lock() {
        if (Lock.hasLock) return Promise.reject(`已经有方法处理中`);
        try {
            await mkdir(LOCAL_PB_LOCK_PATH);
            await writeFile(LOCAL_PB_LOCK_PATH + '/' + process.pid, 'lock');
            Lock.hasLock = true;
            return 'success';
        } catch (err) {
            console.warn(`[mock]lock error ${err}`);
            return Promise.reject(`加锁失败`);
        }
    }

    public async unlock() {
        if (!Lock.hasLock) return "success";

        try {
            await unlink(LOCAL_PB_LOCK_PATH + '/' + process.pid);
            await rmdir(LOCAL_PB_LOCK_PATH);
            Lock.hasLock = false;
            return "success";
        } catch (err) {
            console.warn(`unlock error ${err}`);
            return "success";
        }
    }
}

export default new Lock();