C#開發微信門戶及應用(五)之使用者分組資訊管理

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

在上個月的對C#開發門戶及應用做了介紹，寫過了幾篇的隨筆進行分享，由於時間關係，間隔了一段時間沒有繼續寫這個系列的部落格了，並不是對這個方面停止了研究，而是繼續深入探索這方面的技術，為了更好的應用起來，專心做好底層的技術開發。本篇繼續上一篇的介紹，主要介紹分組管理方面的開發應用，這篇的內容和上一篇，作為一個完整的使用者資訊和分組資訊管理的組合。

1、使用者分組管理內容

使用者分組的引入，主要是方便管理粉絲列表，以及方便向不同的組別發送訊息的操作的，一個公眾帳號，最多支援建立500個分組。

使用者分組管理，包含下面幾個方面的內容：

1 建立分組
2 查詢所有分組
3 查詢使用者所在分組
4 修改分組名
5 移動使用者分組

對於建立分組的定義如下所示。

http請求方式: POST（請使用https協議）
https://api.weixin.qq.com/cgi-bin/groups/create?access_token=ACCESS_TOKEN
POST資料格式：json
POST資料例子：{"group":{"name":"test"}}

正常返回的結果如下所示。

{  "group": {    "id": 107,     "name": "test"  }}

其他介面，也是類似的方式，通過POST一些參數進去URL裡面，擷取返回的Json資料。

前面隨筆定義了GroupJson的實體類資訊如下所示。

  /// <summary>  /// 分組資訊  /// </summary>  public class GroupJson : BaseJsonResult  {    /// <summary>    /// 分組id，由分配    /// </summary>    public int id { get; set; }    /// <summary>    /// 分組名字，UTF8編碼    /// </summary>    public string name { get; set; }  }

根據以上幾個介面的定義，我定義了幾個介面，並把它們歸納到使用者管理的API介面裡面。

    /// <summary>    /// 查詢所有分組    /// </summary>    /// <param name="accessToken">調用介面憑證</param>    /// <returns></returns>    List<GroupJson> GetGroupList(string accessToken);                /// <summary>    /// 建立分組    /// </summary>    /// <param name="accessToken">調用介面憑證</param>    /// <param name="name">分組名稱</param>    /// <returns></returns>    GroupJson CreateGroup(string accessToken, string name);                /// <summary>    /// 查詢使用者所在分組    /// </summary>    /// <param name="accessToken">調用介面憑證</param>    /// <param name="openid">使用者的OpenID</param>    /// <returns></returns>    int GetUserGroupId(string accessToken, string openid);        /// <summary>    /// 修改分組名    /// </summary>    /// <param name="accessToken">調用介面憑證</param>    /// <param name="id">分組id，由分配</param>    /// <param name="name">分組名字（30個字元以內）</param>    /// <returns></returns>    CommonResult UpdateGroupName(string accessToken, int id, string name);                /// <summary>    /// 移動使用者分組    /// </summary>    /// <param name="accessToken">調用介面憑證</param>    /// <param name="openid">使用者的OpenID</param>    /// <param name="to_groupid">分組id</param>    /// <returns></returns>    CommonResult MoveUserToGroup(string accessToken, string openid, int to_groupid);

2、使用者分組管理介面的實現

2.1 建立使用者分組

為瞭解析如何?建立使用者分組的POST資料操作，我們來一步步瞭解建立使用者的具體過程。

首先需要建立一個動態定義的實體類資訊，它包含幾個需要提及的屬性，如下所示。

string url = string.Format("https://api.weixin.qq.com/cgi-bin/groups/create?access_token={0}", accessToken);var data = new {  group = new {  name = name  } };string postData = data.ToJson();

其中我們把對象轉換為合適的Json資料操作，放到了擴充方法ToJson裡面了，這個主要就是方便把動態定義的實體類轉換Json內容，主要就是調用Json.NET的序號操作。

/// <summary>/// 把對象為json字串/// </summary>/// <param name="obj">待序號對象</param>/// <returns></returns>public static string ToJson(this object obj) {  return JsonConvert.SerializeObject(obj, Formatting.Indented); }

準備好Post的資料後，我們就進一步看看擷取資料並轉換為合適格式的作業碼。

GroupJson group = null;CreateGroupResult result = JsonHelper<CreateGroupResult>.ConvertJson(url, postData); if (result != null){     group = result.group; }

其中POST資料並轉換為合適格式實體類的操作，放在了ConvertJson方法裡面，這個方法的定義如下所示，裡面的HttpHelper是我公用類庫的輔助類，主要就是調用底層的httpWebRequest對象方法，進行資料的提交，並擷取返回結果。

/// <summary>/// 轉換Json字串到具體的對象/// </summary>/// <param name="url">返回Json資料的連結地址</param>/// <param name="postData">POST提交的資料</param>/// <returns></returns>    public static T ConvertJson(string url, string postData)    {      HttpHelper helper = new HttpHelper();      string content = helper.GetHtml(url, postData, true);      VerifyErrorCode(content);      T result = JsonConvert.DeserializeObject<T>(content);      return result;    }

這樣，完整的建立使用者分組的操作函數如下所示。

    /// <summary>    /// 建立分組    /// </summary>    /// <param name="accessToken">調用介面憑證</param>    /// <param name="name">分組名稱</param>    /// <returns></returns>    public GroupJson CreateGroup(string accessToken, string name)    {      string url = string.Format("https://api.weixin.qq.com/cgi-bin/groups/create?access_token={0}", accessToken);      var data = new      {        group = new        {          name = name        }      };      string postData = data.ToJson();      GroupJson group = null;      CreateGroupResult result = JsonHelper<CreateGroupResult>.ConvertJson(url, postData);      if (result != null)      {        group = result.group;      }      return group;    }

2.2 查詢所有分組

查詢所有分組，可以把伺服器上的分組全部擷取下來，也就是每個分組的ID和名稱。

    /// <summary>    /// 查詢所有分組    /// </summary>    /// <param name="accessToken">調用介面憑證</param>    /// <returns></returns>    public List<GroupJson> GetGroupList(string accessToken)    {      string url = string.Format("https://api.weixin.qq.com/cgi-bin/groups/get?access_token={0}", accessToken);      List<GroupJson> list = new List<GroupJson>();      GroupListJsonResult result = JsonHelper<GroupListJsonResult>.ConvertJson(url);      if (result != null && result.groups != null)      {        list.AddRange(result.groups);      }      return list;    }

2.3 查詢使用者所在分組

每個使用者都屬於一個分組，預設在 未分組 這個分組裡面，我們可以通過API擷取使用者的分組資訊，也就是擷取所在使用者分組的ID。

    /// <summary>    /// 查詢使用者所在分組    /// </summary>    /// <param name="accessToken">調用介面憑證</param>    /// <param name="openid">使用者的OpenID</param>    /// <returns></returns>    public int GetUserGroupId(string accessToken, string openid)    {      string url = string.Format("https://api.weixin.qq.com/cgi-bin/groups/getid?access_token={0}", accessToken);      var data = new      {        openid = openid      };      string postData = data.ToJson();      int groupId = -1;      GroupIdJsonResult result = JsonHelper<GroupIdJsonResult>.ConvertJson(url, postData);      if (result != null)      {        groupId = result.groupid;      }      return groupId;    }

2.4 修改分組名稱

也可以在實際中，調整使用者所在的分組，作業碼如下。

    /// <summary>    /// 修改分組名    /// </summary>    /// <param name="accessToken">調用介面憑證</param>    /// <param name="id">分組id，由分配</param>    /// <param name="name">分組名字（30個字元以內）</param>    /// <returns></returns>    public CommonResult UpdateGroupName(string accessToken, int id, string name)    {      string url = string.Format("https://api.weixin.qq.com/cgi-bin/groups/update?access_token={0}", accessToken);      var data = new      {        group = new        {          id = id,          name = name        }      };      string postData = data.ToJson();      return Helper.GetExecuteResult(url, postData);    }

這裡的傳回值CommonResult是，一個實體類，包含了bool的成功與否的標誌，以及String類型的錯誤資訊（如果有的話）。

對於這個GetExecuteResult函數體，裡面主要就是提交資料，然後擷取結果，並根據結果進行處理的函數。

    /// <summary>    /// 通用的操作結果    /// </summary>    /// <param name="url">網頁地址</param>    /// <param name="postData">提交的資料內容</param>    /// <returns></returns>    public static CommonResult GetExecuteResult(string url, string postData = null)    {      CommonResult success = new CommonResult();      try      {        ErrorJsonResult result;        if (postData != null)        {          result = JsonHelper<ErrorJsonResult>.ConvertJson(url, postData);        }        else        {          result = JsonHelper<ErrorJsonResult>.ConvertJson(url);        }        if (result != null)        {          success.Success = (result.errcode == ReturnCode.請求成功);          success.ErrorMessage = result.errmsg;        }      }      catch (WeixinException ex)      {        success.ErrorMessage = ex.Message;      }      return success;    }   }

上面紅色部分的意思，就是轉換為實體類的時候，如果錯誤是裡面定義的，那麼記錄錯誤資訊，其他異常我不處理（也就是拋出去）。

2.5 移動使用者到新的分組

移動使用者到新的分組的操作和上面小節的差不多，具體看代碼。

    /// <summary>    /// 移動使用者分組    /// </summary>    /// <param name="accessToken">調用介面憑證</param>    /// <param name="openid">使用者的OpenID</param>    /// <param name="to_groupid">分組id</param>    /// <returns></returns>    public CommonResult MoveUserToGroup(string accessToken, string openid, int to_groupid)    {      string url = string.Format("https://api.weixin.qq.com/cgi-bin/groups/members/update?access_token={0}", accessToken);      var data = new      {        openid = openid,        to_groupid = to_groupid      };      string postData = data.ToJson();      return Helper.GetExecuteResult(url, postData);    }

3、使用者分組介面的調用

上面小節，定義並實現了使用者分組的各類介面，所有的使用者相關的都已經毫無保留貼出代碼，它的叫用作業如下代碼所示（測試代碼）。

    private void btnGetGroupList_Click(object sender, EventArgs e)    {      IUserApi userBLL = new UserApi();      List<GroupJson> list = userBLL.GetGroupList(token);      foreach (GroupJson info in list)      {        string tips = string.Format("{0}:{1}", info.name, info.id);        Console.WriteLine(tips);      }    }    private void btnFindUserGroup_Click(object sender, EventArgs e)    {      IUserApi userBLL = new UserApi();      int groupId = userBLL.GetUserGroupId(token, openId);      string tips = string.Format("GroupId:{0}", groupId);      Console.WriteLine(tips);    }    private void btnCreateGroup_Click(object sender, EventArgs e)    {      IUserApi userBLL = new UserApi();      GroupJson info = userBLL.CreateGroup(token, "建立測試分組");      if (info != null)      {        string tips = string.Format("GroupId:{0} GroupName:{1}", info.id, info.name);        Console.WriteLine(tips);        string newName = "建立測試修改";        CommonResult result = userBLL.UpdateGroupName(token, info.id, newName);        Console.WriteLine("修改分組名稱：" + (result.Success ? "成功" : "失敗:" + result.ErrorMessage));      }    }    private void btnUpdateGroup_Click(object sender, EventArgs e)    {      int groupId = 111;      string newName = "建立測試修改";      IUserApi userBLL = new UserApi();      CommonResult result = userBLL.UpdateGroupName(token, groupId, newName);      Console.WriteLine("修改分組名稱：" + (result.Success ? "成功" : "失敗:" + result.ErrorMessage));    }    private void btnMoveToGroup_Click(object sender, EventArgs e)    {      int togroup_id = 111;//輸入分組ID      if (togroup_id > 0)      {        IUserApi userBLL = new UserApi();        CommonResult result = userBLL.MoveUserToGroup(token, openId, togroup_id);        Console.WriteLine("移動使用者分組名稱：" + (result.Success ? "成功" : "失敗:" + result.ErrorMessage));      }    }

瞭解了上面的代碼和調用規則，我們就能通過API進行使用者分組資訊的管理了。通過在應用程式中整合相關的介面代碼，我們就能夠很好的控制我們的關注使用者列表和使用者分組資訊。從而為我們下一步使用者的資訊推送打好基礎。