C#開發微信門戶及應用(5)--用戶分組信息管理

時間 2019-11-30

標籤 c# 開發微信門戶應用用戶分組信息管理欄目 C# 简体版

原文原文鏈接

在上個月的對C#開發微信門戶及應用作了介紹，寫過了幾篇的隨筆進行分享，因爲時間關係，間隔了一段時間沒有繼續寫這個系列的博客了，並非對這個方面中止了研究，而是繼續深刻探索這方面的技術，爲了更好的應用起來，專心作好底層的技術開發。本篇繼續上一篇的介紹，主要介紹分組管理方面的開發應用，這篇的內容和上一篇，做爲一個完整的用戶信息和分組信息管理的組合。html

一、用戶分組管理內容

用戶分組的引入，主要是方便管理關注者列表，以及方便向不一樣的組別發送消息的操做的，一個公衆帳號，最多支持建立500個分組。json

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

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數據。post

前面隨筆定義了GroupJson的實體類信息以下所示。測試

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

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

根據以上幾個接口的定義，我定義了幾個接口，並把它們概括到用戶管理的API接口裏面。this

        /// <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.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);
        }

三、用戶分組接口的調用

上面小節，定義並實現了用戶分組的各種接口，全部的用戶相關的都已經毫無保留貼出代碼，它的調用操做以下代碼所示（測試代碼）。

        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));
            }
        }