携手创作，共同成长！这是我参与「掘金日新计划 · 8 月更文挑战」的第9天，点击查看活动详情
过滤敏感词
1. 创建一个储存要过滤的敏感词的文本文件
- 首先创建一个文本文件储存要过滤的敏感词
在下面的工具类中我们会读取这个文本文件，这里提前给出
@PostConstruct // 这个注解表示当容器实例化这个bean（服务启动的时候）之后在调用构造器之后这个方法会自动的调用
public void init(){
try(
// 读取写有“敏感词”的文件，getClass表示从程序编译之后的target/classes读配置文件，读之后是字节流
// java7语法，在这里的句子最后会自动执行close语句
InputStream is = this.getClass().getClassLoader().getResourceAsStream("sensitive-words.txt");
// 字节流 -> 字符流 -> 缓冲流
BufferedReader reader = new BufferedReader(new InputStreamReader(is));
) {
String keyword;
// 从文件中一行一行读
while ((keyword = reader.readLine()) != null){
// 添加到前缀树
this.addKeyword(keyword);
}
} catch (IOException e) {
logger.error("加载敏感词文件失败: " + e.getMessage());
}
}
复制代码2. 开发过滤敏感词的工具类
- 开发过滤敏感词组件
为了方便以后复用，我们把过滤敏感词写成一个工具类SensitiveFilter。
@Component
public class SensitiveFilter {
private static final Logger logger = LoggerFactory.getLogger(SensitiveFilter.class);
// 当检测到敏感词后我们要把敏感词替换成什么符号
private static final String REPLACEMENT = "***";
// 根节点
private TrieNode rootNode = new TrieNode();
@PostConstruct // 这个注解表示当容器实例化这个bean（服务启动的时候）之后在调用构造器之后这个方法会自动的调用
public void init(){
try(
// 读取写有“敏感词”的文件，getClass表示从程序编译之后的target/classes读配置文件，读之后是字节流
// java7语法，在这里的句子最后会自动执行close语句
InputStream is = this.getClass().getClassLoader().getResourceAsStream("sensitive-words.txt");
// 字节流 -> 字符流 -> 缓冲流
BufferedReader reader = new BufferedReader(new InputStreamReader(is));
) {
String keyword;
// 从文件中一行一行读
while ((keyword = reader.readLine()) != null){
// 添加到前缀树
this.addKeyword(keyword);
}
} catch (IOException e) {
logger.error("加载敏感词文件失败: " + e.getMessage());
}
}
// 将一个敏感词添加到前缀树中
private void addKeyword(String keyword){
// 首先默认指向根
TrieNode tempNode = rootNode;
for (int i = 0; i < keyword.length(); i++) {
char c = keyword.charAt(i);
TrieNode subNode = tempNode.getSubNode(c);
if(subNode == null){
// subNode为空，初始化子节点；subNode不为空，直接用就可以了
subNode = new TrieNode();
tempNode.addSubNode(c, subNode);
}
// 指针指向子节点，进入下一轮循环
tempNode = subNode;
}
// 最后要设置结束标识
tempNode.setKeywordEnd(true);
}
/**
* 过滤敏感词
* @param text 待过滤的文本
* @return 过滤后的文本
*/
public String filter(String text){
if(StringUtils.isBlank(text)){
// 待过滤的文本为空，直接返回null
return null;
}
// 指针1，指向树
TrieNode tempNode = rootNode;
// 指针2，指向正在检测的字符串段的首
int begin = 0;
// 指针3，指向正在检测的字符串段的尾
int position = 0;
// 储存过滤后的文本
StringBuilder sb = new StringBuilder();
while (begin < text.length()){
char c = text.charAt(position);
// 跳过符号，比如 “开票”是敏感词 #开#票# 这个字符串中间的 '#' 应该跳过
if(isSymbol(c)){
// 是特殊字符
// 若指针1处于根节点，将此符号计入结果，指针2、3向右走一步
if(tempNode == rootNode){
sb.append(c);
begin++;
}
// 无论符号在开头或中间，指针3都向下走一步
position++;
// 符号处理完，进入下一轮循环
continue;
}
// 执行到这里说明字符不是特殊符号
// 检查下级节点
tempNode = tempNode.getSubNode(c);
if(tempNode == null){
// 以begin开头的字符串不是敏感词
sb.append(text.charAt(begin));
// 进入下一个位置
position = ++begin;
// 重新指向根节点
tempNode = rootNode;
} else if(tempNode.isKeywordEnd()){
// 发现敏感词，将begin~position字符串替换掉，存 REPLACEMENT （里面是***）
sb.append(REPLACEMENT);
// 进入下一个位置
begin = ++position;
// 重新指向根节点
tempNode = rootNode;
} else {
// 检查下一个字符
position++;
}
}
return sb.toString();
}
// 判断是否为特殊符号，是则返回true，不是则返回false
private boolean isSymbol(Character c){
// CharUtils.isAsciiAlphanumeric(c)方法：a、b、1、2···返回true，特殊字符返回false
// 0x2E80 ~ 0x9FFF 是东亚的文字范围，东亚文字范围我们不认为是符号
return !CharUtils.isAsciiAlphanumeric(c) && (c < 0x2E80 || c > 0x9FFF);
}
// 前缀树
private class TrieNode{
// 关键词结束标识
private boolean isKeywordEnd = false;
// 当前节点的子节点(key是下级字符、value是下级节点)
private Map<Character, TrieNode> subNodes = new HashMap<>();
public boolean isKeywordEnd() {
return isKeywordEnd;
}
public void setKeywordEnd(boolean keywordEnd) {
isKeywordEnd = keywordEnd;
}
// 添加子节点
public void addSubNode(Character c, TrieNode node){
subNodes.put(c, node);
}
// 获取子节点
public TrieNode getSubNode(Character c){
return subNodes.get(c);
}
}
}
复制代码上面就是过滤敏感词工具类的全部代码，接下来我们来解释一下开发步骤
开发过滤敏感词组件分为三步：
- 定义前缀树（Tree）
我们将定义前缀树写为SensitiveFilter工具类的内部类
// 前缀树
private class TrieNode{
// 关键词结束标识
private boolean isKeywordEnd = false;
// 当前节点的子节点(key是下级字符、value是下级节点)
private Map<Character, TrieNode> subNodes = new HashMap<>();
public boolean isKeywordEnd() {
return isKeywordEnd;
}
public void setKeywordEnd(boolean keywordEnd) {
isKeywordEnd = keywordEnd;
}
// 添加子节点
public void addSubNode(Character c, TrieNode node){
subNodes.put(c, node);
}
// 获取子节点
public TrieNode getSubNode(Character c){
return subNodes.get(c);
}
}
复制代码- 根据敏感词，初始化前缀树
将敏感词添加到前缀树中
// 将一个敏感词添加到前缀树中
private void addKeyword(String keyword){
// 首先默认指向根
TrieNode tempNode = rootNode;
for (int i = 0; i < keyword.length(); i++) {
char c = keyword.charAt(i);
TrieNode subNode = tempNode.getSubNode(c);
if(subNode == null){
// subNode为空，初始化子节点；subNode不为空，直接用就可以了
subNode = new TrieNode();
tempNode.addSubNode(c, subNode);
}
// 指针指向子节点，进入下一轮循环
tempNode = subNode;
}
// 最后要设置结束标识
tempNode.setKeywordEnd(true);
}
复制代码- 编写过滤敏感词的方法
如何过滤文本中的敏感词：
特殊符号怎么处理：
敏感词前缀树初始化完毕之后，过滤文本中的敏感词的算法应该如下：
定义三个指针：
- 指针1指向Tree树
- 指针2指向待过滤字符串段的头
- 指针3指向待过滤字符串段的尾
/**
* 过滤敏感词
* @param text 待过滤的文本
* @return 过滤后的文本
*/
public String filter(String text){
if(StringUtils.isBlank(text)){
// 待过滤的文本为空，直接返回null
return null;
}
// 指针1，指向树
TrieNode tempNode = rootNode;
// 指针2，指向正在检测的字符串段的首
int begin = 0;
// 指针3，指向正在检测的字符串段的尾
int position = 0;
// 储存过滤后的文本
StringBuilder sb = new StringBuilder();
while (begin < text.length()){
char c = text.charAt(position);
// 跳过符号，比如 “开票”是敏感词 #开#票# 这个字符串中间的 '#' 应该跳过
if(isSymbol(c)){
// 是特殊字符
// 若指针1处于根节点，将此符号计入结果，指针2、3向右走一步
if(tempNode == rootNode){
sb.append(c);
begin++;
}
// 无论符号在开头或中间，指针3都向下走一步
position++;
// 符号处理完，进入下一轮循环
continue;
}
// 执行到这里说明字符不是特殊符号
// 检查下级节点
tempNode = tempNode.getSubNode(c);
if(tempNode == null){
// 以begin开头的字符串不是敏感词
sb.append(text.charAt(begin));
// 进入下一个位置
position = ++begin;
// 重新指向根节点
tempNode = rootNode;
} else if(tempNode.isKeywordEnd()){
// 发现敏感词，将begin~position字符串替换掉，存 REPLACEMENT （里面是***）
sb.append(REPLACEMENT);
// 进入下一个位置
begin = ++position;
// 重新指向根节点
tempNode = rootNode;
} else {
// 检查下一个字符
position++;
}
}
return sb.toString();
}
// 判断是否为特殊符号，是则返回true，不是则返回false
private boolean isSymbol(Character c){
// CharUtils.isAsciiAlphanumeric(c)方法：a、b、1、2···返回true，特殊字符返回false
// 0x2E80 ~ 0x9FFF 是东亚的文字范围，东亚文字范围我们不认为是符号
return !CharUtils.isAsciiAlphanumeric(c) && (c < 0x2E80 || c > 0x9FFF);
}
复制代码最后：建议在测试类中测试一下
经测试，过滤敏感词的工具类开发完成，这个工具会在接下来的发布帖子的功能中用到。