微信公号开发之自定义菜单攻略

移动开发
在微信5.0以前,自定义菜单是作为一种内测资格使用的,只有少数公众帐号拥有菜单,因此出现很多企业为了弄到菜单不惜重金求购。现如今,一大批帐号从订阅号转为服务号,很多都是奔着自定义菜单去的。自定义菜单是申请到了,到底该怎么创建、怎么使用呢?本篇文章就为大家解决这个难题。

在微信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方式访问如下链接:

  1. 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接口,代码如下:

  1. package org.liufeng.weixin.util; 
  2.  
  3. import java.security.cert.CertificateException; 
  4. import java.security.cert.X509Certificate; 
  5.  
  6. import javax.net.ssl.X509TrustManager; 
  7.  
  8. /** 
  9.  * 证书信任管理器(用于https请求) 
  10.  *  
  11.  * @author liufeng 
  12.  * @date 2013-08-08 
  13.  */ 
  14. public class MyX509TrustManager implements X509TrustManager { 
  15.  
  16.     public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { 
  17.     } 
  18.  
  19.     public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { 
  20.     } 
  21.  
  22.     public X509Certificate[] getAcceptedIssuers() { 
  23.         return null
  24.     } 

这个证书管理器的作用就是让它信任我们指定的证书,上面的代码意味着信任所有证书,不管是否权威机构颁发。

证书有了,通用的https请求方法就不难实现了,实现代码如下:

  1. package org.liufeng.weixin.util; 
  2.  
  3. import java.io.BufferedReader; 
  4. import java.io.InputStream; 
  5. import java.io.InputStreamReader; 
  6. import java.io.OutputStream; 
  7. import java.net.ConnectException; 
  8. import java.net.URL; 
  9.  
  10. import javax.net.ssl.HttpsURLConnection; 
  11. import javax.net.ssl.SSLContext; 
  12. import javax.net.ssl.SSLSocketFactory; 
  13. import javax.net.ssl.TrustManager; 
  14.  
  15. import net.sf.json.JSONObject; 
  16.  
  17. import org.slf4j.Logger; 
  18. import org.slf4j.LoggerFactory; 
  19.  
  20. /** 
  21.  * 公众平台通用接口工具类 
  22.  *  
  23.  * @author liuyq 
  24.  * @date 2013-08-09 
  25.  */ 
  26. public class WeixinUtil { 
  27.     private static Logger log = LoggerFactory.getLogger(WeixinUtil.class); 
  28.  
  29.     /** 
  30.      * 发起https请求并获取结果 
  31.      *  
  32.      * @param requestUrl 请求地址 
  33.      * @param requestMethod 请求方式(GET、POST) 
  34.      * @param outputStr 提交的数据 
  35.      * @return JSONObject(通过JSONObject.get(key)的方式获取json对象的属性值) 
  36.      */ 
  37.     public static JSONObject httpRequest(String requestUrl, String requestMethod, String outputStr) { 
  38.         JSONObject jsonObject = null
  39.         StringBuffer buffer = new StringBuffer(); 
  40.         try { 
  41.             // 创建SSLContext对象,并使用我们指定的信任管理器初始化 
  42.             TrustManager[] tm = { new MyX509TrustManager() }; 
  43.             SSLContext sslContext = SSLContext.getInstance("SSL""SunJSSE"); 
  44.             sslContext.init(null, tm, new java.security.SecureRandom()); 
  45.             // 从上述SSLContext对象中得到SSLSocketFactory对象 
  46.             SSLSocketFactory ssf = sslContext.getSocketFactory(); 
  47.  
  48.             URL url = new URL(requestUrl); 
  49.             HttpsURLConnection httpUrlConn = (HttpsURLConnection) url.openConnection(); 
  50.             httpUrlConn.setSSLSocketFactory(ssf); 
  51.  
  52.             httpUrlConn.setDoOutput(true); 
  53.             httpUrlConn.setDoInput(true); 
  54.             httpUrlConn.setUseCaches(false); 
  55.             // 设置请求方式(GET/POST) 
  56.             httpUrlConn.setRequestMethod(requestMethod); 
  57.  
  58.             if ("GET".equalsIgnoreCase(requestMethod)) 
  59.                 httpUrlConn.connect(); 
  60.  
  61.             // 当有数据需要提交时 
  62.             if (null != outputStr) { 
  63.                 OutputStream outputStream = httpUrlConn.getOutputStream(); 
  64.                 // 注意编码格式,防止中文乱码 
  65.                 outputStream.write(outputStr.getBytes("UTF-8")); 
  66.                 outputStream.close(); 
  67.             } 
  68.  
  69.             // 将返回的输入流转换成字符串 
  70.             InputStream inputStream = httpUrlConn.getInputStream(); 
  71.             InputStreamReader inputStreamReader = new InputStreamReader(inputStream, "utf-8"); 
  72.             BufferedReader bufferedReader = new BufferedReader(inputStreamReader); 
  73.  
  74.             String str = null
  75.             while ((str = bufferedReader.readLine()) != null) { 
  76.                 buffer.append(str); 
  77.             } 
  78.             bufferedReader.close(); 
  79.             inputStreamReader.close(); 
  80.             // 释放资源 
  81.             inputStream.close(); 
  82.             inputStream = null
  83.             httpUrlConn.disconnect(); 
  84.             jsonObject = JSONObject.fromObject(buffer.toString()); 
  85.         } catch (ConnectException ce) { 
  86.             log.error("Weixin server connection timed out."); 
  87.         } catch (Exception e) { 
  88.             log.error("https request error:{}", e); 
  89.         } 
  90.         return jsonObject; 
  91.     } 

代码说明:

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,代码如下:

  1. package org.liufeng.weixin.pojo; 
  2.  
  3. /** 
  4.  * 微信通用接口凭证 
  5.  *  
  6.  * @author liufeng 
  7.  * @date 2013-08-08 
  8.  */ 
  9. public class AccessToken { 
  10.     // 获取到的凭证 
  11.     private String token; 
  12.     // 凭证有效时间,单位:秒 
  13.     private int expiresIn; 
  14.  
  15.     public String getToken() { 
  16.         return token; 
  17.     } 
  18.  
  19.     public void setToken(String token) { 
  20.         this.token = token; 
  21.     } 
  22.  
  23.     public int getExpiresIn() { 
  24.         return expiresIn; 
  25.     } 
  26.  
  27.     public void setExpiresIn(int expiresIn) { 
  28.         this.expiresIn = expiresIn; 
  29.     } 

接下来是对菜单结构的封装。因为我们是采用面向对象的编程方式,最终提交的json格式菜单数据就应该是由对象直接转换得到,而不是在程序代码中拼一大堆json数据。菜单结构封装的依据是公众平台API文档中给出的那一段json格式的菜单结构,如下所示:

  1.     "button":[ 
  2.     {    
  3.          "type":"click"
  4.          "name":"今日歌曲"
  5.          "key":"V1001_TODAY_MUSIC" 
  6.      }, 
  7.      { 
  8.           "type":"click"
  9.           "name":"歌手简介"
  10.           "key":"V1001_TODAY_SINGER" 
  11.      }, 
  12.      { 
  13.           "name":"菜单"
  14.           "sub_button":[ 
  15.            { 
  16.               "type":"click"
  17.               "name":"hello word"
  18.               "key":"V1001_HELLO_WORLD" 
  19.            }, 
  20.            { 
  21.               "type":"click"
  22.               "name":"赞一下我们"
  23.               "key":"V1001_GOOD" 
  24.            }] 
  25.       }] 

首先是菜单项的基类,所有一级菜单、二级菜单都共有一个相同的属性,那就是name。菜单项基类的封装代码如下:

  1. package org.liufeng.weixin.pojo; 
  2.  
  3. /** 
  4.  * 按钮的基类 
  5.  *  
  6.  * @author liufeng 
  7.  * @date 2013-08-08 
  8.  */ 
  9. public class Button { 
  10.     private String name; 
  11.  
  12.     public String getName() { 
  13.         return name; 
  14.     } 
  15.  
  16.     public void setName(String name) { 
  17.         this.name = name; 
  18.     } 

接着是子菜单项的封装。这里对子菜单是这样定义的:没有子菜单的菜单项,有可能是二级菜单项,也有可能是不含二级菜单的一级菜单。这类子菜单项一定会包含三个属性:type、name和key,封装的代码如下:

  1. package org.liufeng.weixin.pojo; 
  2.  
  3. /** 
  4.  * 普通按钮(子按钮) 
  5.  *  
  6.  * @author liufeng 
  7.  * @date 2013-08-08 
  8.  */ 
  9. public class CommonButton extends Button { 
  10.     private String type; 
  11.     private String key; 
  12.  
  13.     public String getType() { 
  14.         return type; 
  15.     } 
  16.  
  17.     public void setType(String type) { 
  18.         this.type = type; 
  19.     } 
  20.  
  21.     public String getKey() { 
  22.         return key; 
  23.     } 
  24.  
  25.     public void setKey(String key) { 
  26.         this.key = key; 
  27.     } 

再往下是父菜单项的封装。对父菜单项的定义:包含有二级菜单项的一级菜单。这类菜单项包含有二个属性:name和sub_button,而sub_button以是一个子菜单项数组。父菜单项的封装代码如下:

  1. package org.liufeng.weixin.pojo; 
  2.  
  3. /** 
  4.  * 复杂按钮(父按钮) 
  5.  *  
  6.  * @author liufeng 
  7.  * @date 2013-08-08 
  8.  */ 
  9. public class ComplexButton extends Button { 
  10.     private Button[] sub_button; 
  11.  
  12.     public Button[] getSub_button() { 
  13.         return sub_button; 
  14.     } 
  15.  
  16.     public void setSub_button(Button[] sub_button) { 
  17.         this.sub_button = sub_button; 
  18.     } 

最后是整个菜单对象的封装,菜单对象包含多个菜单项(最多只能有3个),这些菜单项即可以是子菜单项(不含二级菜单的一级菜单),也可以是父菜单项(包含二级菜单的菜单项),如果能明白上面所讲的,再来看封装后的代码就很容易理解了:

  1. package org.liufeng.weixin.pojo; 
  2.  
  3. /** 
  4.  * 菜单 
  5.  *  
  6.  * @author liufeng 
  7.  * @date 2013-08-08 
  8.  */ 
  9. public class Menu { 
  10.     private Button[] button; 
  11.  
  12.     public Button[] getButton() { 
  13.         return button; 
  14.     } 
  15.  
  16.     public void setButton(Button[] button) { 
  17.         this.button = button; 
  18.     } 

关于POJO类的封装就介绍完了。

凭证access_token的获取方法

继续在先前通用请求方法的类WeixinUtil.java中加入以下代码,用于获取接口访问凭证:

  1. // 获取access_token的接口地址(GET) 限200(次/天) 
  2. public final static String access_token_url = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET"
  3.  
  4. /** 
  5.  * 获取access_token 
  6.  *  
  7.  * @param appid 凭证 
  8.  * @param appsecret 密钥 
  9.  * @return 
  10.  */ 
  11. public static AccessToken getAccessToken(String appid, String appsecret) { 
  12.     AccessToken accessToken = null
  13.  
  14.     String requestUrl = access_token_url.replace("APPID", appid).replace("APPSECRET", appsecret); 
  15.     JSONObject jsonObject = httpRequest(requestUrl, "GET"null); 
  16.     // 如果请求成功 
  17.     if (null != jsonObject) { 
  18.         try { 
  19.             accessToken = new AccessToken(); 
  20.             accessToken.setToken(jsonObject.getString("access_token")); 
  21.             accessToken.setExpiresIn(jsonObject.getInt("expires_in")); 
  22.         } catch (JSONException e) { 
  23.             accessToken = null
  24.             // 获取token失败 
  25.             log.error("获取token失败 errcode:{} errmsg:{}", jsonObject.getInt("errcode"), jsonObject.getString("errmsg")); 
  26.         } 
  27.     } 
  28.     return accessToken; 

#p#

自定义菜单的创建方法

继续在先前通用请求方法的类WeixinUtil.java中加入以下代码,用于创建自定义菜单:

  1. // 菜单创建(POST) 限100(次/天) 
  2. public static String menu_create_url = "https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN"
  3.  
  4. /** 
  5.  * 创建菜单 
  6.  *  
  7.  * @param menu 菜单实例 
  8.  * @param accessToken 有效的access_token 
  9.  * @return 0表示成功,其他值表示失败 
  10.  */ 
  11. public static int createMenu(Menu menu, String accessToken) { 
  12.     int result = 0
  13.  
  14.     // 拼装创建菜单的url 
  15.     String url = menu_create_url.replace("ACCESS_TOKEN", accessToken); 
  16.     // 将菜单对象转换成json字符串 
  17.     String jsonMenu = JSONObject.fromObject(menu).toString(); 
  18.     // 调用接口创建菜单 
  19.     JSONObject jsonObject = httpRequest(url, "POST", jsonMenu); 
  20.  
  21.     if (null != jsonObject) { 
  22.         if (0 != jsonObject.getInt("errcode")) { 
  23.             result = jsonObject.getInt("errcode"); 
  24.             log.error("创建菜单失败 errcode:{} errmsg:{}", jsonObject.getInt("errcode"), jsonObject.getString("errmsg")); 
  25.         } 
  26.     } 
  27.  
  28.     return result; 

调用封装的方法创建自定义菜单

  1. package org.liufeng.weixin.main; 
  2.  
  3. import org.liufeng.weixin.pojo.AccessToken; 
  4. import org.liufeng.weixin.pojo.Button; 
  5. import org.liufeng.weixin.pojo.CommonButton; 
  6. import org.liufeng.weixin.pojo.ComplexButton; 
  7. import org.liufeng.weixin.pojo.Menu; 
  8. import org.liufeng.weixin.util.WeixinUtil; 
  9. import org.slf4j.Logger; 
  10. import org.slf4j.LoggerFactory; 
  11.  
  12. /** 
  13.  * 菜单管理器类 
  14.  *  
  15.  * @author liufeng 
  16.  * @date 2013-08-08 
  17.  */ 
  18. public class MenuManager { 
  19.     private static Logger log = LoggerFactory.getLogger(MenuManager.class); 
  20.  
  21.     public static void main(String[] args) { 
  22.         // 第三方用户唯一凭证 
  23.         String appId = "000000000000000000"
  24.         // 第三方用户唯一凭证密钥 
  25.         String appSecret = "00000000000000000000000000000000"
  26.  
  27.         // 调用接口获取access_token 
  28.         AccessToken at = WeixinUtil.getAccessToken(appId, appSecret); 
  29.  
  30.         if (null != at) { 
  31.             // 调用接口创建菜单 
  32.             int result = WeixinUtil.createMenu(getMenu(), at.getToken()); 
  33.  
  34.             // 判断菜单创建结果 
  35.             if (0 == result) 
  36.                 log.info("菜单创建成功!"); 
  37.             else 
  38.                 log.info("菜单创建失败,错误码:" + result); 
  39.         } 
  40.     } 
  41.  
  42.     /** 
  43.      * 组装菜单数据 
  44.      *  
  45.      * @return 
  46.      */ 
  47.     private static Menu getMenu() { 
  48.         CommonButton btn11 = new CommonButton(); 
  49.         btn11.setName("天气预报"); 
  50.         btn11.setType("click"); 
  51.         btn11.setKey("11"); 
  52.  
  53.         CommonButton btn12 = new CommonButton(); 
  54.         btn12.setName("公交查询"); 
  55.         btn12.setType("click"); 
  56.         btn12.setKey("12"); 
  57.  
  58.         CommonButton btn13 = new CommonButton(); 
  59.         btn13.setName("周边搜索"); 
  60.         btn13.setType("click"); 
  61.         btn13.setKey("13"); 
  62.  
  63.         CommonButton btn14 = new CommonButton(); 
  64.         btn14.setName("历史上的今天"); 
  65.         btn14.setType("click"); 
  66.         btn14.setKey("14"); 
  67.  
  68.         CommonButton btn21 = new CommonButton(); 
  69.         btn21.setName("歌曲点播"); 
  70.         btn21.setType("click"); 
  71.         btn21.setKey("21"); 
  72.  
  73.         CommonButton btn22 = new CommonButton(); 
  74.         btn22.setName("经典游戏"); 
  75.         btn22.setType("click"); 
  76.         btn22.setKey("22"); 
  77.  
  78.         CommonButton btn23 = new CommonButton(); 
  79.         btn23.setName("美女电台"); 
  80.         btn23.setType("click"); 
  81.         btn23.setKey("23"); 
  82.  
  83.         CommonButton btn24 = new CommonButton(); 
  84.         btn24.setName("人脸识别"); 
  85.         btn24.setType("click"); 
  86.         btn24.setKey("24"); 
  87.  
  88.         CommonButton btn25 = new CommonButton(); 
  89.         btn25.setName("聊天唠嗑"); 
  90.         btn25.setType("click"); 
  91.         btn25.setKey("25"); 
  92.  
  93.         CommonButton btn31 = new CommonButton(); 
  94.         btn31.setName("Q友圈"); 
  95.         btn31.setType("click"); 
  96.         btn31.setKey("31"); 
  97.  
  98.         CommonButton btn32 = new CommonButton(); 
  99.         btn32.setName("电影排行榜"); 
  100.         btn32.setType("click"); 
  101.         btn32.setKey("32"); 
  102.  
  103.         CommonButton btn33 = new CommonButton(); 
  104.         btn33.setName("幽默笑话"); 
  105.         btn33.setType("click"); 
  106.         btn33.setKey("33"); 
  107.  
  108.         ComplexButton mainBtn1 = new ComplexButton(); 
  109.         mainBtn1.setName("生活助手"); 
  110.         mainBtn1.setSub_button(new CommonButton[] { btn11, btn12, btn13, btn14 }); 
  111.  
  112.         ComplexButton mainBtn2 = new ComplexButton(); 
  113.         mainBtn2.setName("休闲驿站"); 
  114.         mainBtn2.setSub_button(new CommonButton[] { btn21, btn22, btn23, btn24, btn25 }); 
  115.  
  116.         ComplexButton mainBtn3 = new ComplexButton(); 
  117.         mainBtn3.setName("更多体验"); 
  118.         mainBtn3.setSub_button(new CommonButton[] { btn31, btn32, btn33 }); 
  119.  
  120.         /** 
  121.          * 这是公众号xiaoqrobot目前的菜单结构,每个一级菜单都有二级菜单项<br> 
  122.          *  
  123.          * 在某个一级菜单下没有二级菜单的情况,menu该如何定义呢?<br> 
  124.          * 比如,第三个一级菜单项不是“更多体验”,而直接是“幽默笑话”,那么menu应该这样定义:<br> 
  125.          * menu.setButton(new Button[] { mainBtn1, mainBtn2, btn33 }); 
  126.          */ 
  127.         Menu menu = new Menu(); 
  128.         menu.setButton(new Button[] { mainBtn1, mainBtn2, mainBtn3 }); 
  129.  
  130.         return menu; 
  131.     } 

注意:在运行以上代码时,需要将appId和appSecret换成你自己公众号的。

如何响应菜单点击事件

自定义菜单的创建工作已经完成,那么该如何接收和响应菜单的点击事件呢,也就是说在公众帐号后台处理程序中,如何识别用户点击的是哪个菜单,以及做出响应。这部分内容其实在前面的教程各种消息的接收与响应中已经讲解清楚了。

来看一下第一篇教程weixinCourse项目中的CoreService类要怎么改写,才能接收响应菜单点击事件,该类修改后的完整代码如下:

  1. package org.liufeng.course.service; 
  2.  
  3. import java.util.Date; 
  4. import java.util.Map; 
  5.  
  6. import javax.servlet.http.HttpServletRequest; 
  7.  
  8. import org.liufeng.course.message.resp.TextMessage; 
  9. import org.liufeng.course.util.MessageUtil; 
  10.  
  11. /** 
  12.  * 核心服务类 
  13.  *  
  14.  * @author liufeng 
  15.  * @date 2013-05-20 
  16.  */ 
  17. public class CoreService { 
  18.     /** 
  19.      * 处理微信发来的请求 
  20.      *  
  21.      * @param request 
  22.      * @return 
  23.      */ 
  24.     public static String processRequest(HttpServletRequest request) { 
  25.         String respMessage = null
  26.         try { 
  27.             // 默认返回的文本消息内容 
  28.             String respContent = "请求处理异常,请稍候尝试!"
  29.  
  30.             // xml请求解析 
  31.             Map<String, String> requestMap = MessageUtil.parseXml(request); 
  32.  
  33.             // 发送方帐号(open_id) 
  34.             String fromUserName = requestMap.get("FromUserName"); 
  35.             // 公众帐号 
  36.             String toUserName = requestMap.get("ToUserName"); 
  37.             // 消息类型 
  38.             String msgType = requestMap.get("MsgType"); 
  39.  
  40.             // 回复文本消息 
  41.             TextMessage textMessage = new TextMessage(); 
  42.             textMessage.setToUserName(fromUserName); 
  43.             textMessage.setFromUserName(toUserName); 
  44.             textMessage.setCreateTime(new Date().getTime()); 
  45.             textMessage.setMsgType(MessageUtil.RESP_MESSAGE_TYPE_TEXT); 
  46.             textMessage.setFuncFlag(0); 
  47.  
  48.             // 文本消息 
  49.             if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_TEXT)) { 
  50.                 respContent = "您发送的是文本消息!"
  51.             } 
  52.             // 图片消息 
  53.             else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_IMAGE)) { 
  54.                 respContent = "您发送的是图片消息!"
  55.             } 
  56.             // 地理位置消息 
  57.             else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_LOCATION)) { 
  58.                 respContent = "您发送的是地理位置消息!"
  59.             } 
  60.             // 链接消息 
  61.             else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_LINK)) { 
  62.                 respContent = "您发送的是链接消息!"
  63.             } 
  64.             // 音频消息 
  65.             else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_VOICE)) { 
  66.                 respContent = "您发送的是音频消息!"
  67.             } 
  68.             // 事件推送 
  69.             else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_EVENT)) { 
  70.                 // 事件类型 
  71.                 String eventType = requestMap.get("Event"); 
  72.                 // 订阅 
  73.                 if (eventType.equals(MessageUtil.EVENT_TYPE_SUBSCRIBE)) { 
  74.                     respContent = "谢谢您的关注!"
  75.                 } 
  76.                 // 取消订阅 
  77.                 else if (eventType.equals(MessageUtil.EVENT_TYPE_UNSUBSCRIBE)) { 
  78.                     // TODO 取消订阅后用户再收不到公众号发送的消息,因此不需要回复消息 
  79.                 } 
  80.                 // 自定义菜单点击事件 
  81.                 else if (eventType.equals(MessageUtil.EVENT_TYPE_CLICK)) { 
  82.                     // 事件KEY值,与创建自定义菜单时指定的KEY值对应 
  83.                     String eventKey = requestMap.get("EventKey"); 
  84.  
  85.                     if (eventKey.equals("11")) { 
  86.                         respContent = "天气预报菜单项被点击!"
  87.                     } else if (eventKey.equals("12")) { 
  88.                         respContent = "公交查询菜单项被点击!"
  89.                     } else if (eventKey.equals("13")) { 
  90.                         respContent = "周边搜索菜单项被点击!"
  91.                     } else if (eventKey.equals("14")) { 
  92.                         respContent = "历史上的今天菜单项被点击!"
  93.                     } else if (eventKey.equals("21")) { 
  94.                         respContent = "歌曲点播菜单项被点击!"
  95.                     } else if (eventKey.equals("22")) { 
  96.                         respContent = "经典游戏菜单项被点击!"
  97.                     } else if (eventKey.equals("23")) { 
  98.                         respContent = "美女电台菜单项被点击!"
  99.                     } else if (eventKey.equals("24")) { 
  100.                         respContent = "人脸识别菜单项被点击!"
  101.                     } else if (eventKey.equals("25")) { 
  102.                         respContent = "聊天唠嗑菜单项被点击!"
  103.                     } else if (eventKey.equals("31")) { 
  104.                         respContent = "Q友圈菜单项被点击!"
  105.                     } else if (eventKey.equals("32")) { 
  106.                         respContent = "电影排行榜菜单项被点击!"
  107.                     } else if (eventKey.equals("33")) { 
  108.                         respContent = "幽默笑话菜单项被点击!"
  109.                     } 
  110.                 } 
  111.             } 
  112.  
  113.             textMessage.setContent(respContent); 
  114.             respMessage = MessageUtil.textMessageToXml(textMessage); 
  115.         } catch (Exception e) { 
  116.             e.printStackTrace(); 
  117.         } 
  118.  
  119.         return respMessage; 
  120.     } 

代码说明:

1)第69行、第81行这两行代码说明了如何判断菜单的点击事件。当消息类型MsgType=event,并且Event=CLICK时,就表示是自定义菜单点击事件;

2)第83行是判断具体点击的是哪个菜单项,根据菜单的key值来判断;

3)第85~109行表示当用户点击某个菜单项后,具体返回什么消息,我只是做个简单示例,统一返回文本消息,读者可以根据实际需要来灵活处理。

注意

网上是有很多工具,让你填入appid,appsecret和菜单结构,提交就能创建菜单,请慎 用!因为appid和appsecret一旦告诉别人,你的公众号的菜单控制权就在别人手上了,总会有别有用心的人出来搞点事的。

下一页讲解自定义菜单的view类型(访问网页)。

#p#

自定义菜单的view类型(访问网页)

不久前,微信公众平台悄悄开放了view类型的菜单,却没有在首页发布任何通知,貌似微信团队很喜欢这么干。一个偶然的机会,我留意到API文档的自定义菜单接口发生了变化,增加了对菜单view类型的说明:

view(访问网页):用户点击view类型按钮后,会直接跳转到开发者指定的url中。

在一级菜单“更多”下增加了二级菜单“使用帮助”,点击该菜单项会直接跳转到网页。

那么,这种类型的菜单是如何创建的呢?

自定义菜单的两种类型(click和view)

公众平台API文档中给出了自定义菜单的json结构示例,我从中截取两个菜单项的json代码,一个是click类型,另一个是view类型,如下所示。

  1. {    
  2.     "type":"click"
  3.     "name":"今日歌曲"
  4.     "key":"V1001_TODAY_MUSIC" 
  5. }, 
  6.     "type":"view"
  7.     "name":"歌手简介"
  8.     "url":"http://www.qq.com/" 

从上面可以看出,两种类型的菜单除了type值不同之外,属性也有差别。click类型的菜单有key属性,而view类型的菜单没有key属性,与之对应的是url属性。通过上一篇的学习我们知道,key值是用于判断用户点击了哪个click类型的菜单项。而view类型的菜单没有key属性,目前无法在公众账号后台判断是否有用户点击了view类型的菜单项,也就没办法知道哪个用户点击了view类型的菜单项。

建立view类型的菜单对象

View类型的菜单有3个属性:type、name和url。在本文前面,我们创建了菜单项的基类Button,Button类只有一个属性name。View类型的菜单对象也需要继承Button类,代码如下:

  1. package org.liufeng.weixin.pojo; 
  2.  
  3. /** 
  4.  * view类型的菜单 
  5.  *  
  6.  * @author liuyq 
  7.  * @date 2013-04-10 
  8.  */ 
  9. public class ViewButton extends Button { 
  10.     private String type; 
  11.     private String url; 
  12.  
  13.     public String getType() { 
  14.         return type; 
  15.     } 
  16.  
  17.     public void setType(String type) { 
  18.         this.type = type; 
  19.     } 
  20.  
  21.     public String getUrl() { 
  22.         return url; 
  23.     } 
  24.  
  25.     public void setUrl(String url) { 
  26.         this.url = url; 
  27.     } 

创建带view类型的菜单示例

我们对前面给出的菜单创建代码进行调整,增加view类型的菜单项,完整的菜单创建代码如下:

  1. package org.liufeng.weixin.main; 
  2.  
  3. import org.liufeng.weixin.pojo.AccessToken; 
  4. import org.liufeng.weixin.pojo.Button; 
  5. import org.liufeng.weixin.pojo.CommonButton; 
  6. import org.liufeng.weixin.pojo.ComplexButton; 
  7. import org.liufeng.weixin.pojo.Menu; 
  8. import org.liufeng.weixin.pojo.ViewButton; 
  9. import org.liufeng.weixin.util.WeixinUtil; 
  10. import org.slf4j.Logger; 
  11. import org.slf4j.LoggerFactory; 
  12.  
  13. /** 
  14.  * 菜单管理器类 
  15.  *  
  16.  * @author liufeng 
  17.  * @date 2013-08-08 
  18.  */ 
  19. public class MenuManager { 
  20.     private static Logger log = LoggerFactory.getLogger(MenuManager.class); 
  21.  
  22.     public static void main(String[] args) { 
  23.         // 第三方用户唯一凭证 
  24.         String appId = "000000000000000000"
  25.         // 第三方用户唯一凭证密钥 
  26.         String appSecret = "00000000000000000000000000000000"
  27.  
  28.         // 调用接口获取access_token 
  29.         AccessToken at = WeixinUtil.getAccessToken(appId, appSecret); 
  30.  
  31.         if (null != at) { 
  32.             // 调用接口创建菜单 
  33.             int result = WeixinUtil.createMenu(getMenu(), at.getToken()); 
  34.  
  35.             // 判断菜单创建结果 
  36.             if (0 == result) 
  37.                 log.info("菜单创建成功!"); 
  38.             else 
  39.                 log.info("菜单创建失败,错误码:" + result); 
  40.         } 
  41.     } 
  42.  
  43.     /** 
  44.      * 组装菜单数据 
  45.      *  
  46.      * @return 
  47.      */ 
  48.     private static Menu getMenu() { 
  49.         CommonButton btn11 = new CommonButton(); 
  50.         btn11.setName("天气预报"); 
  51.         btn11.setType("click"); 
  52.         btn11.setKey("11"); 
  53.  
  54.         CommonButton btn12 = new CommonButton(); 
  55.         btn12.setName("公交查询"); 
  56.         btn12.setType("click"); 
  57.         btn12.setKey("12"); 
  58.  
  59.         CommonButton btn13 = new CommonButton(); 
  60.         btn13.setName("周边搜索"); 
  61.         btn13.setType("click"); 
  62.         btn13.setKey("13"); 
  63.  
  64.         CommonButton btn14 = new CommonButton(); 
  65.         btn14.setName("历史上的今天"); 
  66.         btn14.setType("click"); 
  67.         btn14.setKey("14"); 
  68.          
  69.         CommonButton btn15 = new CommonButton(); 
  70.         btn15.setName("电影排行榜"); 
  71.         btn15.setType("click"); 
  72.         btn15.setKey("32"); 
  73.  
  74.         CommonButton btn21 = new CommonButton(); 
  75.         btn21.setName("歌曲点播"); 
  76.         btn21.setType("click"); 
  77.         btn21.setKey("21"); 
  78.  
  79.         CommonButton btn22 = new CommonButton(); 
  80.         btn22.setName("经典游戏"); 
  81.         btn22.setType("click"); 
  82.         btn22.setKey("22"); 
  83.  
  84.         CommonButton btn23 = new CommonButton(); 
  85.         btn23.setName("美女电台"); 
  86.         btn23.setType("click"); 
  87.         btn23.setKey("23"); 
  88.  
  89.         CommonButton btn24 = new CommonButton(); 
  90.         btn24.setName("人脸识别"); 
  91.         btn24.setType("click"); 
  92.         btn24.setKey("24"); 
  93.  
  94.         CommonButton btn25 = new CommonButton(); 
  95.         btn25.setName("聊天唠嗑"); 
  96.         btn25.setType("click"); 
  97.         btn25.setKey("25"); 
  98.  
  99.         CommonButton btn31 = new CommonButton(); 
  100.         btn31.setName("Q友圈"); 
  101.         btn31.setType("click"); 
  102.         btn31.setKey("31"); 
  103.  
  104.         CommonButton btn33 = new CommonButton(); 
  105.         btn33.setName("幽默笑话"); 
  106.         btn33.setType("click"); 
  107.         btn33.setKey("33"); 
  108.          
  109.         CommonButton btn34 = new CommonButton(); 
  110.         btn34.setName("用户反馈"); 
  111.         btn34.setType("click"); 
  112.         btn34.setKey("34"); 
  113.          
  114.         CommonButton btn35 = new CommonButton(); 
  115.         btn35.setName("关于我们"); 
  116.         btn35.setType("click"); 
  117.         btn35.setKey("35"); 
  118.          
  119.         ViewButton btn32 = new ViewButton(); 
  120.         btn32.setName("使用帮助"); 
  121.         btn32.setType("view"); 
  122.         btn32.setUrl("http://liufeng.gotoip2.com/xiaoqrobot/help.jsp"); 
  123.  
  124.         ComplexButton mainBtn1 = new ComplexButton(); 
  125.         mainBtn1.setName("生活助手"); 
  126.         mainBtn1.setSub_button(new Button[] { btn11, btn12, btn13, btn14, btn15 }); 
  127.  
  128.         ComplexButton mainBtn2 = new ComplexButton(); 
  129.         mainBtn2.setName("休闲驿站"); 
  130.         mainBtn2.setSub_button(new Button[] { btn21, btn22, btn23, btn24, btn25 }); 
  131.  
  132.         ComplexButton mainBtn3 = new ComplexButton(); 
  133.         mainBtn3.setName("更多"); 
  134.         mainBtn3.setSub_button(new Button[] { btn31, btn33, btn34, btn35, btn32 }); 
  135.  
  136.         /** 
  137.          * 这是公众号xiaoqrobot目前的菜单结构,每个一级菜单都有二级菜单项<br> 
  138.          *  
  139.          * 在某个一级菜单下没有二级菜单的情况,menu该如何定义呢?<br> 
  140.          * 比如,第三个一级菜单项不是“更多体验”,而直接是“幽默笑话”,那么menu应该这样定义:<br> 
  141.          * menu.setButton(new Button[] { mainBtn1, mainBtn2, btn33 }); 
  142.          */ 
  143.         Menu menu = new Menu(); 
  144.         menu.setButton(new Button[] { mainBtn1, mainBtn2, mainBtn3 }); 
  145.  
  146.         return menu; 
  147.     } 

 

责任编辑:徐川 来源: blog
相关推荐

2014-09-24 11:45:15

微信企业号开发

2013-11-13 00:37:12

微信微信公号微信公众账号

2013-11-13 01:25:33

微信微信公号微信公众账号

2013-04-10 18:40:59

微信公众平台接口开发

2021-03-04 00:06:16

微信开发自定义

2013-03-28 11:32:07

微信菜单轻App

2015-02-12 15:33:43

微信SDK

2013-11-13 01:19:18

2013-11-13 00:14:16

微信微信公号微信公众账号

2015-02-12 15:38:26

微信SDK

2013-03-25 17:26:09

2013-11-12 23:32:53

微信公号微信公众账号

2013-11-13 00:20:01

微信微信公号微信公众账号

2014-09-28 22:38:21

微信企业号

2021-11-04 09:55:50

鸿蒙HarmonyOS应用

2011-04-25 14:26:32

Ubuntu菜单

2022-05-18 07:44:13

自定义菜单前端

2011-08-02 11:17:13

iOS开发 View

2023-08-10 17:14:52

鸿蒙自定义弹窗

2021-11-24 10:02:53

鸿蒙HarmonyOS应用
点赞
收藏

51CTO技术栈公众号