java微信开发API第四步 微信自定义个性化菜单实现
微信如何实现自定义个性化菜单,下面为大家介绍
一、全局说明
详细说明请参考前两篇文章。
二、本文说明
本文分为五部分:
* 工具类accesstokenutils的封装
* 自定义菜单和个性化菜单文档的阅读解析
* 菜单json的分析以及构建对应bean
* 自定义菜单的实现
* 个性化菜单的实现
微信自定义菜单所有类型菜单都给出演示
本文结束会给出包括本文前四篇文章的所有演示源码
工具类accesstokenutils的封装
在上文中关于accesstoken的获取和定时保存已经详细介绍过,此处直接给出处理过之后封装的accesstokenutils,实现原理以及文档阅读不再给出。
accesstokenutils.java
package com.gist.utils; import java.io.file; import java.io.fileinputstream; import java.io.fileoutputstream; import java.io.ioexception; import java.io.inputstreamreader; import java.net.url; import javax.net.ssl.httpsurlconnection; import com.gist.bean.access_token; import com.google.gson.gson; /** * @author 高远</n> 邮箱:wgyscsf@163.com</n> 博客 http://blog.csdn.net/wgyscsf</n> * 编写时期 2016-4-7 下午5:44:33 */ public class accesstokenutils { private static final long max_time = 7200 * 1000;// 微信允许最长access_token有效时间(ms) private static final string tag = "weixinapitest";// tag private static final string appid = "wx889b020b3666b0b8";// appid private static final string secert = "6da7676bf394f0a9f15fbf06027856bb";// 秘钥 /* * 该方法实现获取access_token、保存并且只保存2小时access_token。如果超过两个小时重新获取;如果没有超过两个小时,直接获取。该方法依赖 * :public static string getaccesstoken(); * * 思路:将获取到的access_token和当前时间存储到file里, * 取出时判断当前时间和存储里面的记录的时间的时间差,如果大于max_time,重新获取,并且将获取到的存储到file替换原来的内容 * ,如果小于max_time,直接获取。 */ // 为了调用不抛异常,这里全部捕捉异常,代码有点长 public static string getsavedaccess_token() { gson gson = new gson();// 第三方jar,处理json和bean的转换 string maccess_token = null;// 需要获取的access_token; fileoutputstream fos = null;// 输出流 fileinputstream fis = null;// 输入流 file file = new file("temp_access_token.temp");// access_token保存的位置 try { // 如果文件不存在,创建 if (!file.exists()) { file.createnewfile(); } } catch (exception e1) { e1.printstacktrace(); } // 如果文件大小等于0,说明第一次使用,存入access_token if (file.length() == 0) { try { maccess_token = getaccesstoken();// 获取accesstoken access_token at = new access_token(); at.setaccess_token(maccess_token); at.setexpires_in(system.currenttimemillis() + "");// 设置存入时间 string json = gson.tojson(at); fos = new fileoutputstream(file, false);// 不允许追加 fos.write((json).getbytes());// 将accesstoken和当前时间存入文件 fos.close(); return maccess_token; } catch (exception e) { e.printstacktrace(); } } else { // 读取文件内容 byte[] b = new byte[2048]; int len = 0; try { fis = new fileinputstream(file); len = fis.read(b); } catch (ioexception e1) { // todo auto-generated catch block e1.printstacktrace(); } string mjsonaccess_token = new string(b, 0, len);// 读取到的文件内容 access_token access_token = gson.fromjson(mjsonaccess_token, new access_token().getclass()); if (access_token.getexpires_in() != null) { long savetime = long.parselong(access_token.getexpires_in()); long nowtime = system.currenttimemillis(); long remiantime = nowtime - savetime; // system.out.println(tag + "时间差:" + remiantime + "ms"); if (remiantime < max_time) { access_token at = gson.fromjson(mjsonaccess_token, new access_token().getclass()); maccess_token = at.getaccess_token(); return maccess_token; } else { maccess_token = getaccesstoken(); access_token at = new access_token(); at.setaccess_token(maccess_token); at.setexpires_in(system.currenttimemillis() + ""); string json = gson.tojson(at); try { fos = new fileoutputstream(file, false);// 不允许追加 fos.write((json).getbytes()); fos.close(); } catch (ioexception e) { // todo auto-generated catch block e.printstacktrace(); } return maccess_token; } } else { return null; } } return maccess_token; } /* * 获取微信服务器accesstoken。该部分和getaccess_token() 一致,不再加注释 */ public static string getaccesstoken() { string urlstring = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=" + appid + "&secret=" + secert; string reslut = null; try { url requrl = new url(urlstring); httpsurlconnection httpsconn = (httpsurlconnection) requrl .openconnection(); inputstreamreader isr = new inputstreamreader( httpsconn.getinputstream()); char[] chars = new char[1024]; reslut = ""; int len; while ((len = isr.read(chars)) != -1) { reslut += new string(chars, 0, len); } isr.close(); } catch (ioexception e) { e.printstacktrace(); } gson gson = new gson(); access_token access_token = gson.fromjson(reslut, new access_token().getclass()); if (access_token.getaccess_token() != null) { return access_token.getaccess_token(); } else { return null; } } }
自定义菜单和个性化菜单文档的阅读解析
•自定义菜单
◦自定义菜单创建接口
◦自定义菜单查询接口
◦自定义菜单删除接口
◦自定义菜单事件推送
◦个性化菜单接口
◦获取公众号的菜单配置
•文档地址:http://mp.weixin.qq.com/wiki/10/0234e39a2025342c17a7d23595c6b40a.html
•官网文档给出这样解释:
* 自定义菜单接口可实现多种类型按钮,如下:1、click:点击事件...;2、view:跳转事件...;3、...(关于自定义菜单)
* 接口调用请求说明 http请求方式:post(请使用https协议) https://api.weixin.qq.com/cgi-bin/menu/create?access_token=access_token(关于自定义菜单)
* click和view的请求示例 {"button":[...]} (关于自定义菜单)
* 参数说明...(关于自定义菜单)
* 创建个性化菜单http请求方式:post(请使用https协议)https://api.weixin.qq.com/cgi-bin/menu/addconditional?access_token=access_token(关于个性化菜单)
* 请求示例: {"button":[...],"matchrule":{...}}(关于个性化菜单)
* 参数说明...(关于个性化菜单)
* 开发者可以通过以下条件来设置用户看到的菜单(关于个性化菜单):
1、用户分组(开发者的业务需求可以借助用户分组来完成)
2、性别
3、手机操作系统
4、地区(用户在微信客户端设置的地区)
5、语言(用户在微信客户端设置的语言)
•理解:
◦又是熟悉的post请求,但是,关于调用貌似说的含糊其辞,不太明白。只是知道我们需要使用“?access_token=access_token”这个参数,这个参数我们在上篇文章已经获取到了。假如我们将微信文档给的那个请求地址中“access_token”换成我们获取到的自己的access_token,访问该网址,会看到“{“errcode”:44002,”errmsg”:”empty post data hint: [gdveda0984vr23]”}”。大概意思是,空的post请求数据。所以,我们要通过post请求的形式传递参数给微信服务器,在文档下面还给出了参数的格式:{“button”:[…]},所以,我们要按照该格式给微信服务器进行传递参数。
◦关于参数说明,我们可以看到在自定义菜单创建中有七个参数。在个性化菜单接口中除去这七个参数之外,另外多个八个参数。简单查看此部分文档,我们可以了解到这个八个参数是为了个性化菜单做匹配筛选用的。
◦现在,我们需要按照微信文档的要求构造json通过post的请求向微信服务器发送这一串json数据,json里面就包括我们创建的各种类型的按钮事件。
菜单json的分析以及构建对应bean
自定义菜单json分析(不包括个性化菜单)。下面这段代码是微信文档给的示例。
click和view的请求示例
{ "button":[ { "type":"click", "name":"今日歌曲", "key":"v1001_today_music" }, { "name":"菜单", "sub_button":[ { "type":"view", "name":"搜索", "url":"http://www.soso.com/" }, { "type":"view", "name":"视频", "url":"http://v.qq.com/" }, { "type":"click", "name":"赞一下我们", "key":"v1001_good" }] }] }
经过分析我们可以看到这串json数据分为三层:“”button”:[{…},{…}]”、“[{…},{{“name”:菜单,”sub_button”:[{},{}]}]”、“{“type”:”view”,”name:”:”视频”,”url”:”…”},{},{}”,可能看起来比较晕。
但是,如果我们能够联想起来现实中看到的微信菜单,就会好理解一点:一级:菜单(一个菜单),下包括一到三个父按钮;二级:父按钮(1~3个父按钮),下包括一到五个子按钮;三级:子按钮(1~5个子按钮)。
现在,我们可以看到json和我们理解的“菜单”可以一一对应起来了。现在重点是如何确认每一级的“级名”,在java中也就是对应的javabean对象。
同时,因为一级菜单下会有多个父按钮,所以是一个list<父菜单>的形式。父按钮下可能有多个子菜单,也是一个 list<子菜单>;但是,父按钮也有可能也是一个单独的可以响应的按钮。是一个单独的父按钮对象。子按钮就是一个单独的子按钮对象。
查看关于自定义菜单的参数说明,我们可以看到按钮分为一级按钮(“button”)和二级按钮(“sub_button”)。还有一些公用的数据类型,例如:菜单响应类型(“type”)、菜单标题(“name”)、click类型的参数(“key”)、view类型的参数(“url”)、media_id类型和view_limited类型的参数(“media_id”)。
•数据抽象(没有写setter,getter):
//按钮基类 public class basebutton { private string type; private string name; private string key; private string url; private string media_id; } //子按钮 public class sonbutton extends basebutton { private string sub_button; } //父按钮 public class fatherbutton extends basebutton { private string button;//可能直接一个父按钮做响应 @serializedname("sub_button")//为了保证gson解析后子按钮的名字是“sub_button”,具体用法请搜索 private list<sonbutton> sonbuttons;//可能有多个子按钮 } public class menu { @serializedname("button") private list<fatherbutton> fatherbuttons; }
以上是完整的自定义菜单的分析以及对应javabean的构建。
对于个性化菜单,如果查看该部分的文档,会发现和自定义菜单大致相同,只是多个一个“配置”的json,格式是这样的:{“button”:[…],”matchrule”:{…}}。
我们发现,“匹配”这段json和“button”是同级的,分析和实现和上面基本等同,直接给出实现的javabean。
//匹配的json对应的json public class matchrule { private string group_id; private string sex; private string client_platform_type; private string country; private string province; private string city; private string language; } //修改menu.java public class menu { @serializedname("button") private list<fatherbutton> fatherbuttons; private matchrule matchrule; }
自定义菜单的实现
任务,我们实现所有微信按钮响应类型:
任务(注释:“m-0”表示父按钮;“m-n”表示第m个父按钮,第n个子按钮(m,n≠0)):1-0:名字:click,响应点击事件:点击推事件 。2-0:名字:父按钮2。2-1:名字:view,响应事件:跳转网页;2-2:名字:scancode_push,响应事件:扫码推事件;2-3:名字:scancode_waitmsg,响应事件:扫码推事件且弹出“消息接收中”提示框;2-4:名字:pic_sysphoto,响应事件
:弹出系统拍照发图。2-5:名字:pic_photo_or_album,响应事件:弹出拍照或者相册发图。3-0:名字:父按钮3。3-1:名字
:pic_weixin,响应事件:弹出微信相册发图器;3-2:名字:location_select,响应事件:弹出地理位置选择器;3-3:名字:media_id,响应事件:下发消息(除文本消息);3-4:名字:view_limited,响应事件:跳转图文消息url。
实现源码(引用的accesstokenutils.java在第一部分:工具类accesstokenutils的封装)
/* * 创建自定义菜单。 */ @test public void createcommmenu() { string access_token = accesstokenutils.getaccesstoken();// 获取accesstoken,accesstokenutils是封装好的类 // 拼接api要求的httpsurl链接 string urlstring = "https://api.weixin.qq.com/cgi-bin/menu/create?access_token=" + access_token; try { // 创建一个url url requrl = new url(urlstring); // 拿取链接 httpsurlconnection httpsconn = (httpsurlconnection) requrl .openconnection(); httpsconn.setdooutput(true); // 取得该连接的输出流,以读取响应内容 outputstreamwriter osr = new outputstreamwriter( httpsconn.getoutputstream()); osr.write(getmenujson());// 使用本类外部方法getmenujson() osr.close(); // 返回结果 inputstreamreader isr = new inputstreamreader( httpsconn.getinputstream()); // 读取服务器的响应内容并显示 char[] chars = new char[1024]; string reslut = ""; int len; while ((len = isr.read(chars)) != -1) { reslut += new string(chars, 0, len); } system.out.println("返回结果:" + reslut); isr.close(); } catch (ioexception e) { e.printstacktrace(); } } public string getmenujson() { gson gson = new gson();// json处理工具 menu menu = new menu();// 菜单类 list<fatherbutton> fatherbuttons = new arraylist<fatherbutton>();// 菜单中的父按钮集合 // ----------- // 父按钮1 fatherbutton fb1 = new fatherbutton(); fb1.setname("click"); fb1.settype("click"); fb1.setkey("10"); // ------------- // 父按钮2 fatherbutton fb2 = new fatherbutton(); fb2.setname("父按钮2"); list<sonbutton> sonbuttons2 = new arraylist<sonbutton>();// 子按钮的集合 // 子按钮2-1 sonbutton sb21 = new sonbutton(); sb21.setname("view"); sb21.seturl("http://www.baidu.com"); sb21.settype("view"); // 子按钮2-2 sonbutton sb22 = new sonbutton(); sb22.setname("scancode_push"); sb22.settype("scancode_push"); sb22.setkey("22"); // 子按钮2-3 sonbutton sb23 = new sonbutton(); sb23.setname("scancode_waitmsg"); sb23.settype("scancode_waitmsg"); sb23.setkey("23"); // 子按钮2-4 sonbutton sb24 = new sonbutton(); sb24.setname("pic_sysphoto"); sb24.settype("pic_sysphoto"); sb24.setkey("24"); // 子按钮2-5 sonbutton sb25 = new sonbutton(); sb25.setname("pic_photo_or_album"); sb25.settype("pic_photo_or_album"); sb25.setkey("25"); // 添加子按钮到子按钮集合 sonbuttons2.add(sb21); sonbuttons2.add(sb22); sonbuttons2.add(sb23); sonbuttons2.add(sb24); sonbuttons2.add(sb25); // 将子按钮放到2-0父按钮集合 fb2.setsonbuttons(sonbuttons2); // ------------------ // 父按钮3 fatherbutton fb3 = new fatherbutton(); fb3.setname("父按钮3"); list<sonbutton> sonbuttons3 = new arraylist<sonbutton>(); // 子按钮3-1 sonbutton sb31 = new sonbutton(); sb31.setname("pic_weixin"); sb31.settype("pic_weixin"); sb31.setkey("31"); // 子按钮3-2 sonbutton sb32 = new sonbutton(); sb32.setname("locatselect"); sb32.settype("location_select"); sb32.setkey("32"); // // 子按钮3-3-->测试不了,因为要media_id。这需要调用素材id. // sonbutton sb33 = new sonbutton(); // sb33.setname("media_id"); // sb33.settype("media_id"); // sb33.setmedia_id("???"); // // 子按钮3-4-->测试不了,因为要media_id。这需要调用素材id. // sonbutton sb34 = new sonbutton(); // sb34.setname("view_limited"); // sb34.settype("view_limited"); // sb34.setmedia_id("???"); // 添加子按钮到子按钮队列 sonbuttons3.add(sb31); sonbuttons3.add(sb32); // sonbuttons3.add(sb33); // sonbuttons3.add(sb34); // 将子按钮放到3-0父按钮队列 fb3.setsonbuttons(sonbuttons3); // --------------------- // 将父按钮加入到父按钮集合 fatherbuttons.add(fb1); fatherbuttons.add(fb2); fatherbuttons.add(fb3); // 将父按钮队列加入到菜单栏 menu.setfatherbuttons(fatherbuttons); string json = gson.tojson(menu); system.out.println(json);// 测试输出 return json; }
个性化菜单的实现
•任务:根据性别展示不同的按钮显示(可以根据性别、地区、分组手机操作系统等)
•修改代码一,因为是不同的微信后台实现,所以接口也不一样,不过还是post请求,代码不用改,只要替换原来urlstring即可。
// 拼接api要求的httpsurl链接 string urlstring = "https://api.weixin.qq.com/cgi-bin/menu/addconditional?access_token=" + access_token;
•修改代码二,只要创建一个matchrule,设置匹配规则,然后将matchrule加入到menu便可以完成匹配规则。
// ----- // 从此处开始设置个性菜单 matchrule matchrule = new matchrule(); matchrule.setsex("2");// 男生 menu.setmatchrule(matchrule); // ----
源码下载:http://xiazai.jb51.net/201606/yuanma/weixinapi(jb51.net).rar
本文已被整理到了《android微信开发教程汇总》,《java微信开发教程汇总》欢迎大家学习阅读。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
上一篇: 很有意思的自嘲
下一篇: Docker 创建私有仓库