【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