2.PHP微信公眾平臺開發(二) 公眾平臺示例程式碼分

發表於2019-05-11

【PHP微信公眾平臺開發系列】
01.配置微信介面
02.公眾平臺示例程式碼分析
 

本文地址:http://www.phpchina.com/archives/view-43358-1.html
本系列由PHPChina特邀作者@David_Tang供稿,轉載請註明作者資訊與本文地址。


一、摘要
微信公眾平臺提供了一個簡單的php示例程式碼,在做進一步開發之前,我們有必要將其詳細瞭解一下。
二、獲取程式碼
微信官網:http://mp.weixin.qq.com/mpres/htmledition/res/wx_sample.zip
三、分析程式碼
完整程式碼如下:

<?php /**
  * wechat php test */ //define your token define("TOKEN", "weixin"); $wechatObj = new wechatCallbackapiTest(); $wechatObj->valid(); class wechatCallbackapiTest
{ public function valid()
    { $echoStr = $_GET["echostr"]; //valid signature , option if($this->checkSignature()){ echo $echoStr; exit;
        }
    } public function responseMsg()
    { //get post data, May be due to the different environments $postStr = $GLOBALS["HTTP_RAW_POST_DATA"]; //extract post data if (!empty($postStr)){ $postObj = simplexml_load_string($postStr, 'SimpleXMLElement', LIBXML_NOCDATA); $fromUsername = $postObj->FromUserName; $toUsername = $postObj->ToUserName; $keyword = trim($postObj->Content); $time = time(); $textTpl = "<xml>
                            <ToUserName><![CDATA[%s]]></ToUserName>
                            <FromUserName><![CDATA[%s]]></FromUserName>
                            <CreateTime>%s</CreateTime>
                            <MsgType><![CDATA[%s]]></MsgType>
                            <Content><![CDATA[%s]]></Content>
                            <FuncFlag>0</FuncFlag>
                            </xml>"; if(!empty( $keyword ))
                { $msgType = "text"; $contentStr = "Welcome to wechat world!"; $resultStr = sprintf($textTpl, $fromUsername, $toUsername, $time, $msgType, $contentStr); echo $resultStr;
                }else{ echo "Input something...";
                }

        }else { echo ""; exit;
        }
    } private function checkSignature()
    { $signature = $_GET["signature"]; $timestamp = $_GET["timestamp"]; $nonce = $_GET["nonce"]; $token = TOKEN; $tmpArr = array($token, $timestamp, $nonce); sort($tmpArr); $tmpStr = implode( $tmpArr ); $tmpStr = sha1( $tmpStr ); if( $tmpStr == $signature ){ return true;
        }else{ return false;
        }
    }
} ?>


3.1 整體分析
原始示例程式碼大致分為四個部分:
  • 定義TOKEN
  • 宣告一個類 wechatCallbackapiTest
  • 建立類wechatCallbackapiTest 的一個例項物件 $wechatObj
  • 呼叫類的 valid() 方法。
3.2 詳細分析
3.2.1 定義TOKEN
define("TOKEN", "weixin");
define 是用來給常量賦值的函式,這句話的意思是賦予“TOKEN”這個常量值為“weixin”。
TOKEN 是用來進行互動安全認證的,開發者可以隨意定義,要和公眾平臺裡設定的一樣。
3.2.2 宣告一個類
class wechatCallbackapiTest{
}
宣告一個類 wechatCallbackapiTest,該類中包含有三個方法(函式)。
a. public function valid()
用於申請 成為開發者 時向微信傳送驗證資訊。
b. public function responseMsg()
處理並回複使用者傳送過來的訊息,也是用的最多的一個函式,幾乎所有的功能都在這裡實現。

responseMsg 函式詳解: $postStr = $GLOBALS["HTTP_RAW_POST_DATA"]; 接收微信公眾平臺傳送過來的使用者訊息,該訊息資料結構為XML,不是php預設的識別資料型別,因此這裡用了$GLOBALS['HTTP_RAW_POST_DATA']來接收,同時賦值給了$postStr

if (!empty($postStr))
判斷$postStr是否為空,如果不為空(接收到了資料),就繼續執行下面的語句;如果為空,則跳轉到與之相對應的else語句。

$postObj = simplexml_load_string($postStr, 'SimpleXMLElement', LIBXML_NOCDATA);
使用simplexml_load_string() 函式將接收到的XML訊息資料載入物件$postObj中。這個嚴謹的寫法後面還得加個判斷是否載入成功的條件語句,不過不寫也沒事。

$fromUsername = $postObj->FromUserName;
將物件$postObj中的傳送訊息使用者的OPENID賦值給$fromUsername變數

$toUsername = $postObj->ToUserName;
將物件$postObj中的公眾賬號的ID賦值給$toUsername變數

$keyword = trim($postObj->Content);
trim() 函式從字串的兩端刪除空白字元和其他預定義字元,這裡就可以得到使用者輸入的關鍵詞

$time = time();
time() 函式返回當前時間的 Unix 時間戳,即自從 Unix 紀元(格林威治時間 1970 年 1 月 1 日 00:00:00)到當前時間的秒數。

$textTpl = "<xml>        <ToUserName><![CDATA[%s]]></ToUserName>
       <FromUserName><![CDATA[%s]]></FromUserName>
        <CreateTime>%s</CreateTime>
       <MsgType><![CDATA[%s]]></MsgType>
       <Content><![CDATA[%s]]></Content>
       <FuncFlag>0</FuncFlag>
       </xml>";
存放微信輸出內容的模板

if(!empty( $keyword ))
判斷$keyword是否為空,不為空則繼續執行下面的語句;如果為空,則跳轉到與之相對應的else語句,即 echo "Input something...";

$msgType = "text";
訊息型別是文字型別

$contentStr = "Welcome to wechat world!";
回覆的訊息內容

$resultStr = sprintf($textTpl, $fromUsername, $toUsername, $time, $msgType, $contentStr);
使用sprintf() 函式將格式化的資料寫入到變數中去;
$fromUsername, $toUsername, $time, $msgType, $contentStr 分別順序替換模板裡“%s”位置,也即是“$resultStr”這個變數最後實際為:
<xml>
<ToUserName><![CDATA[$toUsername]]></ToUserName>
<FromUserName><![CDATA[$fromUsername]]></FromUserName>
<CreateTime>$time</CreateTime>
<MsgType><![CDATA[$msgType]]></MsgType>
<Content><![CDATA[$contentStr]]></Content>
<FuncFlag>0</FuncFlag>      //位0x0001被標誌時,星標剛收到的訊息。
</xml>
echo $resultStr;     //把回覆的訊息輸出
c. private function checkSignature()
開發者通過檢驗signature對請求進行校驗(下面有校驗方式)。若確認此次GET請求來自微信伺服器,請求原樣返回echostr引數內容,則接入生效,否則接入失敗。
signature結合了開發者填寫的token引數和請求中的timestamp引數、nonce引數。
加密/校驗流程:
1. 將token、timestamp、nonce三個引數進行字典序排序
2. 將三個引數字串拼接成一個字串進行sha1加密
3. 開發者獲得加密後的字串可與signature對比,標識該請求來源於微信

3.2.3 建立例項物件
$wechatObj = new wechatCallbackapiTest();
3.2.4 呼叫類方法驗證
$wechatObj->valid();
呼叫類的valid()方法執行介面驗證,介面設定成功後將其註釋掉。
四、總結
以上是對微信官方示例程式碼的一個分析,有解釋不對的地方,還請高手指出。另外,該程式碼只是官方給出的簡單示例程式碼,如果要做複雜的開發,還是要求開發者按照嚴謹的開發模式改寫該段程式碼,會在後續教程中娓娓道來。
五、參考
微信官方公眾平臺API文件:http://mp.weixin.qq.com/wiki/index.php
評論(2)

相關文章