微信公眾號開發（三）自定義菜單。

一：官網接口。

 

自定義菜單創建接口：

http請求方式：POST（請使用https協議） https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN

自定義菜單查詢接口：

http請求方式：GET https://api.weixin.qq.com/cgi-bin/menu/get?access_token=ACCESS_TOKEN

自定義菜單刪除接口：

http請求方式：GET https://api.weixin.qq.com/cgi-bin/menu/delete?access_token=ACCESS_TOKEN

自定義菜單接口可實現多種類型按鈕，如下：

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。

click和view的請求示例

 

{
     "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"
            }]
       }]
 }

其他新增按鈕類型的請求示例。

{
    "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"
        }
    ]
}

參數說明

參數	是否必須	說明
button	是	一級菜單數組，個數應為1~3個
sub_button	否	二級菜單數組，個數應為1~5個
type	是	菜單的響應動作類型
name	是	菜單標題，不超過16個字節，子菜單不超過40個字節
key	click等點擊類型必須	菜單KEY值，用於消息接口推送，不超過128字節
url	view類型必須	網頁鏈接，用戶點擊菜單可打開鏈接，不超過256字節
media_id	media_id類型和view_limited類型必須	調用新增永久素材接口返回的合法media_id

返回結果

 

正確時的返回JSON數據包如下：{"errcode":0,"errmsg":"ok"}

錯誤時的返回JSON數據包如下（示例為無效菜單名長度）：{"errcode":40018,"errmsg":"invalid button name size"}

根據以上的信息，我們進行封裝一下菜單。

click和view的請求示例

{
     "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"
            }]
       }]
 }

首先是 菜單項的基類，所有一級菜單、二級菜單都共有一個相同的屬性，那就是name。菜單項基類的封裝代碼如下：

Button

package com.wx.bean;

/**
 *
 * @類名: Botten
 * @描述: 菜單項的基類
 * @作者: 六
 * @時間: 2018-8-9
 */
public class Button {
    private String name;//所有一級，二級菜單的屬性

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

接着是子菜單項的封裝。這里對子菜單是這樣定義的：沒有子菜單的菜單項，有可能是二級菜單項，也有可能是不含二級菜單的一級菜單。這類子菜單項一定會包含三個屬性：type、name和key，封裝的代碼如下：

CommonButton

package com.wx.bean;

/**
 * 類名: CommonButton </br>
 * 包名： com.wx.bean
 * 描述: 子菜單項 :沒有子菜單的菜單項，有可能是二級菜單項，也有可能是不含二級菜單的一級菜單。 </br>
 * 開發人員： 六  </br>
 * 創建時間：  2018-8-9 </br>
 * 發布版本：V1.0  </br>
 */
public class CommonButton extends Button {

    private String type;
    private String key;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }
}

再往下是父菜單項的封裝。對父菜單項的定義：包含有二級菜單項的一級菜單。這類菜單項包含有二個屬性：name和sub_button，而sub_button以是一個子菜單項數組。父菜單項的封裝代碼如下：

package com.wx.bean;
/**
 * 類名: ComplexButton </br>
 * 包名： com.wx.bean
 * 描述: 父菜單項 :包含有二級菜單項的一級菜單。這類菜單項包含有二個屬性：name和sub_button，而sub_button以是一個子菜單項數組 </br>
 * 開發人員： 六  </br>
 * 創建時間：  2018-8-9 </br>
 * 發布版本：V1.0  </br>
 */
public class ComplexButton extends Button{
    private Button[] sub_button;

    public Button[] getSub_button() {
        return sub_button;
    }

    public void setSub_button(Button[] sub_button) {
        this.sub_button = sub_button;
    }
}

最后是整個菜單對象的封裝，菜單對象包含多個菜單項（最多只能有3個），這些菜單項即可以是子菜單項（不含二級菜單的一級菜單），也可以是父菜單項（包含二級菜單的菜單項），如果能明白上面所講的，再來看封裝后的代碼就很容易理解了：

package com.wx.bean;
/**
 * 類名: Menu </br>
 * 包名： com.wx.bean
 * 描述: 整個菜單對象的封裝 </br>
 * 開發人員：六 </br>
 * 創建時間：  2018-8-9 </br>
 * 發布版本：V1.0  </br>
 */
public class Menu {
    private Button[] button;

    public Button[] getButton() {
        return button;
    }

    public void setButton(Button[] button) {
        this.button = button;
    }
}

封裝通用的請求方法

讀到這里，就默認大家已經掌握了上面講到的所有關於自定義菜單的理論知識，下面就進入代碼實戰講解的部分。

先前我們了解到，創建菜單需要調用二個接口，並且都是https請求，而非http。如果要封裝一個通用的請求方法，該方法至少需要具備以下能力：

1）支持HTTPS請求；

2）支持GET、POST兩種方式；

3）支持參數提交，也支持無參數的情況；

對於https請求，我們需要一個證書信任管理器，這個管理器類需要自己定義，但需要實現X509TrustManager接口。代碼就是我們獲取access_token的時候那個

MyX509TrustManager 類。

這個證書管理器的作用就是讓它信任我們指定的證書，上面的代碼意味着信任所有證書，不管是否權威機構頒發。

證書有了，通用的https請求方法就不難實現了，實現代碼如下：

package com.wx.util;

import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.ConnectException;
import java.net.URL;

import javax.net.ssl.HttpsURLConnection;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLSocketFactory;
import javax.net.ssl.TrustManager;


import com.alibaba.fastjson.JSONException;
import com.alibaba.fastjson.JSONObject;
import com.wx.bean.AccessToken;
import com.wx.bean.Menu;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * 類名: WeixinUtil </br>
 * 包名： com.wx.util
 * 描述: 公眾平台通用接口工具類 </br>
 * 開發人員： 六  </br>
 * 創建時間：  2018-8-9 </br>
 * 發布版本：V1.0  </br>
 */
public class WeixinUtil {

    private static Logger log = LoggerFactory.getLogger(WeixinUtil.class);

    // 獲取access_token的接口地址（GET） 限200（次/天）
    public final static String access_token_url = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET";

    // 菜單創建（POST） 限100（次/天）
    public static String menu_create_url = "https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN";

    /**
     * 創建菜單
     *
     * @param menu 菜單實例
     * @param accessToken 有效的access_token
     * @return 0表示成功，其他值表示失敗
     */
    public static int createMenu(Menu menu, String accessToken) {
        int result = 0;
        // 拼裝創建菜單的url
        String url = menu_create_url.replace("ACCESS_TOKEN", accessToken);
        System.out.println("url:"+url);
        // 將菜單對象轉換成json字符串
        String jsonMenu = JSONObject.toJSON(menu).toString();
        System.out.println("jsonMenu"+jsonMenu);
        // 調用接口創建菜單
        JSONObject jsonObject = httpRequest(url, "POST", jsonMenu);
        System.out.println("jsonObject"+jsonObject);
        if (null != jsonObject) {
            if (0 != jsonObject.getInteger("errcode")) {
                result = jsonObject.getInteger("errcode");
                log.error("創建菜單失敗 errcode:{} errmsg:{}", jsonObject.getInteger("errcode"), jsonObject.getString("errmsg"));
            }
        }

        return result;
    }


    /**
     * 獲取access_token
     *
     * @param appid 憑證
     * @param appsecret 密鑰
     * @return
     */
    public static AccessToken getAccessToken(String appid, String appsecret) {
        AccessToken accessToken = null;

        String requestUrl = access_token_url.replace("APPID", appid).replace("APPSECRET", appsecret);
        JSONObject jsonObject = httpRequest(requestUrl, "GET", null);
        // 如果請求成功
        if (null != jsonObject) {
            try {
                accessToken = new AccessToken();
                accessToken.setAccessToken(jsonObject.getString("access_token"));
                accessToken.setExpiresin(jsonObject.getInteger("expires_in"));
            } catch (JSONException e) {
                accessToken = null;
                // 獲取token失敗
                log.error("獲取token失敗 errcode:{} errmsg:{}", jsonObject.getInteger("errcode"), jsonObject.getString("errmsg"));
            }
        }
        return accessToken;
    }


    /**
     * 描述:  發起https請求並獲取結果
     * @param requestUrl 請求地址
     * @param requestMethod 請求方式（GET、POST）
     * @param outputStr 提交的數據
     * @return JSONObject(通過JSONObject.get(key)的方式獲取json對象的屬性值)
     */
    public static JSONObject httpRequest(String requestUrl, String requestMethod, String outputStr) {
        JSONObject jsonObject = null;
        StringBuffer buffer = new StringBuffer();
        try {
            // 創建SSLContext對象，並使用我們指定的信任管理器初始化
            TrustManager[] tm = { new MyX509TrustManager() };
            SSLContext sslContext = SSLContext.getInstance("SSL", "SunJSSE");
            sslContext.init(null, tm, new java.security.SecureRandom());
            // 從上述SSLContext對象中得到SSLSocketFactory對象
            SSLSocketFactory ssf = sslContext.getSocketFactory();

            URL url = new URL(requestUrl);
            HttpsURLConnection httpUrlConn = (HttpsURLConnection) url.openConnection();
            httpUrlConn.setSSLSocketFactory(ssf);

            httpUrlConn.setDoOutput(true);
            httpUrlConn.setDoInput(true);
            httpUrlConn.setUseCaches(false);

            // 設置請求方式（GET/POST）
            httpUrlConn.setRequestMethod(requestMethod);

            if ("GET".equalsIgnoreCase(requestMethod))
                httpUrlConn.connect();

            // 當有數據需要提交時
            if (null != outputStr) {
                OutputStream outputStream = httpUrlConn.getOutputStream();
                // 注意編碼格式，防止中文亂碼
                outputStream.write(outputStr.getBytes("UTF-8"));
                outputStream.close();
            }

            // 將返回的輸入流轉換成字符串
            InputStream inputStream = httpUrlConn.getInputStream();
            InputStreamReader inputStreamReader = new InputStreamReader(inputStream, "utf-8");
            BufferedReader bufferedReader = new BufferedReader(inputStreamReader);

            String str = null;
            while ((str = bufferedReader.readLine()) != null) {
                buffer.append(str);
            }
            bufferedReader.close();
            inputStreamReader.close();
            // 釋放資源
            inputStream.close();
            inputStream = null;
            httpUrlConn.disconnect();
            jsonObject = JSONObject.parseObject(buffer.toString());
        } catch (ConnectException ce) {
            log.error("Weixin server connection timed out.");
        } catch (Exception e) {
            log.error("https request error:{}", e);
        }
        return jsonObject;
    }
}

測試添加菜單。

package com.wx.manager;

import com.wx.bean.*;
import com.wx.util.WeixinUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * 類名: MenuManager </br>
 * 包名： com.wx.manager
 * 描述:菜單管理器類 </br>
 * 開發人員： 六 </br>
 * 創建時間：  2018-8-9 </br>
 * 發布版本：V1.0  </br>
 */
public class MenuManager {
    private static Logger log = LoggerFactory.getLogger(MenuManager.class);

    public static void main(String[] args) {
        // 第三方用戶唯一憑證
        String appId = "wxb05f6ccd16cf38fb";
        // 第三方用戶唯一憑證密鑰
        String appSecret = "b50d2e0911e255f4723f93d73233b04f";

        // 調用接口獲取access_token
        AccessToken at = WeixinUtil.getAccessToken(appId, appSecret);

        if (null != at) {
            // 調用接口創建菜單
            int result = WeixinUtil.createMenu(getMenu(), at.getAccessToken());

            // 判斷菜單創建結果
            if (0 == result)
                log.info("菜單創建成功！");
            else
                log.info("菜單創建失敗，錯誤碼：" + result);
        }
    }

    /**
     * 組裝菜單數據
     *
     * @return
     */
    private static Menu getMenu() {
        CommonButton btn11 = new CommonButton();
        btn11.setName("天氣預報");
        btn11.setType("click");
        btn11.setKey("11");

        CommonButton btn12 = new CommonButton();
        btn12.setName("公交查詢");
        btn12.setType("click");
        btn12.setKey("12");

        CommonButton btn13 = new CommonButton();
        btn13.setName("周邊搜索");
        btn13.setType("click");
        btn13.setKey("13");

        CommonButton btn14 = new CommonButton();
        btn14.setName("歷史上的今天");
        btn14.setType("click");
        btn14.setKey("14");

        CommonButton btn21 = new CommonButton();
        btn21.setName("歌曲點播");
        btn21.setType("click");
        btn21.setKey("21");

        CommonButton btn22 = new CommonButton();
        btn22.setName("經典游戲");
        btn22.setType("click");
        btn22.setKey("22");

        CommonButton btn23 = new CommonButton();
        btn23.setName("美女電台");
        btn23.setType("click");
        btn23.setKey("23");

        CommonButton btn24 = new CommonButton();
        btn24.setName("人臉識別");
        btn24.setType("click");
        btn24.setKey("24");

        CommonButton btn25 = new CommonButton();
        btn25.setName("聊天嘮嗑");
        btn25.setType("click");
        btn25.setKey("25");

        CommonButton btn31 = new CommonButton();
        btn31.setName("Q友圈");
        btn31.setType("click");
        btn31.setKey("31");

        CommonButton btn32 = new CommonButton();
        btn32.setName("電影排行榜");
        btn32.setType("click");
        btn32.setKey("32");

        CommonButton btn33 = new CommonButton();
        btn33.setName("幽默笑話");
        btn33.setType("click");
        btn33.setKey("33");


        /**
         * 微信：  mainBtn1,mainBtn2,mainBtn3底部的三個一級菜單。
         */

        ComplexButton mainBtn1 = new ComplexButton();
        mainBtn1.setName("生活助手");
        //一級下有4個子菜單
        mainBtn1.setSub_button(new CommonButton[] { btn11, btn12, btn13, btn14 });


        ComplexButton mainBtn2 = new ComplexButton();
        mainBtn2.setName("休閑驛站");
        mainBtn2.setSub_button(new CommonButton[] { btn21, btn22, btn23, btn24, btn25 });


        ComplexButton mainBtn3 = new ComplexButton();
        mainBtn3.setName("更多體驗");
        mainBtn3.setSub_button(new CommonButton[] { btn31, btn32, btn33 });


        /**
         * 封裝整個菜單
         */
        Menu menu = new Menu();
        menu.setButton(new Button[] { mainBtn1, mainBtn2, mainBtn3 });

        return menu;
    }
}

然后就創建成功。