敏感词过滤工具使用教程

敏感词过滤工具使用教程

sensitive-word 👮‍♂️The sensitive word tool for java.(敏感词/违禁词/违法词/脏词。基于 DFA 算法实现的高性能 java 敏感词过滤工具框架。请勿发布涉及政治、广告、营销、翻墙、违反国家法律法规等内容。高性能敏感词检测过滤组件，附带繁体简体互换，支持全角半角互换，汉字转拼音，模糊搜索等功能。)项目地址:https://gitcode.com/gh_mirrors/se/sensitive-word

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

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

sensitive-word/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── com/
│   │   │   │   ├── github/
│   │   │   │   │   ├── houbb/
│   │   │   │   │   │   ├── sensitiveword/
│   │   │   │   │   │   │   ├── bs/
│   │   │   │   │   │   │   ├── support/
│   │   │   │   │   │   │   ├── util/
│   │   │   │   │   │   │   ├── constant/
│   │   │   │   │   │   │   ├── model/
│   │   │   │   │   │   │   ├── service/
│   │   │   │   │   │   │   ├── api/
│   │   │   │   │   │   │   ├── Application.java
│   │   ├── resources/
│   │   │   ├── application.properties
│   │   │   ├── sensitive-words.txt
│   ├── test/
│   │   ├── java/
│   │   │   ├── com/
│   │   │   │   ├── github/
│   │   │   │   │   ├── houbb/
│   │   │   │   │   │   ├── sensitiveword/
│   │   │   │   │   │   │   ├── test/
├── pom.xml

目录结构介绍

• src/main/java/com/github/houbb/sensitiveword/: 包含项目的主要代码文件。
  • bs/: 业务逻辑层。
  • support/: 支持类和工具类。
  • util/: 工具类。
  • constant/: 常量定义。
  • model/: 数据模型。
  • service/: 服务层。
  • api/: API接口。
  • Application.java: 项目启动类。
• src/main/resources/: 包含项目的配置文件和敏感词词库。
  • application.properties: 配置文件。
  • sensitive-words.txt: 敏感词词库。
• src/test/java/com/github/houbb/sensitiveword/test/: 包含项目的测试代码。
• pom.xml: Maven项目配置文件。

2. 项目的启动文件介绍

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

Application.java

package com.github.houbb.sensitiveword;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

启动文件介绍

• @SpringBootApplication: 这是一个组合注解，包含了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan 注解，用于自动配置和扫描组件。
• public static void main(String[] args): 这是应用程序的入口点，启动Spring Boot应用程序。

3. 项目的配置文件介绍

项目的配置文件是 application.properties，位于 src/main/resources/ 目录下。

application.properties

# 服务器端口
server.port=8080

# 敏感词词库文件路径
sensitive.word.path=classpath:sensitive-words.txt

配置文件介绍

• server.port: 指定应用程序的端口号，默认为8080。
• sensitive.word.path: 指定敏感词词库文件的路径，这里使用的是类路径下的 sensitive-words.txt 文件。

以上是敏感词过滤工具项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。

sensitive-word 👮‍♂️The sensitive word tool for java.(敏感词/违禁词/违法词/脏词。基于 DFA 算法实现的高性能 java 敏感词过滤工具框架。请勿发布涉及政治、广告、营销、翻墙、违反国家法律法规等内容。高性能敏感词检测过滤组件，附带繁体简体互换，支持全角半角互换，汉字转拼音，模糊搜索等功能。)项目地址:https://gitcode.com/gh_mirrors/se/sensitive-word