如何在 JS/TS 中实现伪阻塞异步队列？

Question

所以这里有一个矛盾：我想在 javascript/typescript 中创建一个异步阻塞队列（如果你可以在没有 typescript 的情况下实现它，那很好）。基本上我想实现类似 Java 的 BlockingQueue expect 之类的东西，而不是它实际上是阻塞的，它是异步的，我可以等待出队。

这是我要实现的接口：

interface AsyncBlockingQueue<T> {
  enqueue(t: T): void;
  dequeue(): Promise<T>;
}

我会这样使用它：

// enqueue stuff somewhere else

async function useBlockingQueue() {
  // as soon as something is enqueued, the promise will be resolved:
  const value = await asyncBlockingQueue.dequeue();
  // this will cause it to await for a second value
  const secondValue = await asyncBlockingQueue.dequeue();
}

有什么想法吗？

Answer 1

实际上很简单，dequeue 将创建一个 enqueue 将解决的承诺。我们只需要将解析器保持在队列中 - 并且还要关心值在出队之前入队的情况，将已经实现的承诺保持在队列中。

class AsyncBlockingQueue {
  constructor() {
    // invariant: at least one of the arrays is empty
    this.resolvers = [];
    this.promises = [];
  }
  _add() {
    this.promises.push(new Promise(resolve => {
      this.resolvers.push(resolve);
    }));
  }
  enqueue(t) {
    // if (this.resolvers.length) this.resolvers.shift()(t);
    // else this.promises.push(Promise.resolve(t));
    if (!this.resolvers.length) this._add();
    this.resolvers.shift()(t);
  }
  dequeue() {
    if (!this.promises.length) this._add();
    return this.promises.shift();
  }
  // now some utilities:
  isEmpty() { // there are no values available
    return !this.promises.length; // this.length <= 0
  }
  isBlocked() { // it's waiting for values
    return !!this.resolvers.length; // this.length < 0
  }
  get length() {
    return this.promises.length - this.resolvers.length;
  }
  [Symbol.asyncIterator]() {
    // Todo: Use AsyncIterator.from()
    return {
      next: () => this.dequeue().then(value => ({done: false, value})),
      [Symbol.asyncIterator]() { return this; },
    };
  }
}

我不知道 TypeScript，但想必添加必要的类型注释很简单。

为了获得更好的性能，请使用带有循环缓冲区而不是普通数组的 Queue 实现，例如this one。您也可以只使用一个队列并记住您当前存储的是 Promise 还是解析器。

Answer 2

这只是@Bergi 的回答，但使用 typescript + 泛型并进行了一些修改，以使其在我的 typescript 窥视的严格模式下工作。

class AsyncBlockingQueue<T> {
  private _promises: Promise<T>[];
  private _resolvers: ((t: T) => void)[];

  constructor() {
    this._resolvers = [];
    this._promises = [];
  }

  private _add() {
    this._promises.push(new Promise(resolve => {
      this._resolvers.push(resolve);
    }));
  }

  enqueue(t: T) {
    if (!this._resolvers.length) this._add();
    const resolve = this._resolvers.shift()!;
    resolve(t);
  }

  dequeue() {
    if (!this._promises.length) this._add();
    const promise = this._promises.shift()!;
    return promise;
  }

  isEmpty() {
    return !this._promises.length;
  }

  isBlocked() {
    return !!this._resolvers.length;
  }

  get length() {
    return this._promises.length - this._resolvers.length;
  }
}