基于NWIDART的Laravel模块动态菜单管理方案咨询

核心思路 #

让每个独立模块自行定义菜单配置，核心系统通过扫描所有启用模块的配置文件，自动收集并聚合菜单数据，无需手动修改基础代码即可实现新模块菜单的动态加载。

具体实现步骤 #

1. 模块内定义菜单配置 #

在每个模块的 Config 目录下创建 menu.php 文件，统一遵循预设的字段结构定义菜单：

return [
    [
        'title' => '模块管理',
        'route' => 'admin.module.index',
        'icon' => 'fa-cogs',
        'permission' => 'manage_modules', // 可选：权限控制字段
        'order' => 5, // 可选：控制菜单排序
        'children' => [
            ['title' => '模块列表', 'route' => 'admin.module.list'],
            ['title' => '安装模块', 'route' => 'admin.module.install'],
        ]
    ]
];

2. 核心系统收集菜单数据 #

创建菜单服务类 App/Services/MenuService.php，负责扫描所有启用模块并聚合菜单：

namespace App\Services;

use Nwidart\Modules\Facades\Module;
use Illuminate\Support\Facades\Cache;

class MenuService
{
    public static function getDynamicMenu()
    {
        // 缓存优化：避免每次请求都扫描文件
        return Cache::remember('dynamic_menu', 3600, function () {
            $menu = [];
            
            foreach (Module::all() as $module) {
                if (!$module->isEnabled()) continue;
                
                $menuPath = $module->getPath('Config/menu.php');
                if (file_exists($menuPath)) {
                    $moduleMenu = require $menuPath;
                    $menu = array_merge($menu, $moduleMenu);
                }
            }
            
            // 按order字段排序菜单
            usort($menu, fn($a, $b) => ($a['order'] ?? 99) - ($b['order'] ?? 99));
            return $menu;
        });
    }

    // 模块状态变更时调用，清除缓存
    public static function clearMenuCache()
    {
        Cache::forget('dynamic_menu');
    }
}

3. 视图中渲染动态菜单 #

在菜单视图文件中调用服务类获取菜单并渲染：

@foreach(\App\Services\MenuService::getDynamicMenu() as $menuItem)
    @if(auth()->user()?->can($menuItem['permission'] ?? '*'))
        <li class="nav-item">
            <a href="{{ route($menuItem['route']) }}" class="nav-link">
                <i class="nav-icon {{ $menuItem['icon'] }}"></i>
                <p>{{ __($menuItem['title']) }}</p>
            </a>
            
            @isset($menuItem['children'])
                <ul class="nav nav-treeview">
                    @foreach($menuItem['children'] as $child)
                        @if(auth()->user()?->can($child['permission'] ?? '*'))
                            <li class="nav-item">
                                <a href="{{ route($child['route']) }}" class="nav-link">
                                    <i class="far fa-circle nav-icon"></i>
                                    <p>{{ __($child['title']) }}</p>
                                </a>
                            </li>
                        @endif
                    @endforeach
                </ul>
            @endisset
        </li>
    @endif
@endforeach

4. 模块状态联动 #

在模块启用/禁用的逻辑中，调用 MenuService::clearMenuCache() 清除缓存，确保菜单实时更新。

可用工具包 #

• nwidart/laravel-modules：你当前使用的模块拆分工具，本身支持模块路径扫描与配置加载，是实现动态菜单的基础
• spatie/laravel-permission：可与菜单配置中的 permission 字段结合，实现基于用户权限的菜单过滤
• laravel-menu：第三方菜单构建工具，支持通过服务提供者动态注册菜单项目，每个模块可在自身的 ServiceProvider 中注册菜单

最佳实践 #

• 统一配置规范：强制所有模块使用相同的菜单字段结构，避免核心系统处理时出现兼容性问题
• 服务提供者注册模式：替代文件扫描，让每个模块在 ServiceProvider 的 boot() 方法中调用核心菜单类的注册方法，更符合Laravel服务容器设计：

  // 模块的ServiceProvider
  public function boot()
  {
      \App\Services\MenuService::registerMenu([
          'title' => '模块管理',
          'route' => 'admin.module.index',
          // 其他字段
      ]);
  }
  

• 本地化支持：菜单标题使用翻译键（如 'title' => 'module::menu.manage'），并在模块内配置语言文件，实现多语言菜单
• 菜单分组：在配置中增加 group 字段，可将菜单按业务分组展示

内容的提问来源于stack exchange，提问作者Rupesh Gondariya