微信公衆平臺開發教程---自定義菜單

時間 2019-12-11

標籤微信公衆平臺開發教程自定義菜單简体版

原文原文鏈接

轉載自：http://www.cnblogs.com/yank/p/3418194.htmlphp

1、概述：

若是隻有輸入框，可能太簡單，感受像命令行。自定義菜單，給咱們提供了很大的靈活性，更符合用戶的操做習慣。在一個小小的微信對話頁面，能夠實現更多的功能。菜單直觀明瞭，不只能提供事件響應，還支持URL跳轉，若是須要的功能比較複雜，咱們大可使用URL跳轉，跳轉至咱們的網頁便可。html

注意：自定義菜單，只有服務號纔有此功能json

如何註冊，見第一章：微信公衆帳號開發教程（一）基本原理及微信公衆帳號註冊api

效果以下，數組

接着咱們詳細介紹，如何實現自定義菜單？緩存

2、詳細步驟：

一、首先獲取access_token

access_token是公衆號的全局惟一票據，公衆號調用各接口時都需使用access_token。正常狀況下access_token有效期爲7200秒，重複獲取將致使上次獲取的access_token失效。服務器

公衆號可使用AppID和AppSecret調用本接口來獲取access_token。AppID和AppSecret可在開發模式中得到（須要已經成爲開發者，且賬號沒有異常狀態）。注意調用全部微信接口時均需使用https協議。微信

接口調用請求說明app

http請求方式: GET
https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET

參數說明函數

參數	是否必須	說明
grant_type	是	獲取access_token填寫client_credential
appid	是	第三方用戶惟一憑證
secret	是	第三方用戶惟一憑證密鑰，既appsecret

返回說明

正常狀況下，微信會返回下述JSON數據包給公衆號：

{"access_token":"ACCESS_TOKEN","expires_in":7200}

參數	說明
access_token	獲取到的憑證
expires_in	憑證有效時間，單位：秒

錯誤時微信會返回錯誤碼等信息，JSON數據包示例以下（該示例爲AppID無效錯誤）:

{"errcode":40013,"errmsg":"invalid appid"}

二、建立自定義菜單

自定義菜單可以幫助公衆號豐富界面，讓用戶更好更快地理解公衆號的功能。開啓自定義菜單後，公衆號界面如圖所示：

目前自定義菜單最多包括3個一級菜單，每一個一級菜單最多包含5個二級菜單。一級菜單最多4個漢字，二級菜單最多7個漢字，多出來的部分將會以「...」代替。請注意，建立自定義菜單後，因爲微信客戶端緩存，須要24小時微信客戶端纔會展示出來。建議測試時能夠嘗試取消關注公衆帳號後再次關注，則能夠看到建立後的效果。

目前自定義菜單接口可實現兩種類型按鈕，以下：

click：
用戶點擊click類型按鈕後，微信服務器會經過消息接口推送消息類型爲event	的結構給開發者（參考消息接口指南），而且帶上按鈕中開發者填寫的key值，開發者能夠經過自定義的key值與用戶進行交互；
view：
用戶點擊view類型按鈕後，微信客戶端將會打開開發者在按鈕中填寫的url值	（即網頁連接），達到打開網頁的目的，建議與網頁受權獲取用戶基本信息接口結合，得到用戶的登入我的信息。

接口調用請求說明

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

請求示例

 {
     "button":[
     {    
          "type":"click",
          "name":"今日歌曲",
          "key":"V1001_TODAY_MUSIC"
      },
      {
           "type":"click",
           "name":"歌手簡介",
           "key":"V1001_TODAY_SINGER"
      },
      {
           "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	是	一級菜單數組，個數應爲1~3個
sub_button	否	二級菜單數組，個數應爲1~5個
type	是	菜單的響應動做類型，目前有click、view兩種類型
name	是	菜單標題，不超過16個字節，子菜單不超過40個字節
key	click類型必須	菜單KEY值，用於消息接口推送，不超過128字節
url	view類型必須	網頁連接，用戶點擊菜單可打開連接，不超過256字節

返回結果

正確時的返回JSON數據包以下：

{"errcode":0,"errmsg":"ok"}

錯誤時的返回JSON數據包以下（示例爲無效菜單名長度）：

{"errcode":40018,"errmsg":"invalid button name size"}

三、查詢菜單

使用接口建立自定義菜單後，開發者還可以使用接口查詢自定義菜單的結構。

請求說明

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

返回說明

對應建立接口，正確的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":[]}]}]}}

四、刪除菜單

使用接口建立自定義菜單後，開發者還可以使用接口刪除當前使用的自定義菜單。

請求說明

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

返回說明

對應建立接口，正確的Json返回結果:
{"errcode":0,"errmsg":"ok"}

五、事件處理

用戶點擊自定義菜單後，若是菜單按鈕設置爲click類型，則微信會把這次點擊事件推送給開發者，注意view類型（跳轉到URL）的菜單點擊不會上報。

推送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>

參數說明：

參數	描述
ToUserName	開發者微信號
FromUserName	發送方賬號（一個OpenID）
CreateTime	消息建立時間（整型）
MsgType	消息類型，event
Event	事件類型，CLICK
EventKey	事件KEY值，與自定義菜單接口中KEY值對應

3、實例講解

還接着上一篇文章講。微信公衆帳號開發教程（三）實例入門：機器人(附源碼)

咱們將在上一篇文章基礎上，添加自定義菜單功能。

一、獲取access_token

首先須要獲得AppId和AppSecret

當你成爲開發者後，天然可以在，開發者模式，即可看到這兩個值，能夠重置。

而後調用按照二.1中所示，進行操做。

注意：access_token有過時時間，若是過時，須要從新獲取。

代碼以下：

       private static DateTime GetAccessToken_Time;
        /// <summary>
        /// 過時時間爲7200秒
        /// </summary>
        private static int Expires_Period = 7200;
        /// <summary>
        /// 
        /// </summary>
        private static string mAccessToken;
        /// <summary>
        /// 
        /// </summary>
        public static string AccessToken
        {
            get
            {
                //若是爲空，或者過時，須要從新獲取
                if (string.IsNullOrEmpty(mAccessToken) || HasExpired())
                {
                    //獲取
                    mAccessToken = GetAccessToken(AppID, AppSecret);
                }

                return mAccessToken;
            }
        }
        /// <summary>
        /// 
        /// </summary>
        /// <param name="appId"></param>
        /// <param name="appSecret"></param>
        /// <returns></returns>
        private static string GetAccessToken(string appId, string appSecret)
        {
            string url = string.Format("https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid={0}&secret={1}", appId, appSecret);
            string result = HttpUtility.GetData(url);

            XDocument doc = XmlUtility.ParseJson(result, "root");
            XElement root = doc.Root;
            if (root != null)
            {
                XElement access_token = root.Element("access_token");
                if (access_token != null)
                {
                    GetAccessToken_Time = DateTime.Now;
                    if (root.Element("expires_in")!=null)
                    {
                        Expires_Period = int.Parse(root.Element("expires_in").Value);
                    }
                    return access_token.Value;
                }
                else
                {
                    GetAccessToken_Time = DateTime.MinValue;
                }
            }

            return null;
        }
        /// <summary>
        /// 判斷Access_token是否過時
        /// </summary>
        /// <returns>bool</returns>
        private static bool HasExpired()
        {
            if (GetAccessToken_Time != null)
            {
                //過時時間，容許有必定的偏差，一分鐘。獲取時間消耗
                if (DateTime.Now > GetAccessToken_Time.AddSeconds(Expires_Period).AddSeconds(-60))
                {
                    return true;
                }
            }
            return false;
        }

二、設置菜單

菜單需根據須要，按照實際要求進行設定。

這裏咱們提供天氣查詢功能，將經常使用的城市列出來，點擊便可查詢。

而後還提供了友情連接，這裏提供了view類型的菜單，直接能夠跳轉至URL頁面，爲跳轉作個好的演示。

具體菜單以下：

{
    "button": [
        {
            "name": "連接", 
            "sub_button": [
                {
                    "type": "view", 
                    "name": "搜索", 
                    "url": "http://www.baidu.com/"
                }, 
                {
                    "type": "view", 
                    "name": "視頻", 
                    "url": "http://v.qq.com/"
                }, 
                {
                    "type": "click", 
                    "name": "贊一下咱們", 
                    "key": "BTN_GOOD"
                }
            ]
        }, 
        {
            "name": "查詢天氣", 
            "sub_button": [
                {
                    "type": "click", 
                    "name": "武漢", 
                    "key": "BTN_TQ_WUHAN"
                }, 
                {
                    "type": "click", 
                    "name": "上海", 
                    "key": "BTN_TQ_SHANGHAI"
                }, 
                {
                    "type": "click", 
                    "name": "北京", 
                    "key": "BTN_TQ_BEIJING"
                }
            ]
        }, 
        {
            "type": "click", 
            "name": "幫助", 
            "key": "BTN_HELP"
        }
    ]
}

三、管理菜單

由於菜單的變動沒有那麼頻繁，所以經過txt文件來設置菜單，並經過管理界面來管理菜單。

主要的管理功能：

1）從文件加載菜單

2）建立菜單。即將菜單通知微信服務端，並更新至微信客戶端

3）查詢菜單。獲取當前系統的菜單。

4）刪除菜單。從微信服務器刪除菜單，也能夠刪除後再建立。

實現代碼以下：

    public class MenuManager
    {
        /// <summary>
        /// 菜單文件路徑
        /// </summary>
        private static readonly string Menu_Data_Path = System.AppDomain.CurrentDomain.BaseDirectory + "/Data/menu.txt";
        /// <summary>
        /// 獲取菜單
        /// </summary>
        public static string GetMenu()
        {
            string url = string.Format("https://api.weixin.qq.com/cgi-bin/menu/get?access_token={0}", Context.AccessToken);

            return HttpUtility.GetData(url);
        }
        /// <summary>
        /// 建立菜單
        /// </summary>
        public static void CreateMenu(string menu)
        {
            string url = string.Format("https://api.weixin.qq.com/cgi-bin/menu/create?access_token={0}", Context.AccessToken);
            //string menu = FileUtility.Read(Menu_Data_Path);
            HttpUtility.SendHttpRequest(url, menu);
        }
        /// <summary>
        /// 刪除菜單
        /// </summary>
        public static void DeleteMenu()
        {
            string url = string.Format("https://api.weixin.qq.com/cgi-bin/menu/delete?access_token={0}", Context.AccessToken);
            HttpUtility.GetData(url);
        }
        /// <summary>
        /// 加載菜單
        /// </summary>
        /// <returns></returns>
        public static string LoadMenu()
        {
            return FileUtility.Read(Menu_Data_Path);
        }
    }

四、基本方法

上面的代碼，其實咱們對一些公共功能作了封裝。如進行get請求、POST提交等操做，讀取文件等。

這裏咱們提供進行get、Post提交的方法案例代碼，若是使用，建議優化。

using System;
using System.IO;
using System.Net;
using System.Text;
using System.Web;

namespace Yank.WeiXin.Robot.Utility
{
    /// <summary>
    /// Http幫助類
    /// </summary>
    class HttpUtility
    {
        /// <summary>
        /// 發送請求
        /// </summary>
        /// <param name="url">Url地址</param>
        /// <param name="data">數據</param>
        public static string SendHttpRequest(string url, string data)
        {
            return SendPostHttpRequest(url,"application/x-www-form-urlencoded",data); 
        }
        /// <summary>
        /// 
        /// </summary>
        /// <param name="url"></param>
        /// <returns></returns>
        public static string GetData(string url)
        {
            return SendGetHttpRequest(url,"application/x-www-form-urlencoded"); 
        }

        /// <summary>
        /// 發送請求
        /// </summary>
        /// <param name="url">Url地址</param>
        /// <param name="method">方法（post或get）</param>
        /// <param name="method">數據類型</param>
        /// <param name="requestData">數據</param>
        public static string SendPostHttpRequest(string url,string contentType,string requestData)
        {
            WebRequest request = (WebRequest)HttpWebRequest.Create(url);
            request.Method = "POST";
            byte[] postBytes = null;
            request.ContentType = contentType;
            postBytes = Encoding.UTF8.GetBytes(requestData);
            request.ContentLength = postBytes.Length;
            using (Stream outstream = request.GetRequestStream())
            {
                outstream.Write(postBytes, 0, postBytes.Length);
            }
            string result = string.Empty;
            using (WebResponse response = request.GetResponse())
            {
                if (response != null)
                {                    
                    using (Stream stream = response.GetResponseStream())
                    {
                        using (StreamReader reader = new StreamReader(stream, Encoding.UTF8))
                        {
                            result = reader.ReadToEnd();
                        }
                    }
                    
                }
            }
            return result;
        }

        /// <summary>
        /// 發送請求
        /// </summary>
        /// <param name="url">Url地址</param>
        /// <param name="method">方法（post或get）</param>
        /// <param name="method">數據類型</param>
        /// <param name="requestData">數據</param>
        public static string SendGetHttpRequest(string url, string contentType)
        {
            WebRequest request = (WebRequest)HttpWebRequest.Create(url);
            request.Method = "GET";
            request.ContentType = contentType;
            string result = string.Empty;
            using (WebResponse response = request.GetResponse())
            {
                if (response != null)
                {
                    using (Stream stream = response.GetResponseStream())
                    {
                        using (StreamReader reader = new StreamReader(stream, Encoding.UTF8))
                        {
                            result = reader.ReadToEnd();
                        }
                    }
                }
            }
            return result;
        }
    }
}

using System;
using System.Xml.Linq;
using Newtonsoft.Json;

namespace Yank.WeiXin.Robot.Utility
{
    class XmlUtility
    {
        /// <summary>
        /// 
        /// </summary>
        /// <param name="json"></param>
        /// <param name="rootName"></param>
        /// <returns></returns>
        public static XDocument ParseJson(string json,string rootName)
        {
            return JsonConvert.DeserializeXNode(json, rootName);
        }
    }
}

五、事件處理

設置了菜單，這下須要處理事件了。跟咱們以前設計ASPX或者WinForm同樣，都要綁定按鈕的事件。這裏只是經過XML消息將請求傳遞過來。

經過「二、設置菜單"中具體的菜單內容，咱們便已經知道須要進行哪些事件處理了。對於按鈕類型爲view的，無須處理，它會自動跳轉至指定url.

須要處理的點擊事件：

1）贊一下

2）查詢某城市的天氣，北京、上海、武漢

3）幫助

這個還要沿用上章中的事件處理器EventHandler來擴展處理。

具體的實現代碼吧：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Yank.WeiXin.Robot.Messages;

namespace Yank.WeiXin.Robot.Handlers
{
    class EventHandler : IHandler
    {
        /// <summary>
        /// 請求的xml
        /// </summary>
        private string RequestXml { get; set; }
        /// <summary>
        /// 構造函數
        /// </summary>
        /// <param name="requestXml"></param>
        public EventHandler(string requestXml)
        {
            this.RequestXml = requestXml;
        }
        /// <summary>
        /// 處理請求
        /// </summary>
        /// <returns></returns>
        public string HandleRequest()
        {
            string response = string.Empty;
            EventMessage em = EventMessage.LoadFromXml(RequestXml);
            if (em != null)
            {
                switch (em.Event.ToLower())
                {
                    case ("subscribe"):
                        response = SubscribeEventHandler(em);
                        break;
                    case "click":
                        response = ClickEventHandler(em);
                        break;
                }
            }

            return response;
        }
        /// <summary>
        /// 關注
        /// </summary>
        /// <param name="em"></param>
        /// <returns></returns>
        private string SubscribeEventHandler(EventMessage em)
        {
            //回覆歡迎消息
            TextMessage tm = new TextMessage();
            tm.ToUserName = em.FromUserName;
            tm.FromUserName = em.ToUserName;
            tm.CreateTime = Common.GetNowTime();
            tm.Content = "歡迎您關注***，我是大哥大，有事就問我，呵呵！\n\n";
            return tm.GenerateContent();
        }
        /// <summary>
        /// 處理點擊事件
        /// </summary>
        /// <param name="em"></param>
        /// <returns></returns>
        private string ClickEventHandler(EventMessage em)
        {
            string result = string.Empty;
            if (em != null && em.EventKey != null)
            {
                switch (em.EventKey.ToUpper())
                {
                    case "BTN_GOOD":
                        result = btnGoodClick(em);
                        break;
                    case "BTN_TQ_BEIJING":
                        result = searchWeather("beijing", em);
                        break;
                    case "BTN_TQ_SHANGHAI":
                        result = searchWeather("shanghai", em);
                        break;
                    case "BTN_TQ_WUHAN":
                        result = searchWeather("wuhai", em);
                        break;
                    case "BTN_HELP":
                        result = btnHelpClick(em);
                        break;
                }
            }

            return result;
        }
        /// <summary>
        /// 贊一下
        /// </summary>
        /// <param name="em"></param>
        /// <returns></returns>
        private string btnGoodClick(EventMessage em)
        {
            //回覆歡迎消息
            TextMessage tm = new TextMessage();
            tm.ToUserName = em.FromUserName;
            tm.FromUserName = em.ToUserName;
            tm.CreateTime = Common.GetNowTime();
            tm.Content = @"謝謝您的支持！";
            return tm.GenerateContent();
        }
        /// <summary>
        /// 幫助
        /// </summary>
        /// <param name="em"></param>
        /// <returns></returns>
        private string btnHelpClick(EventMessage em)
        {
            //回覆歡迎消息
            TextMessage tm = new TextMessage();
            tm.ToUserName = em.FromUserName;
            tm.FromUserName = em.ToUserName;
            tm.CreateTime = Common.GetNowTime();
            tm.Content = @"查詢天氣，輸入tq 城市名稱\拼音\首字母";
            return tm.GenerateContent();
        }
        /// <summary>
        /// 查詢天氣
        /// </summary>
        /// <param name="cityName"></param>
        /// <param name="em"></param>
        /// <returns></returns>
        private string searchWeather(string cityName, EventMessage em)
        {
            TextMessage tm = new TextMessage();
            tm.Content = WeatherHelper.GetWeather(cityName);
            //進行發送者、接收者轉換
            tm.ToUserName = em.FromUserName;
            tm.FromUserName = em.ToUserName;
            tm.CreateTime = Common.GetNowTime();
            return tm.GenerateContent();
        }
    }
}

六、效果圖

終於大工告成，最後來看下效果圖吧

轉載自：http://www.cnblogs.com/yank/p/3418194.html