com.github.houbb.sensitive.word.support.map

类 SensitiveWordMap

java.lang.Object

com.github.houbb.sensitive.word.support.map.SensitiveWordMap

所有已实现的接口:

IWordMap, ISensitiveCheck

@ThreadSafe
public class SensitiveWordMap
extends Object
implements IWordMap

敏感词 map

从以下版本开始:

0.0.1

作者:

binbin.hou

构造器概要

构造器

构造器和说明
SensitiveWordMap()

方法概要

限定符和类型	方法和说明
boolean	contains(String string, IWordContext context) 是否包含 （1）直接遍历所有 （2）如果遇到，则直接返回 true
List<IWordResult>	findAll(String string, IWordContext context) 返回所有对应的敏感词 （1）结果是有序的 （2）为了保留所有的下标，结果从 v0.1.0 之后不再去重。
IWordResult	findFirst(String string, IWordContext context) 返回第一个对应的敏感词
void	initWordMap(Collection<String> collection) 读取敏感词库，将敏感词放入HashSet中，构建一个DFA算法模型：
String	replace(String target, ISensitiveWordReplace replace, IWordContext context) 替换所有敏感词内容 ps: 这里可以添加优化。
SensitiveCheckResult	sensitiveCheck(String txt, int beginIndex, ValidModeEnum validModeEnum, IWordContext context) 检查敏感词数量 （1）如果未命中敏感词，直接返回 0 （2）命中敏感词，则返回敏感词的长度。

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SensitiveWordMap

public SensitiveWordMap()

方法详细资料

initWordMap

public void initWordMap(Collection<String> collection)

读取敏感词库，将敏感词放入HashSet中，构建一个DFA算法模型：

指定者:

initWordMap 在接口中 IWordMap

参数:

collection - 敏感词库集合

从以下版本开始:

0.0.1

使用对象代码 map 的这种一直递归。 参考资料：https://www.cnblogs.com/AlanLee/p/5329555.html https://blog.csdn.net/chenssy/article/details/26961957

contains

public boolean contains(String string,
                        IWordContext context)

是否包含 （1）直接遍历所有 （2）如果遇到，则直接返回 true

指定者:

contains 在接口中 IWordMap

参数:

string - 字符串

context - 上下文

返回:

是否包含

从以下版本开始:

0.0.1

另请参阅:

建议使用快速返回模式

findAll

public List<IWordResult> findAll(String string,
                                 IWordContext context)

返回所有对应的敏感词 （1）结果是有序的 （2）为了保留所有的下标，结果从 v0.1.0 之后不再去重。

指定者:

findAll 在接口中 IWordMap

参数:

string - 原始字符串

context - 上下文

返回:

结果

从以下版本开始:

0.0.1

另请参阅:

建议使用全部检测返回模式

findFirst

public IWordResult findFirst(String string,
                             IWordContext context)

从接口复制的说明: IWordMap

返回第一个对应的敏感词

指定者:

findFirst 在接口中 IWordMap

参数:

string - 原始字符串

context - 上下文

返回:

结果

replace

public String replace(String target,
                      ISensitiveWordReplace replace,
                      IWordContext context)

从接口复制的说明: IWordMap

替换所有敏感词内容 ps: 这里可以添加优化。

指定者:

replace 在接口中 IWordMap

参数:

target - 目标字符串

replace - 替换策略

context - 上下文

返回:

替换后结果

sensitiveCheck

public SensitiveCheckResult sensitiveCheck(String txt,
                                           int beginIndex,
                                           ValidModeEnum validModeEnum,
                                           IWordContext context)

从接口复制的说明: ISensitiveCheck

检查敏感词数量

（1）如果未命中敏感词，直接返回 0 （2）命中敏感词，则返回敏感词的长度。

ps: 这里结果进行优化， 1. 是否包含敏感词。 2. 敏感词的长度 3. 正常走过字段的长度（便于后期替换优化，避免不必要的循环重复）

指定者:

sensitiveCheck 在接口中 ISensitiveCheck

参数:

txt - 文本信息

beginIndex - 开始下标

validModeEnum - 验证模式

context - 执行上下文

返回:

敏感信息对应的长度