WordShield 一款轻量级且灵活的敏感词过滤库

简介

WordShield 是一款轻量级且灵活的敏感词过滤库,基于 Spring Boot 构建。它提供了简单易用的 API,用于过滤和管理敏感词汇。

github 地址:

https://github.com/avidbyte/wordshield

特性

敏感词过滤:自动过滤字符串中的敏感词汇。

默认敏感词列表:内置预设的敏感词列表。

可定制敏感词列表:支持从指定路径加载自定义敏感词列表。

动态管理:允许动态添加或移除敏感词。

Spring Boot 集成:自动在应用上下文中注册 SensitiveWordFilter Bean。

快速开始

准备工作

Java 8 或更高版本

Spring Boot 2.x 或更高版本

Maven 或 Gradle

添加依赖

Maven

在 pom.xml 文件中添加以下依赖:

xml 复制代码
<dependency>
    <groupId>io.github.avidbyte</groupId>
    <artifactId>wordshield</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle

在 build.gradle 文件中添加以下依赖:

groovy 复制代码
dependencies {
    implementation 'io.github.avidbyte:wordshield:1.0.0'
}

使用方法

初始化过滤器

添加依赖后,SensitiveWordFilter Bean 会被自动注册。您可以在服务类中直接使用它:

java 复制代码
import io.github.avidbyte.wordshield.SensitiveWordFilter;

@Slf4j
@Service
public class ContentService {

    private final SensitiveWordFilter sensitiveWordFilter;

    public ContentService(SensitiveWordFilter sensitiveWordFilter) {
        this.sensitiveWordFilter = sensitiveWordFilter;
    }

    public String filterContent(String content) {
        SensitiveWordResult sensitiveWordResult = sensitiveWordFilter.checkAndFilter(content, "*");
        log.info("文本: {} 是否是敏感词: {}", content, sensitiveWordResult.isContainsSensitiveWord());
        log.info("文本: {} 敏感词处理结果: {}", content, sensitiveWordResult.getFilteredText());
    }
}

自定义敏感词列表

默认情况下,库会加载预设的敏感词列表。不过,您也可以通过提供文件路径来自定义敏感词列表:

在 application.yml 配置

yaml 复制代码
sensitive:
  word:
    loadDefault: false
    source: file
    filePath: /opt/sensitive_word.txt

loadDefault 为 true, wordshield 会先加载预设的敏感词列表, 如果不希望使用预设的敏感词列表, 就将 loadDefault 设置为 false

其他数据来源: database, api, etc. 可以通过这种方式加载

yaml 复制代码
sensitive:
  word:
    loadDefault: false
    source: database

当前配置 wordshield 不会加载预设的敏感词, 敏感词库完全是空的, 需要使用者自己调用新增敏感词的方法构造敏感词库

通过这四个方法也可以动态地管理敏感词列表

java 复制代码
import io.github.avidbyte.wordshield.SensitiveWordFilter;

@Service
public class ContentService {

    private final SensitiveWordFilter sensitiveWordFilter;

    public ContentService(SensitiveWordFilter sensitiveWordFilter) {
        this.sensitiveWordFilter = sensitiveWordFilter;
    }

    public String addSensitiveWords(List<String> words) {
        sensitiveWordFilter.addSensitiveWords(words);
    }

    public String addSensitiveWord(String word) {
        sensitiveWordFilter.addSensitiveWord(word);
    }

    public String removeSensitiveWords(List<String> words) {
        sensitiveWordFilter.removeSensitiveWords(words);
    }

    public String removeSensitiveWord(String word) {
        sensitiveWordFilter.removeSensitiveWord(word);
    }
    
}
相关推荐
ytadpole19 分钟前
揭秘设计模式:工厂模式的五级进化之路
java·设计模式
计算机毕业设计木哥20 分钟前
计算机毕设选题:基于Python+Django的B站数据分析系统的设计与实现【源码+文档+调试】
java·开发语言·后端·python·spark·django·课程设计
失散1320 分钟前
分布式专题——1.2 Redis7核心数据结构
java·数据结构·redis·分布式·架构
用户3721574261351 小时前
Python 实现 HTML 转 Word 和 PDF
java
a587691 小时前
Java核心概念精讲:TCP与UDP的区别、Java NIO的几个核心组件与HTTP和HTTPS的区别等(46-50)
java·面试·nio
渣哥1 小时前
ConcurrentHashMap 的 get 要不要加锁?一次“多此一举”的心路历程
java
愿你天黑有灯下雨有伞1 小时前
一种基于注解与AOP的Spring Boot接口限流防刷方案
java·spring boot·后端
MuMuMu#1 小时前
JAVA NIO学习笔记基础强化学习总结
java·学习·nio
拾忆,想起1 小时前
Redis复制延迟全解析:从毫秒到秒级的优化实战指南
java·开发语言·数据库·redis·后端·缓存·性能优化
我登哥MVP1 小时前
Java File 类学习笔记
java·笔记·学习