模块化

在开发前首先需要了解后台的一个最重要的功能 模块。后台里面的所有的业务功能都被拆分到最小概念模块中里。开发者之间也可以互相共享模块。

模块如何工作

CatchAdmin 的模块通常是存放在modules目录下的，通过下面的命令来进行模块安装

php artisan catch:module:install

根据提示选择对应的模块进行安装

运行完成之后，会在 storage/app 下，生成 module.json，在该文件里可以看到模块相关的信息。

要了解模块具体如何工作的，用一个新模块开发来说明下

开发新模块

开发模块可以通过创建模块开始

点击开发工具的模块管理，然后新建模块，按照提示填入模块的相关信息之后，点击创建即可。就会自动生成相关模块的文件，如下生成一个 test 模块 如图可以看到已经生成了Test模块

• Http 目录就是开发模块
• Models 模型存在
• database 存在 migration 和 seed 的目录
• Providers 这个非常重要，和 Laravel Package 差不多，路由，commands，config 都是需要从这里载入
• route.php 路由文件

这里着重看下 Provider

namespace Modules\Test\Providers;

use Catch\CatchAdmin;
use Catch\Providers\CatchModuleServiceProvider;

class TestServiceProvider extends CatchModuleServiceProvider
{
    public function moduleName(): string|array
    {
        return 'common';
    }
}

默认情况下，会自动加载路由。额外提供另外几个功能

• 事件 如果需要加载模块事件，这个和Laravel 提供的默认事件一样。Provider 提供一个默认$events数组

class TestServiceProvider extends CatchModuleServiceProvider
{
    protected $events = [];
}

• 中间件 需要实现 middlewares 方法!

class TestServiceProvider extends CatchModuleServiceProvider
{
    protected function middlewares(): array
    {
        return [];
    }
}

WARNING

这里设置的 middlewares 是作用于所有模块的，所以谨慎设置

如果需要作用于模块，请直接在模块路由设置即可

自动加载

实际上，CatchAdmin 得模块启动必须依赖一个非常重要的文件，那就是 storage/app/module.json。模块的禁用启用，都是依赖该 json 文件。 如果实际不需要这个依赖，CatchAdmin 提供了一个可配置参数，

.env

// 在 .env 文件中修改
CATCH_MODULE_AUTOLOAD = true

config/catch.php

// 在模块配置中修改
[
    'module' => [
        'autoload' => env('CATCH_MODULE_AUTOLOAD', false),
    ],
]

模块内部依赖

有时候某个模块可能需要依赖另外一个模块，所以需要同时安装才行，可以在模块安装器添加下面的代码。以商城模块为例

namespace Modules\Shop;

use Catch\Support\Module\Installer as ModuleInstaller;
use Modules\Shop\Providers\ShopServiceProvider;

class Installer extends ModuleInstaller
{
    // 添加模块依赖
    protected function dependencies(): array
    {
        return ['member'];
    }
}

安装

INFO

如果不需要提供给别人使用的话，可以不用继续往下看了

如果想将模块贡献出来，供其他人使用，还需要一个安装器。安装器一般都是约定在module的根目录下。可以从权限模块找到相关案例。来看下权限模块的安装器

namespace Modules\Permissions;

use Catch\Support\Module\Installer as ModuleInstaller;

class Installer extends ModuleInstaller
{
    protected function info(): array
    {
        // TODO: Implement info() method.
        return [
            'title' => '权限管理',
            'name' => 'permissions',
            'path' => 'permissions',
            'keywords' => '权限, 角色, 部门',
            'description' => '权限管理模块',
            'provider' => PermissionsServiceProvider::class
        ];
    }

    protected function requirePackages(): void
    {
        // TODO: Implement requirePackages() method.
    }

    protected function removePackages(): void
    {
        // TODO: Implement removePackages() method.
    }
}

安装器需要提供模块的信息，主要通过 info 方法来实现，如果模块有依赖的包，那么需要在 requirePackages 方法实现

protected function requirePackages(): void
{
    // TODO: Implement requirePackages() method.
    $this->composer()->require('package/name')
}

如果使用的是动态菜单，还需要导出模块的相关菜单信息，可以使用这个命令

php artisan catch:export:menu <module> <table?>

• table 可选参数，默认是 permissions 表

导出权限模块的菜单，并且生成seed文件。这个命令只在打包模块时会有用处，如果模块不用与与其他人共享的话，基本用不着

php artisan catch:export:menu permissions

完成这两步，就可以将模块分享给用户了，👏 欢迎大家共建社区