1、前言java
平時在開發微信的過程當中,確定會設計到微信的相關菜單的使用,此次就和你們介紹下如何使用weixin-java-tools來管理菜單api
2、自定義菜單分類數組
一、click:點擊推事件用戶點擊click類型按鈕後,微信服務器會經過消息接口推送消息類型爲event的結構給開發者(參考消息接口指南),而且帶上按鈕中開發者填寫的key值,開發者能夠經過自定義的key值與用戶進行交互;服務器
二、view:跳轉URL用戶點擊view類型按鈕後,微信客戶端將會打開開發者在按鈕中填寫的網頁URL,可與網頁受權獲取用戶基本信息接口結合,得到用戶基本信息。微信
三、scancode_push:掃碼推事件用戶點擊按鈕後,微信客戶端將調起掃一掃工具,完成掃碼操做後顯示掃描結果(若是是URL,將進入URL),且會將掃碼的結果傳給開發者,開發者能夠下發消息。ide
四、scancode_waitmsg:掃碼推事件且彈出「消息接收中」提示框用戶點擊按鈕後,微信客戶端將調起掃一掃工具,完成掃碼操做後,將掃碼的結果傳給開發者,同時收起掃一掃工具,而後彈出「消息接收中」提示框,隨後可能會收到開發者下發的消息。工具
五、pic_sysphoto:彈出系統拍照發圖用戶點擊按鈕後,微信客戶端將調起系統相機,完成拍照操做後,會將拍攝的相片發送給開發者,並推送事件給開發者,同時收起系統相機,隨後可能會收到開發者下發的消息。post
六、pic_photo_or_album:彈出拍照或者相冊發圖用戶點擊按鈕後,微信客戶端將彈出選擇器供用戶選擇「拍照」或者「從手機相冊選擇」。用戶選擇後即走其餘兩種流程。url
七、pic_weixin:彈出微信相冊發圖器用戶點擊按鈕後,微信客戶端將調起微信相冊,完成選擇操做後,將選擇的相片發送給開發者的服務器,並推送事件給開發者,同時收起相冊,隨後可能會收到開發者下發的消息。spa
八、location_select:彈出地理位置選擇器用戶點擊按鈕後,微信客戶端將調起地理位置選擇工具,完成選擇操做後,將選擇的地理位置發送給開發者的服務器,同時收起位置選擇工具,隨後可能會收到開發者下發的消息。
九、media_id:下發消息(除文本消息)用戶點擊media_id類型按鈕後,微信服務器會將開發者填寫的永久素材id對應的素材下發給用戶,永久素材類型能夠是圖片、音頻、視頻、圖文消息。請注意:永久素材id必須是在「素材管理/新增永久素材」接口上傳後得到的合法id。
十、view_limited:跳轉圖文消息URL用戶點擊view_limited類型按鈕後,微信客戶端將打開開發者在按鈕中填寫的永久素材id對應的圖文消息URL,永久素材類型只支持圖文消息。請注意:永久素材id必須是在「素材管理/新增永久素材」接口上傳後得到的合法id。
請注意,3到8的全部事件,僅支持微信iPhone5.4.1以上版本,和Android5.4以上版本的微信用戶,舊版本微信用戶點擊後將沒有迴應,開發者也不能正常接收到事件推送。9和10,是專門給第三方平臺旗下未微信認證(具體而言,是資質認證未經過)的訂閱號準備的事件類型,它們是沒有事件推送的,能力相對受限,其餘類型的公衆號沒必要使用。
3、調用接口地址:http請求方式:POST(請使用https協議) https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN
4、請求示例
{ "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" }] }] }
5、參數說明
參數 | 是否必須 | 說明 |
---|---|---|
button | 是 | 一級菜單數組,個數應爲1~3個 |
sub_button | 否 | 二級菜單數組,個數應爲1~5個 |
type | 是 | 菜單的響應動做類型 |
name | 是 | 菜單標題,不超過16個字節,子菜單不超過40個字節 |
key | click等點擊類型必須 | 菜單KEY值,用於消息接口推送,不超過128字節 |
url | view類型必須 | 網頁連接,用戶點擊菜單可打開連接,不超過1024字節 |
media_id | media_id類型和view_limited類型必須 | 調用新增永久素材接口返回的合法media_id |
6、代碼實現:
package com.weixin.menu; import java.util.ArrayList; import java.util.List; import me.chanjar.weixin.common.bean.WxMenu; import me.chanjar.weixin.common.bean.WxMenu.WxMenuButton; import me.chanjar.weixin.common.exception.WxErrorException; import me.chanjar.weixin.mp.api.WxMpInMemoryConfigStorage; import me.chanjar.weixin.mp.api.WxMpService; import me.chanjar.weixin.mp.api.WxMpServiceImpl; public class WeixinMenuService { public static void main(String[] args) { //建立菜單 //建立一級菜單 WxMenuButton button1=new WxMenuButton(); button1.setType("click"); //點擊事件按鈕 button1.setName("點擊菜單"); button1.setKey("key1"); //根據標誌獲取點擊菜單 //建立一個複合菜單 WxMenuButton button2=new WxMenuButton(); button2.setName("多級菜單"); WxMenuButton button2_1=new WxMenuButton(); button2_1.setType("click"); //點擊事件按鈕 button2_1.setName("子菜單一"); button2_1.setKey("key2"); //根據標誌獲取點擊菜單 WxMenuButton button2_2=new WxMenuButton(); button2_2.setType("click"); //點擊事件按鈕 button2_2.setName("子菜單二"); button2_2.setKey("key3"); //根據標誌獲取點擊菜單 WxMenuButton button3=new WxMenuButton(); button3.setName("url菜單"); button3.setType("view"); button3.setUrl("http://www.baidu.com"); //必須添加http List<WxMenuButton> subButtons=new ArrayList<WxMenuButton>(); subButtons.add(button2_1); subButtons.add(button2_2); button2.setSubButtons(subButtons); List<WxMenuButton> buttons=new ArrayList<WxMenuButton>(); buttons.add(button1); buttons.add(button2); buttons.add(button3); WxMenu menu=new WxMenu(); menu.setButtons(buttons); //發送請求 建立菜單 WxMpService service=new WxMpServiceImpl(); WxMpInMemoryConfigStorage wxConfigProvider=new WxMpInMemoryConfigStorage(); wxConfigProvider.setAppId("wx60a8f1c3a95b0b9c"); wxConfigProvider.setSecret("5b0e8613b538da5ac4bbc610998f10ba"); service.setWxMpConfigStorage(wxConfigProvider); try { service.menuCreate(menu); } catch (WxErrorException e) { // TODO Auto-generated catch block e.printStackTrace(); } } }
7、點擊菜單事件推送
7.1 消息格式
<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>
7.2 參數說明
參數 | 描述 |
---|---|
ToUserName | 開發者微信號 |
FromUserName | 發送方賬號(一個OpenID) |
CreateTime | 消息建立時間 (整型) |
MsgType | 消息類型,event |
Event | 事件類型,CLICK |
EventKey | 事件KEY值,與自定義菜單接口中KEY值對應 |
7.3 消息處理
在接收消息的post中判斷消息類型 並作相關處理。
//獲取消息流 WxMpXmlMessage message=WxMpXmlMessage.fromXml(request.getInputStream()); if(message.getMsgType().equals("event")){ //事件 //判斷event if(message.getEvent().equals("click") && message.getEventKey().equals("key1")){ //do something } }