Java微信公众平台开发之自定义菜单

 

 

一、自定义菜单的说明和按钮类型

1、菜单说明

1)自定义菜单最多包括3个一级菜单，每个一级菜单最多包含5个二级菜单。

2)一级菜单最多4个汉字，二级菜单最多7个汉字，多出来的部分将会以“...”代替。

3)创建自定义菜单后，菜单的刷新策略是，在用户进入公众号会话页或公众号profile页时，如果发现上一次拉取菜单的请求在5分钟以前，就会拉取一下菜单，如果菜单有更新，就会刷新客户端的菜单。测试时可以尝试取消关注公众账号后再次关注，则可以看到创建后的效果。

2、自定义菜单接口可实现多种类型按钮

1)click：点击推事件用户点击click类型按钮后，微信服务器会通过消息接口推送消息类型为event的结构给开发者（参考消息接口指南），并且带上按钮中开发者填写的key值，开发者可以通过自定义的key值与用户进行交互；
2)view：跳转URL用户点击view类型按钮后，微信客户端将会打开开发者在按钮中填写的网页URL，可与网页授权获取用户基本信息接口结合，获得用户基本信息。
3)scancode_push：扫码推事件用户点击按钮后，微信客户端将调起扫一扫工具，完成扫码操作后显示扫描结果（如果是URL，将进入URL），且会将扫码的结果传给开发者，开发者可以下发消息。
4)scancode_waitmsg：扫码推事件且弹出“消息接收中”提示框用户点击按钮后，微信客户端将调起扫一扫工具，完成扫码操作后，将扫码的结果传给开发者，同时收起扫一扫工具，然后弹出“消息接收中”提示框，随后可能会收到开发者下发的消息。
5)pic_sysphoto：弹出系统拍照发图用户点击按钮后，微信客户端将调起系统相机，完成拍照操作后，会将拍摄的相片发送给开发者，并推送事件给开发者，同时收起系统相机，随后可能会收到开发者下发的消息。
6)pic_photo_or_album：弹出拍照或者相册发图用户点击按钮后，微信客户端将弹出选择器供用户选择“拍照”或者“从手机相册选择”。用户选择后即走其他两种流程。
7)pic_weixin：弹出微信相册发图器用户点击按钮后，微信客户端将调起微信相册，完成选择操作后，将选择的相片发送给开发者的服务器，并推送事件给开发者，同时收起相册，随后可能会收到开发者下发的消息。
8)location_select：弹出地理位置选择器用户点击按钮后，微信客户端将调起地理位置选择工具，完成选择操作后，将选择的地理位置发送给开发者的服务器，同时收起位置选择工具，随后可能会收到开发者下发的消息。
9)media_id：下发消息（除文本消息）用户点击media_id类型按钮后，微信服务器会将开发者填写的永久素材id对应的素材下发给用户，永久素材类型可以是图片、音频、视频、图文消息。请注意：永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。
10)view_limited：跳转图文消息URL用户点击view_limited类型按钮后，微信客户端将打开开发者在按钮中填写的永久素材id对应的图文消息URL，永久素材类型只支持图文消息。请注意：永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。

说明：3到8的所有事件，仅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用户，旧版本微信用户点击后将没有回应，开发者也不能正常接收到事件推送。9和10，是专门给第三方平台旗下未微信认证（具体而言，是资质认证未通过）的订阅号准备的事件类型，它们是没有事件推送的，能力相对受限，其他类型的公众号不必使用。

 

二、菜单的创建/查询/删除

官方的click和view事件demo

1. {

2. "button":[

3. {

4. "type":"click",

5. "name":"今日歌曲",

6. "key":"V1001_TODAY_MUSIC"

7. },

8. {

9. "name":"菜单",

10. "sub_button":[

11. {

12. "type":"view",

13. "name":"搜索",

14. "url":"http://www.soso.com/"

15. },

16. {

17. "type":"miniprogram",

18. "name":"wxa",

19. "url":"http://mp.weixin.qq.com",

20. "appid":"wx286b93c14bbf93aa",

21. "pagepath":"pages/lunar/index"

22. },

23. {

24. "type":"click",

25. "name":"赞一下我们",

26. "key":"V1001_GOOD"

27. }]

28. }]

29. }

其他类型(包括9、10)

 

1. {

2. "button": [

3. {

4. "name": "扫码",

5. "sub_button": [

6. {

7. "type": "scancode_waitmsg",

8. "name": "扫码带提示",

9. "key": "rselfmenu_0_0",

10. "sub_button": [ ]

11. },

12. {

13. "type": "scancode_push",

14. "name": "扫码推事件",

15. "key": "rselfmenu_0_1",

16. "sub_button": [ ]

17. }

18. ]

19. },

20. {

21. "name": "发图",

22. "sub_button": [

23. {

24. "type": "pic_sysphoto",

25. "name": "系统拍照发图",

26. "key": "rselfmenu_1_0",

27. "sub_button": [ ]

28. },

29. {

30. "type": "pic_photo_or_album",

31. "name": "拍照或者相册发图",

32. "key": "rselfmenu_1_1",

33. "sub_button": [ ]

34. },

35. {

36. "type": "pic_weixin",

37. "name": "微信相册发图",

38. "key": "rselfmenu_1_2",

39. "sub_button": [ ]

40. }

41. ]

42. },

43. {

44. "name": "发送位置",

45. "type": "location_select",

46. "key": "rselfmenu_2_0"

47. },

48. {

49. "type": "media_id",

50. "name": "图片",

51. "media_id": "MEDIA_ID1"

52. },

53. {

54. "type": "view_limited",

55. "name": "图文消息",

56. "media_id": "MEDIA_ID2"

57. }

58. ]

59. }

1、根据实例开始封装实体类

菜单按钮基类BasicButton.java

1. public class BasicButton {

2.  

3. private String name;

4.  

5. public String getName() {

6. return name;

7. }

8.  

9. public void setName(String name) {

10. this.name = name;

11. }

12. }

菜单Menu.java

1. public class Menu {

2.  

3. public final static String CLICK = "click"; // click菜单

4. public final static String VIEW = "view"; // url菜单

5. public final static String SCANCODE_WAITMSG = "scancode_waitmsg"; // 扫码带提示

6. public final static String SCANCODE_PUSH = "scancode_push"; // 扫码推事件

7. public final static String PIC_SYSPHOTO = "pic_sysphoto"; // 系统拍照发图

8. public final static String PIC_PHOTO_OR_ALBUM = "pic_photo_or_album"; // 拍照或者相册发图

9. public final static String PIC_WEIXIN = "pic_weixin"; // 微信相册发图

10. public final static String LOCATION_SELECT = "location_select"; // 发送位置

11.  

12. private BasicButton[] button;

13.  

14. public BasicButton[] getButton() {

15. return button;

16. }

17.  

18. public void setButton(BasicButton[] button) {

19. this.button = button;

20. }

21. }

view类型按钮类ViewButton.java，其他的类型可以照此一一封装

 

1. public class ViewButton extends BasicButton {

2.  

3. private String type = Menu.VIEW;

4. private String url;

5.  

6. public String getType() {

7. return type;

8. }

9. public void setType(String type) {

10. this.type = type;

11. }

12. public String getUrl() {

13. return url;

14. }

15. public void setUrl(String url) {

16. this.url = url;

17. }

18. }

一级菜单包含二级菜单的封装ComplexMenu.java

1. public class ComplexMenu extends BasicButton {

2.  

3. private BasicButton[] sub_button;

4.  

5. public BasicButton[] getSub_button() {

6. return sub_button;

7. }

8.  

9. public void setSub_button(BasicButton[] sub_button) {

10. this.sub_button = sub_button;

11. }

12. }

2.封装完毕，组装菜单

1. private static Menu getMenu() {

2.  

3. ViewButton btn11 = new ViewButton();

4. btn11.setName("测试11");

5. btn11.setUrl("http://www.qq.com");

6.  

7. ClickButton btn21 = new ClickButton();

8. btn21.setName("测试21");

9. btn21.setKey("21");

10.  

11. ClickButton btn22 = new ClickButton();

12. btn22.setName("测试22");

13. btn22.setKey("22");

14.  

15. //一级菜单(没有二级菜单)

16. ComplexMenu mainBtn1 = new ComplexMenu();

17. mainBtn1.setName("测试1");

18. mainBtn1.setSub_button(new BasicButton[] { btn11});

19.  

20. //一级菜单(有二级菜单)

21. ComplexMenu mainBtn2 = new ComplexMenu();

22. mainBtn2.setName("测试2");

23. mainBtn2.setSub_button(new BasicButton[] { btn21, btn22 });

24.  

25. Menu menu = new Menu();

26. menu.setButton(new BasicButton[] { mainBtn1, mainBtn2 });

27. return menu;

28. }

3.自定义菜单的创建

 

1. /**

2. * 创建的菜单

3. *

4. * @param menu 菜单项

5. * @param token 授权token

6. * @return {"errcode":0,"errmsg":"ok"}

7. */

8. public ResultState createMenu(Menu menu, String token) {

9. TreeMap<String, String> map = new TreeMap<String, String>();

10. map.put("access_token", token);

11. String jsonData = JsonUtil.toJson(menu).toString();

12. String result = HttpReqUtil.HttpsDefaultExecute(HttpReqUtil.POST_METHOD, WechatConfig.MENU_CREATE_URL, map, jsonData);

13. return JsonUtil.fromJson(result, ResultState.class);

14. }

 

4、自定义菜单的查询

返回的实例

1. 对应创建接口，正确的Json返回结果:

2. {

3. "menu": {

4. "button": [

5. {

6. "type": "click",

7. "name": "今日歌曲",

8. "key": "V1001_TODAY_MUSIC",

9. "sub_button": [ ]

10. },

11. {

12. "type": "click",

13. "name": "歌手简介",

14. "key": "V1001_TODAY_SINGER",

15. "sub_button": [ ]

16. },

17. {

18. "name": "菜单",

19. "sub_button": [

20. {

21. "type": "view",

22. "name": "搜索",

23. "url": "http://www.soso.com/",

24. "sub_button": [ ]

25. },

26. {

27. "type": "view",

28. "name": "视频",

29. "url": "http://v.qq.com/",

30. "sub_button": [ ]

31. },

32. {

33. "type": "click",

34. "name": "赞一下我们",

35. "key": "V1001_GOOD",

36. "sub_button": [ ]

37. }

38. ]

39. }

40. ]

41. }

42. }

1. /**

2. * 获取自定义菜单

3. *

4. * @param token

5. * @return

6. */

7. public String getMenu(String token) {

8. TreeMap<String, String> map = new TreeMap<String, String>();

9. map.put("access_token", token);

10. String result = HttpReqUtil.HttpsDefaultExecute(HttpReqUtil.GET_METHOD, WechatConfig.MENU_GET_URL, map, "");

11. return result;

12. }

菜单所有属性MenuAttr.java

1. /**

2. * 菜单所有属性

3. * @author phil

4. *

5. */

6. public class MenuAttr extends BasicMenu {

7.  

8. private String type;

9. private String url;

10. private String key;

11. private String sub_button;

12.  

13. get/set方法

14. }

返回的菜单类MenuReturn.java

1. /**

2. * 返回的菜单类

3. * @author phil

4. *

5. */

6. public class MenuReturn extends BasicMenu{

7.  

8. private MenuAttr[] sub_button;

9.  

10. public MenuAttr[] getSub_button() {

11. return sub_button;

12. }

13.  

14. public void setSub_button(MenuAttr[] subButton) {

15. sub_button = subButton;

16. }

17. }

将json格式的字符串转换为Menu对象

1. /**

2. * 将json格式的字符串转换为Menu对象

3. * @param json

4. * @return

5. */

6. public List<MenuReturn> converMenu(String json) {

7. List<MenuReturn> list = new ArrayList<MenuReturn>();

8. if (json!= null && !"".equals(json)) {

9. JSONObject object = JSONObject.parseObject(json);

10. JSONArray array = object.getJSONObject("menu").getJSONArray("button");

11. for (int i = 0; i < array.size(); i++) {

12. MenuReturn mr= new MenuReturn();

13. mr= array.getObject(i, MenuReturn.class);

14. list.add(mr);

15. }

16. }

17. return list;

18. }

注:此处用的fastjson

此处方法待改进，有更好的请指教一二

5、自定义菜单的删除

1. /**

2. * 删除自定义菜单

3. *

4. * @param token

5. * @return

6. */

7. public boolean deleteMenu(String token) {

8. boolean falg = true;

9. TreeMap<String, String> map = new TreeMap<String, String>();

10. map.put("access_token", token);

11. String result = HttpReqUtil.HttpsDefaultExecute(HttpReqUtil.GET_METHOD, WechatConfig.MENU_DELTE_URL, map, "");

12. ResultState state = JsonUtil.fromJson(result, ResultState.class);

13. if (state.getErrcode()!= 0|| state.getErrmsg() != "ok") {

14. falg = false;

15. }

16. return falg;

17. }

三、自定义菜单事件推送

用户点击自定义菜单后，微信会把点击事件推送给开发者，请注意，点击菜单弹出子菜单，不会产生上报。请注意，第3个到第8个的所有事件，仅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用户，旧版本微信用户点击后将没有回应，开发者也不能正常接收到事件推送。

1、解析微信推送的xml数据包

1. /**

2. * 解析微信发来的请求（XML）

3. * xml示例

4. * <xml>

5. <ToUserName><![CDATA[toUser]]></ToUserName>

6. <FromUserName><![CDATA[FromUser]]></FromUserName>

7. <CreateTime>123456789</CreateTime>

8. <MsgType><![CDATA[event]]></MsgType>

9. <Event><![CDATA[CLICK]]></Event>

10. <EventKey><![CDATA[EVENTKEY]]></EventKey>

11. </xml>

12. * @param request

13. * @return

14. * @throws Exception

15. */

16. public static Map<String, String> parseXml(HttpServletRequest request) throws Exception {

17. // 将解析结果存储在HashMap中

18. Map<String, String> map = new HashMap<String, String>();

19. // 从request中取得输入流

20. InputStream inputStream = request.getInputStream();

21. // 读取输入流

22. SAXReader reader = new SAXReader();

23. Document document = reader.read(inputStream);

24. // 得到xml根元素

25. Element root = document.getRootElement();

26. // 得到根元素的所有子节点

27. List<Element> elementList = root.elements();

28.  

29. // 遍历所有子节点

30. for (Element e : elementList)

31. map.put(e.getName(), e.getText());

32.  

33. // 释放资源

34. inputStream.close();

35. inputStream = null;

36. return map;

37. }

 

2、利用map的get(key)获取value

MsgType 消息类型，event
Event          事件类型，CLICK
EventKey 事件KEY值，与自定义菜单接口中KEY值对应

注：key是参数名

附：WechatConfig.java

 

1. // 创建菜单

2. public static final String MENU_CREATE_URL = "https://api.weixin.qq.com/cgi-bin/menu/create";

3. // 查询自定义菜单

4. public static final String MENU_GET_URL = "https://api.weixin.qq.com/cgi-bin/menu/get";

5. // 删除自定义菜单

6. public static final String MENU_DELTE_URL = "https://api.weixin.qq.com/cgi-bin/menu/delete";