PHP實現支付寶小程式使用者授權的工具類

crelaber發表於2019-02-16

PHP

背景

最近專案需要上線支付寶小程式，同時需要走使用者的授權流程完成使用者資訊的儲存，以前做過微信小程式的開發，本以為實現授權的過程是很簡單的事情，但是再實現的過程中還是遇到了不少的坑，因此記錄一下實現的過程

學到的知識

支付寶開放介面的呼叫模式以及實現方式
支付寶小程式授權的流程
RSA加密方式

吐槽點

支付寶小程式的入口隱藏的很深，沒有微信小程式那麼直接了當
支付寶小程式的開發者工具比較難用，編譯時候比較卡，效能有很大的問題
每提交一次程式碼，支付寶小程式的體驗碼都要進行更換，比較繁瑣，而且localStorage的東西不知道要如何刪除

事先準備

到支付寶開放平臺註冊一個開發者賬號，並做好相應的認證等工作
建立一個小程式，並記錄好相關的小程式資訊，包括支付寶公鑰，私鑰，app公鑰等，可以借鑑支付寶官方提供的相應的公鑰生成工具來生成公鑰和私鑰，工具的下載地址：傳送門
瞭解下支付寶小程式的簽名機制,詳細見docs.open.alipay.com/291/105974
熟悉下支付寶小程式獲取使用者資訊的過程，詳細見支付寶小程式使用者授權指引

授權的步驟

授權時序圖

實現流程

客戶端通過my.getAuthCode介面獲取code，傳給服務端
服務端通過code，呼叫獲取token介面獲取access_token，alipay.system.oauth.token(換取授權訪問令牌)
通過token介面呼叫支付寶會員查詢介面獲取會員資訊，alipay.user.info.share(支付寶會員授權資訊查詢介面)
將獲取的使用者資訊儲存到資料庫

AmpHelper工具類

<?php
/**
 * Created by PhpStorm.
 * User: My
 * Date: 2018/8/16
 * Time: 17:45
 */

namespace App\Http\Helper;

use App\Http\Helper\Sys\BusinessHelper;
use Illuminate\Support\Facades\Log;

class AmpHelper
{

    const API_DOMAIN = "https://openapi.alipay.com/gateway.do?";
    const API_METHOD_GENERATE_QR = 'alipay.open.app.qrcode.create';
    const API_METHOD_AUTH_TOKEN = 'alipay.system.oauth.token';
    const API_METHOD_GET_USER_INFO = 'alipay.user.info.share';

    const SIGN_TYPE_RSA2 = 'RSA2';
    const VERSION = '1.0';
    const FILE_CHARSET_UTF8 = "UTF-8";
    const FILE_CHARSET_GBK = "GBK";
    const RESPONSE_OUTER_NODE_QR = 'alipay_open_app_qrcode_create_response';
    const RESPONSE_OUTER_NODE_AUTH_TOKEN = 'alipay_system_oauth_token_response';
    const RESPONSE_OUTER_NODE_USER_INFO = 'alipay_user_info_share_response';
    const RESPONSE_OUTER_NODE_ERROR_RESPONSE = 'error_response';

    const STATUS_CODE_SUCCESS = 10000;
    const STATUS_CODE_EXCEPT = 20000;


    /**
     * 獲取使用者資訊介面，根據token
     * @param $code 授權碼
     * 通過授權碼獲取使用者的資訊
     */
    public static function getAmpUserInfoByAuthCode($code){
        $aliUserInfo = [];
        $tokenData = AmpHelper::getAmpToken($code);
        //如果token不存在，這種主要是為了處理支付寶的異常記錄
        if(isset($tokenData['code'])){
            return $tokenData;
        }
        $token = formatArrValue($tokenData,'access_token');
        if($token){
            $userBusiParam = self::getAmpUserBaseParam($token);
            $url = self::buildRequestUrl($userBusiParam);
            $resonse = self::getResponse($url,self::RESPONSE_OUTER_NODE_USER_INFO);
            if($resonse['code'] == self::STATUS_CODE_SUCCESS){
                //有效的欄位列
                $userInfoColumn = ['user_id','avatar','province','city','nick_name','is_student_certified','user_type','user_status','is_certified','gender'];
                foreach ($userInfoColumn as $column){
                    $aliUserInfo[$column] = formatArrValue($resonse,$column,'');
                }

            }else{
                $exceptColumns = ['code','msg','sub_code','sub_msg'];
                foreach ($exceptColumns as $column){
                    $aliUserInfo[$column] = formatArrValue($resonse,$column,'');
                }
            }
        }
        return $aliUserInfo;
    }


    /**
     * 獲取小程式token介面
     */
    public static function getAmpToken($code){
        $param = self::getAuthBaseParam($code);
        $url = self::buildRequestUrl($param);
        $response = self::getResponse($url,self::RESPONSE_OUTER_NODE_AUTH_TOKEN);
        $tokenResult = [];
        if(isset($response['code']) && $response['code'] != self::STATUS_CODE_SUCCESS){
            $exceptColumns = ['code','msg','sub_code','sub_msg'];
            foreach ($exceptColumns as $column){
                $tokenResult[$column] = formatArrValue($response,$column,'');
            }
        }else{
            $tokenResult = $response;
        }
        return $tokenResult;
    }

    /**
     * 獲取二維碼連結介面
     * 433ac5ea4c044378826afe1532bcVX78
     * https://openapi.alipay.com/gateway.do?timestamp=2013-01-01 08:08:08&method=alipay.open.app.qrcode.create&app_id=2893&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0&biz_content=
    {"url_param":"/index.html?name=ali&loc=hz", "query_param":"name=1&age=2", "describe":"二維碼描述"}
    */
    public static function generateQrCode($mpPage = 'pages/index',$queryParam = [],$describe){
        $param = self::getQrcodeBaseParam($mpPage,$queryParam,$describe );
        $url = self::buildRequestUrl($param);
        $response = self::getResponse($url,self::RESPONSE_OUTER_NODE_QR);
        return $response;
    }


    /**
     * 獲取返回的資料，對返回的結果做進一步的封裝和解析,因為支付寶的每個介面的返回都是由一個特定的    
     * key組成的，因此這裡直接封裝了而一個通用的方法，對於不同的介面只需要更改相應的node節點就可以了
     */
    public static function getResponse($url,$responseNode){
        $json = curlRequest($url);
        $response = json_decode($json,true);
        $responseContent = formatArrValue($response,$responseNode,[]);
        $errResponse = formatArrValue($response,self::RESPONSE_OUTER_NODE_ERROR_RESPONSE,[]);
        if($errResponse){
            return $errResponse;
        }
        return $responseContent;
    }

    /**
     * 獲取請求的連結
     */
    public static function buildQrRequestUrl($mpPage = 'pages/index',$queryParam = []){
        $paramStr = http_build_query(self::getQrBaseParam($mpPage,$queryParam));
        return self::API_DOMAIN . $paramStr;
    }



    /**
     * 構建請求連結
     */
    public static function buildRequestUrl($param){
        $paramStr = http_build_query($param);
        return self::API_DOMAIN . $paramStr;
    }


    /**
     * 獲取使用者的基礎資訊介面
     */
    public static function getAmpUserBaseParam($token){
        $busiParam = [
            'auth_token' => $token,
        ];
        $param = self::buildApiBuisinessParam($busiParam,self::API_METHOD_GET_USER_INFO);
        return $param;

    }

    /**
     *獲取二維碼的基礎引數
     */
    public static function getQrcodeBaseParam($page= 'pages/index/index',$queryParam = [],$describe = ''){
        $busiParam = [
            'biz_content' => self::getQrBizContent($page,$queryParam,$describe)
        ];
        $param = self::buildApiBuisinessParam($busiParam,self::API_METHOD_GENERATE_QR);
        return $param;

    }

    /**
     *獲取授權的基礎引數
     */
    public static function getAuthBaseParam($code,$refreshToken = ''){
        $busiParam = [
            'grant_type' => 'authorization_code',
            'code' => $code,
            'refresh_token' => $refreshToken,
        ];
        $param = self::buildApiBuisinessParam($busiParam,self::API_METHOD_AUTH_TOKEN);
        return $param;
    }


    /**
     * 構建業務引數
     */
    public static function buildApiBuisinessParam($businessParam,$apiMethod){
        $pubParam = self::getApiPubParam($apiMethod);
        $businessParam = array_merge($pubParam,$businessParam);
        $signContent = self::getSignContent($businessParam);
        error_log('sign_content ===========>'.$signContent);
        $rsaHelper = new RsaHelper();
        $sign = $rsaHelper->createSign($signContent);
        error_log('sign ===========>'.$sign);
        $businessParam['sign'] = $sign;
        return $businessParam;
    }


    /**
     * 公共引數
     *
     */
    public static function getApiPubParam($apiMethod){
        $ampBaseInfo = BusinessHelper::getAmpBaseInfo();
        $param = [
            'timestamp' => date('Y-m-d H:i:s') ,
            'method' => $apiMethod,
            'app_id' => formatArrValue($ampBaseInfo,'appid',config('param.amp.appid')),
            'sign_type' =>self::SIGN_TYPE_RSA2,
            'charset' =>self::FILE_CHARSET_UTF8,
            'version' =>self::VERSION,
        ];
        return $param;
    }


    /**
     * 獲取簽名的內容
     */
    public static function getSignContent($params) {
        ksort($params);
        $stringToBeSigned = "";
        $i = 0;
        foreach ($params as $k => $v) {
            if (!empty($v) && "@" != substr($v, 0, 1)) {
                if ($i == 0) {
                    $stringToBeSigned .= "$k" . "=" . "$v";
                } else {
                    $stringToBeSigned .= "&" . "$k" . "=" . "$v";
                }
                $i++;
            }
        }
        unset ($k, $v);
        return $stringToBeSigned;
    }


    public static function convertArrToQueryParam($param){
        $queryParam = [];
        foreach ($param as $key => $val){
            $obj = $key.'='.$val;
            array_push($queryParam,$obj);
        }
        $queryStr = implode('&',$queryParam);
        return $queryStr;
    }

    /**
     * 轉換字符集編碼
     * @param $data
     * @param $targetCharset
     * @return string
     */
    public static function characet($data, $targetCharset) {
        if (!empty($data)) {
            $fileType = self::FILE_CHARSET_UTF8;
            if (strcasecmp($fileType, $targetCharset) != 0) {
                $data = mb_convert_encoding($data, $targetCharset, $fileType);
            }
        }
        return $data;
    }

    /**
     * 獲取業務引數內容
     */
    public static function getQrBizContent($page, $queryParam = [],$describe = ''){
        if(is_array($queryParam)){
            $queryParam = http_build_query($queryParam);
        }
        $obj = [
            'url_param' => $page,
            'query_param' => $queryParam,
            'describe' => $describe
        ];
        $bizContent = json_encode($obj,JSON_UNESCAPED_UNICODE);
        return $bizContent;
    }

}複製程式碼

AmpHeler工具類關鍵程式碼解析

getAmpUserInfoByAuthCode方法

這個方法是獲取使用者資訊的介面方法，只需要傳入客戶端傳遞的code，就可以獲取到使用者的完整資訊

getAmpToken方法

這個方法是獲取支付寶介面的token的方法，是一個公用方法，後面所有的支付寶的口呼叫，都可以使用這個方法先獲取token

getResponse方法

考慮到會呼叫各個支付寶的介面，因此這裡封裝這個方法是為了方便擷取介面返回成功之後的資訊，提高程式碼的閱讀性

getApiPubParam方法

這個方法是為了獲取公共的引數，包括版本號，編碼，appid，簽名型別等基礎業務引數

getSignContent方法

這個方法是獲取簽名的內容，入參是一個陣列，最後輸出的是引數的拼接字串

buildApiBuisinessParam(businessParam,apiMethod)

這個是構建api獨立的業務引數部分方法，businessParam引數是支付寶各個介面的業務引數部分（出去公共引數），$apiMethod是對應的介面的方法名稱，如獲取token的方法名為alipay.system.oauth.token

簽名幫助類

<?php
/**
 * Created by PhpStorm.
 * User: Auser
 * Date: 2018/12/4
 * Time: 15:37
 */

namespace App\Http\Helper;

/**
 *$rsa2 = new Rsa2();
 *$data = 'mydata'; //待簽名字串
 *$strSign = $rsa2->createSign($data);      //生成簽名
 *$is_ok = $rsa2->verifySign($data, $strSign); //驗證簽名
 */
class RsaHelper
{

    private static $PRIVATE_KEY;
    private static $PUBLIC_KEY;


    function __construct(){
        self::$PRIVATE_KEY = config('param.amp.private_key');
        self::$PUBLIC_KEY = config('param.amp.public_key');
    }

    /**
     * 獲取私鑰
     * @return bool|resource
     */
    private static function getPrivateKey()
    {
        $privKey = self::$PRIVATE_KEY;
        $privKey = "-----BEGIN RSA PRIVATE KEY-----".PHP_EOL.wordwrap($privKey, 64, PHP_EOL, true).PHP_EOL."-----END RSA PRIVATE KEY-----";
        ($privKey) or die('您使用的私鑰格式錯誤，請檢查RSA私鑰配置');
        error_log('private_key is ===========>: '.$privKey);
        return openssl_pkey_get_private($privKey);
    }
    /**
     * 獲取公鑰
     * @return bool|resource
     */
    private static function getPublicKey()
    {
        $publicKey = self::$PUBLIC_KEY;
        $publicKey = "-----BEGIN RSA PRIVATE KEY-----".PHP_EOL.wordwrap($publicKey, 64, PHP_EOL, true).PHP_EOL."-----END RSA PRIVATE KEY-----";
        error_log('public key is : ===========>'.$publicKey);
        return openssl_pkey_get_public($publicKey);
    }
    /**
     * 建立簽名
     * @param string $data 資料
     * @return null|string
     */
    public function createSign($data = '')
    {
        //  var_dump(self::getPrivateKey());die;
        if (!is_string($data)) {
            return null;
        }
        return openssl_sign($data, $sign, self::getPrivateKey(),OPENSSL_ALGO_SHA256 ) ? base64_encode($sign) : null;
    }
    /**
     * 驗證簽名
     * @param string $data 資料
     * @param string $sign 簽名
     * @return bool
     */
    public function verifySign($data = '', $sign = '')
    {
        if (!is_string($sign) || !is_string($sign)) {
            return false;
        }
        return (bool)openssl_verify(
            $data,
            base64_decode($sign),
            self::getPublicKey(),
            OPENSSL_ALGO_SHA256
        );
    }
}複製程式碼

呼叫

$originUserData = AmpHelper::getAmpUserInfoByAuthCode($code);
echo $originUserData;複製程式碼

注意getAmpUserInfoByAuthCode方法，呼叫介面成功，會返回支付寶使用者的正確資訊，示例如下

{
    "alipay_user_info_share_response": {
        "code": "10000",
        "msg": "Success",
        "user_id": "2088102104794936",
        "avatar": "http://tfsimg.alipay.com/images/partner/T1uIxXXbpXXXXXXXX",
        "province": "安徽省",
        "city": "安慶",
        "nick_name": "支付寶小二",
        "is_student_certified": "T",
        "user_type": "1",
        "user_status": "T",
        "is_certified": "T",
        "gender": "F"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}複製程式碼

踩坑點

在開發之前一定要仔細閱讀使用者的授權流程指引文件，否則很容出錯
對於使用者資訊介面，在獲取授權資訊介面並沒有做明確的說明，所以需要先梳理清楚
支付寶的簽名機制和微信的有很大不同，對於習慣了微信小程式開發的人來說，剛開始可能有點不適應，所以需要多看看sdk裡面的實現

IDEA基於支付寶小程式之授權篇
2019-05-04
Idea
支付寶小程式（後臺）---獲取授權和使用者資訊
2018-12-12
IDEA支付寶小程式開發流程——授權登入
2019-01-04
Idea
支付寶怎麼刪除已授權應用？支付寶刪除已授權應用的方法
2019-11-04
微信，支付寶小程式實現原理概述
2019-03-24
Shiro實現使用者授權
2024-05-18
PHP框架中使用者認證和授權的實現方法與示例
2024-07-31
PHP框架
微信小程式結合php後臺實現登入授權機制詳解
2023-03-04
微信小程式PHP
微信小程式——授權
2018-12-24
微信小程式
支付寶小程式效能分析
2021-10-15
支付寶小程式橫屏電子版簽字，canvas實現
2022-04-14
Canvas
IDEA支付寶小程式開發流程——支付
2019-01-14
Idea
pc端實現支付寶支付
2022-11-03
JAVA接入支付寶授權第三方登入
2021-07-07
Java
關於微信小程式使用者拒絕授權後不再彈出授權視窗
2018-08-22
微信小程式
支付寶小程式對比微信小程式
2018-10-15
微信小程式
Keycloak中授權的實現
2024-04-13
如何使用PHP進行OAuth2授權流程的實現
2024-11-10
PHPOAuth
微信小程式授權登入最佳實踐
2018-07-22
微信小程式
微信小程式的授權登入
2018-09-15
微信小程式
10行程式碼實現微信小程式支付功能，使用小程式雲開發實現小程式支付功能（
2021-09-09
行程微信小程式
SpringSecurity(1)---認證+授權程式碼實現
2020-06-03
SpringGse
php微信支付介面開發的實現程式
2018-08-20
PHP
# 支付寶小程式微信小程式分享轉發
2019-04-11
微信小程式
支付寶新版介面曝光：支付寶小程式或迎來重磅入口
2019-01-07
微信小程式授權過程
2020-10-09
微信小程式
微信小程式授權登入獲取使用者資訊
2020-12-10
微信小程式
express基於JWT實現使用者登陸授權
2019-05-08
ExpressJWT
SSM 實現支付寶支付功能（圖文詳解+完整程式碼）
2019-05-15
SSM
接入支付寶小程式能力，人人租機實現從 0-100 增長
2019-12-04
接入支付寶小程式能力人人租機實現從 0-100 增長
2019-12-04
原生 PHP 實現支付寶 App 第三方登入獲取使用者資訊
2019-06-20
PHPAPP
小程式獲取使用者位置資訊後再次手動授權
2019-04-09
基於 golang 的支付寶支付小案例
2021-07-14
Golang
php 小程式服務商支付模式
2020-10-19
PHP模式
求問關於Paypal預授權支付php-sdk相關功能
2021-09-07
PHP
PHP-Laravel支付寶支付和微信支付
2022-07-26
PHPLaravel
擼一個小程式前置授權元件
2018-07-31
元件