C#開發微信門戶及應用(四)之關注使用者列表及詳細資料管理

這篇文章主要為大家詳細介紹了C#開發門戶及應用第四篇，關注使用者列表及詳細資料管理，具有一定的參考價值，感興趣的小夥伴們可以參考一下

在上個月的對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
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);  }  } }