Outreach.io OAuth2 Provider for Laravel Socialite

1.0 2020-03-10 21:00 UTC

This package is auto-updated.

Last update: 2024-09-14 03:53:38 UTC


README

1. 安装

// This assumes that you have composer installed globally
composer require socialiteproviders/spotify

2. 服务提供者

如果已经添加,请从 config\app.php 中的 providers[] 数组中移除 Laravel\Socialite\SocialiteServiceProvider

\SocialiteProviders\Manager\ServiceProvider::class 添加到 config\app.php 中的 providers[] 数组。

例如

'providers' => [
    // a whole bunch of providers
    // remove 'Laravel\Socialite\SocialiteServiceProvider',
    \SocialiteProviders\Manager\ServiceProvider::class, // add
];

注意:如果您想使用 Socialite Facade,您需要安装它。

3. 事件监听器

SocialiteProviders\Manager\SocialiteWasCalled 事件添加到 app/Providers/EventServiceProvider 中的 listen[] 数组。

将您的监听器(即来自提供者的监听器)添加到您刚刚创建的 SocialiteProviders\Manager\SocialiteWasCalled[]

您添加到此提供者的监听器是 'SocialiteProviders\\Outreach\\OutreachExtendSocialite@handle',

注意:除非您使用自己的提供者覆盖它们,否则您不需要为内置的社交提供者添加任何内容。

例如

/**
 * The event handler mappings for the application.
 *
 * @var array
 */
protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // add your listeners (aka providers) here
        'SocialiteProviders\\Outreach\\OutreachExtendSocialite@handle',
    ],
];

4. 配置设置

您需要将条目添加到服务配置文件中,以便在配置文件缓存在生产环境中使用(Laravel 命令 artisan config:cache)后,所有配置仍然可用。

添加到 config/services.php。

'spotify' => [
    'client_id' => env('OUTREACH_KEY'),
    'client_secret' => env('OUTREACH_SECRET'),
    'redirect' => env('OUTREACH_REDIRECT_URI')
],

5. 使用方法

Laravel 配置文档

现在您应该可以使用它,就像您通常使用 Socialite 一样(假设您已安装 facade)

return Socialite::with('spotify')->redirect();

Lumen 支持

您可以使用 Socialite 提供者与 Lumen 一起使用。只需确保您已启用 facade 支持,并且正确遵循设置说明。

注意:如果您使用 Lumen,所有提供者将自动是无状态的,因为 Lumen 不跟踪状态。

此外,Lumen 中无法从 services[] 解析配置。您只能按本文件中所示在 .env 文件中设置值。如果需要,您还可以覆盖配置(如下所示)。

无状态

您可以设置是否希望将提供者作为无状态使用。请记住,OAuth 提供者(Twitter、Tumblr 等)必须支持您选择的选项。注意:如果您使用 Lumen,所有提供者将自动是无状态的,因为 Lumen 不跟踪状态。

// to turn off stateless
return Socialite::with('spotify')->stateless(false)->redirect();

// to use stateless
return Socialite::with('spotify')->stateless()->redirect();

覆盖配置

如果需要在您的应用程序的任何位置动态覆盖提供者的环境或配置变量,您可以使用以下方法

$clientId = "secret";
$clientSecret = "secret";
$redirectUrl = "http://yourdomain.com/api/redirect";
$additionalProviderConfig = ['site' => 'meta.stackoverflow.com'];
$config = new \SocialiteProviders\Manager\Config($clientId, $clientSecret, $redirectUrl, $additionalProviderConfig);
return Socialite::with('spotify')->setConfig($config)->redirect();

获取访问令牌响应体

Laravel Socialite 默认只允许访问 access_token。这可以通过 \Laravel\Socialite\User->token 公共属性访问。有时您需要访问整个响应体,这可能包含诸如 refresh_token 等项。

您可以通过访问属性 $user->accessTokenResponseBody; 来获取访问令牌响应体,在您调用 Socialite 的 user() 方法后。

$user = Socialite::driver('spotify')->user();
$accessTokenResponseBody = $user->accessTokenResponseBody;

##参考

Laravel Socialite 文档
Laracasts Socialite 视频