一、摘要

微信公眾平臺(tái)提供了一個(gè)簡(jiǎn)單的php示例代碼，在做進(jìn)一步開發(fā)之前，我們有必要將其詳細(xì)了解一下。

二、獲取代碼

微信官網(wǎng)：http://xiazai.jb51.net/201612/yuanma/phpwxsample(jb51.net).rar

三、分析代碼

完整代碼如下：

<?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 整體分析

原始示例代碼大致分為四個(gè)部分：

定義TOKEN
聲明一個(gè)類 wechatCallbackapiTest
創(chuàng)建類wechatCallbackapiTest 的一個(gè)實(shí)例對(duì)象 $wechatObj
調(diào)用類的 valid() 方法。

3.2 詳細(xì)分析

3.2.1 定義TOKEN

define("TOKEN", "weixin");

define 是用來(lái)給常量賦值的函數(shù)，這句話的意思是賦予“TOKEN”這個(gè)常量值為“weixin”。

TOKEN 是用來(lái)進(jìn)行交互安全認(rèn)證的，開發(fā)者可以隨意定義，要和公眾平臺(tái)里設(shè)置的一樣。

3.2.2 聲明一個(gè)類

class wechatCallbackapiTest{

}

聲明一個(gè)類 wechatCallbackapiTest，該類中包含有三個(gè)方法（函數(shù)）。

a. public function valid()

用于申請(qǐng) 成為開發(fā)者 時(shí)向微信發(fā)送驗(yàn)證信息。

b. public function responseMsg()

處理并回復(fù)用戶發(fā)送過(guò)來(lái)的消息，也是用的最多的一個(gè)函數(shù)，幾乎所有的功能都在這里實(shí)現(xiàn)。

responseMsg 函數(shù)詳解：

$postStr = $GLOBALS["HTTP_RAW_POST_DATA"];
接收微信公眾平臺(tái)發(fā)送過(guò)來(lái)的用戶消息，該消息數(shù)據(jù)結(jié)構(gòu)為XML，不是php默認(rèn)的識(shí)別數(shù)據(jù)類型，因此這里用了$GLOBALS['HTTP_RAW_POST_DATA']來(lái)接收，同時(shí)賦值給了$postStr

if (!empty($postStr))
判斷$postStr是否為空，如果不為空（接收到了數(shù)據(jù)），就繼續(xù)執(zhí)行下面的語(yǔ)句;如果為空，則跳轉(zhuǎn)到與之相對(duì)應(yīng)的else語(yǔ)句。

$postObj = simplexml_load_string($postStr, 'SimpleXMLElement', LIBXML_NOCDATA);
使用simplexml_load_string() 函數(shù)將接收到的XML消息數(shù)據(jù)載入對(duì)象$postObj中。這個(gè)嚴(yán)謹(jǐn)?shù)膶懛ê竺孢€得加個(gè)判斷是否載入成功的條件語(yǔ)句，不過(guò)不寫也沒(méi)事。

$fromUsername = $postObj->FromUserName;
將對(duì)象$postObj中的發(fā)送消息用戶的OPENID賦值給$fromUsername變量

$toUsername = $postObj->ToUserName;
將對(duì)象$postObj中的公眾賬號(hào)的ID賦值給$toUsername變量

$keyword = trim($postObj->Content);
trim() 函數(shù)從字符串的兩端刪除空白字符和其他預(yù)定義字符，這里就可以得到用戶輸入的關(guān)鍵詞

$time = time();
time() 函數(shù)返回當(dāng)前時(shí)間的 Unix 時(shí)間戳，即自從 Unix 紀(jì)元（格林威治時(shí)間 1970 年 1 月 1 日 00:00:00）到當(dāng)前時(shí)間的秒數(shù)。

$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>";

存放微信輸出內(nèi)容的模板

if(!empty( $keyword ))

判斷$keyword是否為空，不為空則繼續(xù)執(zhí)行下面的語(yǔ)句;如果為空，則跳轉(zhuǎn)到與之相對(duì)應(yīng)的else語(yǔ)句，即 echo "Input something...";

$msgType = "text";

消息類型是文本類型

$contentStr = "Welcome to wechat world!";

回復(fù)的消息內(nèi)容

$resultStr = sprintf($textTpl, $fromUsername, $toUsername, $time, $msgType, $contentStr);

使用sprintf() 函數(shù)將格式化的數(shù)據(jù)寫入到變量中去;
$fromUsername, $toUsername, $time, $msgType, $contentStr 分別順序替換模板里“%s”位置，也即是“$resultStr”這個(gè)變量最后實(shí)際為：

<xml>
<ToUserName><![CDATA[$toUsername]]></ToUserName>
<FromUserName><![CDATA[$fromUsername]]></FromUserName>
<CreateTime>$time</CreateTime>
<MsgType><![CDATA[$msgType]]></MsgType>
<Content><![CDATA[$contentStr]]></Content>
<FuncFlag>0</FuncFlag>  //位0x0001被標(biāo)志時(shí)，星標(biāo)剛收到的消息。
</xml>

echo $resultStr;     //把回復(fù)的消息輸出

c. private function checkSignature()

開發(fā)者通過(guò)檢驗(yàn)signature對(duì)請(qǐng)求進(jìn)行校驗(yàn)（下面有校驗(yàn)方式）。若確認(rèn)此次GET請(qǐng)求來(lái)自微信服務(wù)器，請(qǐng)求原樣返回echostr參數(shù)內(nèi)容，則接入生效，否則接入失敗。

signature結(jié)合了開發(fā)者填寫的token參數(shù)和請(qǐng)求中的timestamp參數(shù)、nonce參數(shù)。

加密/校驗(yàn)流程：
1. 將token、timestamp、nonce三個(gè)參數(shù)進(jìn)行字典序排序
2. 將三個(gè)參數(shù)字符串拼接成一個(gè)字符串進(jìn)行sha1加密
3. 開發(fā)者獲得加密后的字符串可與signature對(duì)比，標(biāo)識(shí)該請(qǐng)求來(lái)源于微信
3.2.3 創(chuàng)建實(shí)例對(duì)象

$wechatObj = new wechatCallbackapiTest();

3.2.4 調(diào)用類方法驗(yàn)證

$wechatObj->valid();

調(diào)用類的valid()方法執(zhí)行接口驗(yàn)證，接口設(shè)置成功后將其注釋掉。

四、總結(jié)

以上是對(duì)微信官方示例代碼的一個(gè)分析，有解釋不對(duì)的地方，還請(qǐng)高手指出。另外，該代碼只是官方給出的簡(jiǎn)單示例代碼，如果要做復(fù)雜的開發(fā)，還是要求開發(fā)者按照嚴(yán)謹(jǐn)?shù)拈_發(fā)模式改寫該段代碼，會(huì)在后續(xù)教程中娓娓道來(lái)。

五、參考

微信官方公眾平臺(tái)API文檔：http://mp.weixin.qq.com/wiki/index.php

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論