微信公众平台开发(二) 微信公众平台示例代码分析
[导读] 一、摘要微信公众平台提供了一个简单的php示例代码,在做进一步开发之前,我们有必要将其详细了解一下。二、获取代码微信官网:http: mp weixin qq com mpres htmledition res wx_sample zip三、分析代码完整代
一、摘要
微信公众平台提供了一个简单的php示例代码,在做进一步开发之前,我们有必要将其详细了解一下。
二、获取代码
微信官网:http://mp.weixin.qq.com/mpres/htmledition/res/wx_sample.zip
三、分析代码
完整代码如下:
01.
<?php
02.
/**
03.
* wechat php test
04.
*/
05.
06.
//define your token
07.
define(
"TOKEN"
,
"weixin"
);
08.
$wechatObj
=
new
wechatCallbackapiTest();
09.
$wechatObj
->valid();
10.
11.
class
wechatCallbackapiTest
12.
{
13.
public
function
valid()
14.
{
15.
$echoStr
=
$_GET
[
"echostr"
];
16.
17.
//valid signature , option
18.
if
(
$this
->checkSignature()){
19.
echo
$echoStr
;
20.
exit
;
21.
}
22.
}
23.
24.
public
function
responseMsg()
25.
{
26.
//get post data, May be due to the different environments
27.
$postStr
=
$GLOBALS
[
"HTTP_RAW_POST_DATA"
];
28.
29.
//extract post data
30.
if
(!
empty
empty
(
$postStr
)){
31.
32.
$postObj
= simplexml_load_string(
$postStr
,
'SimpleXMLElement'
, LIBXML_NOCDATA);
33.
$fromUsername
=
$postObj
->FromUserName;
34.
$toUsername
=
$postObj
->ToUserName;
35.
$keyword
= trim(
$postObj
->Content);
36.
$time
= time();
37.
$textTpl
= "<xml>
38.
<ToUserName><![CDATA[%s]]></ToUserName>
39.
<FromUserName><![CDATA[%s]]></FromUserName>
40.
<CreateTime>%s</CreateTime>
41.
<MsgType><![CDATA[%s]]></MsgType>
42.
<Content><![CDATA[%s]]></Content>
43.
<FuncFlag>0</FuncFlag>
44.
</xml>";
45.
if
(!
empty
empty
(
$keyword
))
46.
{
47.
$msgType
=
"text"
;
48.
$contentStr
=
"Welcome to wechat world!"
;
49.
$resultStr
= sprintf(
$textTpl
,
$fromUsername
,
$toUsername
,
$time
,
$msgType
,
$contentStr
);
50.
echo
$resultStr
;
51.
}
else
{
52.
echo
"Input something..."
;
53.
}
54.
55.
}
else
{
56.
echo
""
;
57.
exit
;
58.
}
59.
}
60.
61.
private
function
checkSignature()
62.
{
63.
$signature
=
$_GET
[
"signature"
];
64.
$timestamp
=
$_GET
[
"timestamp"
];
65.
$nonce
=
$_GET
[
"nonce"
];
66.
67.
$token
= TOKEN;
68.
$tmpArr
=
array
(
$token
,
$timestamp
,
$nonce
);
69.
sort(
$tmpArr
);
70.
$tmpStr
= implode(
$tmpArr
);
71.
$tmpStr
= sha1(
$tmpStr
);
72.
73.
if
(
$tmpStr
==
$signature
){
74.
return
true;
75.
}
else
{
76.
return
false;
77.
}
78.
}
79.
}
80.
81.
?>
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()
处理并回复用户发送过来的消息,也是用的最多的一个函数,几乎所有的功能都在这里实现。
01.
responseMsg 函数详解:
02.
03.
$postStr = $GLOBALS["HTTP_RAW_POST_DATA"];
04.
接收微信公众平台发送过来的用户消息,该消息数据结构为XML,不是php默认的识别数据类型,因此这里用了$GLOBALS['HTTP_RAW_POST_DATA']来接收,同时赋值给了$postStr
05.
06.
if (!empty($postStr))
07.
判断$postStr是否为空,如果不为空(接收到了数据),就继续执行下面的语句;如果为空,则跳转到与之相对应的else语句。
08.
09.
$postObj = simplexml_load_string($postStr, 'SimpleXMLElement', LIBXML_NOCDATA);
10.
使用simplexml_load_string() 函数将接收到的XML消息数据载入对象$postObj中。这个严谨的写法后面还得加个判断是否载入成功的条件语句,不过不写也没事。
11.
12.
$fromUsername = $postObj->FromUserName;
13.
将对象$postObj中的发送消息用户的OPENID赋值给$fromUsername变量
14.
15.
$toUsername = $postObj->ToUserName;
16.
将对象$postObj中的公众账号的ID赋值给$toUsername变量
17.
18.
$keyword = trim($postObj->Content);
19.
trim() 函数从字符串的两端删除空白字符和其他预定义字符,这里就可以得到用户输入的关键词
20.
21.
$time = time();
22.
time() 函数返回当前时间的 Unix 时间戳,即自从 Unix 纪元(格林威治时间 1970 年 1 月 1 日 00:00:00)到当前时间的秒数。
23.
24.
$textTpl = "<
xml
>
25.
<
ToUserName
>
<![CDATA[%s]]>
</
ToUserName
>
26.
<
FromUserName
>
<![CDATA[%s]]>
</
FromUserName
>
27.
<
CreateTime
>%s</
CreateTime
>
28.
<
MsgType
>
<![CDATA[%s]]>
</
MsgType
>
29.
<
Content
>
<![CDATA[%s]]>
</
Content
>
30.
<
FuncFlag
>0</
FuncFlag
>
31.
</
xml
>";
32.
存放微信输出内容的模板
33.
34.
if(!empty( $keyword ))
35.
判断$keyword是否为空,不为空则继续执行下面的语句;如果为空,则跳转到与之相对应的else语句,即 echo "Input something...";
36.
37.
$msgType = "text";
38.
消息类型是文本类型
39.
40.
$contentStr = "Welcome to wechat world!";
41.
回复的消息内容
42.
43.
$resultStr = sprintf($textTpl, $fromUsername, $toUsername, $time, $msgType, $contentStr);
44.
使用sprintf() 函数将格式化的数据写入到变量中去;
45.
$fromUsername, $toUsername, $time, $msgType, $contentStr 分别顺序替换模板里“%s”位置,也即是“$resultStr”这个变量最后实际为:
46.
<
xml
>
47.
<
ToUserName
>
<![CDATA[$toUsername]]>
</
ToUserName
>
48.
<
FromUserName
>
<![CDATA[$fromUsername]]>
</
FromUserName
>
49.
<
CreateTime
>$time</
CreateTime
>
50.
<
MsgType
>
<![CDATA[$msgType]]>
</
MsgType
>
51.
<
Content
>
<![CDATA[$contentStr]]>
</
Content
>
52.
<
FuncFlag
>0</
FuncFlag
> //位0x0001被标志时,星标刚收到的消息。
53.
</
xml
>。
四、总结
以上是对微信官方示例代码的一个分析,有解释不对的地方,还请高手指出。另外,该代码只是官方给出的简单示例代码,如果要做复杂的开发,还是要求开发者按照严谨的开发模式改写该段代码,会在后续教程中娓娓道来。
五、参考
微信官方公众平台API文档:http://mp.weixin.qq.com/wiki/index.php
六、关注
请关注 卓锦苏州 微信公众帐号,卓锦苏州 基于SAE 平台开发,针对于主流的微信功能进行开发测试。
您可以关注 卓锦苏州 公众帐号进行功能测试,以及获取新的应用开发。
1. 登录微信客户端,朋友们 -> 添加朋友 -> 搜号码 -> zhuojinsz,查找并关注。
2. 扫描二维码:
卓锦苏州 功能列表。