laravel-socialite-providers/socialite-wechat-web

该包已被废弃,不再维护。作者建议使用 laravel-fans/socialite-providers 包。

Laravel Socialite 微信网页 OAuth2 提供者

0.2.0 2019-09-04 10:36 UTC

This package is auto-updated.

Last update: 2020-09-12 04:24:49 UTC


README

标题
微信网页

1. 安装

// This assumes that you have composer installed globally
composer require laravel-socialite-providers/socialite-wechat-web

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[]

  • 为该提供者添加的监听器是 'LaravelSocialiteProviders\\WeChatWeb\\WeChatWebExtendSocialite@handle',

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

例如

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

参考

4. 配置设置

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

添加到 config/services.php

'wechat_web' => [
    'client_id' => env('WECHAT_WEB_APP_ID'),
    'client_secret' => env('WECHAT_WEB_APP_SECRET'),
    'redirect' => env('WECHAT_WEB_CALLBACK_URL'),
    'scopes' => preg_split('/,/', env('WECHAT_WEB_SCOPES'), null, PREG_SPLIT_NO_EMPTY), // can not use explode, see vlucas/phpdotenv#175
    'union_id_with' => preg_split('/,/', env('WECHAT_WEB_UNION_ID_WITH'), null, PREG_SPLIT_NO_EMPTY),
],

5. 使用方法

  • Laravel 配置文档

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

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

Lumen 支持

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

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

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

无状态

  • 您可以设置是否希望以无状态方式使用提供者。请记住,OAuth 提供者(Twitter、Tumblr 等)必须支持您选择的任何选项。

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

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

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

覆盖配置

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

$clientId = "secret";
$clientSecret = "secret";
$redirectUrl = "http://yourdomain.com/api/redirect";
$additionalProviderConfig = [
    // Add additional configuration values here.
];
$config = new \SocialiteProviders\Manager\Config(
    $clientId,
    $clientSecret,
    $redirectUrl,
    $additionalProviderConfig
);

return Socialite::with('wechat_web')->setConfig($config)->redirect();

检索访问令牌响应体

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

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

// default use openid as $user->id
$user = Socialite::driver('wechat_web')->user();
$accessTokenResponseBody = $user->accessTokenResponseBody;

// use unionid as $user->id
$user = Socialite::driver('wechat_web')->scopes('unionid')->user();

从令牌中检索用户详细信息(OAuth2)

如果您已经有一个用户的有效访问令牌,您可以使用 userFromToken 方法检索他们的详细信息,但腾讯打破了 OAuth2,需要先设置 "openid"。

$user = Socialite::driver('wechat_web')->setOpenId($openId)->userFromToken($token);

参考