使用步骤
引入 maven 依赖
引入最新的版本即可,见附录开源地址。
<dependency>
<groupid>com.github.houbb</groupid>
<artifactid>sensitive-word</artifactid>
<version>0.18.0</version>
</dependency>
核心方法使用实例
包含了主要的一些功能和方法,如下所示:
- 常规用法 查找替换;
- 指定替换字符串;
- 检测忽略大小写,特殊字符,重复字符,简繁体,中英文等;
- 自定义替换检测策略示例;
package com.example.demo;
import com.github.houbb.sensitive.word.api.iwordcontext;
import com.github.houbb.sensitive.word.api.iwordreplace;
import com.github.houbb.sensitive.word.api.iwordresult;
import com.github.houbb.sensitive.word.bs.sensitivewordbs;
import com.github.houbb.sensitive.word.core.sensitivewordhelper;
import com.github.houbb.sensitive.word.support.result.wordresulthandlers;
import com.github.houbb.sensitive.word.utils.innerwordcharutils;
import java.util.list;
public class sensitivewordtestdemo {
public static void main(string[] args) {
//testnormal();
//testdefinereplace();
//testsensitivewordresulthandler();
//testotherfeatures();
testmorefeatures();
}
// 常规使用案例:替换敏感词
public static void testnormal() {
final string text = "五星红旗迎风飘扬,毛主席的画像屹立在天安门前。";
system.out.println("是否包含铭感词:" + sensitivewordhelper.contains(text));
system.out.println("查找第一个铭感词:" + sensitivewordhelper.findfirst(text));
system.out.println("查找所有铭感词:" + sensitivewordhelper.findall(text));
system.out.println("替换所有铭感词:" + sensitivewordhelper.replace(text));
system.out.println("替换所有铭感词(指定替换符号):" + sensitivewordhelper.replace(text, '⭐'));
}
/**
* 此案例讲解:iwordresulthandler 可以对敏感词的结果进行处理,允许用户自定义。
*/
public static void testsensitivewordresulthandler() {
final string text = "五星红旗迎风飘扬,毛主席的画像屹立在天安门前。";
list<string> wordlist = sensitivewordhelper.findall(text);
//assert.assertequals("[五星红旗, 毛主席, 天安门]", wordlist.tostring());
system.out.println("1.查找到所有铭感词:" + wordlist);
list<string> wordlist2 = sensitivewordhelper.findall(text, wordresulthandlers.word());
//assert.assertequals("[五星红旗, 毛主席, 天安门]", wordlist2.tostring());
system.out.println("2.默认内置处理(同直接查找到所有敏感词):" + wordlist2);
list<iwordresult> wordlist3 = sensitivewordhelper.findall(text, wordresulthandlers.raw());
//assert.assertequals("[wordresult{startindex=0, endindex=4}, wordresult{startindex=9, endindex=12}, wordresult{startindex=18, endindex=21}]", wordlist3.tostring());
system.out.println("3.查找敏感词单词本身的起始位置到终止位置:" + wordlist3);
}
// 实例:常规忽略检测特性
public static void testotherfeatures() {
system.out.println("\n其他属性\n");
string text = "fuck the bad words.";
string word = sensitivewordhelper.findfirst(text);
//assert.assertequals("fuck", word);
system.out.println("忽略大小写:" + word);
system.out.println("替换大小写字符:" + sensitivewordhelper.replace(text));
text = "fuck the bad words.";
word = sensitivewordhelper.findfirst(text);
//assert.assertequals("fuck", word);
system.out.println("忽略半圆角:" + word);
system.out.println("替换半圆角字符:" + sensitivewordhelper.replace(text));
text = "这个是我的微信:9⓿二肆⁹₈③⑸⒋➃㈤㊄";
list<string> wordlist = sensitivewordbs.newinstance().enablenumcheck(true).init().findall(text);
//assert.assertequals("[9⓿二肆⁹₈③⑸⒋➃㈤㊄]", wordlist.tostring());
system.out.println("忽略数字的写法:" + wordlist.tostring());
system.out.println("替换数字字符:" + sensitivewordbs.newinstance().enablenumcheck(true).init().replace(text));
text = "我爱我的祖国和五星紅旗。";
list<string> wordlist1 = sensitivewordhelper.findall(text);
//assert.assertequals("[五星紅旗]", wordlist1.tostring());
system.out.println("检测敏感词简繁体格式是否存在:" + wordlist1.tostring());
text = "ⓕⓤc⒦ the bad words";
list<string> wordlist2 = sensitivewordhelper.findall(text);
//assert.assertequals("[ⓕⓤc⒦]", wordlist2.tostring());
system.out.println("检测敏感词是否存在英文的书写格式:" + wordlist2.tostring());
text = "ⓕⓕⓕfⓤuⓤ⒰cⓒ⒦ the bad words";
list<string> wordlist3 = sensitivewordbs.newinstance()
.ignorerepeat(true)
.init()
.findall(text);
//assert.assertequals("[ⓕⓕⓕfⓤuⓤ⒰cⓒ⒦]", wordlist3.tostring());
system.out.println("检测重复词每个字符是否重复:" + wordlist3.tostring());
}
// 实例:更多检测特性
public static void testmorefeatures() {
// 1.邮箱检测(邮箱等个人信息,默认未启用。)
string text = "楼主好人,邮箱 sensitiveword@xx.com";
list<string> wordlist = sensitivewordbs.newinstance().enableemailcheck(true).init().findall(text);
//assert.assertequals("[sensitiveword@xx.com]", wordlist.tostring());
system.out.println("是否存在邮箱:" + wordlist.tostring());
// 2.连续数字检测(一般用于过滤手机号/qq等广告信息,默认未启用。)
text = "你懂得:12345678";
// 默认检测 8 位
list<string> wordlist1 = sensitivewordbs.newinstance()
.enablenumcheck(true)
.init().findall(text);
//assert.assertequals("[12345678]", wordlist.tostring());
system.out.println("是否存在连续数字字符串:" + wordlist1);
// 指定数字的长度,避免误杀
list<string> wordlist2 = sensitivewordbs.newinstance()
.enablenumcheck(true)
.numchecklen(9)
.init().findall(text);
//assert.assertequals("[]", wordlist2.tostring());
system.out.println("是否存在连续数字字符串2:" + wordlist2.tostring());
// 3.网址检测(用于过滤常见的网址信息,默认未启用, v0.18.0 优化 url 检测,更加严格,降低误判率)
text = "点击链接 https://www.baidu.com 查看答案";
sensitivewordbs sensitivewordbs = sensitivewordbs.newinstance().enableurlcheck(true).init();
list<string> wordlist3 = sensitivewordbs.findall(text);
//assert.assertequals("[https://www.baidu.com]", wordlist3.tostring());
//assert.assertequals("点击链接 ********************* 查看答案", sensitivewordbs.replace(text));
system.out.println("是否存在网址信息:" + wordlist3.tostring());
system.out.println("是否存在网址信息2并替换:" + sensitivewordbs.replace(text));
// 4.ipv4 检测: 避免用户通过 ip 绕过网址检测等,默认未启用。
text = "个人网站,如果网址打不开可以访问 127.0.0.1。";
sensitivewordbs sensitivewordbs2 = sensitivewordbs.newinstance().enableipv4check(true).init();
list<string> wordlist4 = sensitivewordbs2.findall(text);
//assert.assertequals("[127.0.0.1]", wordlist4.tostring());
system.out.println("是否存在 ipv4:" + wordlist4.tostring());
}
// 实例:自定义检测替换策略
public static void testdefinereplace() {
system.out.println("自定义敏感词替换策略:(策略:指定敏感词替换)");
final string text = "五星红旗迎风飘扬,毛主席的画像屹立在天安门前。";
mysensitivewordreplace replace = new mysensitivewordreplace();
string result = sensitivewordhelper.replace(text, replace);
system.out.println("自定义替换策略结果:" + result);
}
}
class mysensitivewordreplace implements iwordreplace {
@override
public void replace(stringbuilder stringbuilder, char[] chars, iwordresult wordresult, iwordcontext iwordcontext) {
string sensitiveword = innerwordcharutils.getstring(chars, wordresult);
// 自定义不同的敏感词替换策略,可以从数据库等地方读取
if ("五星红旗".equals(sensitiveword)) {
stringbuilder.append("国家旗帜");
} else if ("毛主席".equals(sensitiveword)) {
stringbuilder.append("教员");
} else {
// 其他默认使用 * 代替
int wordlength = wordresult.endindex() - wordresult.startindex();
for (int i = 0; i < wordlength; i++) {
stringbuilder.append('*');
}
}
}
}
输出结果展示:
是否包含铭感词:true
查找第一个铭感词:五星红旗
查找所有铭感词:[五星红旗, 毛主席, 天安门]
替换所有铭感词:****迎风飘扬,***的画像屹立在***前。
替换所有铭感词(指定替换符号):⭐⭐⭐⭐迎风飘扬,⭐⭐⭐的画像屹立在⭐⭐⭐前。
自定义敏感词替换策略:(策略:指定敏感词替换)
自定义替换策略结果:国家旗帜迎风飘扬,教员的画像屹立在***前。
1.查找到所有铭感词:[五星红旗, 毛主席, 天安门]
2.默认内置处理(同直接查找到所有敏感词):[五星红旗, 毛主席, 天安门]
3.查找敏感词单词本身的起始位置到终止位置:[wordresult{startindex=0, endindex=4, type='word'}, wordresult{startindex=9, endindex=12, type='word'}, wordresult{startindex=18, endindex=21, type='word'}]其他属性
忽略大小写:fuck
替换大小写字符:**** the bad words.
忽略半圆角:fuck
替换半圆角字符:**** the bad words.
忽略数字的写法:[9⓿二肆⁹₈③⑸⒋➃㈤㊄]
替换数字字符:这个是我的微信:************
检测敏感词简繁体格式是否存在:[五星紅旗]
检测敏感词是否存在英文的书写格式:[ⓕⓤc⒦]
检测重复词每个字符是否重复:[ⓕⓕⓕfⓤuⓤ⒰cⓒ⒦]
是否存在邮箱:[sensitiveword@xx.com]
是否存在连续数字字符串:[12345678]
是否存在连续数字字符串2:[]
是否存在网址信息:[https://www.baidu.com]
是否存在网址信息2并替换:点击链接 ********************* 查看答案
是否存在 ipv4:[127.0.0.1]
核心方法:查找 / 替换

更多的检测策略(自定义)
邮箱-网址-ipv4-连续字符检测
// 实例:更多检测特性
public static void testmorefeatures() {
// 1.邮箱检测(邮箱等个人信息,默认未启用。)
string text = "楼主好人,邮箱 sensitiveword@xx.com";
list<string> wordlist = sensitivewordbs.newinstance().enableemailcheck(true).init().findall(text);
//assert.assertequals("[sensitiveword@xx.com]", wordlist.tostring());
system.out.println("是否存在邮箱:" + wordlist.tostring());
// 2.连续数字检测(一般用于过滤手机号/qq等广告信息,默认未启用。)
text = "你懂得:12345678";
// 默认检测 8 位
list<string> wordlist1 = sensitivewordbs.newinstance()
.enablenumcheck(true)
.init().findall(text);
//assert.assertequals("[12345678]", wordlist.tostring());
system.out.println("是否存在连续数字字符串:" + wordlist1);
// 指定数字的长度,避免误杀
list<string> wordlist2 = sensitivewordbs.newinstance()
.enablenumcheck(true)
.numchecklen(9)
.init().findall(text);
//assert.assertequals("[]", wordlist2.tostring());
system.out.println("是否存在连续数字字符串2:" + wordlist2.tostring());
// 3.网址检测(用于过滤常见的网址信息,默认未启用, v0.18.0 优化 url 检测,更加严格,降低误判率)
text = "点击链接 https://www.baidu.com 查看答案";
sensitivewordbs sensitivewordbs = sensitivewordbs.newinstance().enableurlcheck(true).init();
list<string> wordlist3 = sensitivewordbs.findall(text);
//assert.assertequals("[https://www.baidu.com]", wordlist3.tostring());
//assert.assertequals("点击链接 ********************* 查看答案", sensitivewordbs.replace(text));
system.out.println("是否存在网址信息:" + wordlist3.tostring());
system.out.println("是否存在网址信息2并替换:" + sensitivewordbs.replace(text));
// 4.ipv4 检测: 避免用户通过 ip 绕过网址检测等,默认未启用。
text = "个人网站,如果网址打不开可以访问 127.0.0.1。";
sensitivewordbs sensitivewordbs2 = sensitivewordbs.newinstance().enableipv4check(true).init();
list<string> wordlist4 = sensitivewordbs2.findall(text);
//assert.assertequals("[127.0.0.1]", wordlist4.tostring());
system.out.println("是否存在 ipv4:" + wordlist4.tostring());
}
常规检测:大小写-特殊字符-重复字符-简繁体等
// 实例:常规忽略检测特性
public static void testotherfeatures() {
system.out.println("\n其他属性\n");
string text = "fuck the bad words.";
string word = sensitivewordhelper.findfirst(text);
//assert.assertequals("fuck", word);
system.out.println("忽略大小写:" + word);
system.out.println("替换大小写字符:" + sensitivewordhelper.replace(text));
text = "fuck the bad words.";
word = sensitivewordhelper.findfirst(text);
//assert.assertequals("fuck", word);
system.out.println("忽略半圆角:" + word);
system.out.println("替换半圆角字符:" + sensitivewordhelper.replace(text));
text = "这个是我的微信:9⓿二肆⁹₈③⑸⒋➃㈤㊄";
list<string> wordlist = sensitivewordbs.newinstance().enablenumcheck(true).init().findall(text);
//assert.assertequals("[9⓿二肆⁹₈③⑸⒋➃㈤㊄]", wordlist.tostring());
system.out.println("忽略数字的写法:" + wordlist.tostring());
system.out.println("替换数字字符:" + sensitivewordbs.newinstance().enablenumcheck(true).init().replace(text));
text = "我爱我的祖国和五星紅旗。";
list<string> wordlist1 = sensitivewordhelper.findall(text);
//assert.assertequals("[五星紅旗]", wordlist1.tostring());
system.out.println("检测敏感词简繁体格式是否存在:" + wordlist1.tostring());
text = "ⓕⓤc⒦ the bad words";
list<string> wordlist2 = sensitivewordhelper.findall(text);
//assert.assertequals("[ⓕⓤc⒦]", wordlist2.tostring());
system.out.println("检测敏感词是否存在英文的书写格式:" + wordlist2.tostring());
text = "ⓕⓕⓕfⓤuⓤ⒰cⓒ⒦ the bad words";
list<string> wordlist3 = sensitivewordbs.newinstance()
.ignorerepeat(true)
.init()
.findall(text);
//assert.assertequals("[ⓕⓕⓕfⓤuⓤ⒰cⓒ⒦]", wordlist3.tostring());
system.out.println("检测重复词每个字符是否重复:" + wordlist3.tostring());
}
自定义检测替换策略
自定义检测替换
class mysensitivewordreplace implements iwordreplace {
@override
public void replace(stringbuilder stringbuilder, char[] chars, iwordresult wordresult, iwordcontext iwordcontext) {
string sensitiveword = innerwordcharutils.getstring(chars, wordresult);
// 自定义不同的敏感词替换策略,可以从数据库等地方读取
if ("五星红旗".equals(sensitiveword)) {
stringbuilder.append("国家旗帜");
} else if ("毛主席".equals(sensitiveword)) {
stringbuilder.append("教员");
} else {
// 其他默认使用 * 代替
int wordlength = wordresult.endindex() - wordresult.startindex();
for (int i = 0; i < wordlength; i++) {
stringbuilder.append('*');
}
}
}
}
使用实例:
// 实例:自定义检测替换策略
public static void testdefinereplace() {
system.out.println("自定义敏感词替换策略:(策略:指定敏感词替换)");
final string text = "五星红旗迎风飘扬,毛主席的画像屹立在天安门前。";
mysensitivewordreplace replace = new mysensitivewordreplace();
string result = sensitivewordhelper.replace(text, replace);
system.out.println("自定义替换策略结果:" + result);
}
开源地址
到此这篇关于java 敏感词检测工具的实现的文章就介绍到这了,更多相关java 敏感词检测工具内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!
发表评论