C#開發(fā)微信門戶及之關(guān)注用戶列表及詳細(xì)信息管理的示例分析

這篇文章主要介紹C#開發(fā)微信門戶及之關(guān)注用戶列表及詳細(xì)信息管理的示例分析，文中介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們一定要看完！

微信的很重要的一個特點就是能夠利用其平臺龐大的用戶群體，因此很容易整合在CRM（客戶關(guān)系管理）系統(tǒng)里面，服務(wù)號和訂閱好都能夠向關(guān)注者推送相關(guān)的產(chǎn)品消息，還能和48小時內(nèi)響應(yīng)消息和事件的活躍用戶進(jìn)行交互對話，因此用戶信息是微信API里面非常重要的一環(huán)，本隨筆主要介紹獲取關(guān)注用戶、查看用戶信息、分組管理等方面的開發(fā)應(yīng)用。

1、關(guān)注用戶列表及用戶分組信息

在微信的管理平臺上，我們可以看到自己賬號的關(guān)注者用戶，以及用戶分組信息，如下所示。

上面的管理界面，能看到關(guān)注者用戶的基礎(chǔ)信息，但是使用微信API獲取到的是一個稱之為OpenID的列表，我們先了解這個東西是什么？微信API的說明給出下面的解析：

關(guān)注者列表由一串OpenID（加密后的微信號，每個用戶對每個公眾號的OpenID是唯一的。對于不同公眾號，同一用戶的openid不同）組成。公眾號可通過本接口來根據(jù)OpenID獲取用戶基本信息，包括昵稱、頭像、性別、所在城市、語言和關(guān)注時間。

上面的解析意思很清楚了，就是一個用戶關(guān)注我們的公眾號，那么不管他是第幾次關(guān)注，對我們公眾號來說，都是一個確定的值；但是，一個用戶對其他公眾號，卻有著其他不同的OpenID。

微信提供了為數(shù)不多的幾個關(guān)鍵字信息，用來記錄用戶的相關(guān)內(nèi)容，根據(jù)用戶的相關(guān)定義，我們定義一個實體類，用來放置獲取回來的用戶信息。

 /// <summary>
 /// 高級接口獲取的用戶信息。
 /// 在關(guān)注者與公眾號產(chǎn)生消息交互后，公眾號可獲得關(guān)注者的OpenID
 /// （加密后的微信號，每個用戶對每個公眾號的OpenID是唯一的。對于不同公眾號，同一用戶的openid不同）。
 /// 公眾號可通過本接口來根據(jù)OpenID獲取用戶基本信息，包括昵稱、頭像、性別、所在城市、語言和關(guān)注時間。
 /// </summary>
 public class UserJson : BaseJsonResult
 {
 /// <summary>
 /// 用戶是否訂閱該公眾號標(biāo)識，值為0時，代表此用戶沒有關(guān)注該公眾號，拉取不到其余信息。
 /// </summary>
 public int subscribe { get; set; }

 /// <summary>
 /// 用戶的標(biāo)識，對當(dāng)前公眾號唯一
 /// </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>
 /// 用戶頭像，最后一個數(shù)值代表正方形頭像大?。ㄓ?、46、64、96、132數(shù)值可選，0代表640*640正方形頭像），用戶沒有頭像時該項為空
 /// </summary>
 public string headimgurl { get; set; }

 /// <summary>
 /// 用戶關(guān)注時間，為時間戳。如果用戶曾多次關(guān)注，則取最后關(guān)注時間
 /// </summary>
 public long subscribe_time { get; set; }
 }

根據(jù)分組信息定義，我們定義一個分組的實體類信息。

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

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

2、獲取AIP調(diào)用者的的Token

在做微信API的開發(fā)，很多時候，我們都需要傳入一個AccessToken，這個就是區(qū)分調(diào)用者和記錄會話信息的字符串，因此，在學(xué)習(xí)所有API開發(fā)之前，我們需要很好理解這個訪問控制參數(shù)。

這個對象的定義，我們可以從微信的API說明中了解。

access_token是公眾號的全局唯一票據(jù)，公眾號調(diào)用各接口時都需使用access_token。正常情況下access_token有效期為7200秒，重復(fù)獲取將導(dǎo)致上次獲取的access_token失效。由于獲取access_token的api調(diào)用次數(shù)非常有限，建議開發(fā)者全局存儲與更新access_token，頻繁刷新access_token會導(dǎo)致api調(diào)用受限，影響自身業(yè)務(wù)。

根據(jù)上面的說明定義，我們可以看到，它是一個和身份，以及會話時間有關(guān)的一個參數(shù)，而且它的產(chǎn)生次數(shù)有限制，因此要求我們需要對它進(jìn)行緩存并重復(fù)利用，在會話到期之前，我們應(yīng)該盡可能重用這個參數(shù)，避免反復(fù)請求，增加服務(wù)器壓力，以及調(diào)用的時間。

我定義了一個方法，用來構(gòu)造生成相關(guān)的Access Token，而且它具有緩存的功能，但具體如何緩存及使用，對我API的調(diào)用是透明的，我們只要用的時候，就對它調(diào)用就是了。

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

緩存主要是基于.NET4增加的類庫MemoryCache，這個是一個非常不錯的緩存類。

我的獲取AccessToken的操作實現(xiàn)代碼如下所示。

 /// <summary>
 /// 獲取每次操作微信API的Token訪問令牌
 /// </summary>
 /// <param name="appid">應(yīng)用ID</param>
 /// <param name="secret">開發(fā)者憑據(jù)</param>
 /// <returns></returns>
 public string GetAccessToken(string appid, string secret)
 {
  //正常情況下access_token有效期為7200秒,這里使用緩存設(shè)置短于這個時間即可
  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默認(rèn)是7200秒過期，因此在這個時間段里面，我們盡可能使用緩存來記錄它的值，如果超過了這個時間，我們調(diào)用這個方法的時候，它會自動重新獲取一個新的值給我們了。

3、獲取關(guān)注用戶列表

獲取關(guān)注用戶列表，一次拉取API調(diào)用，最多拉取10000個關(guān)注者的OpenID，可以通過多次拉取的方式來滿足需求。微信的接口定義如下所示。

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

這個接口返回的數(shù)據(jù)是

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

根據(jù)返回的Json數(shù)據(jù)定義，我們還需要定義兩個實體類，用來存放返回的結(jié)果。

 /// <summary>
 /// 獲取關(guān)注用戶列表的Json結(jié)果
 /// </summary>
 public class UserListJsonResult : BaseJsonResult
 {
 /// <summary>
 /// 關(guān)注該公眾賬號的總用戶數(shù)
 /// </summary>
 public int total { get; set; }

 /// <summary>
 /// 拉取的OPENID個數(shù)，最大值為10000
 /// </summary>
 public int count { get; set; }

 /// <summary>
 /// 列表數(shù)據(jù)，OPENID的列表
 /// </summary>
 public OpenIdListData data { get; set; }

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

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

為了獲取相關(guān)的用戶信息，我定義了一個接口，用來獲取用戶的信息，接口定義如下所示。

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

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

然后在實現(xiàn)類里面，我們分別對上面兩個接口進(jìn)行實現(xiàn)，獲取用戶列表信息如下所示。

 /// <summary>
 /// 獲取關(guān)注用戶列表
 /// </summary>
 /// <param name="accessToken">調(diào)用接口憑證</param>
 /// <param name="nextOpenId">第一個拉取的OPENID，不填默認(rèn)從頭開始拉取</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;
 }

我們看到，轉(zhuǎn)換的邏輯已經(jīng)放到了JsonHelper里面去了，這個輔助類里面分別對數(shù)值進(jìn)行了獲取內(nèi)容，驗證返回值，然后轉(zhuǎn)換正確實體類幾個部分的操作。

獲取內(nèi)容，通過輔助類HttpHelper進(jìn)行，這個在我的公用類庫里面，里面的邏輯主要就是通過HttpRequest進(jìn)行數(shù)據(jù)的獲取操作，不在贅述。

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

由于返回的內(nèi)容，我們需要判斷它是否正確返回所需的結(jié)果，如果沒有，拋出自定義的相關(guān)異常，方便處理，具體如下所示。

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

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

然后轉(zhuǎn)換為相應(yīng)的格式，就是通過Json.NET的類庫進(jìn)行轉(zhuǎn)換。

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

這樣我們就可以在ConvertJson函數(shù)實體里面，完整的進(jìn)行處理和轉(zhuǎn)換了，轉(zhuǎn)換完整的函數(shù)代碼如下所示。

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

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

 /// <summary>
 /// 轉(zhuǎn)換Json字符串到具體的對象
 /// </summary>
 /// <param name="url">返回Json數(shù)據(jù)的鏈接地址</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;
 }
}

調(diào)用這個API的界面層代碼如下所示（測試代碼）

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

4、獲取用戶詳細(xì)信息

上面的獲取列表操作，相對比較簡單，而且不用POST任何數(shù)據(jù)，因此通過Get協(xié)議就能獲取到所需的數(shù)據(jù)。

本小節(jié)繼續(xù)介紹獲取用戶詳細(xì)信息的操作，這個操作也是通過GET協(xié)議就可以完成的。

這個API的調(diào)用定義如下所示：

http請求方式: GET
api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN
通過傳入一個OpenId，我們就能很好獲取到用戶的相關(guān)信息了。

前面小節(jié)我們已經(jīng)定義了它的接口，說明了傳入及返回值，根據(jù)定義，它的實現(xiàn)函數(shù)如下所示。

 /// <summary>
 /// 獲取用戶基本信息
 /// </summary>
 /// <param name="accessToken">調(diào)用接口憑證</param>
 /// <param name="openId">普通用戶的標(biāo)識，對當(dāng)前公眾號唯一</param>
 /// <param name="lang">返回國家地區(qū)語言版本，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;
 }

最后，我們結(jié)合獲取用戶列表和獲取用戶詳細(xì)信息的兩個API，我們看看調(diào)用的代碼（測試代碼）。

 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#開發(fā)微信門戶及之關(guān)注用戶列表及詳細(xì)信息管理的示例分析”這篇文章的所有內(nèi)容，感謝各位的閱讀！希望分享的內(nèi)容對大家有幫助，更多相關(guān)知識，歡迎關(guān)注億速云行業(yè)資訊頻道！