当前位置： 移动技术网 > IT编程>开发语言>Java > Java微信公众平台之自定义菜单

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

2019年07月19日  | 移动技术网IT编程  | 我要评论

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

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";

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

您可能感兴趣的文章:

如对本文有疑问， 点击进行留言回复！！

相关文章:

验证码：
最近更新的文章
大家感兴趣的文章
移动技术网