LaravelでSocialiteをしようしてTwitter認証機能を実装してしたので備忘録として書いておきます。
##実装環境
- PHP7.3
- Laravel 6.20.26
##手順
1.アクセストークン・シークレットトークンの取得
2.Socialiteをインストール
3.usersテーブルにtwitter情報を保存するカラムの追加
4.Controllerを作成し、twitterログインを実装
##1.アクセストークン、シークレットの取得
Laravel deveroperでアカウントを作成いて、アクセストーク、シークレットトークンの取得をします。
アカウント作成の際審査があり少し大変のなのでこちらを参考にアカウントを作成しました。
##2.Socialiteをインストール
Composerをしようしてターミナル上で下記のコマンドを実行してSocialiteをインストールする。
composer require laravel/socialite
インストール後はconfig/app.phpのprovidersとaliasの設定をする
'providers' => [
Laravel\Socialite\SocialiteServiceProvider::class,
],
'aliases' => [
'Socialite' => Laravel\Socialite\Facades\Socialite::class,
]
1.で取得してたTwitterのシークレットトークンとアクセストークンとコールバックurl（oauth認証で取得したtwitter情報を受け取る処理）を.envに設定
TWITTER_CLIENT_ID=twitterシークレットトークン
TWITTER_CLIENT_SECRET=twitterアクセストークン
CALLBACK_URL=コールバックURL
oauthの認証情報をconfig/services.phpに設定
'twitter' => [
'client_id' => env('TWITTER_CLIENT_ID'),
'client_secret' => env('TWITTER_CLIENT_SECRET'),
'redirect' => env('CALLBACK_URL'),
],
##3.usersテーブルにtwitter情報を保存するカラムの追加
twitter情報を追加するためのカラムを追加しておく。
php artisan make:migration add_twitter_id_to_users_table --table=users
今回はtwitterのidだけを保存するようにする。メールアドレスとパスワードも保存しないのでnullabeをしていしておく。
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class AddTwitterIdToUsersTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::table('users', function (Blueprint $table) {
$table->string('email')->nullable()->change();
$table->string('password')->nullable()->change();
$table->string('twitter_id')->nullable();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::table('users', function (Blueprint $table) {
//
});
}
}
twitter_idが保存できるようにUserモデルの$fillableにtwitter_idを追加しておく
~省略~
protected $fillable = [
'name', 'email', 'password', 'self_introduction', 'sex', 'img_name', 'twitter_id'
];
~省略~
4.Controllerを作成し、twitterログインを実装
Controllerの作成
php artisan make:controller Auth/TwitterController
ルーティングの設定
Route::group(['prefix' => 'twitter', 'middleware' => 'guest'], function () {
Route::get('login', 'Auth\TwitterController@redirectToProvider')->name('twitter.login'); //oauth認証を行うurl
Route::get('login/callback', 'Auth\TwitterController@handleProviderCallback')->name('twitter.callback'); //認証情報をうけとる処理
});
oauth認証、新規登録,ログイン処理を記述
<?php
namespace App\Http\Controllers\Auth;
use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Illuminate\Http\File;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Facades\Auth;
use Intervention\Image\Facades\Image;
use Socialite;
use App\User;
class TwitterController extends Controller
{
//twitter認証へリダイレクト
public function redirectToProvider()
{
return Socialite::driver('twitter')->redirect();
}
//twitterからユーザー情報受け取る
public function handleProviderCallback()
{
try {
$oauth_user = Socialite::driver('twitter')->user();
} catch (Exeption $e){
return redirect('/');
}
$user = $this->findOrCreateUser($oauth_user);
Auth::login($user);
return redirect()->route('home');
}
//新規登録またはユーザーログイン
public function findOrCreateUser($oauth_user)
{
//新規登録かログインなのかを判定する
$user = User::where('twitter_id', $oauth_user->id)->first();
$avatar_name = $oauth_user->avatar != null ? basename($oauth_user->avatar) : '';
//ログインユーザーの場合
if (!is_null($user)) {
//ユーザー名の変更があれば変更
$user->name = $oauth_user->name;
$user->save();
return $user;
}
//新規登録の場合
if (!empty($avatar_name)) {
$this->imgUpload($oauth_user->avatar);
}
$new_user = User::create([
'name' => $oauth_user->name,
'img_name' => $avatar_name,
'twitter_id' => $oauth_user->id,
]);
return $new_user;
}
//画像のアプロ-ド
public function imgUpload($avatar)
{
$file_name = basename($avatar);
$img = Image::make(file_get_contents($avatar));
return $img->resize(400, 400)->save(storage_path() . '/app/public/images/' . $file_name);
}
}
解説
まずredirectToProvider()メソッドのSocialite::driver('twitter')->redirect()でtwitterのoauthプロバイダへリダイレクトします。
redirect()について
//twitter認証へリダイレクト
public function redirectToProvider()
{
return Socialite::driver('twitter')->redirect();
}
twitterでの認証が成功するとコールバックURLとして設定しておいたhandleProviderCallback()メソッドへリダイレクトされます。認証後Socialite::driver('twitter')->user();を事項するとtwitterの各種ユーザー情報を取得することができます。その情報をもとにユーザーの新規作成、ログインなどの処理を実行する。
//twitterからユーザー情報受け取る
public function handleProviderCallback()
{
try {
$oauth_user = Socialite::driver('twitter')->user();
} catch (Exeption $e){
return redirect('/');
}
$user = $this->findOrCreateUser($oauth_user);
Auth::login($user);
return redirect()->route('home');
}
新規登録、ログインの処理
twitterのidを新規作成の際に保存し、ログインの判定をそのidが存在するのかで判断する。
//新規登録またはユーザーログイン
public function findOrCreateUser($oauth_user)
{
//新規登録かログインなのかを判定する
$user = User::where('twitter_id', $oauth_user->id)->first();
$avatar_name = $oauth_user->avatar != null ? basename($oauth_user->avatar) : '';
//ログインユーザーの場合
if (!is_null($user)) {
//ユーザー名の変更があれば変更
$user->name = $oauth_user->name;
$user->save();
return $user;
}
//新規登録の場合
if (!empty($avatar_name)) {
$this->imgUpload($oauth_user->avatar);
}
$new_user = User::create([
'name' => $oauth_user->name,
'img_name' => $avatar_name,
'twitter_id' => $oauth_user->id,
]);
return $new_user;
twitterのアイコン画像を保存する処理
//画像のアプロ-ド
public function imgUpload($avatar)
{
$file_name = basename($avatar);
$img = Image::make(file_get_contents($avatar));
return $img->resize(400, 400)->save(storage_path() . '/app/public/images/' . $file_name);
}