php的laravel框架快速集成微信登陸

最終的解決方案是:https://github.com/liuyunzhuge/php_weixin_provider,詳細的介紹請往下閱讀。php

本文面向的是php語言laravel框架的用戶,介紹的是基於該框架實現的一個簡易集成微信登陸的方法。使用方法以下:html

1. 安裝php_weixin_providerlaravel

在項目下運行composer require thirdproviders/weixin,便可完成安裝。安裝成功後,在項目的vendor目錄下應該能看到php_weixin_provider的庫文件:git

image

2. 配置微信登陸的參數github

一共有7個參數能夠配置,分別是:設計模式

  • client_id:對應公衆號建立的應用appid
  • client_secret:對應公衆號建立的應用appid
  • redirect:對應微信受權成功後的回調地址
  • proxy_url:對應微信受權的代理服務地址(其做用可閱讀這篇文章瞭解)
  • device:區別是PC端微信登陸仍是移動端微信登陸,默認值爲pc,若是是移動端,可設置爲空
  • state_cookie_name:受權連接中會包含隨機的state參數,這個參數在微信回調的時候會原封不動的返回來,屆時可經過驗證state參數是否與受權連接中傳入的參數相同,來判斷請求是否有效,防止CSRF攻擊。這個方案,會在受權時把state參數先存到cookie裏面,因此這個參數用來指定這個state參數存入的cookie名稱,默認值是wx_state_cookie
  • state_cookie_time:指定wx_state_cookie的有效時長,默認是5分鐘

這七個參數有2種設置方式。數組

第一種是把這些參數以大寫的形式配置到.env配置文件裏面:微信

image

注:一、每一個配置項都是大寫,且以WEIXIN_開頭;二、前三個配置項與前面介紹的參數名稱不徹底一致,KEY對應client_id,SECRET對應client_secret,REDIRECT_URI對應redirect;三、其它的與前面介紹的參數名稱一致。cookie

第二種是把這些參數配置到config/services.php文件裏面去:併發

image

這種方式的配置,每一個配置項的名稱與前面介紹的一致。

要注意的內容:

  1. 因爲php_weixin_provider是基於laravel/socialite實現的,它要求必須配置client_id,client_secret和redirect,不然php_weixin_provider實例化過程就會出錯;對於client_id和client_secret,我認爲統一配置在一個地方是沒有問題的,可是對於redirect,若是統一配置,不必定符合全部場景的需求,由於不是每個用到微信登陸的地方,最後的回調地址都是同一個;因此建議把redirect先配置成一個有效或無效非空的回調地址;反正在後面使用php_weixin_provider的時候還能夠在調用的時候更改這個參數的值。
  2. proxy_url若是有,也建議配置在公共的地方;
  3. state_cookie_name和state_cookie_time因爲都有默認值,基本上無需從新配置;
  4. device能夠在使用的時候再指定。
  5. 全部配置參數均可以在使用的時候從新指定

3. 註冊php_weixin_provider

在項目的config/app.php文件裏面,找到providers配置節,把以下代碼加到它的配置數組裏面:

image

4. 註冊第三方登陸事件的監聽

在項目的app/Providers/EventServiceProvider.php裏面加入如下代碼:

image

laravel框架總體上是一種IOC跟事件驅動的思想,熟悉js就會對事件驅動很是熟悉,熟悉設計模式,就會對IOC(控制反轉,也稱爲DI:依賴注入)比較熟悉,這個是理解第3步和第4步配置做用的關鍵。

5. 編寫微信登陸的接口

舉例以下:

//採用代理跳轉,從PC端微信登陸
Route::get('/login', function () {
    return Socialite::with('weixin')
        ->setProxyUrl('http://proxy.your.com')
        ->setRedirectUrl(url('/login/notify'))
        ->redirect();
});

//採用代理跳轉,從手機端微信登陸
Route::get('/login2', function () {
    return Socialite::with('weixin')
        ->setProxyUrl('http://proxy.your.com')
        ->setDevice('')
        ->setRedirectUrl(url('/login/notify'))
        ->redirect();
});

//不採用代理跳轉,從PC端微信登陸
Route::get('/login', function () {
    return Socialite::with('weixin')
        ->setRedirectUrl(url('/login/notify'))
        ->redirect();
});

//不採用代理跳轉,從手機端微信登陸
Route::get('/login4', function () {
    return Socialite::with('weixin')
        ->setDevice('')
        ->setRedirectUrl(url('/login/notify'))
        ->redirect();
});

Socialite::with('weixin')會返回php_weixin_provider的實例,也就是它:

image

拿到這個實例以後,就能夠採用鏈式的方式調用它提供的全部public方法,好比設置配置參數,setDevice等等。

6. 編寫微信登陸回調的接口

舉例以下:

//登陸回調
Route::get('/login/notify', function () {
    $user = null;
    try {
        $user = Socialite::with('weixin')->user();
    } catch(\Exception $e) {
        return '獲取微信用戶異常';
    }

    return $user->nickname;
});

經過Socialite::with('weixin')拿到php_weixin_provider實例後,調用user方法,就會自動跟微信調用相關接口,並把微信的返回值封裝成對象返回。若是在此過程當中,有任何錯誤都會以異常的形式拋出,好比state參數校驗失敗,好比code失效等。

返回的$user對象包含的有效屬性有:

image

小結

這個方案是基於laravel/socialite實現,併發布到composer來使用的。laravel/socialite是laravel官方提供的第三方登陸的模塊,基於它能夠很方便的集成大部分第三方平臺的認證,目前它官方已經提供不少第三方的登陸實現:https://socialiteproviders.github.io/。除了國外的facebook,google,github等,國內的微信,微博,qq也都有提供。我在一開始也用的是它官方提供的默認的微信登陸provider來作的,可是後來我發現瞭如下幾個問題:

1. 不支持微信受權的代理;

2. pc端跟移動端居然仍是分兩個項目來作的:
image

3. 它封裝的user對象里居然不包含unionid

4. 更改配置參數的方式,實在是讓人以爲難以使用:
image

因此我就在它官方的微信登陸provider基礎上,按照本身的想法,從新實現了一個來解決我發現的這些問題。

相關文章
相關標籤/搜索