Java微信公眾平臺(tái)之自定義菜單

更新時(shí)間：2018年05月07日 11:32:48 作者：Phil_Jing

這篇文章主要為大家詳細(xì)介紹了Java微信公眾平臺(tái)之自定義菜單，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

一、自定義菜單的說明和按鈕類型

1、菜單說明

1)自定義菜單最多包括3個(gè)一級(jí)菜單，每個(gè)一級(jí)菜單最多包含5個(gè)二級(jí)菜單。

2)一級(jí)菜單最多4個(gè)漢字，二級(jí)菜單最多7個(gè)漢字，多出來的部分將會(huì)以“...”代替。
3)創(chuàng)建自定義菜單后，菜單的刷新策略是，在用戶進(jìn)入公眾號(hào)會(huì)話頁或公眾號(hào)profile頁時(shí)，如果發(fā)現(xiàn)上一次拉取菜單的請(qǐng)求在5分鐘以前，就會(huì)拉取一下菜單，如果菜單有更新，就會(huì)刷新客戶端的菜單。測(cè)試時(shí)可以嘗試取消關(guān)注公眾賬號(hào)后再次關(guān)注，則可以看到創(chuàng)建后的效果。

2、自定義菜單接口可實(shí)現(xiàn)多種類型按鈕

1)click：點(diǎn)擊推事件用戶點(diǎn)擊click類型按鈕后，微信服務(wù)器會(huì)通過消息接口推送消息類型為event的結(jié)構(gòu)給開發(fā)者（參考消息接口指南），并且?guī)习粹o中開發(fā)者填寫的key值，開發(fā)者可以通過自定義的key值與用戶進(jìn)行交互；
2)view：跳轉(zhuǎn)URL用戶點(diǎn)擊view類型按鈕后，微信客戶端將會(huì)打開開發(fā)者在按鈕中填寫的網(wǎng)頁URL，可與網(wǎng)頁授權(quán)獲取用戶基本信息接口結(jié)合，獲得用戶基本信息。
3)scancode_push：掃碼推事件用戶點(diǎn)擊按鈕后，微信客戶端將調(diào)起掃一掃工具，完成掃碼操作后顯示掃描結(jié)果（如果是URL，將進(jìn)入U(xiǎn)RL），且會(huì)將掃碼的結(jié)果傳給開發(fā)者，開發(fā)者可以下發(fā)消息。
4)scancode_waitmsg：掃碼推事件且彈出“消息接收中”提示框用戶點(diǎn)擊按鈕后，微信客戶端將調(diào)起掃一掃工具，完成掃碼操作后，將掃碼的結(jié)果傳給開發(fā)者，同時(shí)收起掃一掃工具，然后彈出“消息接收中”提示框，隨后可能會(huì)收到開發(fā)者下發(fā)的消息。
5)pic_sysphoto：彈出系統(tǒng)拍照發(fā)圖用戶點(diǎn)擊按鈕后，微信客戶端將調(diào)起系統(tǒng)相機(jī)，完成拍照操作后，會(huì)將拍攝的相片發(fā)送給開發(fā)者，并推送事件給開發(fā)者，同時(shí)收起系統(tǒng)相機(jī)，隨后可能會(huì)收到開發(fā)者下發(fā)的消息。
6)pic_photo_or_album：彈出拍照或者相冊(cè)發(fā)圖用戶點(diǎn)擊按鈕后，微信客戶端將彈出選擇器供用戶選擇“拍照”或者“從手機(jī)相冊(cè)選擇”。用戶選擇后即走其他兩種流程。
7)pic_weixin：彈出微信相冊(cè)發(fā)圖器用戶點(diǎn)擊按鈕后，微信客戶端將調(diào)起微信相冊(cè)，完成選擇操作后，將選擇的相片發(fā)送給開發(fā)者的服務(wù)器，并推送事件給開發(fā)者，同時(shí)收起相冊(cè)，隨后可能會(huì)收到開發(fā)者下發(fā)的消息。
8)location_select：彈出地理位置選擇器用戶點(diǎn)擊按鈕后，微信客戶端將調(diào)起地理位置選擇工具，完成選擇操作后，將選擇的地理位置發(fā)送給開發(fā)者的服務(wù)器，同時(shí)收起位置選擇工具，隨后可能會(huì)收到開發(fā)者下發(fā)的消息。
9)media_id：下發(fā)消息（除文本消息）用戶點(diǎn)擊media_id類型按鈕后，微信服務(wù)器會(huì)將開發(fā)者填寫的永久素材id對(duì)應(yīng)的素材下發(fā)給用戶，永久素材類型可以是圖片、音頻、視頻、圖文消息。請(qǐng)注意：永久素材id必須是在“素材管理/新增永久素材”接口上傳后獲得的合法id。
10)view_limited：跳轉(zhuǎn)圖文消息URL用戶點(diǎn)擊view_limited類型按鈕后，微信客戶端將打開開發(fā)者在按鈕中填寫的永久素材id對(duì)應(yīng)的圖文消息URL，永久素材類型只支持圖文消息。請(qǐng)注意：永久素材id必須是在“素材管理/新增永久素材”接口上傳后獲得的合法id。

說明：3到8的所有事件，僅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用戶，舊版本微信用戶點(diǎn)擊后將沒有回應(yīng)，開發(fā)者也不能正常接收到事件推送。9和10，是專門給第三方平臺(tái)旗下未微信認(rèn)證（具體而言，是資質(zhì)認(rèn)證未通過）的訂閱號(hào)準(zhǔn)備的事件類型，它們是沒有事件推送的，能力相對(duì)受限，其他類型的公眾號(hào)不必使用。

二、菜單的創(chuàng)建/查詢/刪除

官方的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": "發(fā)圖", 
   "sub_button": [ 
    { 
     "type": "pic_sysphoto", 
     "name": "系統(tǒng)拍照發(fā)圖", 
     "key": "rselfmenu_1_0", 
     "sub_button": [ ] 
     }, 
    { 
     "type": "pic_photo_or_album", 
     "name": "拍照或者相冊(cè)發(fā)圖", 
     "key": "rselfmenu_1_1", 
     "sub_button": [ ] 
    }, 
    { 
     "type": "pic_weixin", 
     "name": "微信相冊(cè)發(fā)圖", 
     "key": "rselfmenu_1_2", 
     "sub_button": [ ] 
    } 
   ] 
  }, 
  { 
   "name": "發(fā)送位置", 
   "type": "location_select", 
   "key": "rselfmenu_2_0" 
  }, 
  { 
   "type": "media_id", 
   "name": "圖片", 
   "media_id": "MEDIA_ID1" 
  }, 
  { 
   "type": "view_limited", 
   "name": "圖文消息", 
   "media_id": "MEDIA_ID2" 
  } 
 ] 
}

1、根據(jù)實(shí)例開始封裝實(shí)體類

菜單按鈕基類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"; // 系統(tǒng)拍照發(fā)圖 
 public final static String PIC_PHOTO_OR_ALBUM = "pic_photo_or_album"; // 拍照或者相冊(cè)發(fā)圖 
 public final static String PIC_WEIXIN = "pic_weixin"; // 微信相冊(cè)發(fā)圖 
 public final static String LOCATION_SELECT = "location_select"; // 發(fā)送位置 
 
 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; 
 } 
}

一級(jí)菜單包含二級(jí)菜單的封裝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("測(cè)試11"); 
 btn11.setUrl("http://www.qq.com"); 
  
 ClickButton btn21 = new ClickButton(); 
 btn21.setName("測(cè)試21"); 
 btn21.setKey("21"); 
 
 ClickButton btn22 = new ClickButton(); 
 btn22.setName("測(cè)試22"); 
 btn22.setKey("22"); 
 
 //一級(jí)菜單(沒有二級(jí)菜單) 
 ComplexMenu mainBtn1 = new ComplexMenu(); 
 mainBtn1.setName("測(cè)試1"); 
 mainBtn1.setSub_button(new BasicButton[] { btn11}); 
 
 //一級(jí)菜單(有二級(jí)菜單) 
 ComplexMenu mainBtn2 = new ComplexMenu(); 
 mainBtn2.setName("測(cè)試2"); 
 mainBtn2.setSub_button(new BasicButton[] { btn21, btn22 }); 
  
 Menu menu = new Menu(); 
 menu.setButton(new BasicButton[] { mainBtn1, mainBtn2 }); 
 return menu; 
}

3.自定義菜單的創(chuàng)建

/** 
 * 創(chuàng)建的菜單 
 * 
 * @param menu 菜單項(xiàng) 
 * @param token 授權(quán)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、自定義菜單的查詢

返回的實(shí)例

對(duì)應(yīng)創(chuàng)建接口，正確的Json返回結(jié)果:

{ 
 "menu": { 
  "button": [ 
   { 
    "type": "click", 
    "name": "今日歌曲", 
    "key": "V1001_TODAY_MUSIC", 
    "sub_button": [ ] 
   }, 
   { 
    "type": "click", 
    "name": "歌手簡(jiǎn)介", 
    "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格式的字符串轉(zhuǎn)換為Menu對(duì)象

/** 
 * 將json格式的字符串轉(zhuǎn)換為Menu對(duì)象 
 * @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

此處方法待改進(jìn)，有更好的請(qǐng)指教一二

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

三、自定義菜單事件推送

用戶點(diǎn)擊自定義菜單后，微信會(huì)把點(diǎn)擊事件推送給開發(fā)者，請(qǐng)注意，點(diǎn)擊菜單彈出子菜單，不會(huì)產(chǎn)生上報(bào)。請(qǐng)注意，第3個(gè)到第8個(gè)的所有事件，僅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用戶，舊版本微信用戶點(diǎn)擊后將沒有回應(yīng)，開發(fā)者也不能正常接收到事件推送。

1、解析微信推送的xml數(shù)據(jù)包

/** 
 * 解析微信發(fā)來的請(qǐng)求（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 { 
 // 將解析結(jié)果存儲(chǔ)在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(); 
 // 得到根元素的所有子節(jié)點(diǎn) 
 List<Element> elementList = root.elements(); 
 
 // 遍歷所有子節(jié)點(diǎn) 
 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值對(duì)應(yīng)

注：key是參數(shù)名

附：WechatConfig.java

// 創(chuàng)建菜單 
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";

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: