C#開發微信入口網站及應用(五)之用戶分組資訊管理-C#.Net教程-PHP中文網

這篇文章主要為大家詳細介紹了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进行用户分组信息的管理了。通过在应用程序中集成相关的接口代码，我们就能够很好的控制我们的关注用户列表和用户分组信息。从而为我们下一步用户的信息推送打好基础。

以上是C#開發微信入口網站及應用(五)之用戶分組資訊管理的詳細內容。更多資訊請關注PHP中文網其他相關文章！