敏感词过滤开源项目教程

敏感词过滤开源项目教程

sensitive-word-filter简易敏感词处理器，支持返回敏感词，高亮敏感词，替换敏感词等操作项目地址:https://gitcode.com/gh_mirrors/se/sensitive-word-filter

1. 项目的目录结构及介绍

敏感词过滤项目的目录结构如下：

sensitive-word-filter/
├── README.md
├── config
│   └── sensitive-words.txt
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── hailin
│   │   │           └── sensitiveword
│   │   │               ├── SensitiveWordFilter.java
│   │   │               └── SensitiveWordInit.java
│   │   └── resources
│   │       └── application.properties
│   └── test
│       └── java
│           └── com
│               └── hailin
│                   └── sensitiveword
│                       └── SensitiveWordFilterTest.java
└── pom.xml

目录结构介绍

• README.md: 项目说明文档。
• config/: 配置文件目录，包含敏感词列表文件 sensitive-words.txt。
• src/: 源代码目录。
  • main/: 主程序目录。
    • java/: Java 源代码目录。
      • com/hailin/sensitiveword/: 敏感词过滤相关类。
        • SensitiveWordFilter.java: 敏感词过滤核心类。
        • SensitiveWordInit.java: 敏感词初始化类。
    • resources/: 资源文件目录，包含应用配置文件 application.properties。
  • test/: 测试代码目录。
    • java/: Java 测试代码目录。
      • com/hailin/sensitiveword/: 敏感词过滤测试类。
        • SensitiveWordFilterTest.java: 敏感词过滤测试类。
• pom.xml: Maven 项目配置文件。

2. 项目的启动文件介绍

项目的启动文件是 SensitiveWordFilter.java，位于 src/main/java/com/hailin/sensitiveword/ 目录下。

SensitiveWordFilter.java

该文件包含了敏感词过滤的核心逻辑，主要功能如下：

• 初始化敏感词库。
• 提供敏感词过滤方法。

示例代码：

package com.hailin.sensitiveword;

import java.util.Set;

public class SensitiveWordFilter {
    private SensitiveWordInit sensitiveWordInit;

    public SensitiveWordFilter() {
        this.sensitiveWordInit = new SensitiveWordInit();
        sensitiveWordInit.initKeyWord();
    }

    public boolean containsSensitiveWord(String text) {
        Set<String> sensitiveWords = sensitiveWordInit.getSensitiveWord(text);
        return !sensitiveWords.isEmpty();
    }

    public String filterSensitiveWord(String text) {
        return sensitiveWordInit.replaceSensitiveWord(text, '*');
    }
}

3. 项目的配置文件介绍

项目的配置文件主要有两个：

1. application.properties: 应用配置文件，位于 src/main/resources/ 目录下。
2. sensitive-words.txt: 敏感词列表文件，位于 config/ 目录下。

application.properties

该文件包含了应用的基本配置，例如：

sensitive.word.file.path=config/sensitive-words.txt

sensitive-words.txt

该文件包含了敏感词列表，每行一个敏感词，例如：

敏感词1
敏感词2
敏感词3

通过这些配置文件，可以灵活地管理和更新敏感词库。

sensitive-word-filter简易敏感词处理器，支持返回敏感词，高亮敏感词，替换敏感词等操作项目地址:https://gitcode.com/gh_mirrors/se/sensitive-word-filter