时间戳

首页 > 解决方案 > 如何使用 worker-loader 与 webworkers 创建 typescript 库

javascript - 如何使用 worker-loader 与 webworkers 创建 typescript 库

问题描述

我尝试使用网络工作者创建打字稿库。当我使用 webpack-dev-server 测试我的代码时，一切看起来都很好，找到了所有文件，但是当我让 npm run build 并尝试在另一个本地项目（npm install /local/path）中使用 lib 时，我GET http://localhost:8080/X.worker.js 在浏览器控制台中看到.

webpack.config.js：

const path = require('path');

module.exports = {
    devtool: 'inline-source-map',
    entry: {
        'mylib': './src/index.ts',
        'mylib.min': './src/index.ts',
    },
    output: {
        path: path.resolve(__dirname, '_bundles'),
        filename: '[name].js',
        libraryTarget: 'umd',
        library: 'mylib',
        umdNamedDefine: true
    },
    resolve: {
        extensions: ['.ts', '.tsx', '.js']
    },
    optimization: {
        minimize: true
    },
    module: {
        rules: [
            {
                test: /\.tsx?$/,
                loader: 'awesome-typescript-loader',
                exclude: /node_modules/,
                query: {
                    declaration: false,
                }
            },
            {
                test: /\.worker\.js$/,
                use: {
                    loader: "worker-loader"
                }
            },
        ]
    }
};

tsconfig.json

{
    "compilerOptions": {
        "target": "es5",
        "module": "es6",
        "lib": [
            "webworker",
            "es2015",
            "dom"
        ],
        "moduleResolution": "node",
        "sourceMap": true,
        "strict": true,
        "alwaysStrict": true,
        "outDir": "lib",
        "resolveJsonModule": true,
        "declaration": true,
        "skipLibCheck": true,
        "allowJs": true
    },
    "include": [
        "**/*.ts",
        "**/*.tsx"
    ],
    "exclude": [
        "node_modules",
        "lib",
    ]
}

包.json

{
  "name": "mylib",
  "version": "1.0.0",
  "description": "",
  "main": "_bundles/mylib.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "webpack": "webpack",
    "build": "rm -rf ./lib && tsc",
    "serve": "webpack-dev-server",
    "clean": "rm -rf _bundles lib lib-esm",
    "newbuild": "npm run clean && tsc && tsc -m es6 --outDir lib-esm && webpack"
  },
  "repository": {
    "type": "git",
    "url": "..."
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "bugs": {
    "url": "..."
  },
  "homepage": "...e",
  "devDependencies": {
    "prettier": "^2.1.2",
    "tslint": "^6.1.3",
    "tslint-config-prettier": "^1.18.0",
    "worker-loader": "^3.0.5"
  },
  "dependencies": {
     ...
  }
}

我如何导入工人的示例：

import X from "worker-loader!./X";

标签： javascripttypescriptwebpackweb-workerworker-loader

解决方案

几个月前，我发现自己处于完全相同的境地。我找到了一个对我有用的解决方案，但首先让我们讨论一下为什么会发生这种情况。

问题：

这里有3层。

  1. 库的开发层
  2. 库的构建层
  3. 使用库构建的应用程序

第 1 层很简单。在任何你想创建一个新工人的文件中，说它index.ts，你做你的import X from "worker-loader!./X". 您index.ts确切知道在哪里可以找到您的工作人员文件。这就是为什么事情在你的 webpack-dev-server 上工作的原因。

第 2 层是事情变得奇怪的地方。当你用 处理工作文件时worker-loader，webpack 会输出几个文件。您的配置说filename: '[name].js'，它将为您的源文件夹中的每个文件输出一个文件，所有文件都在您的文件夹中的同一级别_bundles。Webpack 会看到你的import X from "worker-loader!./X"，它还会看到你的目标名称和导入文件的位置，以及执行导入的文件。它将输出包中Web Worker 文件的位置重写为相对于包的其余部分的绝对路径。您可以通过使用worker-loader 中的选项来更仔细地控制这一点。但这并不能真正解决问题，因为您只是将 设置为绝对路径，这导致我们进入第 3 步......index.jspublicPathpublicPath

第 3 层，即您尝试使用您的包的地方，是出现问题的地方。你永远无法预料到人们可能会import { makeAWorker } from 'your-library'在他们的代码中尝试去哪里。无论他们将它导入到哪里，构建文件（在消费者应用程序的 node_modules 中）都将使用 webpack 写入构建的路径index.js来查找工作文件，但现在绝对路径是相对于您的消费者项目（通常是home 路径，例如 index.html 所在的位置），而不是构建的 node_modules 文件夹。因此，您的消费者应用程序不知道在哪里可以找到工作文件。

我的解决方案：有点破解

在我的场景中，我认为我的工作文件的内容足够简单，可以从字符串创建一个工作人员，并以这种方式导入它。例如，一个工作文件看起来像这样：

// worker.ts

// Build a worker from an anonymous function body
export default URL.createObjectURL(
  new Blob([
    '(',
    function () {

      // actual worker content here

    }.toString(),
    ')()', ],
    { type: 'application/javascript' }
  )
);

然后在我想产生工人的地方：

// index.ts

import workerScript from './worker';

const myWorker = new Worker(workerScript, {worker_options});

这是可行的，因为现在您不再要求 webpack 创建文件并为您编写正确的导入位置。最后，您甚至不会在您的捆绑包中为您的工作脚本提供单独的文件。你可以worker-loader完全放弃。您index.ts将创建 Blob 及其 URL，并且您的消费者应用程序将在该 URL 处找到工作脚本，该 URL 是在运行时动态生成的。

确实是一个黑客

这种方法有一些严重的缺点，这导致我提出问题bundle web workers asintegral part of npm package with single file webpack output。问题是在你的工作脚本中，你真的没有导入任何东西的选项。我很幸运，因为我的工人相对简单。它依赖于一个 node_module，它本身没有依赖关系。我一开始只是在脚本中包含该模块的源代码，但是由于我有多个脚本需要相同的外部模块，所以我最终在它生成时将它作为一条数据传递给了 worker：

import { Rainbow } from './utils';

var data = {
  id,
  data              
  RainbowAsString: Rainbow.toString(),
};

myWorker.postMessage(data);

然后在工作人员中，我只需转换RainbowAsString回一个函数并使用它。如果您想了解更多细节，可以查看我使用此方法构建的库：leaflet-topography。查看src/TopoLayer.ts文件以了解工作人员的使用方式，并src//workers查看文件夹以了解我如何设置工作人员 blob。

结论

我认为必须有更好的方法。一种可能的快速解决方法是编写一个复制脚本，将工作文件从node_modules/yourLibrary您的消费者应用程序的构建文件夹中复制。但这并不能带来很好的可移植性，其他人将不得不做同样的事情来让你的库与他们的应用程序一起工作。我的解决方案并不完美，但它适用于简单的工作脚本。我仍在考虑一个更强大的解决方案，允许工人自己进行进口。

编辑：一个适当的解决方案：

所以在写完这个答案之后，我受到启发加入了对话如何使用它来捆绑库？在 webpack-loader 存储库中。显然，当 webpack 5 大约 2 个月前发布时，他们增加了对这种语法的支持：

new Worker(new URL('./path/to/worker.js', import.meta.url))

我还没有尝试过，但它看起来像您需要的解决方案（以及我在 2 个月前提出我的 hack 时需要的解决方案）。试试这个——它可能正是你需要告诉 webpack 捆绑你的库，同时保持工作脚本和导入它的脚本之间的关系。

推荐阅读