查看: 1906|回复: 0

[.NET源码] C#开发微信门户及应用(4) 关注用户列表及详细信息管理

发表于 2018-2-11 10:30:35

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

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

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

在微信的管理平台上,我们可以看到自己账号的关注者用户,以及用户分组信息,如下所示。

上面的管理界面,能看到关注者用户的基础信息,但是使用微信API获取到的是一个称之为OpenID的列表,我们先了解这个东西是什么?微信API的说明给出下面的解析:

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

上面的解析意思很清楚了,就是一个用户关注我们的公众号,那么不管他是第几次关注,对我们公众号来说,都是一个确定的值;但是,一个用户对其他公众号,却有着其他不同的OpenID。

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

  1. /// <summary>
  2. /// 高级接口获取的用户信息。
  3. /// 在关注者与公众号产生消息交互后,公众号可获得关注者的OpenID
  4. /// (加密后的微信号,每个用户对每个公众号的OpenID是唯一的。对于不同公众号,同一用户的openid不同)。
  5. /// 公众号可通过本接口来根据OpenID获取用户基本信息,包括昵称、头像、性别、所在城市、语言和关注时间。
  6. /// </summary>
  7. public class UserJson : BaseJsonResult
  8. {
  9. /// <summary>
  10. /// 用户是否订阅该公众号标识,值为0时,代表此用户没有关注该公众号,拉取不到其余信息。
  11. /// </summary>
  12. public int subscribe { get; set; }
  13. /// <summary>
  14. /// 用户的标识,对当前公众号唯一
  15. /// </summary>
  16. public string openid { get; set; }
  17. /// <summary>
  18. /// 用户的昵称
  19. /// </summary>
  20. public string nickname { get; set; }
  21. /// <summary>
  22. /// 用户的性别,值为1时是男性,值为2时是女性,值为0时是未知
  23. /// </summary>
  24. public int sex { get; set; }
  25. /// <summary>
  26. /// 用户的语言,简体中文为zh_CN
  27. /// </summary>
  28. public string language { get; set; }
  29. /// <summary>
  30. /// 用户所在城市
  31. /// </summary>
  32. public string city { get; set; }
  33. /// <summary>
  34. /// 用户所在省份
  35. /// </summary>
  36. public string province { get; set; }
  37. /// <summary>
  38. /// 用户所在国家
  39. /// </summary>
  40. public string country { get; set; }
  41. /// <summary>
  42. /// 用户头像,最后一个数值代表正方形头像大小(有0、46、64、96、132数值可选,0代表640*640正方形头像),用户没有头像时该项为空
  43. /// </summary>
  44. public string headimgurl { get; set; }
  45. /// <summary>
  46. /// 用户关注时间,为时间戳。如果用户曾多次关注,则取最后关注时间
  47. /// </summary>
  48. public long subscribe_time { get; set; }
  49. }
复制代码

根据分组信息定义,我们定义一个分组的实体类信息。

  1. /// <summary>
  2. /// 分组信息
  3. /// </summary>
  4. public class GroupJson : BaseJsonResult
  5. {
  6. /// <summary>
  7. /// 分组id,由微信分配
  8. /// </summary>
  9. public int id { get; set; }
  10. /// <summary>
  11. /// 分组名字,UTF8编码
  12. /// </summary>
  13. public string name { get; set; }
  14. }
复制代码

2、获取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的调用是透明的,我们只要用的时候,就对它调用就是了。

  1. /// 获取凭证接口
  2. /// </summary>
  3. /// <param name="appid">第三方用户唯一凭证</param>
  4. /// <param name="secret">第三方用户唯一凭证密钥,既appsecret</param>
  5. string GetAccessToken(string appid, string secret);
复制代码

缓存主要是基于.NET4增加的类库MemoryCache,这个是一个非常不错的缓存类。

我的获取AccessToken的操作实现代码如下所示。

  1. /// <summary>
  2. /// 获取每次操作微信API的Token访问令牌
  3. /// </summary>
  4. /// <param name="appid">应用ID</param>
  5. /// <param name="secret">开发者凭据</param>
  6. /// <returns></returns>
  7. public string GetAccessToken(string appid, string secret)
  8. {
  9. //正常情况下access_token有效期为7200秒,这里使用缓存设置短于这个时间即可
  10. string access_token = MemoryCacheHelper.GetCacheItem<string>("access_token", delegate()
  11. {
  12. string grant_type = "client_credential";
  13. var url = string.Format("https://api.weixin.qq.com/cgi-bin/token?grant_type={0}&appid=小贝&secret={2}",
  14. grant_type, appid, secret);
  15. HttpHelper helper = new HttpHelper();
  16. string result = helper.GetHtml(url);
  17. string regex = "\"access_token\":\"(?<token>.*?)\"";
  18. string token = CRegex.GetText(result, regex, "token");
  19. return token;
  20. },
  21. new TimeSpan(0, 0, 7000)//7000秒过期
  22. );
  23. return access_token;
  24. }
复制代码

由于我们知道,AccessToken默认是7200秒过期,因此在这个时间段里面,我们尽可能使用缓存来记录它的值,如果超过了这个时间,我们调用这个方法的时候,它会自动重新获取一个新的值给我们了。

3、获取关注用户列表

获取关注用户列表,一次拉取API调用,最多拉取10000个关注者的OpenID,可以通过多次拉取的方式来满足需求。微信的接口定义如下所示。

http请求方式: GET(请使用https协议)
https://api.weixin.qq.com/cgi-bi ... _openid=NEXT_OPENID

这个接口返回的数据是

  1. {"total":2,"count":2,"data":{"openid":["","OPENID1","OPENID2"]},"next_openid":"NEXT_OPENID"}
复制代码

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

  1. /// <summary>
  2. /// 获取关注用户列表的Json结果
  3. /// </summary>
  4. public class UserListJsonResult : BaseJsonResult
  5. {
  6. /// <summary>
  7. /// 关注该公众账号的总用户数
  8. /// </summary>
  9. public int total { get; set; }
  10. /// <summary>
  11. /// 拉取的OPENID个数,最大值为10000
  12. /// </summary>
  13. public int count { get; set; }
  14. /// <summary>
  15. /// 列表数据,OPENID的列表
  16. /// </summary>
  17. public OpenIdListData data { get; set; }
  18. /// <summary>
  19. /// 拉取列表的后一个用户的OPENID
  20. /// </summary>
  21. public string next_openid { get; set; }
  22. }
  23. /// <summary>
  24. /// 列表数据,OPENID的列表
  25. /// </summary>
  26. public class OpenIdListData
  27. {
  28. /// <summary>
  29. /// OPENID的列表
  30. /// </summary>
  31. public List<string> openid { get; set; }
  32. }
复制代码

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

  1. /// <summary>
  2. /// 微信用户管理的API接口
  3. /// </summary>
  4. public interface IUserApi
  5. {
  6. /// <summary>
  7. /// 获取关注用户列表
  8. /// </summary>
  9. /// <param name="accessToken">调用接口凭证</param>
  10. /// <param name="nextOpenId">第一个拉取的OPENID,不填默认从头开始拉取</param>
  11. /// <returns></returns>
  12. List<string> GetUserList(string accessToken, string nextOpenId = null);
  13. /// <summary>
  14. /// 获取用户基本信息
  15. /// </summary>
  16. /// <param name="accessToken">调用接口凭证</param>
  17. /// <param name="openId">普通用户的标识,对当前公众号唯一</param>
  18. /// <param name="lang">返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语</param>
  19. UserJson GetUserDetail(string accessToken, string openId, Language lang = Language.zh_CN);
复制代码

然后在实现类里面,我们分别对上面两个接口进行实现,获取用户列表信息如下所示。

  1. /// <summary>
  2. /// 获取关注用户列表
  3. /// </summary>
  4. /// <param name="accessToken">调用接口凭证</param>
  5. /// <param name="nextOpenId">第一个拉取的OPENID,不填默认从头开始拉取</param>
  6. /// <returns></returns>
  7. public List<string> GetUserList(string accessToken, string nextOpenId = null)
  8. {
  9. List<string> list = new List<string>();
  10. string url = string.Format("https://api.weixin.qq.com/cgi-bin/user/get?access_token={0}", accessToken);
  11. if (!string.IsNullOrEmpty(nextOpenId))
  12. {
  13. url += "&next_openid=" + nextOpenId;
  14. }
  15. UserListJsonResult result = JsonHelper<UserListJsonResult>.ConvertJson(url);
  16. if (result != null && result.data != null)
  17. {
  18. list.AddRange(result.data.openid);
  19. }
  20. return list;
  21. }
复制代码

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

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

  1. HttpHelper helper = new HttpHelper();
  2. string content = helper.GetHtml(url);
复制代码

由于返回的内容,我们需要判断它是否正确返回所需的结果,如果没有,抛出自定义的相关异常,方便处理,具体如下所示。

  1. /// <summary>
  2. /// 检查返回的记录,如果返回没有错误,或者结果提示成功,则不抛出异常
  3. /// </summary>
  4. /// <param name="content">返回的结果</param>
  5. /// <returns></returns>
  6. private static bool VerifyErrorCode(string content)
  7. {
  8. if (content.Contains("errcode"))
  9. {
  10. ErrorJsonResult errorResult = JsonConvert.DeserializeObject<ErrorJsonResult>(content);
  11. //非成功操作才记录异常,因为有些操作是返回正常的结果({"errcode": 0, "errmsg": "ok"})
  12. if (errorResult != null && errorResult.errcode != ReturnCode.请求成功)
  13. {
  14. string error = string.Format("微信请求发生错误!错误代码:{0},说明:小贝", (int)errorResult.errcode, errorResult.errmsg);
  15. LogTextHelper.Error(errorResult);
  16. throw new WeixinException(error);//抛出错误
  17. }
  18. }
  19. return true;
  20. }
复制代码

然后转换为相应的格式,就是通过Json.NET的类库进行转换。

  1. T result = JsonConvert.DeserializeObject<T>(content);
  2. return result;
复制代码

这样我们就可以在ConvertJson函数实体里面,完整的进行处理和转换了,转换完整的函数代码如下所示。

  1. /// <summary>
  2. /// Json字符串操作辅助类
  3. /// </summary>
  4. public class JsonHelper<T> where T : class, new()
  5. {
  6. /// <summary>
  7. /// 检查返回的记录,如果返回没有错误,或者结果提示成功,则不抛出异常
  8. /// </summary>
  9. /// <param name="content">返回的结果</param>
  10. /// <returns></returns>
  11. private static bool VerifyErrorCode(string content)
  12. {
  13. if (content.Contains("errcode"))
  14. {
  15. ErrorJsonResult errorResult = JsonConvert.DeserializeObject<ErrorJsonResult>(content);
  16. //非成功操作才记录异常,因为有些操作是返回正常的结果({"errcode": 0, "errmsg": "ok"})
  17. if (errorResult != null && errorResult.errcode != ReturnCode.请求成功)
  18. {
  19. string error = string.Format("微信请求发生错误!错误代码:{0},说明:小贝", (int)errorResult.errcode, errorResult.errmsg);
  20. LogTextHelper.Error(errorResult);
  21. throw new WeixinException(error);//抛出错误
  22. }
  23. }
  24. return true;
  25. }
  26. /// <summary>
  27. /// 转换Json字符串到具体的对象
  28. /// </summary>
  29. /// <param name="url">返回Json数据的链接地址</param>
  30. /// <returns></returns>
  31. public static T ConvertJson(string url)
  32. {
  33. HttpHelper helper = new HttpHelper();
  34. string content = helper.GetHtml(url);
  35. VerifyErrorCode(content);
  36. T result = JsonConvert.DeserializeObject<T>(content);
  37. return result;
  38. }
  39. }
复制代码

调用这个API的界面层代码如下所示(测试代码)

  1. IUserApi userBLL = new UserApi();
  2. List<string> userList = userBLL.GetUserList(token)
复制代码

4、获取用户详细信息

上面的获取列表操作,相对比较简单,而且不用POST任何数据,因此通过Get协议就能获取到所需的数据。

本小节继续介绍获取用户详细信息的操作,这个操作也是通过GET协议就可以完成的。

这个API的调用定义如下所示:

http请求方式: GET
https://api.weixin.qq.com/cgi-bi ... d=OPENID&lang=zh_CN
通过传入一个OpenId,我们就能很好获取到用户的相关信息了。

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

  1. /// <summary>
  2. /// 获取用户基本信息
  3. /// </summary>
  4. /// <param name="accessToken">调用接口凭证</param>
  5. /// <param name="openId">普通用户的标识,对当前公众号唯一</param>
  6. /// <param name="lang">返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语</param>
  7. public UserJson GetUserDetail(string accessToken, string openId, Language lang = Language.zh_CN)
  8. {
  9. string url = string.Format("https://api.weixin.qq.com/cgi-bin/user/info?access_token={0}&openid=小贝&lang={2}",
  10. accessToken, openId, lang.ToString());
  11. UserJson result = JsonHelper<UserJson>.ConvertJson(url);
  12. return result;
  13. }
复制代码

最后,我们结合获取用户列表和获取用户详细信息的两个API,我们看看调用的代码(测试代码)。

  1. private void btnGetUsers_Click(object sender, EventArgs e)
  2. {
  3. IUserApi userBLL = new UserApi();
  4. List<string> userList = userBLL.GetUserList(token);
  5. foreach (string openId in userList)
  6. {
  7. UserJson userInfo = userBLL.GetUserDetail(token, openId);
  8. if (userInfo != null)
  9. {
  10. string tips = string.Format("{0}:小贝", userInfo.nickname, userInfo.openid);
  11. Console.WriteLine(tips);
  12. }
  13. }
  14. }
复制代码

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持程序员之家。

您可能感兴趣的文章:

  • C#微信小程序服务端获取用户解密信息实例代码
  • C#开发微信门户及应用(1) 微信接口使用
  • C#开发微信门户及应用(2) 微信消息处理和应答
  • C#开发微信门户及应用(3) 文本消息和图文消息应答
  • C#开发微信门户及应用(5) 用户分组信息管理


回复

使用道具 举报