鸿蒙-阻塞式文件锁

一、背景

最近在做鸿蒙版本的埋点SDK， 涉及到多线程同步问题。我们都知道多线程存在并发问题（多线程同步和互斥的问题）。今天我介绍一下我在鸿蒙项目中，使用ArkTS的API实现阻塞式的同步锁，来确保线程安全。

1.1 鸿蒙的并发基础设施

在进入正文之前，我先介绍一下鸿蒙系统的并发基础设施，大概分为如下三类：

需要注意的是TaskPool、Worker是鸿蒙ArkTs SDK提供的API，这两种线程(轻量级进程) 之间是内存隔离, 只能够通过 特定的API传递一些@Sendable的数据， 不能够通过 **变量(引用)**的方式直接访问。

1.2 鸿蒙文件管理

鸿蒙的ArkTS SDK中，提供了 文件管理的API, 其中关于 锁的API有：

上述的API，已经非常丰富了，几乎可以满足所有的开发需求。 但是我的情况比较特殊： 我期望的是我的线程通过tryLock去获取互斥锁，如果没有获取到就一直轮训。

你可能会有疑问： lock(exclusive?: boolean): Promise + await 不正好能够满足需求吗？ 是的， 如果确实可以，但是这在鸿蒙当中有一个前提：是需要调用代码块是异步的(方法被async修饰)。这一点我不期望的。

二、场景

如上图所示，线程一和线程二 同时 访问cache.lock的文件锁，获得锁之后，然后对journal文件操作，以确保journal文件内容的完整性和可靠性。

三、实现

同步代码通过轮训实现的同步锁：

import fs from '@ohos.file.fs';
import { FILE_LOCK_TAG } from './FileLockTest';
import { process } from '@kit.ArkTS';

export class FileSyncLock {

  parentDirPath:string
  lockFilePath:string
  workId?:string
  ...

  // 尝试打开 this.lockFilePath文件并，进行加锁
  acquireLockSync():fs.File | undefined {
    let file:fs.File | undefined = undefined
    do {
      try {
        file = fs.openSync(this.lockFilePath,fs.OpenMode.CREATE);
        file.tryLock(true)
        console.error(FILE_LOCK_TAG,`${this.workId}  ${process.tid} Lock acquired. fd : ${file.fd}`);
      } catch (err) {
      }
    } while (!file)
    return file
  }

  // 解锁并关闭某个文件
  releaseLock(file:fs.File) {
    try {
      file.unlock()
      fs.closeSync(file);
      console.error(FILE_LOCK_TAG,`${this.workId} ${process.tid}  Lock released.`);
    } catch (err) {
      // console.debug(FILE_LOCK_TAG,`${this.workId}  ${process.tid}  Failed to release lock: ${JSON.stringify(err)}`);
    }
  }
}

调用方式：

test() {
    let mLock:FileSyncLock = new FileSyncLock(data.cacheDir,"cache.lock",data.workId);
    let f:fs.File = mLock.acquireLockSync()
    // 做一些线程不安全的事情
    doSomethingUnsafe()
    mLock.releaseLock(f!!)
  }

四、写在最后

学到的内容：

1. fs.openSync(this.lockFilePath,fs.OpenMode.CREATE); 这个API只能确保是同步打开文件，获得一个句柄，不能自带加锁，需要额外调用Lock相关的API。
2. 上述的轮询时获得锁的方式是 不推荐的， 因为会使得当前线程一直处于活跃状态，对CPU不太友好，但是可以用于 临界资源竞争不太激烈的场景。
3. 建议使用官网的 协程式获得锁 的方式， 更符合现代编程范式。

官网参考链接：鸿蒙-文件管理
Github代码地址： : 阻塞式文件锁