dokalanyi / laravel-facebook-sdk
为Laravel & Lumen 5.x提供的Facebook SDK v5完全单元测试集成
Requires
- php: >=5.5.0
- facebook/graph-sdk: ^5.0
- illuminate/auth: ~6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/config: ~6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/database: ~6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/routing: ~6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/session: ~6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/support: ~6.0|^7.0|^8.0|^9.0|^10.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0|~5.0|~6.0
- squizlabs/php_codesniffer: ~2.0
This package is not auto-updated.
Last update: 2024-09-25 08:49:20 UTC
README
这是一个完全单元测试的包,用于轻松地将Facebook SDK v5集成到Laravel和Lumen 5.0、5.1、5.2和5.3中。
此包适用于Laravel和Lumen 5.0、5.1、5.2和5.3
- 对于Laravel 4.2,请参阅1.3分支。
- 安装
- 重定向示例中的用户登录
- 向Facebook发出请求
- Facebook登录
- 将Facebook中的数据保存到数据库
- 在Laravel中登录用户
- 处理多个应用
- 错误处理
- 故障排除
- 测试
- 贡献
- 致谢
- 许可证
我真的应该使用Laravel Socialite吗?
Laravel 5自带对Socialite的支持,允许您使用OAuth 2.0提供者进行身份验证。Facebook登录使用OAuth 2.0,因此Socialite支持Facebook登录。
如果您只需要认证一个应用并获取一个用户访问令牌以获取用户的基本数据,那么Socialite或The PHP League的Facebook OAuth Client应该能满足您的需求。
但是,如果您需要以下任何功能,则希望将Facebook PHP SDK与该包结合使用
- 从签名请求中获取访问令牌
- 照片或视频上传
- 批量请求
- 轻松分页
- 将图数据作为集合返回
安装
将Laravel Facebook SDK包添加到您的composer.json
文件中。
composer require sammyk/laravel-facebook-sdk
自动发现:从版本3.5.0开始,Laravel Facebook SDK支持Laravel 5.5及更高版本的自动发现。
服务提供者
在您的应用配置中,将LaravelFacebookSdkServiceProvider
添加到提供者数组中。
'providers' => [ SammyK\LaravelFacebookSdk\LaravelFacebookSdkServiceProvider::class, ];
Lumen,将提供者添加到您的bootstrap/app.php
文件中。
$app->register(SammyK\LaravelFacebookSdk\LaravelFacebookSdkServiceProvider::class);
外观(可选)
如果您想使用外观,请将其添加到应用配置中的别名数组中。
'aliases' => [ 'Facebook' => SammyK\LaravelFacebookSdk\FacebookFacade::class, ];
IoC容器
IoC容器将自动为您解决LaravelFacebookSdk
的依赖项。您可以通过多种方式从IoC容器中获取LaravelFacebookSdk
的实例。
// Directly from the IoC $fb = App::make('SammyK\LaravelFacebookSdk\LaravelFacebookSdk'); // Or in PHP >= 5.5 $fb = app(SammyK\LaravelFacebookSdk\LaravelFacebookSdk::class); // From a constructor class FooClass { public function __construct(SammyK\LaravelFacebookSdk\LaravelFacebookSdk $fb) { // . . . } } // From a method class BarClass { public function barMethod(SammyK\LaravelFacebookSdk\LaravelFacebookSdk $fb) { // . . . } } // Or even a closure Route::get('/facebook/login', function(SammyK\LaravelFacebookSdk\LaravelFacebookSdk $fb) { // . . . });
配置文件
注意:从版本3.4.0开始,发布配置文件是可选的,只要您设置了您的必需的配置值。
请注意:配置文件包含一个默认的Graph API版本,该版本会定期更新到最新稳定版本,这可能会在您更新此包的次要或补丁版本时引起破坏性更改。建议您仍然发布配置文件,并在自己方便的时候更新Graph API版本,以防止出现破坏性更改。
在Facebook中创建应用后,您需要提供应用ID和密钥。在Laravel中,您可以使用artisan
来发布配置文件。
$ php artisan vendor:publish --provider="SammyK\LaravelFacebookSdk\LaravelFacebookSdkServiceProvider" --tag="config"
文件在哪里? Laravel 5会将配置文件发布到
/config/laravel-facebook-sdk.php
。
在Lumen中,您需要手动将配置文件从/src/config/laravel-facebook-sdk.php
复制到您项目基础目录中的配置文件夹。Lumen默认没有/config
文件夹,因此如果您还没有创建,则需要创建它。
必需的配置值
您需要将配置文件中的app_id
和app_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(SammyK\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(SammyK\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());
Facebook登录
当我们说“通过Facebook登录”时,我们实际上是指“获取一个用户访问令牌,以便代表用户调用Graph API”。这是通过Facebook通过OAuth 2.0完成的。有多种方法可以使用Facebook PHP SDK中称为“辅助函数”的方法来使用Facebook进行用户登录。
支持的四种登录方法包括
- 通过重定向登录(OAuth 2.0)
- 通过JavaScript登录(使用JS SDK cookie)
- 从应用画布登录(带有签名请求)
- 从页面标签登录(带有签名请求)
通过重定向登录
将用户登录到您的应用的最常见方法之一是使用重定向URL。
想法是生成一个唯一的URL,用户点击它。一旦用户点击链接,他们将被重定向到Facebook,要求他们授权您的应用请求的任何权限。一旦用户做出响应,Facebook将用户重定向回您指定的回调URL,无论是成功响应还是错误响应。
可以使用SDK的getRedirectLoginHelper()
方法获取重定向助手。
生成登录URL
您可以像使用Facebook PHP SDK v5一样获取登录URL。
Route::get('/facebook/login', function(SammyK\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(SammyK\LaravelFacebookSdk\LaravelFacebookSdk $fb) { try { $token = $fb ->getRedirectLoginHelper() ->getAccessToken(); } catch (Facebook\Exceptions\FacebookSDKException $e) { // Failed to obtain access token dd($e->getMessage()); } });
LaravelFacebookSdk中有一个包装方法getRedirectLoginHelper()->getAccessToken()
,称为getAccessTokenFromRedirect()
,它将回调URL默认为laravel-facebook-sdk.default_redirect_uri
配置值。
Route::get('/facebook/callback', function(SammyK\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,因此您必须在初始化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(SammyK\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安装将在您尝试在Facebook中查看您的应用时抛出
TokenMismatchException
。请参阅如何修复此问题。
如果您的应用位于Facebook应用画布的上下文中,您可以从第一次页面加载时通过POST
发送到您的应用的签名请求中获取访问令牌。
注意:画布助手只从Facebook接收到的签名请求数据中获取现有的访问令牌。如果访问您的应用的用户尚未授权您的应用或其访问令牌已过期,则
getAccessToken()
方法将返回null
。在这种情况下,您需要使用重定向或JavaScript登录用户。
使用SDK的画布助手从签名请求数据中获取访问令牌。
Route::match(['get', 'post'], '/facebook/canvas', function(SammyK\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(SammyK\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 SammyK\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_node_field_aliases
静态变量在您的User
模型中映射字段名称。
数组的键是图节点上字段的名称。数组的值是本地数据库中列的名称。
use SammyK\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 SammyK\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 SammyK\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 SammyK\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 SammyK\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(SammyK\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(SammyK\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\FacebookSDKException
的Facebook\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)。请参阅许可文件以获取更多信息。