在前端开发中，我们经常需要使用 SHA 算法进行数据加密。其中，SHA.js 是一个流行的 JavaScript 库，用于生成 SHA-1、SHA-256、SHA-512 等哈希值。而使用 @types/sha.js 这个 npm 包，我们可以在 TypeScript 项目中更加方便地使用 SHA.js 库，本文将详细介绍该 npm 包的使用。
安装
在终端窗口中输入以下命令来安装 @types/sha.js 包：
npm install --save-dev @types/sha.js
基本用法
以下是使用 SHA.js 库计算 SHA-256 的示例代码：
import { sha256 } from "sha.js";
const hash = sha256()
.update("hello")
.digest("hex");
console.log(hash); // 输出 2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824如上示例所示，我们使用 sha256() 方法创建一个新的 SHA-256 哈希对象，然后使用 .update(data) 方法更新输入数据，并使用 .digest(encoding?) 方法获取哈希值。其中，encoding 参数用于指定哈希值的编码格式（如 hex、base64 等），默认为 "binary"。
@types/sha.js 包为 SHA.js 库添加了 TypeScript 类型定义，使得在编写 TypeScript 代码时更加方便。以下是上述示例代码的 TypeScript 版本：
import sha256 from "sha.js";
const hash: string = sha256()
.update("hello")
.digest("hex");
console.log(hash); // 输出 2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824如上示例所示，我们使用 import 导入了 sha256 方法（注意，这里使用了 default 导出），然后进行和 JavaScript 版本相同的计算操作。
指定编码格式
在使用 .digest() 方法时，我们可以通过参数指定哈希值的编码格式。以下是示例代码：
import sha256 from "sha.js";
const hash: string = sha256()
.update("hello")
.digest("base64");
console.log(hash); // 输出 LzJnul+wozJuzSs1uf4p4RsfFtwfRDI2RjKkWEpLZJQ=在上述示例中，我们指定了 digest 方法的参数为 "base64"，表示输出哈希值以 base64 编码形式的字符串。另外，我们还可以使用 "hex" 编码格式，以输出哈希值的十六进制表示形式。
自定义哈希算法
除了 SHA-1、SHA-256、SHA-512 等预定义的哈希算法，SHA.js 库还支持自定义哈希算法，以满足不同的需求。以下是自定义 SHA-3-256 哈希算法的示例代码：
-- -------------------- ---- -------
------ --- ---- ---------
----- ------------ -
------- ------ -------- - --- ----------
------- ----- -------- - --- ---------
------------- -
------------
-
------- ------ -
--- ---- - - -- - - --- ---- -
------------- - --
-
--- ---- - - -- - - -- ---- -
------------ - --
-
------------- - -----
------------- - -----
-
------ ------------ ------ - -------- ---- -
--- ------
-- ------- ---- --- --------- -
----- - ----------------- --------
- ---- -
----- - -----
-
----- ------ - ------------ - ---
--- ---- - - -- - - ------- ---- -
--------------------- - - ----
-
------ -----
-
------- --------------- ------- ------- ------- -
--- ---- - - -- - - --- ---- -
----------- - -- -- ------------------------ - - - ---
-
--- ---- - - -- - - --- ---- -
----- -- - -------------- ------------- - ------------ - ------------ - -------------
----- -- - -------------- ------------- - ------------ - ------------ - -------------
----- -- - -------------- ------------- - ------------ - ------------ - -------------
----- -- - -------------- ------------- - ------------ - ------------ - -------------
----- -- - -------------- ------------- - ------------ - ------------ - -------------
------------ - -------------- ----
------------ - -------------- ----
------------ - -------------- ----
------------ - -------------- ----
------------ - -------------- ----
----- - - -------------------- - ------ - -- - -- - --- ----
--- ---- - - -- - - -- ---- -
----------- - -- -- --------------------- - -- - --- - - - -- -- -- - -- - ----
-
-- -- --- --- -
------------ -- --
-
-
--- ---- - - -- - - -- ---- -
------------ - - - -- -- -------------
-
-
------- --------- ------- -- -------- ------ -
------ -- -- -- - -- --- --- - ----
-
------ ----------------- ----- - -------- - ---------- ------ - ------ -
------------ -- -----
------------ -- -----
------------ -- -----
------------ -- -----
--- ---- - - -- - - --- ---- -
----- -- - -------------- ------------- - ------------ - ------------ - -------------
----- -- - -------------- ------------- - ------------ - ------------ - -------------
----- -- - -------------- ------------- - ------------ - ------------ - -------------
----- -- - -------------- ------------- - ------------ - ------------ - -------------
----- -- - -------------- ------------- - ------------ - ------------ - -------------
------------ - -------------- ----
------------ - -------------- ----
------------ - -------------- ----
------------ - -------------- ----
------------ - -------------- ----
----- - - - - -- - -- - --
--- ---- - - -- - - -- ---- -
----- ---- - -------------- - -- - - - - - ------------- - -- - --- --- --- - -- - --- - -----
----------- - -- -- ---- -- -- - -- - ----
-
-
----- ------ - -----------------
--- ---- - - -- - - -- ---- -
--- - - --------------
--- ---- - - -- - - -- ---- -
------------------- - ----- - - - - ---
- ---- --
-
-
-- --------- --- ------ -
------ -----------------------
- ---- -- --------- --- --------- -
------ --------------------------
- ---- -
------ -------
-
-
-
----- ----- ------ - --- --------------
----------------
---------------
------------------ -- -- ----------------------------------------------------------------在上述示例中，我们定义了 SHA3_256Hash 类，继承自 SHA-256 哈希对象，通过自定义 update 和 digest 方法来实现 SHA-3-256 算法。具体地，我们在 init 方法中初始化哈希状态，然后在 update 方法中循环处理输入数据，最后在 digest 方法中输出哈希值。
总结
通过本文的介绍，我们了解了 @types/sha.js 包的基本使用方法，以及如何自定义哈希算法。在实际开发中，我们可以根据项目需求选择合适的哈希算法，并结合 @types/sha.js 和 TypeScript 等工具来实现数据加密和身份验证等功能。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedae6cb5cbfe1ea0610e3f