{"id":18918263,"url":"https://github.com/avidbyte/wordshield","last_synced_at":"2025-09-04T23:31:53.532Z","repository":{"id":254768825,"uuid":"845910486","full_name":"avidbyte/wordshield","owner":"avidbyte","description":"敏感词过滤：自动过滤字符串中的敏感词汇。 默认敏感词列表：内置预设的敏感词列表。 可定制敏感词列表：支持从指定路径加载自定义敏感词列表。 动态管理：允许动态添加或移除敏感词。 Spring Boot 集成：自动在应用上下文中注册 SensitiveWordFilter Bean。","archived":false,"fork":false,"pushed_at":"2024-09-11T10:39:16.000Z","size":334,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-08T10:47:44.915Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/avidbyte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-22T06:59:00.000Z","updated_at":"2024-10-23T05:49:35.000Z","dependencies_parsed_at":"2024-09-11T14:00:25.236Z","dependency_job_id":"fcaa48d6-b7fb-44ee-8d1d-b3f6c087a335","html_url":"https://github.com/avidbyte/wordshield","commit_stats":null,"previous_names":["avidbyte/wordshield"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avidbyte%2Fwordshield","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avidbyte%2Fwordshield/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avidbyte%2Fwordshield/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avidbyte%2Fwordshield/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/avidbyte","download_url":"https://codeload.github.com/avidbyte/wordshield/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232005258,"owners_count":18459033,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T10:30:48.100Z","updated_at":"2024-12-31T15:48:58.320Z","avatar_url":"https://github.com/avidbyte.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n[![License](https://img.shields.io/badge/license-Apache--2.0-4D7A97)](https://github.com/avidbyte/wordshield/blob/main/LICENSE)\n[![Maven Central](https://img.shields.io/badge/maven--central-1.0.0-blue)](https://mvnrepository.com/artifact/io.github.avidbyte/wordshield/1.0.0)\n[![Maven Central](https://img.shields.io/badge/PRs--welcome-red)](https://github.com/avidbyte/wordshield/pulls)\n\n# 简介\nWordShield 是一款轻量级且灵活的敏感词过滤库，基于 Spring Boot 构建。它提供了简单易用的 API，用于过滤和管理敏感词汇。\n\n开源之路不易，如果你觉得本项目对你有所帮助，请慷慨地点一个 Star，你的支持将是我持续前进的动力！\n# 特性\n敏感词过滤：自动过滤字符串中的敏感词汇。\n默认敏感词列表：内置预设的敏感词列表。\n可定制敏感词列表：支持从指定路径加载自定义敏感词列表。\n动态管理：允许动态添加或移除敏感词。\nSpring Boot 集成：自动在应用上下文中注册 SensitiveWordFilter Bean。\n\n本项目敏感词部分来源 https://github.com/konsheng/Sensitive-lexicon 由于不支持通配符,处理了一些以*结尾的敏感词\n\n\n# 快速开始\n## 准备工作\nJava 8 或更高版本\nSpring Boot 2.x 或更高版本\nMaven 或 Gradle\n## 添加依赖\nMaven\n在 pom.xml 文件中添加以下依赖：\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.github.avidbyte\u003c/groupId\u003e\n    \u003cartifactId\u003ewordshield\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nGradle\n在 build.gradle 文件中添加以下依赖：\n```groovy\ndependencies {\n    implementation 'io.github.avidbyte:wordshield:1.0.0'\n}\n```\n\n## 使用方法\n初始化过滤器\n添加依赖后，SensitiveWordFilter Bean 会被自动注册。您可以在服务类中直接使用它：\n\n```java\nimport io.github.avidbyte.wordshield.SensitiveWordFilter;\n\n@Service\npublic class ContentService {\n\n    private final SensitiveWordFilter sensitiveWordFilter;\n\n    public ContentService(SensitiveWordFilter sensitiveWordFilter) {\n        this.sensitiveWordFilter = sensitiveWordFilter;\n    }\n\n    public String filterContent(String content) {\n        SensitiveWordResult sensitiveWordResult = sensitiveWordFilter.checkAndFilter(content, \"*\");\n        log.info(\"文本: {} 是否是敏感词: {}\", content, sensitiveWordResult.isContainsSensitiveWord());\n        log.info(\"文本: {} 敏感词处理结果: {}\", content, sensitiveWordResult.getFilteredText());\n    }\n}\n```\n\n## 自定义敏感词列表\n默认情况下，库会加载预设的敏感词列表。不过，您也可以通过提供文件路径来自定义敏感词列表：\n\n在 application.yml 配置\n\n```yaml\nsensitive:\n  word:\n    loadDefault: false\n    source: file\n    filePath: /opt/sensitive_word.txt\n```\n\nloadDefault 为 true, wordshield 会先加载预设的敏感词列表, 如果不希望使用预设的敏感词列表, 就将 loadDefault 设置为 false\n\n其他数据来源: database, api, etc. 可以通过这种方式加载\n```yaml\nsensitive:\n  word:\n    loadDefault: false\n    source: database\n```\n当前配置 wordshield 不会加载预设的敏感词, 敏感词库完全是空的, 需要使用者自己调用新增敏感词的方法构造敏感词库\n通过这四个方法也可以动态地管理敏感词列表\n```java\nimport io.github.avidbyte.wordshield.SensitiveWordFilter;\n\n@Service\npublic class ContentService {\n\n    private final SensitiveWordFilter sensitiveWordFilter;\n\n    public ContentService(SensitiveWordFilter sensitiveWordFilter) {\n        this.sensitiveWordFilter = sensitiveWordFilter;\n    }\n\n    public String addSensitiveWords(List\u003cString\u003e words) {\n        sensitiveWordFilter.addSensitiveWords(words);\n    }\n\n    public String addSensitiveWord(String word) {\n        sensitiveWordFilter.addSensitiveWord(word);\n    }\n\n    public String removeSensitiveWords(List\u003cString\u003e words) {\n        sensitiveWordFilter.removeSensitiveWords(words);\n    }\n\n    public String removeSensitiveWord(String word) {\n        sensitiveWordFilter.removeSensitiveWord(word);\n    }\n    \n}\n\n\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favidbyte%2Fwordshield","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favidbyte%2Fwordshield","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favidbyte%2Fwordshield/lists"}