在上個月的對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#開發微信門戶及應用(23)-微信小店商品管理接口的封裝和測試
C#開發微信門戶及應用(21)-微信企業號的消息和事件的接收處理及解密
C#開發微信門戶及應用(19)-微信企業號的消息發送（文本、圖片、文件、語音、視頻、圖文消息等）
C#開發微信門戶及應用(18)-微信企業號的通訊錄管理開發之成員管理
C#開發微信門戶及應用(17)-微信企業號的通訊錄管理開發之部門管理
C#開發微信門戶及應用(15)-微信菜單增加掃一掃、發圖片、發地理位置功能
C#開發微信門戶及應用(14)-在微信菜單中采用重定向獲取用戶數據
C#開發微信門戶及應用(11)--微信菜單的多種表現方式介紹
C#開發微信門戶及應用(10)--在管理系統中同步微信用戶分組信息