C#开发微信门户及应用(4)--关注用户列表及详细信息管理

时间  2019-11-11
标签 c# 开发 微信 门户 应用 关注 用户 列表 详细 信息管理 栏目 C# 繁體版
原文   原文链接

在上个月的对C#开发微信门户及应用作了介绍，写过了几篇的随笔进行分享，因为时间关系，间隔了一段时间没有继续写这个系列的博客了，并非对这个方面中止了研究，而是继续深刻探索这方面的技术，为了更好的应用起来，专心作好底层的技术开发。html

微信的很重要的一个特色就是可以利用其平台庞大的用户群体，所以很容易整合在CRM（客户关系管理）系统里面，服务号和订阅好都可以向关注者推送相关的产品消息，还能和48小时内响应消息和事件的活跃用户进行交互对话，所以用户信息是微信API里面很是重要的一环，本随笔主要介绍获取关注用户、查看用户信息、分组管理等方面的开发应用。api

一、关注用户列表及用户分组信息

在微信的管理平台上，咱们能够看到本身帐号的关注者用户，以及用户分组信息，以下所示。缓存

 

上面的管理界面，能看到关注者用户的基础信息，可是使用微信API获取到的是一个称之为OpenID的列表，咱们先了解这个东西是什么？微信API的说明给出下面的解析：服务器

关注者列表由一串OpenID（加密后的微信号，每一个用户对每一个公众号的OpenID是惟一的。对于不一样公众号，同一用户的openid不一样）组成。公众号可经过本接口来根据OpenID获取用户基本信息，包括昵称、头像、性别、所在城市、语言和关注时间。微信

上面的解析意思很清楚了，就是一个用户关注咱们的公众号，那么无论他是第几回关注，对咱们公众号来讲，都是一个肯定的值；可是，一个用户对其余公众号，却有着其余不一样的OpenID。app

微信提供了为数很少的几个关键字信息，用来记录用户的相关内容，根据用户的相关定义，咱们定义一个实体类，用来放置获取回来的用户信息。函数

    /// <summary>
    /// 高级接口获取的用户信息。
    /// 在关注者与公众号产生消息交互后，公众号可得到关注者的OpenID
    /// （加密后的微信号，每一个用户对每一个公众号的OpenID是惟一的。对于不一样公众号，同一用户的openid不一样）。
    /// 公众号可经过本接口来根据OpenID获取用户基本信息，包括昵称、头像、性别、所在城市、语言和关注时间。
    /// </summary>
    public class UserJson : BaseJsonResult
    {
        /// <summary>
        /// 用户是否订阅该公众号标识，值为0时，表明此用户没有关注该公众号，拉取不到其他信息。
        /// </summary>
        public int subscribe { get; set; }

        /// <summary>
        /// 用户的标识，对当前公众号惟一
        /// </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>
        /// 用户头像，最后一个数值表明正方形头像大小（有0、4六、6四、9六、132数值可选，0表明640*640正方形头像），用户没有头像时该项为空
        /// </summary>
        public string headimgurl { get; set; }

        /// <summary>
        /// 用户关注时间，为时间戳。若是用户曾屡次关注，则取最后关注时间
        /// </summary>
        public long subscribe_time { get; set; }
    }

根据分组信息定义，咱们定义一个分组的实体类信息。post

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

        /// <summary>
        /// 分组名字，UTF8编码
        /// </summary>
        public string name { get; set; }
    }

二、获取AIP调用者的的Token 

在作微信API的开发，不少时候，咱们都须要传入一个AccessToken，这个就是区分调用者和记录会话信息的字符串，所以，在学习全部API开发以前，咱们须要很好理解这个访问控制参数。学习

这个对象的定义，咱们能够从微信的API说明中了解。测试

access_token是公众号的全局惟一票据，公众号调用各接口时都需使用access_token。正常状况下access_token有效期为7200秒，重复获取将致使上次获取的access_token失效。因为获取access_token的api调用次数很是有限，建议开发者全局存储与更新access_token，频繁刷新access_token会致使api调用受限，影响自身业务。

根据上面的说明定义，咱们能够看到，它是一个和身份，以及会话时间有关的一个参数，并且它的产生次数有限制，所以要求咱们须要对它进行缓存并重复利用，在会话到期以前，咱们应该尽量重用这个参数，避免反复请求，增长服务器压力，以及调用的时间。

我定义了一个方法，用来构造生成相关的Access Token，并且它具备缓存的功能，但具体如何缓存及使用，对我API的调用是透明的，咱们只要用的时候，就对它调用就是了。

        /// 获取凭证接口
        /// </summary>
        /// <param name="appid">第三方用户惟一凭证</param>
        /// <param name="secret">第三方用户惟一凭证密钥，既appsecret</param>
        string GetAccessToken(string appid, string secret);

缓存主要是基于.NET4增长的类库MemoryCache，这个是一个很是不错的缓存类。

个人获取AccessToken的操做实现代码以下所示。

        /// <summary>
        /// 获取每次操做微信API的Token访问令牌
        /// </summary>
        /// <param name="appid">应用ID</param>
        /// <param name="secret">开发者凭据</param>
        /// <returns></returns>
        public string GetAccessToken(string appid, string secret)
        {
            //正常状况下access_token有效期为7200秒,这里使用缓存设置短于这个时间便可
            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默认是7200秒过时，所以在这个时间段里面，咱们尽量使用缓存来记录它的值，若是超过了这个时间，咱们调用这个方法的时候，它会自动从新获取一个新的值给咱们了。

 

三、获取关注用户列表

获取关注用户列表，一次拉取API调用，最多拉取10000个关注者的OpenID，能够经过屡次拉取的方式来知足需求。微信的接口定义以下所示。

http请求方式: GET（请使用https协议）
https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&next_openid=NEXT_OPENID

这个接口返回的数据是

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

根据返回的Json数据定义，咱们还须要定义两个实体类，用来存放返回的结果。

    /// <summary>
    /// 获取关注用户列表的Json结果
    /// </summary>
    public class UserListJsonResult : BaseJsonResult
    {
        /// <summary>
        /// 关注该公众帐号的总用户数
        /// </summary>
        public int total { get; set; }

        /// <summary>
        /// 拉取的OPENID个数，最大值为10000
        /// </summary>
        public int count { get; set; }

        /// <summary>
        /// 列表数据，OPENID的列表
        /// </summary>
        public OpenIdListData data { get; set; }

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

    /// <summary>
    /// 列表数据，OPENID的列表
    /// </summary>
    public class OpenIdListData
    {
        /// <summary>
        /// OPENID的列表
        /// </summary>
        public List<string> openid { get; set; }
    }

为了获取相关的用户信息，我定义了一个接口，用来获取用户的信息，接口定义以下所示。

    /// <summary>
    /// 微信用户管理的API接口
    /// </summary>
    public interface IUserApi
    {
        /// <summary>
        /// 获取关注用户列表
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="nextOpenId">第一个拉取的OPENID，不填默认从头开始拉取</param>
        /// <returns></returns>
        List<string> GetUserList(string accessToken, string nextOpenId = null);

        /// <summary>
        /// 获取用户基本信息
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="openId">普通用户的标识，对当前公众号惟一</param>
        /// <param name="lang">返回国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语</param>
        UserJson GetUserDetail(string accessToken, string openId, Language lang = Language.zh_CN);

而后在实现类里面，咱们分别对上面两个接口进行实现，获取用户列表信息以下所示。

        /// <summary>
        /// 获取关注用户列表
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="nextOpenId">第一个拉取的OPENID，不填默认从头开始拉取</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;
        }

咱们看到，转换的逻辑已经放到了JsonHelper里面去了，这个辅助类里面分别对数值进行了获取内容，验证返回值，而后转换正确实体类几个部分的操做。

获取内容，经过辅助类HttpHelper进行，这个在个人公用类库里面，里面的逻辑主要就是经过HttpRequest进行数据的获取操做，不在赘述。

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

因为返回的内容，咱们须要判断它是否正确返回所需的结果，若是没有，抛出自定义的相关异常，方便处理，具体以下所示。

        /// <summary>
        /// 检查返回的记录，若是返回没有错误，或者结果提示成功，则不抛出异常
        /// </summary>
        /// <param name="content">返回的结果</param>
        /// <returns></returns>
        private static bool VerifyErrorCode(string content)
        {
            if (content.Contains("errcode"))
            {
                ErrorJsonResult errorResult = JsonConvert.DeserializeObject<ErrorJsonResult>(content);
                //非成功操做才记录异常，由于有些操做是返回正常的结果（{"errcode": 0, "errmsg": "ok"}）
                if (errorResult != null && errorResult.errcode != ReturnCode.请求成功)
                {
                    string error = string.Format("微信请求发生错误！错误代码：{0}，说明：{1}", (int)errorResult.errcode, errorResult.errmsg);
                    LogTextHelper.Error(errorResult);

                    throw new WeixinException(error);//抛出错误
                }
            }
            return true;
        }

而后转换为相应的格式，就是经过Json.NET的类库进行转换。

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

这样咱们就能够在ConvertJson函数实体里面，完整的进行处理和转换了，转换完整的函数代码以下所示。

    /// <summary>
    /// Json字符串操做辅助类
    /// </summary>
    public class JsonHelper<T> where T : class, new()
    {
        /// <summary>
        /// 检查返回的记录，若是返回没有错误，或者结果提示成功，则不抛出异常
        /// </summary>
        /// <param name="content">返回的结果</param>
        /// <returns></returns>
        private static bool VerifyErrorCode(string content)
        {
            if (content.Contains("errcode"))
            {
                ErrorJsonResult errorResult = JsonConvert.DeserializeObject<ErrorJsonResult>(content);
                //非成功操做才记录异常，由于有些操做是返回正常的结果（{"errcode": 0, "errmsg": "ok"}）
                if (errorResult != null && errorResult.errcode != ReturnCode.请求成功)
                {
                    string error = string.Format("微信请求发生错误！错误代码：{0}，说明：{1}", (int)errorResult.errcode, errorResult.errmsg);
                    LogTextHelper.Error(errorResult);

                    throw new WeixinException(error);//抛出错误
                }
            }
            return true;
        }

        /// <summary>
        /// 转换Json字符串到具体的对象
        /// </summary>
        /// <param name="url">返回Json数据的连接地址</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;
        }
}

调用这个API的界面层代码以下所示（测试代码）

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

 

四、获取用户详细信息

上面的获取列表操做，相对比较简单，并且不用POST任何数据，所以经过Get协议就能获取到所需的数据。

本小节继续介绍获取用户详细信息的操做，这个操做也是经过GET协议就能够完成的。

这个API的调用定义以下所示：

http请求方式: GET
https://api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN

经过传入一个OpenId，咱们就能很好获取到用户的相关信息了。

前面小节咱们已经定义了它的接口，说明了传入及返回值，根据定义，它的实现函数以下所示。

        /// <summary>
        /// 获取用户基本信息
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="openId">普通用户的标识，对当前公众号惟一</param>
        /// <param name="lang">返回国家地区语言版本，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;
        }

最后，咱们结合获取用户列表和获取用户详细信息的两个API，咱们看看调用的代码（测试代码）。

        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#开发微信门户及应用(25)-微信企业号的客户端管理功能

C#开发微信门户及应用(24)-微信小店货架信息管理

C#开发微信门户及应用(23)-微信小店商品管理接口的封装和测试

C#开发微信门户及应用(22)-微信小店的开发和使用

C#开发微信门户及应用(21)-微信企业号的消息和事件的接收处理及解密 

C#开发微信门户及应用(20)-微信企业号的菜单管理

C#开发微信门户及应用(19)-微信企业号的消息发送（文本、图片、文件、语音、视频、图文消息等）

C#开发微信门户及应用(18)-微信企业号的通信录管理开发之成员管理

C#开发微信门户及应用(17)-微信企业号的通信录管理开发之部门管理

C#开发微信门户及应用(16)-微信企业号的配置和使用

C#开发微信门户及应用(15)-微信菜单增长扫一扫、发图片、发地理位置功能

 C#开发微信门户及应用(14)-在微信菜单中采用重定向获取用户数据

C#开发微信门户及应用(13)-使用地理位置扩展相关应用

C#开发微信门户及应用(12)-使用语音处理

C#开发微信门户及应用(11)--微信菜单的多种表现方式介绍

C#开发微信门户及应用(10)--在管理系统中同步微信用户分组信息

C#开发微信门户及应用(9)-微信门户菜单管理及提交到微信服务器

C#开发微信门户及应用(8)-微信门户应用管理系统功能介绍

C#开发微信门户及应用(7)-微信多客服功能及开发集成

C#开发微信门户及应用(6)--微信门户菜单的管理操做

C#开发微信门户及应用(5)--用户分组信息管理

C#开发微信门户及应用(4)--关注用户列表及详细信息管理

C#开发微信门户及应用(3)--文本消息和图文消息的应答

C#开发微信门户及应用(2)--微信消息的处理和应答

C#开发微信门户及应用(1)--开始使用微信接口

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程