在上个月的对C#开辟微信流派及运用做了引见,写过了几篇的漫笔举行分享,由于时刻关联,间隔了一段时刻没有继承写这个系列的博客了,并非对这个方面住手了研讨,而是继承深切探究这方面的手艺,为了更好的运用起来,用心做好底层的手艺开辟。
微信的很重要的一个特性就是可以应用其平台巨大的用户群体,因而很轻易整合在CRM(客户关联治理)体系内里,效劳号和定阅好都可以向关注者推送相干的产物音讯,还能和48小时内响应音讯和事宜的活泼用户举行交互对话,因而用户信息是微信API内里非常重要的一环,本漫笔重要引见猎取关注用户、检察用户信息、分组治理等方面的开辟运用。
1、关注用户列表及用户分组信息
在微信的治理平台上,我们可以看到本身账号的关注者用户,以及用户分组信息,以下所示。
上面的治理界面,能看到关注者用户的基本信息,然则运用微信API猎取到的是一个称之为OpenID的列表,我们先相识这个东西是什么?微信API的申明给出下面的剖析:
关注者列表由一串OpenID(加密后的微信号,每一个用户对每一个民众号的OpenID是唯一的。关于差别民众号,统一用户的openid差别)构成。民众号可经由过程本接口来依据OpenID猎取用户基本信息,包含昵称、头像、性别、地点城市、言语和关注时刻。
上面的剖析意义很清晰了,就是一个用户关注我们的民众号,那末不论他是第几次关注,对我们民众号来讲,都是一个肯定的值;然则,一个用户对其他民众号,却有着其他差别的OpenID。
微信供应了为数不多的几个关键字信息,用来纪录用户的相干内容,依据用户的相干定义,我们定义一个实体类,用来安排猎取返来的用户信息。
/// <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、46、64、96、132数值可选,0代表640*640正方形头像),用户没有头像时该项为空 /// </summary> public string headimgurl { get; set; } /// <summary> /// 用户关注时刻,为时刻戳。假如用户曾屡次关注,则取末了关注时刻 /// </summary> public long subscribe_time { get; set; } }
依据分组信息定义,我们定义一个分组的实体类信息。
/// <summary> /// 分组信息 /// </summary> public class GroupJson : BaseJsonResult { /// <summary> /// 分组id,由微信分派 /// </summary> public int id { get; set; } /// <summary> /// 分组名字,UTF8编码 /// </summary> public string name { get; set; } }
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的挪用是通明的,我们只要用的时刻,就对它挪用就是了。
/// 猎取凭证接口 /// </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秒逾期,因而在这个时刻段内里,我们尽量运用缓存来纪录它的值,假如超过了这个时刻,我们挪用这个要领的时刻,它会自动从新猎取一个新的值给我们了。
3、猎取关注用户列表
猎取关注用户列表,一次拉取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)
4、猎取用户细致信息
上面的猎取列表操纵,相对比较简单,而且不必POST任何数据,因而经由过程Get协定就可以猎取到所需的数据。
本小节继承引见猎取用户细致信息的操纵,这个操纵也是经由过程GET协定就可以完成的。
这个API的挪用定义以下所示:
http要求体式格局: GET
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#开辟微信流派及运用(四)之关注用户列表及细致信息治理的细致内容,更多请关注ki4网别的相干文章!