微信公众帐号开发教程第14篇-自定义菜单的创建及菜单事件响应
- WBOYオリジナル
- 2016-06-13 11:28:30976ブラウズ
微信5.0发布
2013年8月5日，伴随着微信5.0 iPhone版的发布，公众平台也进行了重要的更新，主要包括：
1）运营主体为组织，可选择成为服务号或者订阅号；
2）服务号可以申请自定义菜单；
3）使用QQ登录的公众号，可以升级为邮箱登录；
4）使用邮箱登录的公众号，可以修改登录邮箱；
5）编辑图文消息可选填作者；
6）群发消息可以同步到腾讯微博。
其中，大家议论最多的当属前两条，就是关于帐号类型和自定义菜单的更新，我这里做几点补充说明：
1）目前公众号类型分为两种：服务号和订阅号，8月5日平台更新后所有的帐号默认为订阅号，有一次转换成服务号的机会；
2）服务号主要面向企业、政府和其他组织，而订阅号主要面向媒体和个人；
3）只有服务号可以申请自定义菜单，订阅号不能申请；
4）服务号每月只能群发一条消息，而订阅号每天能群发一条消息。
平台更新后，让很多人纠结的是自定义菜单和每天群发一条消息不可兼得，对此，我不想过多评论。
引言及内容概要
在微信5.0以前，自定义菜单是作为一种内测资格使用的，只有少数公众帐号拥有菜单，因此出现很多企业为了弄到菜单不惜重金求购。现如今，一大批帐号从订阅号转为服务号，很多都是奔着自定义菜单去的。而且，经测试发现，微信最近的审核放松很多，只要申请服务号、自定义菜单的基本都成功了，根本不管填写的资料真伪。不知道以后微信会不会翻脸，要求补全企业资料，那将会是一种给小孩一颗糖吃再把他打哭的感觉。。。
自定义菜单是申请到了，到底该怎么创建、怎么使用呢？最近几天不管是微信官方交流群，还是在我博客留言里，都能够看到不少开发者都在为这个发愁。本篇文章就为大家解决这个难题。
自定义菜单的创建步骤
1、找到AppId和AppSecret。自定义菜单申请成功后，在“高级功能”-“开发模式”-“接口配置信息”的最后两项就是；
2、根据AppId和AppSecret，以https get方式获取访问特殊接口所必须的凭证access_token；
3、根据access_token，将json格式的菜单数据通过https post方式提交。
分析创建菜单的难点
原来创建菜单这么简单，三步就能搞定？跟把大象放冰箱差不多。呵呵，当然没有这么简单，那我们一步步来看，到底难在哪里？
首先，第1步肯定都没有问题，只要成功申请了自定义菜单，一定能拿到AppId和AppSecret这两个值。
再来看第2步，由于是get方式获取access_token，很多人直接把拼好的url放在浏览器里执行，access_token就拿到了。抛开是不是用编程方式实现的来说，这真是个好办法，显然大家在第二步上也没有问题。
最后再看第3步，拼装json格式的菜单数据，虽然繁锁一点，但基本上也都没有什么问题的，因为官方给了个例子，照猫画虎就行了。那问题一定就出现在https post提交上了。
结论：不知道如何创建自定义菜单的朋友，大都可以归为以下三种情况：
1）根本不看或者没看懂公众平台API文档中关于“通用接口”、“自定义菜单接口”和“使用限制”部分的说明；
2）不知道如何发起HTTPS请求（平时的http请求，直接使用HttpUrlConnection就可以轻松搞定，但https请求要复杂一点）；
3）不知道如何通过POST方式提交json格式的菜单数据。
正在看文章的你，不知道是属于哪一种，或者几种情况都有，不妨留言说出来，也可以做个调查。不管属于哪一种情况，既然看到了这篇文章，相信一定会让你弄明白的。
解读通用接口文档---凭证的获取
我们先来看通用接口文档的简介部分，如下图所示。
通俗点讲，这段简介可以这么理解：公众平台还有很多特殊的接口，像自定义菜单的创建、语音文件的获取、主动发送消息等，如果开发者想通过HTTP请求访问这些特殊接口，就必须要有访问凭证，也就是access_token。
那么，又该如何获取接口访问凭证access_token呢？让我们继续往下看。
图中已经表达的很清楚了，获取access_token是通过GET方式访问如下链接：
https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET
链接中有三个参数，分别是grant_type、appid和secret。根据图中的参数说明，grant_type传固定值client_credential，而appid和secret就是申请完自定义菜单后微信分配给我们的。
请求发送成功后，微信服务器会返回一个json串，包含access_token和expires_in两个元素。其中，access_token就是我们最终需要的凭证，而expires_in是凭证的有效期，单位是秒，7200秒也就是2个小时。这就意味着，不是每次访问特殊接口，都需要重新获取一次access_token，只要access_token还在有效期内，就一直可以使用。
解读自定义菜单接口文档
还是一样，先来看看自定义菜单接口的简介部分，如下图所示。
从图中我们能够获取到以下信息：
1）拿到凭证access_token后，我们能对菜单执行三种操作：创建、查询和删除；
2）自定义菜单目前只支持click一种事件，即用户点击后回复某种类型的消息；不能够实现点击菜单项直接打开页面（type=view未开放，目前只是微生活有）；
3）由于微信客户端缓存的原因，菜单创建后并不会立即在微信上显示出来，需要过24小时。在测试菜单创建时，可以通过取消关注后，再关注的方式达到立即看菜单的目的。
继续往下看，就是关于菜单怎么创建的介绍了，如下图所示。
其实就是向地址https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN以POST方式提交一个JSON格式的菜单字符串。
后面，关于参数说明的部分我就不一一贴图说明了，把重点说一下：
1）自定义菜单是一个3x5结构的，即菜单最多只能有二级，一级菜单最多只能有3个，每个一级菜单下最多可以有5个二级菜单项；
2）菜单项都有一个key值。当用户点击某个菜单项时，微信会将该菜单项的key值以事件推送的方式发送给我们的后台处理程序。
关于菜单的查询、创建我就不提了，这两个接口使用的频率非常小，一般都用不上。如果需要，再按照我上面提供的思路也不难理解。
解读API文档之使用限制
很多小伙伴看到这张图就开始疑惑了：怎么菜单还限制使用次数，用户量越来越大的时候，根本不够用啊。看清楚，这个限制是针对接口调用的，也就是针对开发者的，和用户数、使用次数半点关系也没有。
就先拿获取凭证接口来说吧，限制一天只能调用200次。还记得前面提到过access_token是有有效期的，并且有效期为两小时，也就是获取一次access_token后的两小时内，都可以继续使用，那么理想情况一天24小时内，是不是只需要获取12次就够了？难道200次还不够用？
再来看下菜单创建接口限制一天只能调用100次。我就这么解释吧，菜单创建一次后，只要你不切换模式（指的是在编辑模式和开发模式间切换）、不调用删除接口，这个菜单会永远存在的。谁没事干，一天要创建100次菜单，就算是测试，测个10次8次足够了吧？
菜单的查询和删除接口的限制我就不解释了，至今为止这二个接口我都没使用过一次。就算有这样的使用需求，一天这么多次的调用，完全足够了。
封装通用的请求方法
读到这里，就默认大家已经掌握了上面讲到的所有关于自定义菜单的理论知识，下面就进入代码实战讲解的部分。
先前我们了解到，创建菜单需要调用二个接口，并且都是https请求，而非http。如果要封装一个通用的请求方法，该方法至少需要具备以下能力：
1）支持HTTPS请求；
2）支持GET、POST两种方式；
3）支持参数提交，也支持无参数的情况；
对于https请求，我们需要一个证书信任管理器，这个管理器类需要自己定义，但需要实现X509TrustManager接口，代码如下：
package org.liufeng.weixin.util;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import javax.net.ssl.X509TrustManager;
/**
* 证书信任管理器（用于https请求）
*
* @author liufeng
* @date 2013-08-08
*/
public class MyX509TrustManager implements X509TrustManager {
public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {
}
public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {
}
public X509Certificate[] getAcceptedIssuers() {
return null;
}
}
这个证书管理器的作用就是让它信任我们指定的证书，上面的代码意味着信任所有证书，不管是否权威机构颁发。
证书有了，通用的https请求方法就不难实现了，实现代码如下：
package org.liufeng.weixin.util;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.ConnectException;
import java.net.URL;
import javax.net.ssl.HttpsURLConnection;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLSocketFactory;
import javax.net.ssl.TrustManager;
import net.sf.json.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* 公众平台通用接口工具类
*
* @author liuyq
* @date 2013-08-09
*/
public class WeixinUtil {
private static Logger log = LoggerFactory.getLogger(WeixinUtil.class);
/**
* 发起https请求并获取结果
*
* @param requestUrl 请求地址
* @param requestMethod 请求方式（GET、POST）
* @param outputStr 提交的数据
* @return JSONObject(通过JSONObject.get(key)的方式获取json对象的属性值)
*/
public static JSONObject httpRequest(String requestUrl, String requestMethod, String outputStr) {
JSONObject jsonObject = null;
StringBuffer buffer = new StringBuffer();
try {
// 创建SSLContext对象，并使用我们指定的信任管理器初始化
TrustManager[] tm = { new MyX509TrustManager() };
SSLContext sslContext = SSLContext.getInstance("SSL", "SunJSSE");
sslContext.init(null, tm, new java.security.SecureRandom());
// 从上述SSLContext对象中得到SSLSocketFactory对象
SSLSocketFactory ssf = sslContext.getSocketFactory();
URL url = new URL(requestUrl);
HttpsURLConnection httpUrlConn = (HttpsURLConnection) url.openConnection();
httpUrlConn.setSSLSocketFactory(ssf);
httpUrlConn.setDoOutput(true);
httpUrlConn.setDoInput(true);
httpUrlConn.setUseCaches(false);
// 设置请求方式（GET/POST）
httpUrlConn.setRequestMethod(requestMethod);
if ("GET".equalsIgnoreCase(requestMethod))
httpUrlConn.connect();
// 当有数据需要提交时
if (null != outputStr) {
OutputStream outputStream = httpUrlConn.getOutputStream();
// 注意编码格式，防止中文乱码
outputStream.write(outputStr.getBytes("UTF-8"));
outputStream.close();
}
// 将返回的输入流转换成字符串
InputStream inputStream = httpUrlConn.getInputStream();
InputStreamReader inputStreamReader = new InputStreamReader(inputStream, "utf-8");
BufferedReader bufferedReader = new BufferedReader(inputStreamReader);
String str = null;
while ((str = bufferedReader.readLine()) != null) {
buffer.append(str);
}
bufferedReader.close();
inputStreamReader.close();
// 释放资源
inputStream.close();
inputStream = null;
httpUrlConn.disconnect();
jsonObject = JSONObject.fromObject(buffer.toString());
} catch (ConnectException ce) {
log.error("Weixin server connection timed out.");
} catch (Exception e) {
log.error("https request error:{}", e);
}
return jsonObject;
}
}
代码说明：
1）41~50行：解决https请求的问题，很多人问题就出在这里；
2）55~59行：兼容GET、POST两种方式；
3）61~67行：兼容有数据提交、无数据提交两种情况，也有相当一部分人不知道如何POST提交数据；
Pojo类的封装
在获取凭证创建菜单前，我们还需要封装一些pojo，这会让我们的代码更美观，有条理。
首先是调用获取凭证接口后，微信服务器会返回json格式的数据：{"access_token":"ACCESS_TOKEN","expires_in":7200}，我们将其封装为一个AccessToken对象，对象有二个属性：token和expiresIn，代码如下：
package org.liufeng.weixin.pojo; /** * 微信通用接口凭证 * * @author liufeng * @date 2013-08-08 */ public class AccessToken { // 获取到的凭证 private String token; // 凭证有效时间，单位：秒 private int expiresIn; public String getToken() { return token; } public void setToken(String token) { this.token = token; } public int getExpiresIn() { return expiresIn; } public void setExpiresIn(int expiresIn) { this.expiresIn = expiresIn; } }接下来是对菜单结构的封装。因为我们是采用面向对象的编程方式，最终提交的json格式菜单数据就应该是由对象直接转换得到，而不是在程序代码中拼一大堆json数据。菜单结构封装的依据是公众平台API文档中给出的那一段json格式的菜单结构，如下所示：
{
"button":[
{
"type":"click",
"name":"今日歌曲",
"key":"V1001_TODAY_MUSIC"
},
{
"type":"click",
"name":"歌手简介",
"key":"V1001_TODAY_SINGER"
},
{
"name":"菜单",
"sub_button":[
{
"type":"click",
"name":"hello word",
"key":"V1001_HELLO_WORLD"
},
{
"type":"click",
"name":"赞一下我们",
"key":"V1001_GOOD"
}]
}]
}
首先是菜单项的基类，所有一级菜单、二级菜单都共有一个相同的属性，那就是name。菜单项基类的封装代码如下：
package org.liufeng.weixin.pojo;
/**
* 按钮的基类
*
* @author liufeng
* @date 2013-08-08
*/
public class Button {
private String name;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
接着是子菜单项的封装。这里对子菜单是这样定义的：没有子菜单的菜单项，有可能是二级菜单项，也有可能是不含二级菜单的一级菜单。这类子菜单项一定会包含三个属性：type、name和key，封装的代码如下：
package org.liufeng.weixin.pojo;
/**
* 普通按钮（子按钮）
*
* @author liufeng
* @date 2013-08-08
*/
public class CommonButton extends Button {
private String type;
private String key;
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public String getKey() {
return key;
}
public void setKey(String key) {
this.key = key;
}
}
再往下是父菜单项的封装。对父菜单项的定义：包含有二级菜单项的一级菜单。这类菜单项包含有二个属性：name和sub_button，而sub_button以是一个子菜单项数组。父菜单项的封装代码如下：
package org.liufeng.weixin.pojo;
/**
* 复杂按钮（父按钮）
*
* @author liufeng
* @date 2013-08-08
*/
public class ComplexButton extends Button {
private Button[] sub_button;
public Button[] getSub_button() {
return sub_button;
}
public void setSub_button(Button[] sub_button) {
this.sub_button = sub_button;
}
}
最后是整个菜单对象的封装，菜单对象包含多个菜单项（最多只能有3个），这些菜单项即可以是子菜单项（不含二级菜单的一级菜单），也可以是父菜单项（包含二级菜单的菜单项），如果能明白上面所讲的，再来看封装后的代码就很容易理解了：
package org.liufeng.weixin.pojo;
/**
* 菜单
*
* @author liufeng
* @date 2013-08-08
*/
public class Menu {
private Button[] button;
public Button[] getButton() {
return button;
}
public void setButton(Button[] button) {
this.button = button;
}
}
关于POJO类的封装就介绍完了。
凭证access_token的获取方法
继续在先前通用请求方法的类WeixinUtil.java中加入以下代码，用于获取接口访问凭证：
// 获取access_token的接口地址（GET） 限200（次/天）
public final static String access_token_url = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET";
/**
* 获取access_token
*
* @param appid 凭证
* @param appsecret 密钥
* @return
*/
public static AccessToken getAccessToken(String appid, String appsecret) {
AccessToken accessToken = null;
String requestUrl = access_token_url.replace("APPID", appid).replace("APPSECRET", appsecret);
JSONObject jsonObject = httpRequest(requestUrl, "GET", null);
// 如果请求成功
if (null != jsonObject) {
try {
accessToken = new AccessToken();
accessToken.setToken(jsonObject.getString("access_token"));
accessToken.setExpiresIn(jsonObject.getInt("expires_in"));
} catch (JSONException e) {
accessToken = null;
// 获取token失败
log.error("获取token失败 errcode:{} errmsg:{}", jsonObject.getInt("errcode"), jsonObject.getString("errmsg"));
}
}
return accessToken;
}
调用封装的方法创建自定义菜单
// 菜单创建（POST） 限100（次/天）
public static String menu_create_url = "https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN";
/**
* 创建菜单
*
* @param menu 菜单实例
* @param accessToken 有效的access_token
* @return 0表示成功，其他值表示失败
*/
public static int createMenu(Menu menu, String accessToken) {
int result = 0;
// 拼装创建菜单的url
String url = menu_create_url.replace("ACCESS_TOKEN", accessToken);
// 将菜单对象转换成json字符串
String jsonMenu = JSONObject.fromObject(menu).toString();
// 调用接口创建菜单
JSONObject jsonObject = httpRequest(url, "POST", jsonMenu);
if (null != jsonObject) {
if (0 != jsonObject.getInt("errcode")) {
result = jsonObject.getInt("errcode");
log.error("创建菜单失败 errcode:{} errmsg:{}", jsonObject.getInt("errcode"), jsonObject.getString("errmsg"));
}
}
return result;
}
注意：在运行以上代码时，需要将appId和appSecret换成你自己公众号的。
整个工程的结构
为了保证文章的完整独立性和可读性，我是新建了一个Java Project（Java web工程也可以，没有太大关系），没有在前几篇文章所讲到的weixinCourse工程中添加代码。如果需要，读者可以自己实现将菜单创建的代码移到自己已有的工程中去。
图中所有Java文件的源代码都在文章中贴出并进行了说明，图中使用到的jar也是Java开发中通用的jar包，很容易在网上下载到。
工程中引入的jar包主要分为两类：
1）第一类是json开发工具包，用于Java对象和Json字符串之间的转换；json开发工具包一共有3个jar：ezmorph-1.0.6.jar，json-lib-2.2.3-jdk13.jar和morph-1.1.1.jar。
2）第二类是slf4j日志工具包，用于记录系统运行所产生的日志，日志可以输出到控制台或文件中。
整个工程中，唯一没有讲到的是src下的log4j.properties的配置，也把它贴出来，方便大家参考，这样才是一个完整的工程源码。log4j.properties文件的内容如下：
log4j.rootLogger=info,console,file log4j.appender.console=org.apache.log4j.ConsoleAppender log4j.appender.console.layout=org.apache.log4j.PatternLayout log4j.appender.console.layout.ConversionPattern=[%-5p] %m%n log4j.appender.file=org.apache.log4j.DailyRollingFileAppender log4j.appender.file.DatePattern='-'yyyy-MM-dd log4j.appender.file.File=./logs/weixinmpmenu.log log4j.appender.file.Append=true log4j.appender.file.layout=org.apache.log4j.PatternLayout log4j.appender.file.layout.ConversionPattern=[%-5p] %d %37c %3x - %m%n
如何响应菜单点击事件
自定义菜单的创建工作已经完成，那么该如何接收和响应菜单的点击事件呢，也就是说在公众帐号后台处理程序中，如何识别用户点击的是哪个菜单，以及做出响应。这部分内容其实在教程的第5篇各种消息的接收与响应中已经讲解清楚了。
来看一下第一篇教程weixinCourse项目中的CoreService类要怎么改写，才能接收响应菜单点击事件，该类修改后的完整代码如下：
package org.liufeng.course.service;
import java.util.Date;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.liufeng.course.message.resp.TextMessage;
import org.liufeng.course.util.MessageUtil;
/**
* 核心服务类
*
* @author liufeng
* @date 2013-05-20
*/
public class CoreService {
/**
* 处理微信发来的请求
*
* @param request
* @return
*/
public static String processRequest(HttpServletRequest request) {
String respMessage = null;
try {
// 默认返回的文本消息内容
String respContent = "请求处理异常，请稍候尝试！";
// xml请求解析
Map<String, String> requestMap = MessageUtil.parseXml(request);
// 发送方帐号（open_id）
String fromUserName = requestMap.get("FromUserName");
// 公众帐号
String toUserName = requestMap.get("ToUserName");
// 消息类型
String msgType = requestMap.get("MsgType");
// 回复文本消息
TextMessage textMessage = new TextMessage();
textMessage.setToUserName(fromUserName);
textMessage.setFromUserName(toUserName);
textMessage.setCreateTime(new Date().getTime());
textMessage.setMsgType(MessageUtil.RESP_MESSAGE_TYPE_TEXT);
textMessage.setFuncFlag(0);
// 文本消息
if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_TEXT)) {
respContent = "您发送的是文本消息！";
}
// 图片消息
else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_IMAGE)) {
respContent = "您发送的是图片消息！";
}
// 地理位置消息
else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_LOCATION)) {
respContent = "您发送的是地理位置消息！";
}
// 链接消息
else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_LINK)) {
respContent = "您发送的是链接消息！";
}
// 音频消息
else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_VOICE)) {
respContent = "您发送的是音频消息！";
}
// 事件推送
else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_EVENT)) {
// 事件类型
String eventType = requestMap.get("Event");
// 订阅
if (eventType.equals(MessageUtil.EVENT_TYPE_SUBSCRIBE)) {
respContent = "谢谢您的关注！";
}
// 取消订阅
else if (eventType.equals(MessageUtil.EVENT_TYPE_UNSUBSCRIBE)) {
// TODO 取消订阅后用户再收不到公众号发送的消息，因此不需要回复消息
}
// 自定义菜单点击事件
else if (eventType.equals(MessageUtil.EVENT_TYPE_CLICK)) {
// 事件KEY值，与创建自定义菜单时指定的KEY值对应
String eventKey = requestMap.get("EventKey");
if (eventKey.equals("11")) {
respContent = "天气预报菜单项被点击！";
} else if (eventKey.equals("12")) {
respContent = "公交查询菜单项被点击！";
} else if (eventKey.equals("13")) {
respContent = "周边搜索菜单项被点击！";
} else if (eventKey.equals("14")) {
respContent = "历史上的今天菜单项被点击！";
} else if (eventKey.equals("21")) {
respContent = "歌曲点播菜单项被点击！";
} else if (eventKey.equals("22")) {
respContent = "经典游戏菜单项被点击！";
} else if (eventKey.equals("23")) {
respContent = "美女电台菜单项被点击！";
} else if (eventKey.equals("24")) {
respContent = "人脸识别菜单项被点击！";
} else if (eventKey.equals("25")) {
respContent = "聊天唠嗑菜单项被点击！";
} else if (eventKey.equals("31")) {
respContent = "Q友圈菜单项被点击！";
} else if (eventKey.equals("32")) {
respContent = "电影排行榜菜单项被点击！";
} else if (eventKey.equals("33")) {
respContent = "幽默笑话菜单项被点击！";
}
}
}
textMessage.setContent(respContent);
respMessage = MessageUtil.textMessageToXml(textMessage);
} catch (Exception e) {
e.printStackTrace();
}
return respMessage;
}
}
代码说明：
1）第69行、第81行这两行代码说明了如何判断菜单的点击事件。当消息类型MsgType=event，并且Event=CLICK时，就表示是自定义菜单点击事件；
2）第83行是判断具体点击的是哪个菜单项，根据菜单的key值来判断；
3）第85~109行表示当用户点击某个菜单项后，具体返回什么消息，我只是做个简单示例，统一返回文本消息，读者可以根据实际需要来灵活处理。
总结
到这里关于自定义菜单的创建、菜单事件的判断和处理响应就全部介绍完了。我只希望看过文章的人不要只是拷贝代码，如果是这样，我完全不用花这么多的时间来写这篇文章，直接把工程放在下载区多简单。另外，网上是有很多工具，让你填入appid,appsecret和菜单结构，提交就能创建菜单，请慎用！因为appid和appsecret一旦告诉别人，你的公众号的菜单控制权就在别人手上了，总会有别有用心的人出来搞点事的。