C#開發微信門戶及應用(4)--關注用戶列表及詳細信息管理

時間  2019-11-11
標籤 c# 開發 微信 門戶 應用 關注 用戶 列表 詳細 信息管理 欄目 C# 简体版
原文   原文鏈接

在上個月的對C#開發微信門戶及應用作了介紹，寫過了幾篇的隨筆進行分享，因爲時間關係，間隔了一段時間沒有繼續寫這個系列的博客了，並非對這個方面中止了研究，而是繼續深刻探索這方面的技術，爲了更好的應用起來，專心作好底層的技術開發。html

微信的很重要的一個特色就是可以利用其平臺龐大的用戶羣體，所以很容易整合在CRM（客戶關係管理）系統裏面，服務號和訂閱好都可以向關注者推送相關的產品消息，還能和48小時內響應消息和事件的活躍用戶進行交互對話，所以用戶信息是微信API裏面很是重要的一環，本隨筆主要介紹獲取關注用戶、查看用戶信息、分組管理等方面的開發應用。api

一、關注用戶列表及用戶分組信息

在微信的管理平臺上，咱們能夠看到本身帳號的關注者用戶，以及用戶分組信息，以下所示。緩存

 

上面的管理界面，能看到關注者用戶的基礎信息，可是使用微信API獲取到的是一個稱之爲OpenID的列表，咱們先了解這個東西是什麼？微信API的說明給出下面的解析：服務器

關注者列表由一串OpenID（加密後的微信號，每一個用戶對每一個公衆號的OpenID是惟一的。對於不一樣公衆號，同一用戶的openid不一樣）組成。公衆號可經過本接口來根據OpenID獲取用戶基本信息，包括暱稱、頭像、性別、所在城市、語言和關注時間。微信

上面的解析意思很清楚了，就是一個用戶關注咱們的公衆號，那麼無論他是第幾回關注，對咱們公衆號來講，都是一個肯定的值；可是，一個用戶對其餘公衆號，卻有着其餘不一樣的OpenID。app

微信提供了爲數很少的幾個關鍵字信息，用來記錄用戶的相關內容，根據用戶的相關定義，咱們定義一個實體類，用來放置獲取回來的用戶信息。函數

    /// <summary>
    /// 高級接口獲取的用戶信息。
    /// 在關注者與公衆號產生消息交互後，公衆號可得到關注者的OpenID
    /// （加密後的微信號，每一個用戶對每一個公衆號的OpenID是惟一的。對於不一樣公衆號，同一用戶的openid不一樣）。
    /// 公衆號可經過本接口來根據OpenID獲取用戶基本信息，包括暱稱、頭像、性別、所在城市、語言和關注時間。
    /// </summary>
    public class UserJson : BaseJsonResult
    {
        /// <summary>
        /// 用戶是否訂閱該公衆號標識，值爲0時，表明此用戶沒有關注該公衆號，拉取不到其他信息。
        /// </summary>
        public int subscribe { get; set; }

        /// <summary>
        /// 用戶的標識，對當前公衆號惟一
        /// </summary>
        public string openid { get; set; }

        /// <summary>
        /// 用戶的暱稱
        /// </summary>
        public string nickname { get; set; }

        /// <summary>
        /// 用戶的性別，值爲1時是男性，值爲2時是女性，值爲0時是未知
        /// </summary>
        public int sex { get; set; }

        /// <summary>
        /// 用戶的語言，簡體中文爲zh_CN
        /// </summary>
        public string language { get; set; }

        /// <summary>
        /// 用戶所在城市
        /// </summary>
        public string city { get; set; }

        /// <summary>
        /// 用戶所在省份
        /// </summary>
        public string province { get; set; }

        /// <summary>
        /// 用戶所在國家
        /// </summary>
        public string country { get; set; }

        /// <summary>
        /// 用戶頭像，最後一個數值表明正方形頭像大小（有0、4六、6四、9六、132數值可選，0表明640*640正方形頭像），用戶沒有頭像時該項爲空
        /// </summary>
        public string headimgurl { get; set; }

        /// <summary>
        /// 用戶關注時間，爲時間戳。若是用戶曾屢次關注，則取最後關注時間
        /// </summary>
        public long subscribe_time { get; set; }
    }

根據分組信息定義，咱們定義一個分組的實體類信息。post

    /// <summary>
    /// 分組信息
    /// </summary>
    public class GroupJson : BaseJsonResult
    {
        /// <summary>
        /// 分組id，由微信分配
        /// </summary>
        public int id { get; set; }

        /// <summary>
        /// 分組名字，UTF8編碼
        /// </summary>
        public string name { get; set; }
    }

二、獲取AIP調用者的的Token 

在作微信API的開發，不少時候，咱們都須要傳入一個AccessToken，這個就是區分調用者和記錄會話信息的字符串，所以，在學習全部API開發以前，咱們須要很好理解這個訪問控制參數。學習

這個對象的定義，咱們能夠從微信的API說明中瞭解。測試

access_token是公衆號的全局惟一票據，公衆號調用各接口時都需使用access_token。正常狀況下access_token有效期爲7200秒，重複獲取將致使上次獲取的access_token失效。因爲獲取access_token的api調用次數很是有限，建議開發者全局存儲與更新access_token，頻繁刷新access_token會致使api調用受限，影響自身業務。

根據上面的說明定義，咱們能夠看到，它是一個和身份，以及會話時間有關的一個參數，並且它的產生次數有限制，所以要求咱們須要對它進行緩存並重複利用，在會話到期以前，咱們應該儘量重用這個參數，避免反覆請求，增長服務器壓力，以及調用的時間。

我定義了一個方法，用來構造生成相關的Access Token，並且它具備緩存的功能，但具體如何緩存及使用，對我API的調用是透明的，咱們只要用的時候，就對它調用就是了。

        /// 獲取憑證接口
        /// </summary>
        /// <param name="appid">第三方用戶惟一憑證</param>
        /// <param name="secret">第三方用戶惟一憑證密鑰，既appsecret</param>
        string GetAccessToken(string appid, string secret);

緩存主要是基於.NET4增長的類庫MemoryCache，這個是一個很是不錯的緩存類。

個人獲取AccessToken的操做實現代碼以下所示。

        /// <summary>
        /// 獲取每次操做微信API的Token訪問令牌
        /// </summary>
        /// <param name="appid">應用ID</param>
        /// <param name="secret">開發者憑據</param>
        /// <returns></returns>
        public string GetAccessToken(string appid, string secret)
        {
            //正常狀況下access_token有效期爲7200秒,這裏使用緩存設置短於這個時間便可
            string access_token = MemoryCacheHelper.GetCacheItem<string>("access_token", delegate()
                {
                    string grant_type = "client_credential";
                    var url = string.Format("https://api.weixin.qq.com/cgi-bin/token?grant_type={0}&appid={1}&secret={2}",
                                            grant_type, appid, secret);

                    HttpHelper helper = new HttpHelper();
                    string result = helper.GetHtml(url);
                    string regex = "\"access_token\":\"(?<token>.*?)\"";
                    string token = CRegex.GetText(result, regex, "token");
                    return token;
                },
                new TimeSpan(0, 0, 7000)//7000秒過時
            );

            return access_token;            
        }

因爲咱們知道，AccessToken默認是7200秒過時，所以在這個時間段裏面，咱們儘量使用緩存來記錄它的值，若是超過了這個時間，咱們調用這個方法的時候，它會自動從新獲取一個新的值給咱們了。

 

三、獲取關注用戶列表

獲取關注用戶列表，一次拉取API調用，最多拉取10000個關注者的OpenID，能夠經過屢次拉取的方式來知足需求。微信的接口定義以下所示。

http請求方式: GET（請使用https協議）
https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&next_openid=NEXT_OPENID

這個接口返回的數據是

{"total":2,"count":2,"data":{"openid":["","OPENID1","OPENID2"]},"next_openid":"NEXT_OPENID"}

根據返回的Json數據定義，咱們還須要定義兩個實體類，用來存放返回的結果。

    /// <summary>
    /// 獲取關注用戶列表的Json結果
    /// </summary>
    public class UserListJsonResult : BaseJsonResult
    {
        /// <summary>
        /// 關注該公衆帳號的總用戶數
        /// </summary>
        public int total { get; set; }

        /// <summary>
        /// 拉取的OPENID個數，最大值爲10000
        /// </summary>
        public int count { get; set; }

        /// <summary>
        /// 列表數據，OPENID的列表
        /// </summary>
        public OpenIdListData data { get; set; }

        /// <summary>
        /// 拉取列表的後一個用戶的OPENID
        /// </summary>
        public string next_openid { get; set; }
    }

    /// <summary>
    /// 列表數據，OPENID的列表
    /// </summary>
    public class OpenIdListData
    {
        /// <summary>
        /// OPENID的列表
        /// </summary>
        public List<string> openid { get; set; }
    }

爲了獲取相關的用戶信息，我定義了一個接口，用來獲取用戶的信息，接口定義以下所示。

    /// <summary>
    /// 微信用戶管理的API接口
    /// </summary>
    public interface IUserApi
    {
        /// <summary>
        /// 獲取關注用戶列表
        /// </summary>
        /// <param name="accessToken">調用接口憑證</param>
        /// <param name="nextOpenId">第一個拉取的OPENID，不填默認從頭開始拉取</param>
        /// <returns></returns>
        List<string> GetUserList(string accessToken, string nextOpenId = null);

        /// <summary>
        /// 獲取用戶基本信息
        /// </summary>
        /// <param name="accessToken">調用接口憑證</param>
        /// <param name="openId">普通用戶的標識，對當前公衆號惟一</param>
        /// <param name="lang">返回國家地區語言版本，zh_CN 簡體，zh_TW 繁體，en 英語</param>
        UserJson GetUserDetail(string accessToken, string openId, Language lang = Language.zh_CN);

而後在實現類裏面，咱們分別對上面兩個接口進行實現，獲取用戶列表信息以下所示。

        /// <summary>
        /// 獲取關注用戶列表
        /// </summary>
        /// <param name="accessToken">調用接口憑證</param>
        /// <param name="nextOpenId">第一個拉取的OPENID，不填默認從頭開始拉取</param>
        /// <returns></returns>
        public List<string> GetUserList(string accessToken, string nextOpenId = null)
        {
            List<string> list = new List<string>();

            string url = string.Format("https://api.weixin.qq.com/cgi-bin/user/get?access_token={0}", accessToken);
            if (!string.IsNullOrEmpty(nextOpenId))
            {
                url += "&next_openid=" + nextOpenId;
            }

            UserListJsonResult result = JsonHelper<UserListJsonResult>.ConvertJson(url);
            if (result != null && result.data != null)
            {
                list.AddRange(result.data.openid);
            }

            return list;
        }

咱們看到，轉換的邏輯已經放到了JsonHelper裏面去了，這個輔助類裏面分別對數值進行了獲取內容，驗證返回值，而後轉換正確實體類幾個部分的操做。

獲取內容，經過輔助類HttpHelper進行，這個在個人公用類庫裏面，裏面的邏輯主要就是經過HttpRequest進行數據的獲取操做，不在贅述。

HttpHelper helper = new HttpHelper();
string content = helper.GetHtml(url);

因爲返回的內容，咱們須要判斷它是否正確返回所需的結果，若是沒有，拋出自定義的相關異常，方便處理，具體以下所示。

        /// <summary>
        /// 檢查返回的記錄，若是返回沒有錯誤，或者結果提示成功，則不拋出異常
        /// </summary>
        /// <param name="content">返回的結果</param>
        /// <returns></returns>
        private static bool VerifyErrorCode(string content)
        {
            if (content.Contains("errcode"))
            {
                ErrorJsonResult errorResult = JsonConvert.DeserializeObject<ErrorJsonResult>(content);
                //非成功操做才記錄異常，由於有些操做是返回正常的結果（{"errcode": 0, "errmsg": "ok"}）
                if (errorResult != null && errorResult.errcode != ReturnCode.請求成功)
                {
                    string error = string.Format("微信請求發生錯誤！錯誤代碼：{0}，說明：{1}", (int)errorResult.errcode, errorResult.errmsg);
                    LogTextHelper.Error(errorResult);

                    throw new WeixinException(error);//拋出錯誤
                }
            }
            return true;
        }

而後轉換爲相應的格式，就是經過Json.NET的類庫進行轉換。

            T result = JsonConvert.DeserializeObject<T>(content);
            return result;

這樣咱們就能夠在ConvertJson函數實體裏面，完整的進行處理和轉換了，轉換完整的函數代碼以下所示。

    /// <summary>
    /// Json字符串操做輔助類
    /// </summary>
    public class JsonHelper<T> where T : class, new()
    {
        /// <summary>
        /// 檢查返回的記錄，若是返回沒有錯誤，或者結果提示成功，則不拋出異常
        /// </summary>
        /// <param name="content">返回的結果</param>
        /// <returns></returns>
        private static bool VerifyErrorCode(string content)
        {
            if (content.Contains("errcode"))
            {
                ErrorJsonResult errorResult = JsonConvert.DeserializeObject<ErrorJsonResult>(content);
                //非成功操做才記錄異常，由於有些操做是返回正常的結果（{"errcode": 0, "errmsg": "ok"}）
                if (errorResult != null && errorResult.errcode != ReturnCode.請求成功)
                {
                    string error = string.Format("微信請求發生錯誤！錯誤代碼：{0}，說明：{1}", (int)errorResult.errcode, errorResult.errmsg);
                    LogTextHelper.Error(errorResult);

                    throw new WeixinException(error);//拋出錯誤
                }
            }
            return true;
        }

        /// <summary>
        /// 轉換Json字符串到具體的對象
        /// </summary>
        /// <param name="url">返回Json數據的連接地址</param>
        /// <returns></returns>
        public static T ConvertJson(string url)
        {
            HttpHelper helper = new HttpHelper();
            string content = helper.GetHtml(url);
            VerifyErrorCode(content);

            T result = JsonConvert.DeserializeObject<T>(content);
            return result;
        }
}

調用這個API的界面層代碼以下所示（測試代碼）

            IUserApi userBLL = new UserApi();
            List<string> userList = userBLL.GetUserList(token)

 

四、獲取用戶詳細信息

上面的獲取列表操做，相對比較簡單，並且不用POST任何數據，所以經過Get協議就能獲取到所需的數據。

本小節繼續介紹獲取用戶詳細信息的操做，這個操做也是經過GET協議就能夠完成的。

這個API的調用定義以下所示：

http請求方式: GET
https://api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN

經過傳入一個OpenId，咱們就能很好獲取到用戶的相關信息了。

前面小節咱們已經定義了它的接口，說明了傳入及返回值，根據定義，它的實現函數以下所示。

        /// <summary>
        /// 獲取用戶基本信息
        /// </summary>
        /// <param name="accessToken">調用接口憑證</param>
        /// <param name="openId">普通用戶的標識，對當前公衆號惟一</param>
        /// <param name="lang">返回國家地區語言版本，zh_CN 簡體，zh_TW 繁體，en 英語</param>
        public UserJson GetUserDetail(string accessToken, string openId, Language lang = Language.zh_CN)
        {
            string url = string.Format("https://api.weixin.qq.com/cgi-bin/user/info?access_token={0}&openid={1}&lang={2}",
                   accessToken, openId, lang.ToString());

            UserJson result = JsonHelper<UserJson>.ConvertJson(url);
            return result;
        }

最後，咱們結合獲取用戶列表和獲取用戶詳細信息的兩個API，咱們看看調用的代碼（測試代碼）。

        private void btnGetUsers_Click(object sender, EventArgs e)
        {
            IUserApi userBLL = new UserApi();
            List<string> userList = userBLL.GetUserList(token);
            foreach (string openId in userList)
            {
                UserJson userInfo = userBLL.GetUserDetail(token, openId);
                if (userInfo != null)
                {                    
                    string tips = string.Format("{0}:{1}", userInfo.nickname, userInfo.openid);
                    Console.WriteLine(tips);
                }
            }
        }

 

本系列相關文章以下：

C#開發微信門戶及應用(25)-微信企業號的客戶端管理功能

C#開發微信門戶及應用(24)-微信小店貨架信息管理

C#開發微信門戶及應用(23)-微信小店商品管理接口的封裝和測試

C#開發微信門戶及應用(22)-微信小店的開發和使用

C#開發微信門戶及應用(21)-微信企業號的消息和事件的接收處理及解密 

C#開發微信門戶及應用(20)-微信企業號的菜單管理

C#開發微信門戶及應用(19)-微信企業號的消息發送（文本、圖片、文件、語音、視頻、圖文消息等）

C#開發微信門戶及應用(18)-微信企業號的通信錄管理開發之成員管理

C#開發微信門戶及應用(17)-微信企業號的通信錄管理開發之部門管理

C#開發微信門戶及應用(16)-微信企業號的配置和使用

C#開發微信門戶及應用(15)-微信菜單增長掃一掃、發圖片、發地理位置功能

 C#開發微信門戶及應用(14)-在微信菜單中採用重定向獲取用戶數據

C#開發微信門戶及應用(13)-使用地理位置擴展相關應用

C#開發微信門戶及應用(12)-使用語音處理

C#開發微信門戶及應用(11)--微信菜單的多種表現方式介紹

C#開發微信門戶及應用(10)--在管理系統中同步微信用戶分組信息

C#開發微信門戶及應用(9)-微信門戶菜單管理及提交到微信服務器

C#開發微信門戶及應用(8)-微信門戶應用管理系統功能介紹

C#開發微信門戶及應用(7)-微信多客服功能及開發集成

C#開發微信門戶及應用(6)--微信門戶菜單的管理操做

C#開發微信門戶及應用(5)--用戶分組信息管理

C#開發微信門戶及應用(4)--關注用戶列表及詳細信息管理

C#開發微信門戶及應用(3)--文本消息和圖文消息的應答

C#開發微信門戶及應用(2)--微信消息的處理和應答

C#開發微信門戶及應用(1)--開始使用微信接口

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程