@celebi/mint-filter
TypeScript icon, indicating that this package has built-in type declarations

3.0.1-beta.3 • Public • Published

forked from ZhelinCheng/mint-filter

请升级至3.0.0+,低版本存在一种无法判断的情况。

基于Aho–Corasick算法,更轻巧的JavaScript敏感词过滤库🚀。支持Node.js、浏览器等环境(JavaScript/TypeScript),支持敏感词替换成*号。

💪 支持平台

本插件支持Node及浏览器平台,因为使用了Set等新特性,在浏览器上需要Babel的支持!

🎇 说明

基于Aho–Corasick算法实现的敏感词过滤方案,Aho–Corasick算法是由Alfred V. Aho和Margaret J.Corasick 发明的字符串搜索算法,用于在输入的一串字符串中匹配有限组“字典”中的子串。它与普通字符串匹配的不同点在于同时与所有字典串进行匹配。算法均摊情况下具有近似于线性的时间复杂度,约为字符串的长度加所有匹配的数量。

实现详细说明(搜索算法未更新,请查看代码):

个人博客:《TypeScript:Aho–Corasick算法实现敏感词过滤》

掘金社区:《TypeScript:Aho–Corasick算法实现敏感词过滤》

性能

使用20000个随机敏感词实例化的平均时间:< 96ms

测试字符串包含随机生成的汉字、字母、数字。 以下测试均在20000个随机敏感词构建的树下进行测试,每组测试6次取平均值:

编号 字符串长度 不替换敏感词[replace:false] 替换敏感词
1 1000 < 1.35ms < 1.55ms
2 5000 < 3.60ms < 3.60ms
3 10000 < 8.10ms < 9.81ms
4 20000 < 15.03ms < 16.03ms
5 50000 < 20.83ms < 21.18ms
6 100000 < 29.02ms < 34.45ms

需要注意的是,实际生产环境运行速度会比上面测试数据更快。

📦 安装

npm i -S @celebi/mint-filter

yarn add @celebi/mint-filter

🎉 使用

CommonJS 引用

// Mint导出是 export default Mint
// 所以在使用require引用的时,Mint可能挂载在default下面
const Mint = require('@celebi/mint-filter').default
const mint = new Mint(['敏感词数组'])

// 异步方法,该方法返回的是一个Promise对象
mint.filter('word').then((res) => {})

// 同步方法
mint.filterSync('word')

TypeScript / ES Module引用

import Mint from '@celebi/mint-filter'
const mint = new Mint(['敏感词数组'])

// 异步方法,该方法返回的是一个Promise对象
mint.filter('word').then((res) => {})

// 同步方法
mint.filterSync('word')

方法

所有方法都提供同步/异步两种。英文字母会全部转换成大写比较。

filter(word, options)

  • word<[string]>:需要过滤的字符串。
  • options<[FilterOptions]>:是一个对象,支持的参数replace是否将敏感词替换成*、words是否提取敏感词,全部为布尔值。
  • returns: <[Promise]<[FilterValue]>>

该方法将返回过滤文本和被过滤的敏感词。

import Mint from '@celebi/mint-filter'
const mint = new Mint(['敏感词'])

mint.filter('这是一个敏感词字符串')
    .then(data => {
      console.log(data) // { text: '这是一个***字符串', words: [ '敏感词' ], pass: false }
    })

mint.filter('这是一个敏感词字符串', { replace: false })
    .then(data => {
      console.log(data) // { text: '这是一个敏感词字符串', words: [ '敏感词' ], pass: false }
    })

filterSync(word, replace)

  • word<[string]>:filter的同步方法。
  • options<[FilterOptions]>:是一个对象,支持的参数replace是否将敏感词替换成*、words是否提取敏感词,全部为布尔值。
  • returns: <[FilterValue]>

validator(word) 快速校验文本

  • word<[string]>:需要验证的字符串文本。
  • returns: <[boolean]>

判断文本是否通过敏感词验证,发现敏感词会立即返回false

📚开发

开发:

npm run dev

构建:

npm run build

Package Sidebar

Install

npm i @celebi/mint-filter

Weekly Downloads

48

Version

3.0.1-beta.3

License

MIT

Unpacked Size

42.5 kB

Total Files

24

Last publish

Collaborators

  • ayers.feng