violetshih/laravel-facebook-sdk

为 Laravel & Lumen 5.x 完全单元测试的 Facebook SDK v5 集成

1.0.2 2024-02-02 15:36 UTC

This package is auto-updated.

Last update: 2024-10-01 00:20:45 UTC


README

Build Status Latest Stable Version Total Downloads License

一个完全单元测试的包,可以轻松地将 Facebook SDK v5 集成到 Laravel 和 Lumen 5.0、5.1、5.2 和 5.3。

这是一个针对 Laravel 和 Lumen 5.0、5.1、5.2 和 5.3 的包

Laravel 5

Lumen 5

我是否应该使用 Laravel Socialite?

Laravel 5 内置了对 Socialite 的支持,允许您通过 OAuth 2.0 提供商进行身份验证。Facebook 登录使用 OAuth 2.0,因此 Socialite 支持 Facebook 登录。

如果您只需要对应用进行身份验证并获取用户访问令牌以获取用户的基本数据,那么 Socialite 或 The PHP League 的 Facebook OAuth 客户端 应该能满足您的需求。

但如果你需要以下功能中的任何一个,你将需要将 Facebook PHP SDK 与此包结合使用

安装

将 Laravel Facebook SDK 包添加到您的 composer.json 文件中。

composer require Violetshih/laravel-facebook-sdk

自动发现:从版本 3.5.0 开始,Laravel Facebook SDK 支持 Laravel 5.5 及更高版本的 自动发现

服务提供者

在您的应用配置中,将 LaravelFacebookSdkServiceProvider 添加到 providers 数组。

'providers' => [
    Violetshih\LaravelFacebookSdk\LaravelFacebookSdkServiceProvider::class,
    ];

对于 Lumen,将提供者添加到您的 bootstrap/app.php 文件中。

$app->register(Violetshih\LaravelFacebookSdk\LaravelFacebookSdkServiceProvider::class);

门面(可选)

如果您想使用门面,请将其添加到您的应用配置中的 aliases 数组。

'aliases' => [
    'Facebook' => Violetshih\LaravelFacebookSdk\FacebookFacade::class,
    ];

但是,还有 更好的方法 来使用此包,不要使用门面

IoC 容器

IoC 容器将自动为您解决 LaravelFacebookSdk 依赖。您可以通过多种方式从 IoC 容器中获取 LaravelFacebookSdk 的实例。

// Directly from the IoC
$fb = App::make('Violetshih\LaravelFacebookSdk\LaravelFacebookSdk');
// Or in PHP >= 5.5
$fb = app(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk::class);

// From a constructor
class FooClass {
    public function __construct(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
       // . . .
    }
}

// From a method
class BarClass {
    public function barMethod(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
       // . . .
    }
}

// Or even a closure
Route::get('/facebook/login', function(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
    // . . .
});

配置文件

注意:从版本 3.4.0 开始,发布配置文件是可选的,只要您设置了 必需的配置值

请注意:配置文件包含一个默认的Graph API版本,该版本会定期升级到最新稳定版本,这可能会在您在次要或修补程序版本中更新此包时导致破坏性更改。建议您仍然发布配置文件,并在自己方便的时候更新Graph API版本,以防止破坏。

在Facebook中创建应用后,您需要提供应用ID和密钥。在Laravel中,您可以使用artisan命令发布配置文件。

$ php artisan vendor:publish --provider="Violetshih\LaravelFacebookSdk\LaravelFacebookSdkServiceProvider" --tag="config"

文件在哪里? Laravel 5会将配置文件发布到/config/laravel-facebook-sdk.php

Lumen中,您需要手动将配置文件从/src/config/laravel-facebook-sdk.php复制到您基础项目目录中的配置文件夹。由于Lumen默认没有/config文件夹,所以如果您还没有创建,则需要创建它。

必需的配置值

您需要将配置文件中的app_idapp_secret值更新为您的应用ID和密钥

默认情况下,配置文件将查找环境变量以获取您的应用ID和密钥。建议您使用环境变量存储此信息,以保护您的应用密钥免受攻击者侵害。确保更新您的/.env文件以包含您的应用ID和密钥。

FACEBOOK_APP_ID=1234567890
FACEBOOK_APP_SECRET=SomeFooAppSecret

用户登录重定向示例

以下是一个如何使用重定向方法将用户登录到您的应用的完整示例。

此示例还演示了如何交换短期访问令牌和长期访问令牌,并在用户表中不存在条目时将用户保存到您的users表中。

最后,它将使用Laravel内置的用户身份验证登录用户。

Lumen中的会话:“通过重定向登录”功能依赖于会话来存储CSRF令牌。由于Lumen 5.2+中没有会话,您需要使用不同的方法获取访问令牌。对于测试,您可以从Graph API Explorer中获取访问令牌(确保从“应用程序”下拉菜单中选择您的应用)。

// Generate a login URL
Route::get('/facebook/login', function(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb)
{
    // Send an array of permissions to request
    $login_url = $fb->getLoginUrl(['email']);

    // Obviously you'd do this in blade :)
    echo '<a href="' . $login_url . '">Login with Facebook</a>';
});

// Endpoint that is redirected to after an authentication attempt
Route::get('/facebook/callback', function(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb)
{
    // Obtain an access token.
    try {
        $token = $fb->getAccessTokenFromRedirect();
    } catch (Facebook\Exceptions\FacebookSDKException $e) {
        dd($e->getMessage());
    }

    // Access token will be null if the user denied the request
    // or if someone just hit this URL outside of the OAuth flow.
    if (! $token) {
        // Get the redirect helper
        $helper = $fb->getRedirectLoginHelper();

        if (! $helper->getError()) {
            abort(403, 'Unauthorized action.');
        }

        // User denied the request
        dd(
            $helper->getError(),
            $helper->getErrorCode(),
            $helper->getErrorReason(),
            $helper->getErrorDescription()
        );
    }

    if (! $token->isLongLived()) {
        // OAuth 2.0 client handler
        $oauth_client = $fb->getOAuth2Client();

        // Extend the access token.
        try {
            $token = $oauth_client->getLongLivedAccessToken($token);
        } catch (Facebook\Exceptions\FacebookSDKException $e) {
            dd($e->getMessage());
        }
    }

    $fb->setDefaultAccessToken($token);

    // Save for later
    Session::put('fb_user_access_token', (string) $token);

    // Get basic info on the user from Facebook.
    try {
        $response = $fb->get('/me?fields=id,name,email');
    } catch (Facebook\Exceptions\FacebookSDKException $e) {
        dd($e->getMessage());
    }

    // Convert the response to a `Facebook/GraphNodes/GraphUser` collection
    $facebook_user = $response->getGraphUser();

    // Create the user if it does not exist or update the existing entry.
    // This will only work if you've added the SyncableGraphNodeTrait to your User model.
    $user = App\User::createOrUpdateGraphNode($facebook_user);

    // Log the user into Laravel
    Auth::login($user);

    return redirect('/')->with('message', 'Successfully logged in with Facebook');
});

有关用户身份验证的更多详细信息,请参阅Facebook登录

向 Facebook 发送请求

对Facebook的请求是通过Graph API进行的。此包是官方Facebook PHP SDK v5的Laravel包装器,因此官方SDK中可用的所有方法也都可在本包中使用。

获取用户信息

以下代码片段将检索表示已登录用户的用户节点

try {
  $response = $fb->get('/me?fields=id,name,email', 'user-access-token');
} catch(\Facebook\Exceptions\FacebookSDKException $e) {
  dd($e->getMessage());
}

$userNode = $response->getGraphUser();
printf('Hello, %s!', $userNode->getName());

有关get()方法的更多信息。

Facebook 登录

当我们说“使用Facebook登录”时,我们实际上是指“获取一个用户访问令牌,以代表用户调用Graph API”。这是通过Facebook通过OAuth 2.0完成的。使用Facebook PHP SDK称为“辅助函数”的方法有很多。

支持的四种登录方法为

  1. 重定向登录(OAuth 2.0)
  2. JavaScript登录(带有JS SDK cookie)
  3. 从应用画布登录(带签名请求)
  4. 从页面标签登录(带签名请求)

通过重定向登录

将用户登录到您的应用程序最常见的方法之一是使用重定向URL。

想法是生成一个唯一的URL,用户会点击它。一旦用户点击链接,他们将被重定向到Facebook,并要求他们授予您的应用程序请求的任何权限。一旦用户做出响应,Facebook将用户重定向回您指定的回调URL,该URL可以是一个成功的响应或错误响应。

可以使用SDK的getRedirectLoginHelper()方法获取重定向助手。

生成登录URL

您可以像使用Facebook PHP SDK v5一样获取登录URL。

Route::get('/facebook/login', function(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
    $login_link = $fb
            ->getRedirectLoginHelper()
            ->getLoginUrl('https://exmaple.com/facebook/callback', ['email', 'user_events']);
    
    echo '<a href="' . $login_link . '">Log in with Facebook</a>';
});

但是,如果您在配置文件中设置了default_redirect_uri回调URL,则可以使用getLoginUrl()包装方法,该方法将回调URL(default_redirect_uri)和权限范围(default_scope)默认设置为配置文件中设置的值。

$login_link = $fb->getLoginUrl();

或者,您可以传递权限和自定义回调URL到包装器以覆盖默认配置。

注意:由于权限列表有时会更改,但回调URL通常保持不变,因此权限数组是getLoginUrl()包装方法中的第一个参数,这与SDK的getRedirectLoginHelper()->getLoginUrl($url, $permissions)方法相反。

$login_link = $fb->getLoginUrl(['email', 'user_status'], 'https://exmaple.com/facebook/callback');
// Or, if you want to default to the callback URL set in the config
$login_link = $fb->getLoginUrl(['email', 'user_status']);

从回调URL获取访问令牌

用户点击上面的登录链接并确认或拒绝应用程序权限请求后,他们将重定向到指定的回调URL。

在回调URL上获取访问令牌的标准“SDK”方法如下

Route::get('/facebook/callback', function(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
    try {
        $token = $fb
            ->getRedirectLoginHelper()
            ->getAccessToken();
    } catch (Facebook\Exceptions\FacebookSDKException $e) {
        // Failed to obtain access token
        dd($e->getMessage());
    }
});

LaravelFacebookSdk中有一个名为getAccessTokenFromRedirect()的包装方法,用于getRedirectLoginHelper()->getAccessToken(),它将回调URL默认设置为laravel-facebook-sdk.default_redirect_uri配置值。

Route::get('/facebook/callback', function(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
    try {
        $token = $fb->getAccessTokenFromRedirect();
    } catch (Facebook\Exceptions\FacebookSDKException $e) {
        // Failed to obtain access token
        dd($e->getMessage());
    }
    
    // $token will be null if the user denied the request
    if (! $token) {
        // User denied the request
    }
});

通过JavaScript登录

如果您正在使用JavaScript SDK,则可以从JavaScript SDK设置的cookie中获取访问令牌。

默认情况下,JavaScript SDK不会设置cookie,因此您必须在init() SDK时明确启用它,使用cookie: true

FB.init({
  appId      : 'your-app-id',
  cookie     : true,
  version    : 'v2.10'
});

使用FB.login()通过JavaScript SDK登录用户后,您可以从存储在JavaScript SDK设置的cookie中的签名请求中获取用户访问令牌。

Route::get('/facebook/javascript', function(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
    try {
        $token = $fb->getJavaScriptHelper()->getAccessToken();
    } catch (Facebook\Exceptions\FacebookSDKException $e) {
        // Failed to obtain access token
        dd($e->getMessage());
    }

    // $token will be null if no cookie was set or no OAuth data
    // was found in the cookie's signed request data
    if (! $token) {
        // User hasn't logged in using the JS SDK yet
    }
});

从应用画布登录

TokenMismatchException: 默认Laravel安装将抛出TokenMismatchException,当您尝试在Facebook中查看您的应用程序时。 查看如何解决这个问题

如果您的应用程序存在于Facebook应用程序画布的上下文中,则可以从第一次页面加载时通过POST到您的应用程序的签名请求中获取访问令牌。

注意:画布助手仅从Facebook接收到的签名请求数据中获取现有的访问令牌。如果访问您的应用程序的用户尚未授权您的应用程序或访问令牌已过期,则getAccessToken()方法将返回null。在这种情况下,您需要通过重定向JavaScript登录用户。

使用SDK的canvas助手从签名请求数据中获取访问令牌。

Route::match(['get', 'post'], '/facebook/canvas', function(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
    try {
        $token = $fb->getCanvasHelper()->getAccessToken();
    } catch (Facebook\Exceptions\FacebookSDKException $e) {
        // Failed to obtain access token
        dd($e->getMessage());
    }

    // $token will be null if the user hasn't authenticated your app yet
    if (! $token) {
        // . . .
    }
});

页面标签登录

TokenMismatchException: 默认的Laravel安装会在你尝试在Facebook中查看页面标签时抛出 TokenMismatchException查看如何解决这个问题

如果你的应用位于Facebook页面标签的上下文中,这相当于应用画布,并且“从应用画布登录”的方法也可以用来获取访问令牌。但是页面标签的签名请求中还有额外的数据。

SDK提供了一个页面标签助手,用于在页面标签的上下文中从签名请求数据中获取访问令牌。

Route::match(['get', 'post'], '/facebook/page-tab', function(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
    try {
        $token = $fb->getPageTabHelper()->getAccessToken();
    } catch (Facebook\Exceptions\FacebookSDKException $e) {
        // Failed to obtain access token
        dd($e->getMessage());
    }

    // $token will be null if the user hasn't authenticated your app yet
    if (! $token) {
        // . . .
    }
});

其他授权请求

Facebook支持两种其他类型的授权URL - 重新请求和重新认证。

重新请求

重新请求(或重新请求?)会再次请求用户之前拒绝的权限。使用重新请求URL而不是仅仅用正常登录链接重定向用户是很重要的,因为

一旦有人拒绝了某个权限,登录对话框就不会再次询问他们,除非你明确告诉对话框你正在重新请求被拒绝的权限。- Facebook 文档

你可以使用 getReRequestUrl() 方法生成重新请求URL。

$rerequest_link = $fb->getReRequestUrl(['email'], 'https://exmaple.com/facebook/login');
// Or, if you want to default to the callback URL set in the config
$rerequest_link = $fb->getReRequestUrl(['email']);

重新认证

重新认证 会强制用户通过再次输入他们的Facebook账户密码来确认他们的身份。这在你需要在你Web应用的敏感数据更改或查看之前添加另一个安全层时很有用。

你可以使用 getReAuthenticationUrl() 方法生成重新认证URL。

$re_authentication_link = $fb->getReAuthenticationUrl(['email'], 'https://exmaple.com/facebook/login');
// Or, if you want to default to the callback URL set in the config
$re_authentication_link = $fb->getReAuthenticationUrl(['email']);
// Or without permissions
$re_authentication_link = $fb->getReAuthenticationUrl();

保存访问令牌

在大多数情况下,除非你计划在用户不在浏览你的应用时(例如,例如凌晨3点的CRON作业)代表用户向Graph API发出请求,否则你不需要将访问令牌保存到数据库中。

在获取访问令牌后,你可以将其存储在会话中以供后续请求使用。

Session::put('facebook_access_token', (string) $token);

然后,在每个调用Graph API的脚本中,你可以从会话中提取令牌并将其设置为默认值。

$token = Session::get('facebook_access_token');
$fb->setDefaultAccessToken($token);

在数据库中保存从Facebook获取的数据

将Graph API接收到的数据保存到数据库有时可能是一项繁琐的任务。由于Graph API返回的数据格式可预测,因此 SyncableGraphNodeTrait 可以使将数据保存到数据库变得简单。

任何实现了 SyncableGraphNodeTrait 的Eloquent模型都将应用 createOrUpdateGraphNode() 方法。这个方法使直接从Facebook返回的数据在本地数据库中创建或更新变得非常容易。

use Violetshih\LaravelFacebookSdk\SyncableGraphNodeTrait;

class Event extends Eloquent {
    use SyncableGraphNodeTrait;
}

例如,如果你有一个名为 Event 的Eloquent模型,以下是如何从Graph API获取特定事件并将其作为新条目插入数据库或使用新信息更新现有条目的示例。

$response = $fb->get('/some-event-id?fields=id,name');
$eventNode = $response->getGraphEvent();

// A method called createOrUpdateGraphNode() on the `Event` eloquent model
// will create the event if it does not exist or it will update the existing
// record based on the ID from Facebook.
$event = Event::createOrUpdateGraphNode($eventNode);

createOrUpdateGraphNode() 将自动将返回的字段名称映射到数据库中的列名称。例如,如果你的 events 表的列名称与 事件 节的字段名称不匹配,你可以 映射字段

字段映射

由于数据库中的列名称可能不匹配Graph节点的字段名称,因此你可以使用 $graph_node_field_aliases 静态变量映射你的 User 模型中的字段名称。

数组的关键字是图节点上的字段名称。数组的值是本地数据库中的列名称。

use Violetshih\LaravelFacebookSdk\SyncableGraphNodeTrait;

class User extends Eloquent implements UserInterface
{
    use SyncableGraphNodeTrait;
    
    protected static $graph_node_field_aliases = [
        'id' => 'facebook_user_id',
        'name' => 'full_name',
        'graph_node_field_name' => 'database_column_name',
    ];
}

指定“可填充”字段

默认情况下,createOrUpdateGraphNode()方法将尝试将节点的所有字段插入到数据库中。但是,有时Graph API会返回您未明确请求且不存在于您的数据库中的字段。在这种情况下,我们可以使用$graph_node_fillable_fields属性来白名单特定的字段。

use Violetshih\LaravelFacebookSdk\SyncableGraphNodeTrait;

class Event extends Eloquent
{
    use SyncableGraphNodeTrait;
    
    protected static $graph_node_fillable_fields = ['id', 'name', 'start_time'];
}

使用数据库列的名称。例如,如果您已将数据库中的id字段别名为facebook_id列,则需要在您的$graph_node_fillable_fields数组中指定facebook_id

嵌套字段映射

由于Graph API会将请求中的一些字段作为其他节点/对象返回,您可以使用Laravel的array_dot()表示法来引用这些字段。

例如,您可能要对/me/events端点发出请求并遍历所有事件并将它们保存到您的Event模型中。事件节点将返回事件节点,并作为地点节点返回place.location字段。响应数据可能如下所示

{
  "data": [
    {
      "id": "123", 
      "name": "Foo Event", 
      "place": {
        "location": {
          "city": "Dearborn", 
          "state": "MI", 
          "country": "United States", 
          . . .
        }, 
        "id": "827346"
      }
    },
    . . .
  ]
}

假设您有一个如下所示的事件表

Schema::create('events', function(Blueprint $table)
{
    $table->increments('id');
    $table->bigInteger('facebook_id')->nullable()->unsigned()->index();
    $table->string('name')->nullable();
    $table->string('city')->nullable();
    $table->string('state')->nullable();
    $table->string('country')->nullable();
});

这是您如何在您的Event模型中将嵌套字段映射到数据库表中的方法

use Violetshih\LaravelFacebookSdk\SyncableGraphNodeTrait;

class Event extends Eloquent
{
    use SyncableGraphNodeTrait;
    
    protected static $graph_node_field_aliases = [
        'id' => 'facebook_id',
        'place.location.city' => 'city',
        'place.location.state' => 'state',
        'place.location.country' => 'country',
    ];
}

日期格式

Facebook PHP SDK将大多数日期格式转换为DateTime实例。当您想要将日期/时间值插入到数据库中(例如,事件节点start_time字段)时,这可能会引起问题。

默认情况下,SyncableGraphNodeTrait会将所有DateTime实例转换为以下date()格式

Y-m-d H:i:s

这应该是大多数关系数据库上大多数情况下的正确格式。但是,此格式缺少时区,这可能对您的应用程序很重要。此外,如果您以不同的格式存储日期/时间值,您可能需要自定义将DateTime实例转换为的格式。为此,只需将$graph_node_date_time_to_string_format属性添加到您的模型中,并将其设置为任何有效的日期格式

use Violetshih\LaravelFacebookSdk\SyncableGraphNodeTrait;

class Event extends Eloquent
{
    use SyncableGraphNodeTrait;
    
    protected static $graph_node_date_time_to_string_format = 'c'; # ISO 8601 date
}

将用户登录到 Laravel

Laravel Facebook SDK使您能够使用Laravel的内置认证驱动程序轻松登录用户。

更新用户表

为了使Facebook认证与Laravel的内置认证一起工作,您需要将Facebook用户的ID存储在您的用户表中。

当然,您还需要创建一个列来存储您想保留的关于用户的每条其他信息。

如果您需要在用户不浏览您的应用程序时代表用户进行请求(例如,凌晨3点的cron作业),则可以将访问令牌存储在数据库中。但通常您不需要将访问令牌存储在数据库中。

您需要生成一个迁移来修改您的users表并添加任何新列。

注意:请确保将<name-of-users-table>更改为您的用户表名称。

$ php artisan make:migration add_facebook_columns_to_users_table --table="<name-of-users-table>"

现在更新迁移文件,包括您想在用户上保存的新字段。至少您需要保存Facebook用户ID。

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class AddFacebookColumnsToUsersTable extends Migration
{
    public function up()
    {
        Schema::table('users', function(Blueprint $table)
        {
            // If the primary id in your you user table is different than the Facebook id
            // Make sure it's an unsigned() bigInteger()
            $table->bigInteger('facebook_user_id')->unsigned()->index();
            // Normally you won't need to store the access token in the database
            $table->string('access_token')->nullable();
        });
    }

    public function down()
    {
        Schema::table('users', function(Blueprint $table)
        {
            $table->dropColumn(
                'facebook_user_id',
                'access_token'
            );
        });
    }
}

别忘了运行迁移。

$ php artisan migrate

如果您计划使用Facebook用户ID作为主键,请确保您有一个名为id的列,该列是无符号大整数并已建立索引。如果您将Facebook ID存储在不同的字段中,请确保该字段存在于数据库中,并在您的模型中将它映射到自定义ID名称。

如果您正在使用Eloquent ORM并在数据库中存储访问令牌,请确保在User模型中隐藏access_token字段,以防止可能的外部暴露。

别忘了将SyncableGraphNodeTrait添加到您的用户模型中,以便您可以将模型与Graph API返回的数据同步。

# User.php
use Violetshih\LaravelFacebookSdk\SyncableGraphNodeTrait;

class User extends Eloquent implements UserInterface {
    use SyncableGraphNodeTrait;

    protected $hidden = ['access_token'];
}

在Laravel中登录用户

用户通过Facebook登录并且您已从Graph API获取了用户ID后,可以通过将登录用户的User模型传递给Auth::login()方法来在Laravel中登录用户。

class FacebookController {
    public function getUserInfo(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
       try {
           $response = $fb->get('/me?fields=id,name,email');
       } catch (Facebook\Exceptions\FacebookSDKException $e) {
           dd($e->getMessage());
       }
       
       // Convert the response to a `Facebook/GraphNodes/GraphUser` collection
       $facebook_user = $response->getGraphUser();
       
       // Create the user if it does not exist or update the existing entry.
       // This will only work if you've added the SyncableGraphNodeTrait to your User model.
       $user = App\User::createOrUpdateGraphNode($facebook_user);
       
       // Log the user into Laravel
       Auth::login($user);
    }
}

处理多个应用

如果您想在同一脚本中使用多个Facebook应用或希望在运行时调整设置,您可以使用自定义设置创建一个新的LaravelFacebookSdk实例。

Route::get('/example', function(Violetshih\LaravelFacebookSdk\LaravelFacebookSdk $fb) {
    // All the possible configuration options are available here
    $fb2 = $fb->newInstance([
      'app_id' => env('FACEBOOK_APP_ID2'),
      'app_secret' => env('FACEBOOK_APP_SECRET2'),
      'default_graph_version' => 'v2.10',
      // . . .
    ]);
});

错误处理

Facebook PHP SDK会抛出Facebook\Exceptions\FacebookSDKException异常。每当Graph返回错误响应时,SDK将抛出一个继承自Facebook\Exceptions\FacebookSDKExceptionFacebook\Exceptions\FacebookResponseException。如果抛出Facebook\Exceptions\FacebookResponseException,您可以通过调用getPrevious()方法来获取与错误相关的特定异常。

try {
    // Stuffs here
} catch (Facebook\Exceptions\FacebookResponseException $e) {
    $graphError = $e->getPrevious();
    echo 'Graph API Error: ' . $e->getMessage();
    echo ', Graph error code: ' . $graphError->getCode();
    exit;
} catch (Facebook\Exceptions\FacebookSDKException $e) {
    echo 'SDK Error: ' . $e->getMessage();
    exit;
}

LaravelFacebookSdk不会抛出任何自定义异常。

故障排除

在画布应用中获取TokenMismatchException

如果您的应用在应用画布或页面标签的上下文中提供服务,当您尝试在Facebook上查看应用时,可能会看到TokenMismatchException错误。这是因为Facebook将通过发送带有signed_request参数的POST请求来渲染您的应用,而Laravel 5为每个非读请求启用了CSRF保护,从而触发了错误。

虽然可以完全禁用此功能,但这绝对不是推荐的做法,因为CSRF保护是您网站的重要安全功能,并且默认情况下应在每个路由上启用。

在Laravel 5.1 & 5.2中禁用CSRF

在您的app\Http\Middleware\VerifyCsrfToken.php文件中为画布端点添加一个异常到$except数组。

<?php

namespace App\Http\Middleware;

use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as BaseVerifier;

class VerifyCsrfToken extends BaseVerifier
{
    /**
     * The URIs that should be excluded from CSRF verification.
     *
     * @var array
     */
    protected $except = [
        'facebook/canvas',
        'facebook/page-tab',
        // ... insert all your canvas endpoints here
    ];
}

在Laravel 5.0中禁用CSRF

在Laravel 5.0中禁用CSRF验证有点复杂,但有一篇文章解释了如何在Laravel 5.0中为特定路由禁用CSRF保护

在您的app\Http\Middleware\VerifyCsrfToken.php文件中,添加一个excludedRoutes()方法。然后创建一个包含您画布应用或页面标签端点的路由数组。完整的文件如下所示

<?php namespace App\Http\Middleware;

use Closure;
use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as BaseVerifier;
use Illuminate\Session\TokenMismatchException;

class VerifyCsrfToken extends BaseVerifier
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     *
     * @throws TokenMismatchException
     */
    public function handle($request, Closure $next)
    {
        if ($this->isReading($request) || $this->excludedRoutes($request) || $this->tokensMatch($request)) {
            return $this->addCookieToResponse($request, $next($request));
        }

        throw new TokenMismatchException;
    }

    /**
     * Ignore CSRF on these routes.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return bool
     */
    private function excludedRoutes($request)
    {
        $routes = [
          'my-app/canvas',
          'my-app/page-tab',
          // ... insert all your canvas endpoints here
        ];

        foreach($routes as $route){
            if ($request->is($route)) {
                return true;
            }
        }

        return false;
    }
}

保存用户时获取QueryException

如果您正在使用MySQL,在用createOrUpdateGraphNode()将用户保存到数据库时可能会得到一个QueryException

QueryException in Connection.php line 754:
SQLSTATE[HY000]: General error: 1364 Field 'password' doesn't have a default value

这是因为默认情况下启用了严格模式,将sql_mode设置为包括STRICT_TRANS_TABLES。由于我们不需要用户通过Facebook登录的密码,因此该字段将是空的。解决这个错误的办法是在您的config/database.php文件中将MySQL数据库驱动程序的strict设置为false

测试

测试是用phpunit编写的。您可以从项目目录的根目录运行以下命令来运行测试。

$ ./vendor/bin/phpunit

贡献

请参阅CONTRIBUTING以获取详细信息。

鸣谢

此软件包由Sammy Kaye Powers维护。请参阅贡献者完整列表

许可证

MIT许可证(MIT)。请参阅许可文件以获取更多信息。