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

时间:2019-04-14
本文章向大家介绍Java微信公众平台之自定义菜单，主要包括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

{ 
 "button":[ 
 {  
   "type":"click", 
   "name":"今日歌曲", 
   "key":"V1001_TODAY_MUSIC" 
  }, 
  { 
   "name":"菜单", 
   "sub_button":[ 
   { 
    "type":"view", 
    "name":"搜索", 
    "url":"http://www.soso.com/" 
   }, 
   { 
    "type":"miniprogram", 
    "name":"wxa", 
    "url":"http://mp.weixin.qq.com", 
    "appid":"wx286b93c14bbf93aa", 
    "pagepath":"pages/lunar/index" 
   }, 
   { 
    "type":"click", 
    "name":"赞一下我们", 
    "key":"V1001_GOOD" 
   }] 
  }] 
}

其他类型(包括9、10)

{ 
 "button": [ 
  { 
   "name": "扫码", 
   "sub_button": [ 
    { 
     "type": "scancode_waitmsg", 
     "name": "扫码带提示", 
     "key": "rselfmenu_0_0", 
     "sub_button": [ ] 
    }, 
    { 
     "type": "scancode_push", 
     "name": "扫码推事件", 
     "key": "rselfmenu_0_1", 
     "sub_button": [ ] 
    } 
   ] 
  }, 
  { 
   "name": "发图", 
   "sub_button": [ 
    { 
     "type": "pic_sysphoto", 
     "name": "系统拍照发图", 
     "key": "rselfmenu_1_0", 
     "sub_button": [ ] 
     }, 
    { 
     "type": "pic_photo_or_album", 
     "name": "拍照或者相册发图", 
     "key": "rselfmenu_1_1", 
     "sub_button": [ ] 
    }, 
    { 
     "type": "pic_weixin", 
     "name": "微信相册发图", 
     "key": "rselfmenu_1_2", 
     "sub_button": [ ] 
    } 
   ] 
  }, 
  { 
   "name": "发送位置", 
   "type": "location_select", 
   "key": "rselfmenu_2_0" 
  }, 
  { 
   "type": "media_id", 
   "name": "图片", 
   "media_id": "MEDIA_ID1" 
  }, 
  { 
   "type": "view_limited", 
   "name": "图文消息", 
   "media_id": "MEDIA_ID2" 
  } 
 ] 
}

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

菜单按钮基类BasicButton.java

public class BasicButton { 
  
 private String name; 
 
 public String getName() { 
  return name; 
 } 
 
 public void setName(String name) { 
  this.name = name; 
 } 
}

菜单Menu.java

public class Menu { 
  
 public final static String CLICK = "click"; // click菜单 
 public final static String VIEW = "view"; // url菜单 
 public final static String SCANCODE_WAITMSG = "scancode_waitmsg"; // 扫码带提示 
 public final static String SCANCODE_PUSH = "scancode_push"; // 扫码推事件 
 public final static String PIC_SYSPHOTO = "pic_sysphoto"; // 系统拍照发图 
 public final static String PIC_PHOTO_OR_ALBUM = "pic_photo_or_album"; // 拍照或者相册发图 
 public final static String PIC_WEIXIN = "pic_weixin"; // 微信相册发图 
 public final static String LOCATION_SELECT = "location_select"; // 发送位置 
 
 private BasicButton[] button; 
 
 public BasicButton[] getButton() { 
  return button; 
 } 
 
 public void setButton(BasicButton[] button) { 
  this.button = button; 
 } 
}

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

public class ViewButton extends BasicButton { 
  
 private String type = Menu.VIEW; 
 private String url; 
  
 public String getType() { 
  return type; 
 } 
 public void setType(String type) { 
  this.type = type; 
 } 
 public String getUrl() { 
  return url; 
 } 
 public void setUrl(String url) { 
  this.url = url; 
 } 
}

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

public class ComplexMenu extends BasicButton { 
  
 private BasicButton[] sub_button; 
 
 public BasicButton[] getSub_button() { 
  return sub_button; 
 } 
 
 public void setSub_button(BasicButton[] sub_button) { 
  this.sub_button = sub_button; 
 } 
}

2.封装完毕，组装菜单

private static Menu getMenu() { 
  
 ViewButton btn11 = new ViewButton(); 
 btn11.setName("测试11"); 
 btn11.setUrl("http://www.qq.com"); 
  
 ClickButton btn21 = new ClickButton(); 
 btn21.setName("测试21"); 
 btn21.setKey("21"); 
 
 ClickButton btn22 = new ClickButton(); 
 btn22.setName("测试22"); 
 btn22.setKey("22"); 
 
 //一级菜单(没有二级菜单) 
 ComplexMenu mainBtn1 = new ComplexMenu(); 
 mainBtn1.setName("测试1"); 
 mainBtn1.setSub_button(new BasicButton[] { btn11}); 
 
 //一级菜单(有二级菜单) 
 ComplexMenu mainBtn2 = new ComplexMenu(); 
 mainBtn2.setName("测试2"); 
 mainBtn2.setSub_button(new BasicButton[] { btn21, btn22 }); 
  
 Menu menu = new Menu(); 
 menu.setButton(new BasicButton[] { mainBtn1, mainBtn2 }); 
 return menu; 
}

3.自定义菜单的创建

/** 
 * 创建的菜单 
 * 
 * @param menu 菜单项 
 * @param token 授权token 
 * @return {"errcode":0,"errmsg":"ok"} 
 */ 
public ResultState createMenu(Menu menu, String token) { 
 TreeMap<String, String> map = new TreeMap<String, String>(); 
 map.put("access_token", token); 
 String jsonData = JsonUtil.toJson(menu).toString(); 
 String result = HttpReqUtil.HttpsDefaultExecute(HttpReqUtil.POST_METHOD, WechatConfig.MENU_CREATE_URL, map, jsonData); 
 return JsonUtil.fromJson(result, ResultState.class); 
}

4、自定义菜单的查询

返回的实例

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

{ 
 "menu": { 
  "button": [ 
   { 
    "type": "click", 
    "name": "今日歌曲", 
    "key": "V1001_TODAY_MUSIC", 
    "sub_button": [ ] 
   }, 
   { 
    "type": "click", 
    "name": "歌手简介", 
    "key": "V1001_TODAY_SINGER", 
    "sub_button": [ ] 
   }, 
   { 
    "name": "菜单", 
    "sub_button": [ 
     { 
      "type": "view", 
      "name": "搜索", 
      "url": "http://www.soso.com/", 
      "sub_button": [ ] 
     }, 
     { 
      "type": "view", 
      "name": "视频", 
      "url": "http://v.qq.com/", 
      "sub_button": [ ] 
     }, 
     { 
      "type": "click", 
      "name": "赞一下我们", 
      "key": "V1001_GOOD", 
      "sub_button": [ ] 
     } 
    ] 
   } 
  ] 
 } 
} 

/** 
  * 获取自定义菜单 
  * 
  * @param token 
  * @return 
  */ 
 public String getMenu(String token) { 
  TreeMap<String, String> map = new TreeMap<String, String>(); 
  map.put("access_token", token); 
  String result = HttpReqUtil.HttpsDefaultExecute(HttpReqUtil.GET_METHOD, WechatConfig.MENU_GET_URL, map, ""); 
  return result; 
 }

菜单所有属性MenuAttr.java

/** 
 * 菜单所有属性 
 * @author phil 
 * 
 */ 
public class MenuAttr extends BasicMenu { 
  
 private String type; 
 private String url; 
 private String key; 
 private String sub_button; 
  
 get/set方法 
}

返回的菜单类MenuReturn.java

/** 
 * 返回的菜单类 
 * @author phil 
 * 
 */ 
public class MenuReturn extends BasicMenu{ 
  
 private MenuAttr[] sub_button; 
 
 public MenuAttr[] getSub_button() { 
  return sub_button; 
 } 
 
 public void setSub_button(MenuAttr[] subButton) { 
  sub_button = subButton; 
 } 
}

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

/** 
 * 将json格式的字符串转换为Menu对象 
 * @param json 
 * @return 
 */ 
public List<MenuReturn> converMenu(String json) { 
 List<MenuReturn> list = new ArrayList<MenuReturn>(); 
 if (json!= null && !"".equals(json)) { 
  JSONObject object = JSONObject.parseObject(json); 
  JSONArray array = object.getJSONObject("menu").getJSONArray("button"); 
  for (int i = 0; i < array.size(); i++) { 
   MenuReturn mr= new MenuReturn(); 
   mr= array.getObject(i, MenuReturn.class); 
   list.add(mr); 
  } 
 } 
 return list; 
}

注:此处用的fastjson

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

5、自定义菜单的删除

 /** 
 * 删除自定义菜单 
 * 
 * @param token 
 * @return 
 */ 
public boolean deleteMenu(String token) { 
 boolean falg = true; 
 TreeMap<String, String> map = new TreeMap<String, String>(); 
 map.put("access_token", token); 
 String result = HttpReqUtil.HttpsDefaultExecute(HttpReqUtil.GET_METHOD, WechatConfig.MENU_DELTE_URL, map, ""); 
 ResultState state = JsonUtil.fromJson(result, ResultState.class); 
 if (state.getErrcode()!= 0|| state.getErrmsg() != "ok") { 
  falg = false; 
 } 
 return falg; 
}

三、自定义菜单事件推送

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

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

/** 
 * 解析微信发来的请求（XML） 
 * xml示例 
 * <xml> 
 <ToUserName><![CDATA[toUser]]></ToUserName> 
 <FromUserName><![CDATA[FromUser]]></FromUserName> 
 <CreateTime>123456789</CreateTime> 
 <MsgType><![CDATA[event]]></MsgType> 
 <Event><![CDATA[CLICK]]></Event> 
 <EventKey><![CDATA[EVENTKEY]]></EventKey> 
 </xml> 
 * @param request 
 * @return 
 * @throws Exception 
 */ 
public static Map<String, String> parseXml(HttpServletRequest request) throws Exception { 
 // 将解析结果存储在HashMap中 
 Map<String, String> map = new HashMap<String, String>(); 
 // 从request中取得输入流 
 InputStream inputStream = request.getInputStream(); 
 // 读取输入流 
 SAXReader reader = new SAXReader(); 
 Document document = reader.read(inputStream); 
 // 得到xml根元素 
 Element root = document.getRootElement(); 
 // 得到根元素的所有子节点 
 List<Element> elementList = root.elements(); 
 
 // 遍历所有子节点 
 for (Element e : elementList) 
  map.put(e.getName(), e.getText()); 
 
 // 释放资源 
 inputStream.close(); 
 inputStream = null; 
 return map; 
}

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

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

注：key是参数名

附：WechatConfig.java

// 创建菜单 
public static final String MENU_CREATE_URL = "https://api.weixin.qq.com/cgi-bin/menu/create"; 
// 查询自定义菜单 
public static final String MENU_GET_URL = "https://api.weixin.qq.com/cgi-bin/menu/get"; 
// 删除自定义菜单 
public static final String MENU_DELTE_URL = "https://api.weixin.qq.com/cgi-bin/menu/delete";

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

随机文章
java知识点必读
最近更新