有乐趣的环境能滋养创意,没有人工作只是为了好玩,但并不意味工作不能变得有趣。 ——李奥贝纳(上海网站建设)
应用RestSharp 库花费Restful Service
Admin
2012年1月27日
如今互联网上的办事接口都是Restful的,SOAP的Service已经不是主流。.NET/Mono下如何花费Restful Service呢,再也没有了便利的Visual Studio的便利临盆****代理的对象了,你还在用HttpWebRequest 本身封装吗?Restful Service还有授权题目,本身写出来的代码是不是很不优雅?凡是Restful Service返回的数据格局是XML或者Json,还要设置办事的输入参数等等,应用起来很错杂。本文向你推荐一个开源的库RestSharp轻松花费Restful Service。RestSharp是一个开源的.NET平台下REST和Http API的客户端库,支撑的平台有.NET 3.5/4、Mono、Mono for Android、MonoTouch、Windows Phone 7.1 Mango。他可以简化我们接见Restful办事,可以到这里下载代码 https://github.com/johnsheehan/RestSharp/archives/master 更简单的应用NuGet。RestSharp应用Json.Net处理惩罚 Json数据同Poco对象的序列化。
下面分别从库的应用体式格式长进行介绍,应用的Restful Service是腾讯社区开放平台(http://opensns.qq.com/)。 1、办事认证,RestSharp定义了一个认证授权的接口 IAuthenticator ,有NtlmAuthenticator、HttpBasicAuthenticator、OAuth1Authenticator、OAuth2Authenticator几种,根蒂根基上可以满足请求了,腾讯社区开放平台应用OAuth2,腾讯社区开放平台额外增长了一个OpenId的参数,我们从OAuth2Authenticator的基类持续实现一个:
public class OAuthUriQueryParameterAuthenticator : OAuth2Authenticator { private readonly string openId; private readonly string consumerKey;
public OAuthUriQueryParameterAuthenticator(string openId, string accessToken, string consumerkey) :base(accessToken) { this.openId = openId; this.consumerKey = consumerkey; }
public override void Authenticate(IRestClient client, IRestRequest request) { request.AddParameter("access_token", AccessToken, ParameterType.GetOrPost); request.AddParameter("openid", openId, ParameterType.GetOrPost); request.AddParameter("oauth_consumer_key", consumerKey, ParameterType.GetOrPost); }
2、Get恳求办法,下面的例子是按照access_token获得对应用户身份的openid: https://graph.qq.com/oauth2.0/me?access_token=YOUR_ACCESS_TOKEN
public string GetOpenId(string accessToken) {
RestClient _restClient = new RestClient(Endpoints.ApiBaseUrl); var request = _requestHelper.CreateOpenIDRequest(accessToken); var response = ute(request); var openid = GetUserOpenId(response.Content); return openid; }
private RestSharp.RestResponse ute(RestRequest request) {
//返回的成果
var response = _restClient.ute(request);
if (response.StatusCode != HttpStatusCode.OK) { throw new QzoneException(response); } return response; }
internal RestRequest CreateOpenIDRequest(string accesstoken) { var request = new RestRequest(Method.GET); request.Resource = "oauth2.0/me?access_token={accesstoken}"; request.AddParameter("accesstoken", accesstoken, ParameterType.UrlSegment); return request; }
上方代码里涉及到了办事的输入参数经由过程AddParameter办法很便利的处理惩罚,是不是很简单。
3、POST恳求办事,下面的例子是揭晓一条微博信息(纯文本)到腾讯微博平台上http://wiki.opensns.qq.com/wiki/%E3%80%90QQ%E7%99%BB%E5%BD%95%E3%80%91add_t:
/// <summary> /// 揭晓一条微博信息(纯文本)到腾讯微博平台上 /// </summary> /// <param name="content">默示要揭晓的微博内容。必须为UTF-8编码,最长为140个汉字,也就是420字节。 /// 若是微博内容中有URL,后台会主动将该URL转换为短URL,每个URL折算成11个字节。</param> /// <param name="clientip">用户ip,以解析用户地点地</param> /// <param name="jing">用户地点地理地位的经度。为实数,最多支撑10位有效数字。有效局限:-180.0到+180.0,+默示东经,默认为0.0</param> /// <param name="wei">用户地点地理地位的纬度。为实数,最多支撑10位有效数字。有效局限:-90.0到+90.0,+默示北纬,默认为0.0。</param> /// <param name="syncflag">标识是否将公布的微博同步到QQ空间(0:同步; 1:不合步;),默认为0.</param> /// <returns></returns> internal AddWeiboResult AddWeibo(string content, string clientip = "", string jing = "", string wei = "", int syncflag = 0) {
RestClient _restClient = new RestClient(Endpoints.ApiBaseUrl);
_restClient.Authenticator = new OAuthUriQueryParameterAuthenticator(context.AccessToken.OpenId, context.AccessToken.AccessToken, context.Config.GetAppKey()); var request = _requestHelper.CreateAddWeiboRequest(content, clientip,jing,wei,syncflag);
var response = ute(request); var payload = Deserialize<AddWeiboResult>(response.Content); return payload; }
internal RestRequest CreateAddWeiboRequest(string content, string clientip, string jing, string wei, int syncflag) { var request = new RestRequest(Method.POST); request.RequestFormat = DataFormat.Json; request.AddHeader("Content-Type", "application/x-www-form-urlencoded"); request.Resource = "t/add_t"; request.AddParameter("content", content); if (!string.IsNullOrEmpty(clientip)) { request.AddParameter("clientip", clientip); } if (!string.IsNullOrEmpty(jing)) { request.AddParameter("jing", jing); } if (!string.IsNullOrEmpty(wei)) { request.AddParameter("wei", wei); } request.AddParameter("syncflag", syncflag); return request; }
这个办法须要应用到OAuth2的认证和前面的不须要认证的接口斗劲起来并没有变错杂,代码很优雅。
4、来点错杂的,发个图片微博,RestSharp对HttpFile的封装也很不错,应用起来一样很简单,看代码中的红色项目组:
internal RestRequest CreateAddPictureWeiboRequest(string content, string clientip, string jing, string wei, int syncflag, string fileName, byte[] bytes) { var request = new RestRequest(Method.POST); request.RequestFormat = DataFormat.Json; var boundary = string.Concat("--", Util.GenerateRndNonce()); request.AddHeader("Content-Type", string.Concat("multipart/form-data; boundary=", boundary)); request.Resource = "t/add_pic_t"; request.AddParameter("content", content); if (!string.IsNullOrEmpty(clientip)) { request.AddParameter("clientip", clientip); } if (!string.IsNullOrEmpty(jing)) { request.AddParameter("jing", jing); } if (!string.IsNullOrEmpty(wei)) { request.AddParameter("wei", wei); } request.AddParameter("syncflag", syncflag); request.AddFile("pic", bytes, fileName); return request; }
上方这几个API的调用已经很具有代表性了,是不是可以很好的简化你应用Restful Service,记住DRY(don’t repeat yourself),可以很好的加快你的应用的开辟。
作者: 自由、创新、研究、摸索&#8230;&#8230;
出处:http://shanyou.cnblogs.com/
版权:本文版权归作者和博客园共有
转载:迎接转载,为了保存作者的创作热忱,请按请求【转载】,感谢
请求:未经作者赞成,必须保存此段声明;必须在文章中给出原文连接;不然必究法令义务
|