npm 包 jsii 使用教程

阅读时长 4 分钟读完

什么是 jsii?

jsii 是一款用于构建多语言 JavaScript 接口的框架。它可以实现在不同编程语言之间,高效地并且透明地集成和交互。因此,jsii 是一个完美的选项,使得我们可以在一个单一的底层库中封装大量的复杂逻辑。

使用 jsii,开发者能够以 TypeScript 编写多语言 JavaScript 接口,然后将其编译为多个目标语言的库,包括但不限于 JavaScript,Java,DotNet,Go 和 Python。

在本文中,我们将介绍如何使用 jsii 创建跨语言的库。

安装 jsii

在开始之前,请先确保您具备以下环境:

  • Node.js(需要版本 12.13 或更高版本)

要安装 jsii,您可以使用 npm 命令进行安装:

安装完毕后,您可以使用以下命令检查 jsii 版本号:

创建一个新项目

在安装 jsii 后,我们可以使用 jsii 项目生成器创建一个新的默认项目,如下所示:

该命令创建了一个包含生成的文件的文件夹。此文件夹是一个完整的 TypeScript 项目,包括以下部分:

  • package.json:项目描述文件。
  • types/index.d.ts:TypeScript 对于我们新模块的输入/输出类型的定义。
  • lib/index.js:模块的 JavaScript 实现。
  • bin/ts-npm-packaging:一个类型为 ts.NodeCommandLine 命令行工具,用于将项目打包为 npm 包。

创建一个基本的 jsii 类

接下来,我们创建一个能够将两个数字相加的类。我们首先编写 TypeScript 定义文件 src/adder.ts,如下所示:

然后,我们在 lib 文件夹中创建一个相应的 JavaScript 实现文件,如下所示:

-- -------------------- ---- -------
---- --------

-- -- ----- -
------------------------------ ------------- ------- -------
----- ------- ---------- - -----------------------------

-- -- ----- ----
----- ----- ------- --------- -
  -------- ---- -
    ------ -------------- -----
  -
-

------------- - ------

这段代码可以实现一个简单的加法功能。

编译 jsii 模块

完成你的项目后,你就可以编译它了。通过以下命令,您可以构建该项目中的所有包并在本地安装它们:

这会在您的本地 npm 系统中安装您的 jsii 包。现在,您可以在其他项目中使用该包了。

发布 jsii 包

如果您有一个 jsii 项目,并且想将其发布到 npm 上,您需要做以下事情:

  • 在您的项目根目录中运行 npm login 命令。
  • 在您的项目根目录中运行 npm publish --access public 即可发布您的 jsii 包。

使用 jsii 包

为了展示如何使用 jsii 包,我们重新创建 jsii 官方文档中的 Python 文件 src/test.py,如下所示:

-- -------------------- ---- -------
------ ----
---- ----- ------ -----

-----------------------
----- ------------------
  --- --------- ---- -----
    ------ --- - ---

------------
--- -------
  - - -
  - - --
  -------- - -----------
  ------ - --------------- --
  -------------

-- -------- -- -----------
  --------------

我们首先导入 jsii 和我们的 Adder。

然后,我们定义 AdderImpl 类,它实现了 Adder。我们重写了 AdderImpl 的 add 方法来调用 Python 内置的加法运算符。

最后,我们定义 main 函数,并创建 AdderImpl 实例。我们传递两个数字作为 AdderImpl 的 add 方法的参数,并输出结果。

总结

在本文中,我们学习了如何使用 jsii 构建跨语言的库。我们了解了如何安装和使用 jsii,以及如何创建一个基本的 jsii 类。此外,我们还讨论了如何构建和发布您的 jsii 包,以及如何使用它。jsii 是一个非常有用的库,在不同语言之间的接口集成和交互中具有丰富的应用。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f6bec0fa9b7065299ccb904

纠错
反馈