Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/houbb/sensitive-word-admin

The sensitive tool admin.(敏感词工具对应的控台)
https://github.com/houbb/sensitive-word-admin

admin client sensitive sensitive-data sensitive-word server

Last synced: about 4 hours ago
JSON representation

The sensitive tool admin.(敏感词工具对应的控台)

Host: GitHub
URL: https://github.com/houbb/sensitive-word-admin
Owner: houbb
License: apache-2.0
Created: 2021-07-07T09:25:26.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-11-02T14:57:59.000Z (5 days ago)
Last Synced: 2024-11-02T15:30:07.357Z (5 days ago)
Topics: admin, client, sensitive, sensitive-data, sensitive-word, server
Language: HTML
Homepage:
Size: 7.47 MB
Stars: 33
Watchers: 2
Forks: 19
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # sensitive-word-admin

[sensitive-word-admin](https://github.com/houbb/sensitive-word-admin) 是和 [sensitive-word](https://github.com/houbb/sensitive-word) 配套使用的控台。

[![Build Status](https://travis-ci.com/houbb/sensitive-word-admin.svg?branch=master)](https://travis-ci.com/houbb/sensitive-word-admin)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.houbb/sensitive-word-admin/badge.svg)](http://mvnrepository.com/artifact/com.github.houbb/sensitive-word-admin)

[![](https://img.shields.io/badge/license-Apache2-FF0080.svg)](https://github.com/houbb/sensitive-word-admin/blob/master/LICENSE.txt)

[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/houbb/sensitive-word-admin)

## 拓展阅读

> [sensitive-word-admin 敏感词控台 v1.2.0 版本开源](https://mp.weixin.qq.com/s/7wSy0PuJLTudEo9gTY5s5w)

> [sensitive-word 基于 DFA 算法实现的高性能敏感词工具介绍](https://mp.weixin.qq.com/s/OKLCWlOTv_PSi9MIfDpoMw)

## 特性

- 基本的 CRUD

- 敏感词修改实时生效

> [变更日志](https://github.com/houbb/sensitive-word-admin/blob/master/CHANGELOG.md)

# 启动

## 数据库脚本

mysql 执行数据库脚本：

> [mysql-5.7.sql](https://github.com/houbb/sensitive-word-admin/blob/master/sensitive-word-admin-dal/src/main/resources/sql/mysql-5.7.sql)

测试版本为 mysql5.7，理论 8.0 也支持。

## 编译

```bash

mvn clean install -DskipTests=true

```

建议 jdk 1.8

## 启动

运行 [Application#main()](https://github.com/houbb/sensitive-word-admin/blob/master/sensitive-word-admin-web/src/main/java/com/github/houbb/sensitive/word/admin/Application.java)

启动成功后，访问：

> [http://localhost:8080/](http://localhost:8080/)

![登录首页](sensitive-word-admin-index.png)

## 操作

功能管理进行初步操作，其他待后续完善。

# API

ApiSensitiveWordController 中包含对应的 api 方法，后续可以添加验签等校验。

## 接口列表

| api | 入参 | 出参 | 说明 |

|:----|:----|:----|:------|

| /api/sensitiveWord/contains | string | boolean | 是否包含敏感词 |

| /api/sensitiveWord/findAll | string | `List` | 获取所有的敏感词 |

| /api/sensitiveWord/findFist | string | string | 获取第一个的敏感词 |

| /api/sensitiveWord/replace | string | string | 获取替换后的结果 |

| /api/sensitiveWord/tags | string | `Set` | 获取敏感词的标签列表 |

# 如何自定义标签

## 自定义单词 TAG

我们在配置中指定：

```java

@Configuration

public class SensitiveWordConfig {

    @Autowired

    private MyDdWordAllow myDdWordAllow;

    @Autowired

    private MyDdWordDeny myDdWordDeny;

    /**

     * 自定义单词标签

     *

     * @since v1.4.0

     */

    @Autowired

    private MyDdWordTags myDdWordTags;

    /**

     * 初始化引导类

     * @return 初始化引导类

     * @since 1.0.0

     */

    @Bean

    public SensitiveWordBs sensitiveWordBs() {

        return SensitiveWordBs.newInstance()

                .wordAllow(WordAllows.chains(WordAllows.defaults(), myDdWordAllow))

                .wordDeny(WordDenys.chains(WordDenys.defaults(), myDdWordDeny))

                .wordTag(myDdWordTags)

                .ignoreRepeat(false)

                // 各种其他配置

                .init();

    }

}

```

## MyDdWordTags 自定义实现

MyDdWordTags 是一个实现的例子：

核心分为两步：

1）根据【标签单词映射表】获取单词对应的标签编码(tag_code) 列表

2）根据【标签表】中的 tag_code 去查询对应的 标签描述(tag_label) 列表

所以需要分别配置二者，然后进行关联。

```java

@Component

public class MyDdWordTags implements IWordTag {

    @Autowired

    private WordTagMappingService wordTagMappingService;

    @Autowired

    private TagService tagService;

    @Override

    public Set getTag(String word) {

        if(StringUtil.isEmpty(word)) {

            return Collections.emptySet();

        }

        // 获取单词对应的 TAG codes

        Wrapper wordTagMappingWrapper = new EntityWrapper<>();

        wordTagMappingWrapper.eq("word", word);

        wordTagMappingWrapper.setSqlSelect("tag_code");

        List mappingList = wordTagMappingService.selectList(wordTagMappingWrapper);

        if(CollectionUtil.isEmpty(mappingList)) {

            return Collections.emptySet();

        }

        // 根据 tag code 获取对应的 TAG LABEL

        List wordTagCodeList = mappingList.stream().map(WordTagMapping::getTagCode).collect(Collectors.toList());

        Wrapper tagWrapper = new EntityWrapper<>();

        tagWrapper.eq("status", TagStatusEnum.S.getCode());

        tagWrapper.in("tag_code", wordTagCodeList);

        tagWrapper.setSqlSelect("tag_label");

        List dbTagList = tagService.selectList(tagWrapper);

        if(CollectionUtil.isEmpty(dbTagList)) {

            return Collections.emptySet();

        }

        return dbTagList.stream().map(Tag::getTagLabel).collect(Collectors.toSet());

    }

}

```

# Road-Map

- [ ] 登录/登出

- [ ] 页面操作的权限管理

- [ ] 调用方系统 token 注册管理

- [ ] 调用 API

- [ ] 敏感词的数据大盘

- [ ] 调用信息数据大盘

- [ ] 操作审计日志

# 开源矩阵

[sensitive-word 基于 DFA 算法实现的高性能敏感词工具](https://github.com/houbb/sensitive-word)

[sensitive 基于注解的 java 日志脱敏工具框架，更加优雅的日志打印](https://github.com/houbb/sensitive)