在上個月的對C#開發微信門戶及應用做了介紹，寫過了幾篇的隨筆進行分享，由於時間關系，間隔了一段時間沒有繼續寫這個系列的博客了，並不是對這個方面停止了研究，而是繼續深入探索這方面的技術，為了更好的應用起來，專心做好底層的技術開發。
微信的很重要的一個特點就是能夠利用其平台龐大的用戶群體，因此很容易整合在CRM（客戶關系管理）系統里面，服務號和訂閱好都能夠向關注者推送相關的產品消息，還能和48小時內響應消息和事件的活躍用戶進行交互對話，因此用戶信息是微信API里面非常重要的一環，本隨筆主要介紹獲取關注用戶、查看用戶信息、分組管理等方面的開發應用。
1、關注用戶列表及用戶分組信息
在微信的管理平台上，我們可以看到自己賬號的關注者用戶，以及用戶分組信息，如下所示。
上面的管理界面，能看到關注者用戶的基礎信息，但是使用微信API獲取到的是一個稱之為OpenID的列表，我們先了解這個東西是什么？微信API的說明給出下面的解析：
關注者列表由一串OpenID（加密后的微信號，每個用戶對每個公眾號的OpenID是唯一的。對於不同公眾號，同一用戶的openid不同）組成。公眾號可通過本接口來根據OpenID獲取用戶基本信息，包括昵稱、頭像、性別、所在城市、語言和關注時間。
上面的解析意思很清楚了，就是一個用戶關注我們的公眾號，那么不管他是第幾次關注，對我們公眾號來說，都是一個確定的值；但是，一個用戶對其他公眾號，卻有着其他不同的OpenID。
微信提供了為數不多的幾個關鍵字信息，用來記錄用戶的相關內容，根據用戶的相關定義，我們定義一個實體類，用來放置獲取回來的用戶信息。
/// <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、46、64、96、132數值可選，0代表640*640正方形頭像），用戶沒有頭像時該項為空 /// </summary> public string headimgurl { get; set; } /// <summary> /// 用戶關注時間，為時間戳。如果用戶曾多次關注，則取最后關注時間 /// </summary> public long subscribe_time { get; set; } }
根據分組信息定義，我們定義一個分組的實體類信息。
/// <summary> /// 分組信息 /// </summary> public class GroupJson : BaseJsonResult { /// <summary> /// 分組id，由微信分配 /// </summary> public int id { get; set; } /// <summary> /// 分組名字，UTF8編碼 /// </summary> public string name { get; set; } }
2、獲取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秒過期，因此在這個時間段里面，我們盡可能使用緩存來記錄它的值，如果超過了這個時間，我們調用這個方法的時候，它會自動重新獲取一個新的值給我們了。
3、獲取關注用戶列表
獲取關注用戶列表，一次拉取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)
4、獲取用戶詳細信息
上面的獲取列表操作，相對比較簡單，而且不用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#開發微信門戶及應用(23)-微信小店商品管理接口的封裝和測試
C#開發微信門戶及應用(21)-微信企業號的消息和事件的接收處理及解密
C#開發微信門戶及應用(19)-微信企業號的消息發送（文本、圖片、文件、語音、視頻、圖文消息等）
C#開發微信門戶及應用(18)-微信企業號的通訊錄管理開發之成員管理
C#開發微信門戶及應用(17)-微信企業號的通訊錄管理開發之部門管理
C#開發微信門戶及應用(15)-微信菜單增加掃一掃、發圖片、發地理位置功能
C#開發微信門戶及應用(14)-在微信菜單中采用重定向獲取用戶數據
C#開發微信門戶及應用(11)--微信菜單的多種表現方式介紹
C#開發微信門戶及應用(10)--在管理系統中同步微信用戶分組信息