Laravel 8扩展laravel-saml2的Saml2Controller遇配置缺失错误

问题根源 #

自定义控制器未正确初始化原包的依赖链，导致Slides\Saml2\OneLoginBuilder未被执行，无法将config/saml2.php的配置注入到onelogin/php-saml库中，从而触发配置文件找不到的错误。

可行解决方案 #

方案一：继承原控制器并复用依赖注入 #

这是最简便的方式，直接继承原包的控制器，重写需要定制的方法即可自动复用原有的配置初始化逻辑：

1. 创建自定义控制器：

<?php

namespace App\Http\Controllers;

use Slides\Saml2\Http\Controllers\Saml2Controller;

class MySaml2Controller extends Saml2Controller
{
    // 重写需要自定义的方法，例如登录逻辑
    public function login()
    {
        // 保留原包的核心逻辑
        parent::login();
        
        // 添加你的自定义操作
        // 示例：记录登录日志
        // Log::info('SAML登录请求触发');
    }
}

2. 修改路由指向自定义控制器：
   在routes/web.php中替换原SAML相关路由：

// 替换原包路由，指向你的自定义控制器
Route::get('/saml2/login', [\App\Http\Controllers\MySaml2Controller::class, 'login']);
Route::post('/saml2/acs', [\App\Http\Controllers\MySaml2Controller::class, 'acs']);
Route::get('/saml2/logout', [\App\Http\Controllers\MySaml2Controller::class, 'logout']);
Route::get('/saml2/metadata', [\App\Http\Controllers\MySaml2Controller::class, 'metadata']);

方案二：手动调用OneLoginBuilder初始化配置 #

如果不想继承原控制器，可手动通过OneLoginBuilder加载配置并初始化Auth实例：

<?php

namespace App\Http\Controllers;

use Slides\Saml2\OneLoginBuilder;
use OneLogin\Saml2\Auth;
use Illuminate\Routing\Controller;

class MySaml2Controller extends Controller
{
    protected $auth;

    public function __construct()
    {
        // 用OneLoginBuilder加载config/saml2.php的配置
        $builder = new OneLoginBuilder(config('saml2'));
        $settings = $builder->buildSettings();
        
        // 初始化Auth实例
        $this->auth = new Auth($settings);
    }

    // 自定义登录方法
    public function login()
    {
        $this->auth->login();
        // 你的自定义逻辑
    }
}

方案三：通过服务容器绑定统一管理依赖 #

在AppServiceProvider中绑定Auth实例，确保所有地方获取的Auth都已加载正确配置：

1. 修改app/Providers/AppServiceProvider.php：

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Slides\Saml2\OneLoginBuilder;
use OneLogin\Saml2\Auth;

class AppServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->bind(Auth::class, function ($app) {
            $builder = new OneLoginBuilder($app['config']['saml2']);
            return new Auth($builder->buildSettings());
        });
    }
}

2. 在自定义控制器中依赖注入Auth：

<?php

namespace App\Http\Controllers;

use OneLogin\Saml2\Auth;
use Illuminate\Routing\Controller;

class MySaml2Controller extends Controller
{
    protected $auth;

    public function __construct(Auth $auth)
    {
        $this->auth = $auth;
    }

    public function login()
    {
        $this->auth->login();
        // 自定义逻辑
    }
}

注意事项 #

不要直接在vendor/onelogin/php-saml目录下手动创建配置文件，该目录属于composer管理的依赖目录，更新依赖时会被完全覆盖，导致配置丢失。

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