# go-sensitive-word

敏感词（敏感词/违禁词/违法词/脏词）检测工具，基于 DFA 算法实现的高性能 Go 敏感词过滤工具框架。

## 快速接入

**安装**
```bash
go get -u github.com/zmexing/go-sensitive-word@latest
```

**使用**
```go
package main

import (
   "fmt"
   sensitive "github.com/zmexing/go-sensitive-word"
   "log"
)

func main() {
   filter, err := sensitive.NewFilter(
      sensitive.StoreOption{Type: sensitive.StoreMemory}, // 基于内存
      sensitive.FilterOption{Type: sensitive.FilterDfa},  // 基于DFA算法
   )

   if err != nil {
      log.Fatalf("敏感词服务启动失败, err:%v", err)
      return
   }

   // 加载敏感词库
   err = filter.LoadDictEmbed(
      sensitive.DictCovid19,
      sensitive.DictOther,
      sensitive.DictReactionary,
      sensitive.DictViolence,
      sensitive.DictPeopleLife,
      sensitive.DictPornography,
      sensitive.DictAdditional,
      sensitive.DictCorruption,
      sensitive.DictTemporaryTencent,
   )
   if err != nil {
      log.Fatalf("加载词库发生了错误, err:%v", err)
      return
   }

   // 动态添加自定义敏感词
   err = filter.Store.AddWord("李世民", "秦始皇")
   if err != nil {
      log.Fatalf("添加敏感词发生了错误, err:%v", err)
      return
   }

   // 动态自定义敏感词白名单
   err = filter.Store.DelWord("武汉海鲜市场", "武汉")
   if err != nil {
      log.Fatalf("删除敏感词发生了错误, err:%v", err)
      return
   }

   sensitiveText := "李世民和老祖秦始皇的是忘年交，他们两个相约一起去武汉海鲜市场玩耍"

   // 是否有敏感词
   res1 := filter.IsSensitive(sensitiveText)
   fmt.Printf("res1: %v \n", res1)

   // 找到一个敏感词
   res2 := filter.FindOne(sensitiveText)
   fmt.Printf("res2: %v \n", res2)

   // 找到所有敏感词
   res3 := filter.FindAll(sensitiveText)
   fmt.Printf("res3: %v \n", res3)

   // 找到所有敏感词及出现次数
   res4 := filter.FindAllCount(sensitiveText)
   fmt.Printf("res4: %v \n", res4)

   // 和谐敏感词
   res5 := filter.Replace(sensitiveText, '*')
   fmt.Printf("res5: %v \n", res5)

   // 过滤铭感词
   res6 := filter.Remove(sensitiveText)
   fmt.Printf("res6: %v \n", res6)
}


// 输出结果
// res1: true
// res2: 李世民
// res3: [李世民 秦始皇]
// res4: map[李世民:1 秦始皇:1]
// res5: ***和老祖***的是忘年交，他们两个相约一起去武汉海鲜市场玩耍
// res6: 和老祖的是忘年交，他们两个相约一起去武汉海鲜市场玩耍 
```

### 支持的功能API

| 方法名              | 说明             |
| ---------------- | -------------- |
| `IsSensitive()`  | 判断文本中是否存在敏感词   |
| `FindOne()`      | 查找文本中的第一个敏感词   |
| `FindAll()`      | 查找文本中所有敏感词（去重） |
| `FindAllCount()` | 查找所有敏感词及其出现次数  |
| `Replace()`      | 替换所有敏感词为指定字符   |
| `Remove()`       | 从文本中删除所有敏感词    |
| `AddWord()`      | 动态添加敏感词        |
| `DelWord()`      | 动态删除敏感词        |


## 更多特性

### 字符串检测

```go
// HasEmail 判断字符串中是否存在邮箱地址
func HasEmail(s string) bool

// MaskEmail 将字符串中存在的邮箱地址替换成 "*"
func MaskEmail(s string) string

// HasURL 判断字符串中是否存在网址
func HasURL(s string) bool

// MaskURL 将字符串中存在的网址替换成 "*"
func MaskURL(s string) string

// HasDigit 判断字符串中是否存在指定个数的数字（大于等于该数字）
func HasDigit(s string, count int) bool

// MaskDigit 将字符串中存在的数字替换成 "*"
func MaskDigit(s string) string

// HasWechatID 判断字符串中是否存在微信号
func HasWechatID(s string) bool

// MaskWechatID 将字符串中存在的微信号替换成 "*"
func MaskWechatID(s string) string
```

## 常见问题

- [Unicode相似字符攻击](./docs/unicode.md)
- [零宽字符攻击](docs/zero-width.md)

## 参考资料
- 基于Java DFA实现的敏感词过滤：https://github.com/houbb/sensitive-word
- unicode字词的神奇组合：https://www.zhihu.com/question/30873035
- unicode违规技巧：https://zhuanlan.zhihu.com/p/545309061
- unicode视觉欺骗：https://zhuanlan.zhihu.com/p/611904676
- unicode字符列表：https://symbl.cc/en/unicode-table
- 汉字结构描述字符：https://zh.wikipedia.org/wiki/%E8%A1%A8%E6%84%8F%E6%96%87%E5%AD%97%E6%8F%8F%E8%BF%B0%E5%AD%97%E7%AC%A6
- 敏感词库：https://github.com/konsheng/Sensitive-lexicon

## 声明

本项目包含了一些敏感词库，其设计目的是为了解决在互联网环境中可能出现的不适当内容，通过技术手段屏蔽这些敏感词，旨在构建一个更健康、更安全的网络空间。

请注意以下几点：

1. **项目目的**：
    - 本项目的初衷是为开发者提供一个工具，帮助他们在各类互联网产品中过滤和屏蔽不适当或敏感的内容，从而营造一个良好的网络生态环境。

2. **使用限制**：
    - 本项目中的敏感词库仅供技术研究和实现内容过滤功能之用。
    - 任何个人或组织不得将本项目中的敏感词库用于传播、分享或其他任何可能导致敏感信息扩散的行为。

3. **责任声明**：
    - 使用本项目所产生的任何直接或间接后果，均由使用者自行承担。本项目开发者不对因不当使用造成的任何损失或法律后果负责。

4. **使用规范**：
    - 请确保在使用本项目时遵守相关法律法规。
    - 禁止将本项目用于任何违法或不正当的用途。

通过下载和使用本项目，即表示您同意并接受上述声明的所有内容。希望本项目能够为您在构建净化网络空间的过程中提供帮助。我们鼓励所有开发者共同努力，营造一个健康、安全的网络环境。