有趣的 hook - useWorker

简介: 前几天看到个有趣的 hook: useWorker。可以直接将函数转换为 worker,然后调用执行,这样便可以将一些耗时、阻塞的计算放到 worker 中执行,避免主线程阻塞。由于很好奇这个 hook 如果在不支持 worker 的浏览器上有没有做兼容,就把源码看了一下,这里记录一下。📝

网络异常,图片无法展示
|

前几天看到个有趣的 hook: useWorker。可以直接将函数转换为 worker,然后调用执行,这样便可以将一些耗时、阻塞的计算放到 worker 中执行,避免主线程阻塞。

由于很好奇这个 hook 如果在不支持 worker 的浏览器上有没有做兼容,就把源码看了一下,这里记录一下。📝

源码解析

由于库很小,文件就不看了,直接看下导出:

导出

export { useWorker } from './useWorker';
export { WORKER_STATUS } from './lib/status';
复制代码

导出一共就两个,一个 useWorker hook 主体,一个是 WORKER_STATUS 常量,里面包含几种状态:

export enum WORKER_STATUS {
    PENDING = 'PENDING',
    SUCCESS = 'SUCCESS',
    RUNNING = 'RUNNING',
    ERROR = 'ERROR',
    TIMEOUT_EXPIRED = 'TIMEOUT_EXPIRED'
}
复制代码

useWorker 定义和实现

先看下 useWorker 定义:

type Options = {
    timeout?: number;
    remoteDependencies?: string[];
    autoTerminate?: boolean;
    transferable?: TRANSFERABLE_TYPE;
};
export const useWorker = <T extends (...fnArgs: any[]) => any>(fn: T, options: Options = DEFAULT_OPTIONS) => [
    typeof workerHook,
    WorkerController
];
复制代码

在看下实现,useWorker 包含一个 state workerStatus,默认为 PENDING

包含四个 ref

  • worker: 创建的 worker 实例
  • isRunningworker 执行状态
  • promise: 保存 worker 执行的 promiseresolvereject,方便调用
  • timeoutId:记录 timeout 定时器的 id,设置 timeout 时使用

还包含了几个方法:

  • setWorkerStatus:用于设置 worker 状态和 isRunning
  • killWorker:用于终止和清理 worker
  • onWorkerEnd: 在 worker 执行完成时调用,会按照 option 判定是否需要清理 worker,并更新状态
  • generateWorker:创建 worker 实例,并与其建立通信。
  • callWorker:调用 worker 执行
  • workerHookuseWorker 返回值之一,用于调用 callWorker

还有一个 effect,就是组件卸载时调用 killWorker 清理 worker

而另一个返回值 workerController 则是包含 statuskillWorker

const workerController = {
    status: workerStatus,
    kill: killWorker
};
复制代码

执行流程

我们先看下使用方法,然后配合看下代码如何运行:

import React from 'react';
import { useWorker } from '@koale/useworker';
const numbers = [...Array(5000000)].map(e => ~~(Math.random() * 1000000));
const sortNumbers = nums => nums.sort();
const Example = () => {
    const [sortWorker] = useWorker(sortNumbers);
    const runSort = async () => {
        const result = await sortWorker(numbers);
        console.log(result);
    };
    return (
        <button type='button' onClick={runSort}>
            Run Sort
        </button>
    );
};
复制代码

使用时首先调用 useWorker,会返回 workerHookworkerController,例子中 workerHook 命名为 sortWorkerworkerController 没用到。

然后在点击按钮时,会调用 runSortrunSort 会调用 workerHook 并传入 numbers。看下 workerHook 的源码。

const workerHook = React.useCallback(
    (...fnArgs: Parameters<T>) => {
        const terminate = options.autoTerminate != null ? options.autoTerminate : DEFAULT_OPTIONS.autoTerminate;
        if (isRunning.current) {
            /* eslint-disable-next-line no-console */
            console.error(
                '[useWorker] You can only run one instance of the worker at a time, if you want to run more than one in parallel, create another instance with the hook useWorker(). Read more: https://github.com/alewin/useWorker'
            );
            return Promise.reject();
        }
        if (terminate || !worker.current) {
            worker.current = generateWorker();
        }
        return callWorker(...fnArgs);
    },
    [options.autoTerminate, generateWorker, callWorker]
);
复制代码

他会先判定 terminate 参数,用于判定是否需要自动回收。然后判定 isRunning,避免重复执行。然后判定是否存在 worker 实例,不存在则调用 generateWorker 创建。随后便将传入的参数传递给 callWorker

再看下 generateWorker 的源码。

const generateWorker = useDeepCallback(() => {
    const {
        remoteDependencies = DEFAULT_OPTIONS.remoteDependencies,
        timeout = DEFAULT_OPTIONS.timeout,
        transferable = DEFAULT_OPTIONS.transferable
    } = options;
    const blobUrl = createWorkerBlobUrl(fn, remoteDependencies!, transferable!);
    const newWorker: Worker & { _url?: string } = new Worker(blobUrl);
    newWorker._url = blobUrl;
    newWorker.onmessage = (e: MessageEvent) => {
        const [status, result] = e.data as [WORKER_STATUS, ReturnType<T>];
        switch (status) {
            case WORKER_STATUS.SUCCESS:
                promise.current[PROMISE_RESOLVE]?.(result);
                onWorkerEnd(WORKER_STATUS.SUCCESS);
                break;
            default:
                promise.current[PROMISE_REJECT]?.(result);
                onWorkerEnd(WORKER_STATUS.ERROR);
                break;
        }
    };
    newWorker.onerror = (e: ErrorEvent) => {
        promise.current[PROMISE_REJECT]?.(e);
        onWorkerEnd(WORKER_STATUS.ERROR);
    };
    if (timeout) {
        timeoutId.current = window.setTimeout(() => {
            killWorker();
            setWorkerStatus(WORKER_STATUS.TIMEOUT_EXPIRED);
        }, timeout);
    }
    return newWorker;
}, [fn, options, killWorker]);
复制代码

此处使用的是自定义 hookuseDeepCallback,他会深比对 dependences 来触发 callback 的更新。

可以看到主要是调用了 createWorkerBlobUrl 创建了一个 worker url,然后创建 worker 实例,并绑定 onmessageonerror,并在随后开启超时定时器。

createWorkerBlobUrl 代码就三句:

const blobCode = `
    ${remoteDepsParser(deps)};
    onmessage=(${jobRunner})({
      fn: (${fn}),
      transferable: '${transferable}'
    })
  `;
const blob = new Blob([blobCode], { type: 'text/javascript' });
const url = URL.createObjectURL(blob);
复制代码

显示将 jobRunner、fn、transferable 拼接成一段方法字符串,然后创建 blob 并将其转换为 url

jobRunner 会调用 fn,然后将 fn 返回的结果和状态通过 postMessage 发送给主线程,主线程会触发 onmessage,调用 promiseRef 返回结果 和调用 onWorkerEndonWorkerEnd 会按照 autoTerminate 参数决定是否需要在完成任务后自动销毁 worker

其中还有一些报错处理、超时处理的代码,就不细说了。

兼容处理

然而没发现兼容相关的代码。useWorker 使用到了 createObjectURLWorker,当然这俩兼容性还可以,兼容的 IE 10。如果不放心可以主动做个降级:

const runSort = async () => {
    try {
        const result = await sortWorker(numbers);
        console.log(result);
    } catch (e) {
        sortNumbers(numbers);
    }
};
复制代码

虽然 hook 外无法包裹条件判断,但由于调用 sortWorker 才会去执行 createObjectURLWorker 实例化,我们在调用时做个判断即可,或者通过前置判断:

const runSort = async () => {
    const result = typeof Worker === 'undefined' ? sortNumbers(numbers) : await sortWorker(numbers);
};
复制代码

总结

useWorker 可以在进行耗能计算时通过 worker 来避免主线程的阻塞,如果在业务中有使用如前端大批量数据搜索、复杂计算时可以考虑使用,可以有效提高代码性能。

其它相似库

如果要在非 react 环境下转换 worker,也可以尝试以下库,或者照着思路自己实现:

相关文章
|
7月前
|
关系型数据库 MySQL API
如何使用hook?
如何使用hook?
51 0
|
JavaScript API
自定义hook是什么
自定义hook是什么
|
前端开发 JavaScript 算法
useState() hook 的原理解析
useState() hook 的原理解析
162 0
|
前端开发 JavaScript
react 进阶hook 之 State Hook
在类组件中,使用 this.setState({a:xxx}) 是会对当前类实例的属性进行混合。但是在state hook 中是不会进行混合的,原因嘛: 官方就是要让你你定义多个 hooks, 将每一个代码块进行分离,从而降低代码的维护成本。
react 进阶hook 之 State Hook
|
前端开发
react 进阶hook 之 context Hook
react context 上下文,相信大家都会使用。不会的可查看。详情的概念这里不介绍,只接受在函数组件中,使用context hooks 的使用
react 进阶hook 之 context Hook
|
前端开发
react 进阶hook 之 useImperativeHandle hook
这个hook比较简单,作用: 获取函数组件里面的事件,我们通过 ref 来获取类组件的事件,所以 这个 useImperativeHandle Hook 一般是于 ref 转发一起使用。
react 进阶hook 之 useImperativeHandle hook
|
JavaScript 前端开发
react 进阶hook 之 useLayoutEffect hook
useLayoutEffect 其函数签名与 useEffect相同,但它会在所有的 DOM 变更之后同步调用 effect。可以使用它来读取 DOM 布局并同步触发重渲染
react 进阶hook 之 useLayoutEffect hook
|
前端开发
react 进阶hook 之自定义Hook
hooks是一个函数,并且是在react 函数组件中使用的,不同的hook的作用也是不一样的,例如,state hook是用来定义函数组件的状态, 而effect hook 是用来定义组件的副作用,那么自定义hook是用来干啥的呢?,自定来定义一个hook 函数,里面可以包含 多个hooks。简单点的说是,把相同逻辑的hooks封装在同一个函数里。
react 进阶hook 之自定义Hook
|
存储 JavaScript 前端开发
react 进阶hook 之 Effect Hook
在效果图中,ui是会先出现的,然后我们的title值才会从 viteApp 改成 title 0,所以可以证明 effect的执行时间点是在等ui 渲染之后再来进行执行的,并且打印我会优先effect会优先输出。也就是异步执行
react 进阶hook 之 Effect Hook
|
C++
C/C++ IAT HOOK MessageBoxW
最近在研究各种姿势的 HOOK,虽然 HOOK 这个东西已经是很久之前就有的技术了,但好在目前应用仍然很广泛,所以老老实实肯大佬们 10 年前啃过的骨头,下面是庄重的代码献祭时刻。
275 0