Blasp - Laravel下的敏感词过滤包使用教程

1. 项目目录结构及介绍

Blasp 是一个为 Laravel 设计的敏感词过滤包，它可以帮助检测和遮蔽句子中的不当词汇。以下是项目的目录结构及其说明：

blasp/
├── assets/                # 静态资源文件夹
├── config/                # 配置文件
│   └── blasp.php          # Blasp 配置文件
├── src/                   # 源代码文件夹
│   ├── Facades/           #Facade 类
│   ├── Filters/           #过滤器类
│   ├── Providers/         #服务提供者
│   └── Validators/        #验证器
├── tests/                 #测试文件
├── .gitignore             #Git 忽略文件
├── CHANGELOG.md           #更新日志
├── CONTRIBUTING.md        #贡献指南
├── LICENSE.md             #许可证文件
├── README.md              #项目说明文件
├── composer.json          #Composer 配置文件
└── phpunit.xml            #PHPUnit 配置文件

2. 项目的启动文件介绍

在 src/ 目录下，Providers/BlaspServiceProvider.php 是项目的启动文件，它负责绑定服务到 Laravel 服务容器，并注册任何其他需要加载的功能，如 artisan 命令或中间件。

namespace Blaspsoft\Blasp\Providers;

use Illuminate\Support\ServiceProvider;

class BlaspServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->singleton('blasp', function ($app) {
            return new \Blaspsoft\Blasp\Blasp;
        });
    }

    public function boot()
    {
        // 发布配置文件
        $this->publishes([
            __DIR__ . '/../config/blasp.php' => config_path('blasp.php'),
        ], 'blasp-config');
    }
}

3. 项目的配置文件介绍

配置文件 config/blasp.php 是用来管理敏感词列表、分隔符和替换字符的。以下是配置文件的基本结构：

return [
    'profanities' => [
        // 敏感词列表
    ],
    'false_positives' => [
        // 误报词列表
    ],
    'replacements' => [
        // 替换字符配置
    ],
    'separators' => [
        // 分隔符配置
    ],
    'cache_expiration' => 60, // 缓存时间
];

在配置文件中，你可以自定义敏感词列表和替换规则，也可以设置缓存的过期时间以优化性能。使用时，你可以通过 config('blasp') 来访问这些配置。