ianvizarra / laravel-facebook-sdk
我刚刚为 Laravel 6 和 7 支持创建了此项目。完全单元测试了 Facebook SDK v5 与 Laravel & Lumen 5.x 的集成
Requires
- php: >=5.5.0
- facebook/graph-sdk: ^5.0
- illuminate/auth: ~5.0|~5.1|~5.2|~5.3
- illuminate/config: ~5.0|~5.1|~5.2|~5.3
- illuminate/database: ~5.0|~5.1|~5.2|~5.3
- illuminate/routing: ~5.0|~5.1|~5.2|~5.3
- illuminate/session: ~5.0|~5.1|~5.2|~5.3
- illuminate/support: ~5.0|~5.1|~5.2|~5.3
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0|~5.0|~6.0
- squizlabs/php_codesniffer: ~2.0
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 客户端 应该满足您的需求。
但是,如果您需要以下任何功能,您将需要将此包与 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,用户点击该URL。一旦用户点击链接,他们将被重定向到Facebook,要求他们授予您的应用请求的任何权限。一旦用户做出响应,Facebook将用户重定向回您指定的回调URL,其中包含成功响应或错误响应。
可以通过SDK的getRedirectLoginHelper()
方法获取重定向助手。
生成登录URL
您可以得到一个登录URL,就像使用Facebook PHP SDK v5一样。
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,因此您需要在调用 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(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 } });
从 App Canvas 登录
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 页面标签的上下文中,它与应用程序画布相同,并且“从 App Canvas 登录”方法也可以用来获取访问令牌。但是页面标签在签名请求中还有其他数据。
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 - rerequests 和 re-authentications。
Rerequests
Rerequests(或 re-requests?)会再次要求用户授权他们之前已拒绝的权限。使用 rerequest URL 进行此操作非常重要,而不是仅仅通过正常的登录链接将他们重定向,因为
一旦有人拒绝了一个权限,登录对话框不会再次要求他们,除非您明确告诉对话框您正在重新请求已拒绝的权限。- Facebook 文档
您可以使用 getReRequestUrl()
方法生成 rerequest 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
表中的列名称与Event节点的字段名称不匹配,您可以通过映射字段来映射。
字段映射
由于您的数据库中的列名称可能不匹配Graph节点的字段名称,您可以使用$graph_node_field_aliases
静态变量在User
模型中映射字段名称。
数组的keys是Graph节点上的字段名称。数组的values是本地数据库中的列名称。
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
模型中。事件节点将返回作为地点位置字段的位置节点。响应数据可能如下所示
{ "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 API返回错误响应时,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)。请参阅许可证文件以获取更多信息。