C#开发微信门户及利用(4)–关心用户列表及详细信息管理

在上个月的对C#开发微信门户及拔取做了介绍,写过了几篇的随笔进行分享,由于时日涉及,间隔了一段时间没有持续写那么些种类的博客了,并不是对那个方面甘休了研商,而是继续深远探究那上面的技能,为了更好的行使起来,专心做好底层的技术开发。

微信的很重大的一个特点就是力所能及利用其平台庞大的用户群体,因而很简单整合在CRM(客户关系管理)系统之中,服务号和订阅好都能够向关心者推送相关的产品音信,还可以和48钟头内响应音讯和事件的生气勃勃用户举行互相对话,由此用户音信是微信API里面越发关键的一环,本随笔主要介绍获取关心用户、查看用户音讯、分组管理等地方的开发应用。

1、关心用户列表及用户分组音信

在微信的治本平台上,大家可以看看自己账号的关切者用户,以及用户分组消息,如下所示。

图片 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开发之前,大家要求很好明白这几个访问控制参数。

图片 2

以此目的的定义,我们可以从微信的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
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)–起首应用微信接口

相关文章