Laravel Model Cleanup 项目教程

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

Laravel Model Cleanup 项目的目录结构如下：

laravel-model-cleanup/
├── config/
│   └── model-cleanup.php
├── src/
│   ├── Commands/
│   │   └── CleanUpModelsCommand.php
│   ├── CleanupConfig.php
│   ├── GetsCleanedUp.php
│   ├── ModelCleanupServiceProvider.php
│   └── ...
├── tests/
│   └── ...
├── .editorconfig
├── .gitattributes
├── .gitignore
├── CHANGELOG.md
├── composer.json
├── LICENSE.md
├── phpunit.xml.dist
├── psalm.xml
└── README.md

目录结构介绍

• config/: 包含项目的配置文件 model-cleanup.php，用于定义需要清理的模型。
• src/: 包含项目的核心代码，包括命令、配置类、服务提供者等。
  • Commands/: 包含清理模型的命令文件 CleanUpModelsCommand.php。
  • CleanupConfig.php: 清理配置类，用于定义清理规则。
  • GetsCleanedUp.php: 接口文件，定义了模型需要实现的清理方法。
  • ModelCleanupServiceProvider.php: 服务提供者，用于注册和配置清理服务。
• tests/: 包含项目的测试文件，用于测试清理功能的正确性。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitattributes: Git 属性配置文件，用于定义文件的属性。
• .gitignore: Git 忽略文件配置，用于忽略不需要版本控制的文件。
• CHANGELOG.md: 项目更新日志，记录每次更新的内容。
• composer.json: Composer 配置文件，定义项目的依赖和元数据。
• LICENSE.md: 项目许可证文件，定义项目的开源许可证。
• phpunit.xml.dist: PHPUnit 配置文件，用于配置测试环境。
• psalm.xml: Psalm 静态分析工具配置文件，用于代码质量检查。
• README.md: 项目说明文件，包含项目的介绍、安装和使用说明。

2. 项目的启动文件介绍

Laravel Model Cleanup 项目的启动文件主要是 ModelCleanupServiceProvider.php，它负责注册和配置清理服务。

ModelCleanupServiceProvider.php

namespace Spatie\ModelCleanup;

use Illuminate\Support\ServiceProvider;

class ModelCleanupServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->publishes([
            __DIR__.'/../config/model-cleanup.php' => config_path('model-cleanup.php'),
        ], 'config');
    }

    public function register()
    {
        $this->mergeConfigFrom(__DIR__.'/../config/model-cleanup.php', 'model-cleanup');

        $this->app->bind('command.model-cleanup:clean', CleanUpModelsCommand::class);

        $this->commands([
            'command.model-cleanup:clean',
        ]);
    }
}

启动文件介绍

• boot(): 发布配置文件 model-cleanup.php 到 Laravel 的配置目录。
• register(): 合并配置文件，绑定清理命令 CleanUpModelsCommand，并注册命令到 Laravel 的命令列表中。

3. 项目的配置文件介绍

Laravel Model Cleanup 项目的配置文件是 config/model-cleanup.php，它定义了需要清理的模型。

model-cleanup.php

return [
    /*
     * 所有实现 `Spatie\ModelCleanup\GetsCleanedUp` 接口的模型
     * 将会被清理。
     */
    'models' => [
        // App\Models\YourModel::class,
    ],
];

配置文件介绍

• models: 定义需要清理的模型类，模型类需要实现 GetsCleanedUp 接口，并在 cleanUp 方法中定义清理规则。

通过以上配置，你可以轻松地管理和清理 Laravel 项目中的旧记录。