# 开源优化-SensitiveWords

**Repository Path**: starfree/SensitiveWords

## Basic Information

- **Project Name**: 开源优化-SensitiveWords
- **Description**: 基于开源词语识别项目的高性能识别工具（可用于敏感词识别，关键词识别等）
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2021-08-26
- **Last Updated**: 2021-08-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#SensitiveWords<br>
#基于开源敏感词识别项目的优化版敏感词识别工具<br>

##原项目地址：https://github.com/toolgood/ToolGood.Words  如果觉得不错请给原作者和我一个star,thanks！<br>
##此版本目前只移植了JAVA语言版本，原项目中有多种语言版本，后续完善之后会考虑上传到maven中央仓库。<br>

##在原版本的基础上优化了以下内容：<br>
>1、内置了敏感词库。<br>
>2、引入了Ehcache缓存，初始化之后每次识别都会从缓存加载词库，不需要每次进行词库文件的IO读取，提高了性能。<br>
>3、封装了一部分静态方法，使用更加方便。<br>

##使用方法：<br>
1、作为工具类使用<br>
（1）初始化，先调用一次初始化方法,提供了3种初始化方法。<br>
```
     SensitiveEhcacheManager.init(); //通过加载内置敏感词资源初始化
     SensitiveEhcacheManager.init(String sensitiveFilePath); //通过指定的文件路径加载敏感词并初始化
     SensitiveEhcacheManager.init(List<String> sensitiveWords); //通过传入敏感词集合初始化
``` 

（2）通过WordsSearch，调用敏感词查找方法。<br>
```
     List<WordsSearchResult> = WordsSearch.sensitiveWorsFilter(String text); //text为待识别的文本
```

2、在springboot中使用<br>
（1）可以在springboot项目启动时初始化敏感词库，创建一个启动类。<br>

```
@Component
//指定启动器启动优先级顺序为1
@Order(value = 1)
public class EhcacheInitRunner implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments var1) throws Exception{
        // 读取敏感词词库并加载到缓存
        SensitiveEhcacheManager.init();
    }
}
```
（2）在接口需要调用的地方代码如下。<br>
```
    List<WordsSearchResult> = WordsSearch.sensitiveWorsFilter(text); //text为待识别的文本
```
<br> 
##更多用法后续完善，to be continue...