SpringBoot使用SensitiveWord實現(xiàn)敏感詞過濾
包含默認敏感詞過濾和自定義敏感詞過濾。
導入依賴
<dependency> <groupId>com.github.houbb</groupId> <artifactId>sensitive-word</artifactId> <version>0.2.0</version> </dependency>
方法
| 方法 | 參數(shù) | 返回值 | 說明 |
|---|---|---|---|
| contains(String) | 待驗證的字符串 | 布爾值 | 驗證字符串是否包含敏感詞 |
| replace(String, ISensitiveWordReplace) | 使用指定的替換策略替換敏感詞 | 字符串 | 返回脫敏后的字符串 |
| replace(String, char) | 使用指定的 char 替換敏感詞 | 字符串 | 返回脫敏后的字符串 |
| replace(String) | 使用 * 替換敏感詞 | 字符串 | 返回脫敏后的字符串 |
| findAll(String) | 待驗證的字符串 | 字符串列表 | 返回字符串中所有敏感詞 |
| findFirst(String) | 待驗證的字符串 | 字符串 | 返回字符串中第一個敏感詞 |
| findAll(String, IWordResultHandler) | IWordResultHandler 結果處理類 | 字符串列表 | 返回字符串中所有敏感詞 |
| findFirst(String, IWordResultHandler) | IWordResultHandler 結果處理類 | 字符串 | 返回字符串中第一個敏感詞 |
ISensitiveWordReplace：敏感詞替換策略。
IWordResultHandler：結果處理?？梢詫γ舾性~的結果進行處理，允許用戶自定義。內(nèi)置了WordResultHandlers 工具類。
- WordResultHandlers.word()：只保留敏感詞單詞本身。
- WordResultHandlers.raw()：保留敏感詞相關信息，包含敏感詞以及敏感詞對應的開始和結束下標。
默認示例
使用默認提供的方法。
@Test
void testWord() {
String text = "紅旗迎風飄揚，主席的畫像屹立在天安門前。";
System.out.println(SensitiveWordHelper.contains(text));
System.out.println(SensitiveWordHelper.replace(text));
System.out.println(SensitiveWordHelper.replace(text, '0'));
System.out.println(SensitiveWordHelper.findFirst(text));
System.out.println(SensitiveWordHelper.findFirst(text, WordResultHandlers.word()));
System.out.println(SensitiveWordHelper.findFirst(text, WordResultHandlers.raw()));
System.out.println(SensitiveWordHelper.findAll(text));
System.out.println(SensitiveWordHelper.findAll(text, WordResultHandlers.word()));
System.out.println(SensitiveWordHelper.findAll(text, WordResultHandlers.raw()));
}
輸出：
Init sensitive word map end! Cost time: 163ms
true
****迎風飄揚，***的畫像屹立在***前。
0000迎風飄揚，000的畫像屹立在000前。
紅旗
紅旗
WordResult{word='紅旗', startIndex=0, endIndex=4}
[紅旗, 主席, 天安門]
[紅旗, 主席, 天安門]
[WordResult{word='紅旗', startIndex=0, endIndex=4}, WordResult{word='主席', startIndex=9, endIndex=12}, WordResult{word='天安門', startIndex=18, endIndex=21}]
自定義替換策略示例
采用自定義的替換策略實現(xiàn)。首先需要實現(xiàn) ISensitiveWordReplace接口自定義替換策略：
package com.tothefor;
import com.github.houbb.heaven.util.lang.CharUtil;
import com.github.houbb.sensitive.word.api.ISensitiveWordReplace;
import com.github.houbb.sensitive.word.api.ISensitiveWordReplaceContext;
public class MySensitiveWordReplace implements ISensitiveWordReplace {
@Override
public String replace(ISensitiveWordReplaceContext context) {
String sensitiveWord = context.sensitiveWord();
// 自定義不同的敏感詞替換策略，可以從數(shù)據(jù)庫等地方讀取
if ("紅旗".equals(sensitiveWord)) {
return "旗幟";
}
if ("天安門".equals(sensitiveWord)) {
return "門";
}
if ("主席".equals(sensitiveWord)) {
return "教員";
}
// 其他默認使用 * 代替
int wordLength = context.wordLength();
return CharUtil.repeat('*', wordLength);
}
}
使用：
@Test
void testWord() {
String text = "紅旗迎風飄揚，主席的畫像屹立在天安門前。";
System.out.println(SensitiveWordHelper.contains(text));
System.out.println(SensitiveWordHelper.replace(text, new MySensitiveWordReplace()));
String text1 = "最好的記憶不如最淡的墨水。";
System.out.println(SensitiveWordHelper.contains(text1));
System.out.println(SensitiveWordHelper.replace(text1, new MySensitiveWordReplace()));
}
輸出：
Init sensitive word map end! Cost time: 16ms
true
旗幟迎風飄揚，教員的畫像屹立在門前。
false
最好的記憶不如最淡的墨水。
自定義
點進 SensitiveWordHelper 源碼，可以看見以下代碼：
private static final SensitiveWordBs WORD_BS = SensitiveWordBs.newInstance().init();
而且可以發(fā)現(xiàn)，方法也都是調用的 SensitiveWordBs 類的方法。所以，可以理解成 SensitiveWordHelper 只是對 SensitiveWordBs 的一層封裝，而之所以封裝就是為了提供給開發(fā)者針對簡單場景的快速的使用。
而且從上面的創(chuàng)建語句中可以看見，沒有加任何其他的東西，就只是初始化了一個，這也是最簡單的。接下來就是自定義 SensitiveWordBs 實現(xiàn)敏感詞過濾。
自定義SensitiveWordBs
下來看有哪些參數(shù)可以加，各項配置的說明如下：
| 序號 | 方法 | 說明 |
|---|---|---|
| 1 | ignoreCase | 忽略大小寫 |
| 2 | ignoreWidth | 忽略半角圓角 |
| 3 | ignoreNumStyle | 忽略數(shù)字的寫法 |
| 4 | ignoreChineseStyle | 忽略中文的書寫格式 |
| 5 | ignoreEnglishStyle | 忽略英文的書寫格式 |
| 6 | ignoreRepeat | 忽略重復詞 |
| 7 | enableNumCheck | 是否啟用數(shù)字檢測。默認連續(xù) 8 位數(shù)字認為是敏感詞 |
| 8 | enableEmailCheck | 是有啟用郵箱檢測 |
| 9 | enableUrlCheck | 是否啟用鏈接檢測 |
然后創(chuàng)建自定義的 SensitiveWordBs，如下：
package com.tothefor.motorcode.core.SensitiveWord;
import com.github.houbb.sensitive.word.bs.SensitiveWordBs;
import com.github.houbb.sensitive.word.support.allow.WordAllows;
import com.github.houbb.sensitive.word.support.deny.WordDenys;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SensitiveWordConfig {
@Autowired
private CustomWordAllow customWordAllow;
@Autowired
private CustomWordDeny customWordDeny;
/**
* 初始化引導類
*
* @return 初始化引導類
* @since 1.0.0
*/
@Bean
public SensitiveWordBs sensitiveWordBs() {
// 可根據(jù)數(shù)據(jù)庫數(shù)據(jù)判斷 動態(tài)增加配置
return SensitiveWordBs.newInstance()
.wordDeny(WordDenys.chains(WordDenys.system(),customWordDeny)) // 設置黑名單
.wordAllow(WordAllows.chains(WordAllows.system(), customWordAllow)) // 設置白名單
.ignoreCase(true)
.ignoreWidth(true)
.ignoreNumStyle(true)
.ignoreChineseStyle(true)
.ignoreEnglishStyle(true)
.ignoreRepeat(true)
.enableEmailCheck(true)
.enableUrlCheck(true)
// 各種其他配置
.init();
}
}
其中，wordDeny、wordAllow是自定義敏感詞的黑名單和白名單?？梢栽O置單個，也可以設置多個。如下：
// 設置系統(tǒng)默認敏感詞
SensitiveWordBs wordBs = SensitiveWordBs.newInstance()
.wordDeny(WordDenys.system()) // 黑名單
.wordAllow(WordAllows.system()) // 白名單
.init();
// 設置自定義敏感詞
SensitiveWordBs wordBs = SensitiveWordBs.newInstance()
.wordDeny(new MyWordDeny())
.wordAllow(new MyWordAllow())
.init();
// 設置多個敏感詞，系統(tǒng)默認和自定義
IWordDeny wordDeny = WordDenys.chains(WordDenys.system(), new MyWordDeny());
IWordAllow wordAllow = WordAllows.chains(WordAllows.system(), new MyWordAllow());
SensitiveWordBs wordBs = SensitiveWordBs.newInstance()
.wordDeny(wordDeny)
.wordAllow(wordAllow)
.init();
接下來再加自定義敏感詞配置。
自定義敏感詞白名單
自定義有哪一些是敏感詞白名單，如果遇見是需要進行展示的。通過實現(xiàn) IWordAllow 接口重寫 allow() 方法返回白名單敏感詞。
package com.tothefor.motorcode.core.SensitiveWord;
import com.github.houbb.sensitive.word.api.IWordAllow;
import org.springframework.stereotype.Service;
import java.util.Arrays;
import java.util.List;
@Service
public class CustomWordAllow implements IWordAllow {
/**
* 允許的內(nèi)容-返回的內(nèi)容不被當做敏感詞
* @return
*/
@Override
public List<String> allow() {
// 從數(shù)據(jù)庫中查詢白名單敏感詞
return Arrays.asList("紅旗");
}
}
自定義敏感詞黑名單
增加敏感詞黑名單。通過實現(xiàn) IWordDeny 接口重寫 deny() 方法返回黑名單敏感詞。
package com.tothefor.motorcode.core.SensitiveWord;
import com.github.houbb.sensitive.word.api.IWordDeny;
import org.springframework.stereotype.Service;
import java.util.Arrays;
import java.util.List;
/**
* 自定義敏感詞
*/
@Service
public class CustomWordDeny implements IWordDeny {
/**
* 拒絕出現(xiàn)的數(shù)據(jù)-返回的內(nèi)容被當做是敏感詞
*
* @return
*/
@Override
public List<String> deny() {
// 從數(shù)據(jù)庫中查詢自定義敏感詞
return Arrays.asList("紅旗");
}
}
示例
測試自定義使用：
@Autowired
private SensitiveWordBs sensitiveWordBs;
@Test
void testWord() {
String text = "紅旗迎風飄揚，主席的畫像屹立在天安門前。";
System.out.println(sensitiveWordBs.contains(text));
System.out.println(sensitiveWordBs.replace(text));
System.out.println(sensitiveWordBs.replace(text, '0'));
System.out.println(sensitiveWordBs.replace(text, new MySensitiveWordReplace()));
System.out.println(sensitiveWordBs.findFirst(text));
System.out.println(sensitiveWordBs.findFirst(text, WordResultHandlers.word()));
System.out.println(sensitiveWordBs.findFirst(text, WordResultHandlers.raw()));
System.out.println(sensitiveWordBs.findAll(text));
System.out.println(sensitiveWordBs.findAll(text, WordResultHandlers.word()));
System.out.println(sensitiveWordBs.findAll(text, WordResultHandlers.raw()));
}
輸出：
true
紅旗迎風飄揚，***的畫像屹立在***前。
紅旗迎風飄揚，000的畫像屹立在000前。
紅旗迎風飄揚，教員的畫像屹立在門前。
主席
主席
WordResult{word='主席', startIndex=9, endIndex=12}
[主席, 天安門]
[主席, 天安門]
[WordResult{word='主席', startIndex=9, endIndex=12}, WordResult{word='天安門', startIndex=18, endIndex=21}]
可以看見，和之前的有一點不一樣。‘紅旗’ 并沒有被過濾掉，主要原因就是因為我們的自定義敏感詞白名單中加入了 ‘紅旗’ ，所以沒有被過濾掉。但是黑名單中又有這個詞，為什么沒有被過濾掉？這里有個點就是：如果黑名單和白名單中都有同一個敏感詞，那么這個詞是不會被過濾的。
重置詞庫
因為敏感詞庫的初始化較為耗時，建議程序啟動時做一次 init 初始化。但為了保證敏感詞修改可以實時生效且保證接口的盡可能簡化，可以在數(shù)據(jù)庫詞庫發(fā)生變更時，需要詞庫生效，主動觸發(fā)一次初始化 sensitiveWordBs.init()。因為在調用 sensitiveWordBs.init() 的時候，根據(jù) IWordDeny+IWordAllow 重新構建敏感詞庫。因為初始化可能耗時較長（秒級別），所有優(yōu)化為 init 未完成時不影響舊的詞庫功能，完成后以新的為準。
@Autowired private SensitiveWordBs sensitiveWordBs; sensitiveWordBs.init();
每次數(shù)據(jù)庫的信息發(fā)生變化之后，首先調用更新數(shù)據(jù)庫敏感詞庫的方法，然后調用這個方法。但不推薦將此方法放在數(shù)據(jù)庫被修改后就調用，而推薦單獨開一個接口，手動調用。
總結
所有的操作均是在 SensitiveWordBs 上操作的。
以上就是SpringBoot使用SensitiveWord實現(xiàn)敏感詞過濾的詳細內(nèi)容，更多關于SpringBoot SensitiveWord敏感詞過濾的資料請關注腳本之家其它相關文章！
相關文章
Spring MVC深度解析從原理到實戰(zhàn)(最新推薦)
MVC是一種經(jīng)典的軟件架構模式,本文給大家介紹Spring MVC深度解析從原理到實戰(zhàn),感興趣的朋友一起看看吧2025-05-05
java實例方法被覆蓋,靜態(tài)方法被隱藏Explain(詳解)
下面小編就為大家?guī)硪黄猨ava實例方法被覆蓋,靜態(tài)方法被隱藏Explain(詳解)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-05-05
文章主要介紹了SpringCloud中的@FeignClient注解的使用及其參數(shù)詳解,包括value/name、url、path、configuration、fallback/fallbackFactory、contextId等,通過@FeignClient注解,可以方便地聲明一個REST客戶端,并定義與目標服務通信的接口2024-11-11
這篇文章主要給大家介紹了關于Java面試題之多線程和高并發(fā)的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用java具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2021-07-07
spring boot項目生成docker鏡像并完成容器部署的方法步驟
這篇文章主要介紹了spring boot項目生成docker鏡像并完成容器部署的方法步驟，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-10-10
本文主要介紹了一文搞懂MyBatis一級緩存和二級緩存，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-05-05
linux中nohup?java?-jar啟動java項目的步驟
nohup是一個Unix和Linux命令,用于運行關閉時不會被終止的進程,這篇文章主要給大家介紹了關于linux中nohup?java?-jar啟動java項目的相關資料,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2024-08-08
quartz是一個定時調度的框架，就目前市場上來說，其實有比quartz更優(yōu)秀的一些定時調度框架，不但性能比quartz好，學習成本更低，而且還提供可視化操作定時任務，這篇文章主要介紹了springboot整合quartz項目使用（含完整代碼）,需要的朋友可以參考下2023-05-05
文章主要介紹了在Spring?Boot中訪問后臺靜態(tài)資源時可能出現(xiàn)的404錯誤及解決方法,并解釋了MyBatis中駝峰命名轉下劃線的默認行為以及如何使用@Id和@GeneratedValue注解來標識主鍵屬性2024-12-12
近來讀了《深入理解JVM虛擬機》的部分內(nèi)容,對JVM也慢慢有個整體的認識,今天就來分享一下我對JVM類加載過程的學習和理解,需要的朋友可以參考下2021-06-06