npm 包 wh_censorify 使用教程

阅读时长 4 分钟读完

背景

在 Web 开发中,我们经常需要对敏感词进行过滤处理。这个过程可以通过编写自己的代码实现,但是这个过程可能比较繁琐,且不同的语言实现方式不同。

针对这个问题,一些开发者将自己的经验总结为一个 npm 包,供开发者快速使用。这里介绍一款 npm 包 wh_censorify 的使用方法。

简介

wh_censorify 是一款基于 JavaScript 的 npm 包,可以帮助开发者快速实现对字符串内的敏感词过滤。

这个包的优点在于:

  • 易用性高,只需要几行代码就可以实现功能;
  • 高度可定制化,可以通过参数调整是否开启大小写敏感,是否只输出匹配到的敏感词等参数;
  • 支持多种语言,可以支持多种语言的敏感词匹配。

安装

安装这款包非常简单,只需要在终端中运行以下命令:

安装后即可使用。

使用方法

导入 wh_censorify:

然后我们可以使用 censorify 函数来对字符串进行敏感词过滤。

这个例子演示了最基本的使用方法。我们可以看到 censorify 函数接收一个字符串参数,并返回处理后的字符串。在这个例子中,函数用 *** 替换了敏感词。

我们可以通过几个参数来自定义脱敏方式,例如:

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

除了 mask 参数,其余参数的默认值均为 true。我们可以根据实际需求调整这些参数。

敏感词库

wh_censorify 包含常用语言的通用敏感词库,但是如果您需要解决某些特殊场景下的敏感词过滤,或想使用自己的敏感词库,可以通过以下方法:

使用自己的敏感词库

您可以通过 options 参数中的 dict 参数来指定自己的敏感词库,其格式为一个字符串数组,例如:

这个例子中,我们使用了自己提供的敏感词库。如果您的敏感词库比较庞大,可以将其存储在文件中,然后通过 require 函数导入。

添加新的敏感词

如果您在使用 wh_censorify 时发现了未被包括的敏感词,可以将其添加到包含通用敏感词的敏感词库中。方法如下:

这个例子中,我们向 wh_censorify.dict.common 数组添加了新的敏感词。由于 wh_censorify.dict.common 是一个数组,我们可以直接使用 concat 方法将两个数组合并成一个。最后需要注意的是,如果您只需要在某些特定的地方增加新的敏感词,可以使用 .dict.common 和 .dict.xxx 等方式选取特定的敏感词库。

总结

通过本篇文章,我们学习了 wh_censorify 包的基本用法和定制方法,包括如何使用自己的敏感词库、如何添加新的敏感词以及如何自定义脱敏方式等。通过 wh_censorify 包,我们能够快速实现字符串的敏感词过滤,让我们的 Web 开发变得更加高效。

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

纠错
反馈