微信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方式訪问例如以下链接:
链接中有三个参数,各自是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;
-
-
-
-
-
-
-
- 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;
-
-
-
-
-
-
-
- public class WeixinUtil {
- private static Logger log = LoggerFactory.getLogger(WeixinUtil.class);
-
-
-
-
-
-
-
-
-
- public static JSONObject httpRequest(String requestUrl, String requestMethod, String outputStr) {
- JSONObject jsonObject = null;
- StringBuffer buffer = new StringBuffer();
- try {
-
- TrustManager[] tm = { new MyX509TrustManager() };
- SSLContext sslContext = SSLContext.getInstance("SSL", "SunJSSE");
- sslContext.init(null, tm, new java.security.SecureRandom());
-
- 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);
-
- 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;
-
-
-
-
-
-
-
- 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;
-
-
-
-
-
-
-
- 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;
-
-
-
-
-
-
-
- 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;
-
-
-
-
-
-
-
- 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个),这些菜单项即能够是子菜单项(不含二级菜单的一级菜单),也能够是父菜单项(包括二级菜单的菜单项),假设能明确上面所讲的,再来看封装后的代码就非常easy理解了:
- package org.liufeng.weixin.pojo;
-
-
-
-
-
-
-
- public class Menu {
- private Button[] button;
-
- public Button[] getButton() {
- return button;
- }
-
- public void setButton(Button[] button) {
- this.button = button;
- }
- }
关于POJO类的封装就介绍完了。
凭证access_token的获取方法
继续在先前通用请求方法的类WeixinUtil.java中添加下面代码,用于获取接口訪问凭证:
-
- public final static String access_token_url = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET";
-
-
-
-
-
-
-
-
- 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;
-
- log.error("获取token失败 errcode:{} errmsg:{}", jsonObject.getInt("errcode"), jsonObject.getString("errmsg"));
- }
- }
- return accessToken;
- }
自己定义菜单的创建方法
继续在先前通用请求方法的类WeixinUtil.java中添加下面代码,用于创建自己定义菜单:
-
- public static String menu_create_url = "https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN";
-
-
-
-
-
-
-
-
- public static int createMenu(Menu menu, String accessToken) {
- int result = 0;
-
-
- String url = menu_create_url.replace("ACCESS_TOKEN", accessToken);
-
- 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;
- }
调用封装的方法创建自己定义菜单
- package org.liufeng.weixin.main;
-
- import org.liufeng.weixin.pojo.AccessToken;
- import org.liufeng.weixin.pojo.Button;
- import org.liufeng.weixin.pojo.CommonButton;
- import org.liufeng.weixin.pojo.ComplexButton;
- import org.liufeng.weixin.pojo.Menu;
- import org.liufeng.weixin.util.WeixinUtil;
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
-
-
-
-
-
-
-
- public class MenuManager {
- private static Logger log = LoggerFactory.getLogger(MenuManager.class);
-
- public static void main(String[] args) {
-
- String appId = "000000000000000000";
-
- String appSecret = "00000000000000000000000000000000";
-
-
- AccessToken at = WeixinUtil.getAccessToken(appId, appSecret);
-
- if (null != at) {
-
- int result = WeixinUtil.createMenu(getMenu(), at.getToken());
-
-
- if (0 == result)
- log.info("菜单创建成功!");
- else
- log.info("菜单创建失败,错误码:" + result);
- }
- }
-
-
-
-
-
-
- private static Menu getMenu() {
- CommonButton btn11 = new CommonButton();
- btn11.setName("天气预报");
- btn11.setType("click");
- btn11.setKey("11");
-
- CommonButton btn12 = new CommonButton();
- btn12.setName("公交查询");
- btn12.setType("click");
- btn12.setKey("12");
-
- CommonButton btn13 = new CommonButton();
- btn13.setName("周边搜索");
- btn13.setType("click");
- btn13.setKey("13");
-
- CommonButton btn14 = new CommonButton();
- btn14.setName("历史上的今天");
- btn14.setType("click");
- btn14.setKey("14");
-
- CommonButton btn21 = new CommonButton();
- btn21.setName("歌曲点播");
- btn21.setType("click");
- btn21.setKey("21");
-
- CommonButton btn22 = new CommonButton();
- btn22.setName("经典游戏");
- btn22.setType("click");
- btn22.setKey("22");
-
- CommonButton btn23 = new CommonButton();
- btn23.setName("美女电台");
- btn23.setType("click");
- btn23.setKey("23");
-
- CommonButton btn24 = new CommonButton();
- btn24.setName("人脸识别");
- btn24.setType("click");
- btn24.setKey("24");
-
- CommonButton btn25 = new CommonButton();
- btn25.setName("聊天唠嗑");
- btn25.setType("click");
- btn25.setKey("25");
-
- CommonButton btn31 = new CommonButton();
- btn31.setName("Q友圈");
- btn31.setType("click");
- btn31.setKey("31");
-
- CommonButton btn32 = new CommonButton();
- btn32.setName("电影排行榜");
- btn32.setType("click");
- btn32.setKey("32");
-
- CommonButton btn33 = new CommonButton();
- btn33.setName("幽默笑话");
- btn33.setType("click");
- btn33.setKey("33");
-
- ComplexButton mainBtn1 = new ComplexButton();
- mainBtn1.setName("生活助手");
- mainBtn1.setSub_button(new CommonButton[] { btn11, btn12, btn13, btn14 });
-
- ComplexButton mainBtn2 = new ComplexButton();
- mainBtn2.setName("休闲驿站");
- mainBtn2.setSub_button(new CommonButton[] { btn21, btn22, btn23, btn24, btn25 });
-
- ComplexButton mainBtn3 = new ComplexButton();
- mainBtn3.setName("许多其他体验");
- mainBtn3.setSub_button(new CommonButton[] { btn31, btn32, btn33 });
-
-
-
-
-
-
-
-
- Menu menu = new Menu();
- menu.setButton(new Button[] { mainBtn1, mainBtn2, mainBtn3 });
-
- return menu;
- }
- }
注意:在运行以上代码时,须要将appId和appSecret换成你自己公众号的。
整个工程的结构
为了保证文章的完整独立性和可读性,我是新建了一个Java Project(Java web工程也能够,沒有太大关系),沒有在前几篇文章所讲到的weixinCourse工程中增加代码。假设须要,读者能够自己实现将菜单创建的代码移到自己已有的工程中去。
图中全部Java文件的源码都在文章中贴出并进行了说明,图中使用到的jar也是Java开发中通用的jar包,非常easy在网上下载到。
工程中引入的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类要怎么改写,才干接收响应菜单点击事件,该类改动后的完整代码例如以下:
代码说明:
1)第69行、第81行这两行代码说明了怎样推断菜单的点击事件。当消息类型MsgType=event,而且Event=CLICK时,就表示是自己定义菜单点击事件;
2)第83行是推断详细点击的是哪个菜单项,依据菜单的key值来推断;
3)第85~109行表示当用户点击某个菜单项后,详细返回什么消息,我仅仅是做个简单演示例子,统一返回文本消息,读者能够依据实际须要来灵活处理。
总结
到这里关于自己定义菜单的创建、菜单事件的推断和处理响应就全部介绍完了。我仅仅希望看过文章的人不要仅仅是拷贝代码,假设是这样,我全然不用花这么多的时间来写这篇文章,直接把工程放在下载区多简单。另外,网上是有非常多工具,让你填入appid,appsecret和菜单结构,提交就能创建菜单,请慎用!由于appid和appsecret一旦告诉别人,你的公众号的菜单控制权就在别人手上了,总会有别实用心的人出来搞点事的。
假设认为文章对你有所帮助,请通过留言或关注微信公众帐号xiaoqrobot来支持柳峰!
转帖请注明本文出自柳峰的博客(http://blog.csdn.net/lyq8479),请尊重他人的辛勤劳动成果,谢谢!