开源.NetCore通用工具库Xmtool使用连载 - HTTP请求篇
【Github源码】
《上一篇》 介绍了Xmtool工具库中的XML操作类库,今天我们继续为大家介绍其中的HTTP请求类库。
在现如今的软件需求场景中,HTTP网络请求几乎是开发过程中必然会使用的功能;而系统自带的HTTPClient对象使用起来并不是那么容易和友好,因此我们对其进行了二次封装成了一个Web类库。
该Web类库提供了HTTP请求和HTTP安全相关两方面的封装。HTTP请求是基于系统自带的HttpClient对象进行了二次封装,提供了更易用的方法,并且对Json类型更加友好;HTTP安全方面主要针对XSS攻击提供了字符处理方法,后续会根据需要不断添加。
HTTP请求
使用HTTP请求,首选需要获取HttpClientExt对象:
HttpClientExt client = Xmtool.Web.Client();
// 或者
HttpClientExt client = Xmtool.Web.Client("microservice-1");
根据获取Client时传入的参数不同,系统将返回不同的实例;但对相同的参数会做单例处理,也就是说相同的参数将获取到同一个实例;当不传入任何参数时,每次都会返回一个全新的实例。
根据HTTP常用请求场景类库提供了各种属性和方法:
AddRequestHeaderWithoutValidation方法
1. Timeout属性
说明:用来设置或获取HTTP请求的超时时间。
2. BaseAddress属性
说明: 用来设置或获取HTTP请求的基本地址,在后续使用相对地址发送请求时会使用该地址进行拼接。
3. AddDefaultHeader方法
public HttpClientExt AddDefaultHeader(string name, string value)
说明:为HTTP请求设置请求头信息,该头信息会在实例每次发起请求时携带。
参数:
name:请求头名称。
value:请求头内容。
HttpClientExt client = Xmtool.Web.Client();
client.AddDefaultHeader("User", "admin");
4. AddRequestHeader方法
public HttpClientExt AddRequestHeader(string name, string value)
说明:为HTTP请求设置请求头信息,该头信息仅会在实例下一次发起请求时携带。
参数:
name:请求头名称。
value:请求头内容。
5. AddRequestHeaderWithoutValidation方法
public HttpClientExt AddRequestHeaderWithoutValidation(string name, string value)
说明:为HTTP请求设置请求头信息,该头信息仅会在实例下一次发起请求时携带;该方法和AddRequestHeader的区别是不会对参数的合法性进行检查。
参数:
name:请求头名称。
value:请求头内容。
6. SetContent方法
public HttpClientExt SetContent(string content)
说明:为下一次HTTP请求(主要是提交类请求,如Post)设置提交内容。
参数:
content:请求提交内容。
HttpClientExt client = Xmtool.Web.Client();
client.SetContnent("Good Day");
// TODO
7. SetJsonContent方法
public HttpClientExt SetJsonContent(string content)
说明:为下一次请求设置提交内容,必须是JSON格式。
参数:
content:请求提交内容,JSON格式。
HttpClientExt client = Xmtool.Web.Client();
client.SetJsonContnent("{\"Author\": \"softwaiter\"}");
// TODO
8. SetJsonContent方法二
public HttpClientExt SetJsonContent(DynamicObjectExt obj)
说明:通过动态对象为下一次请求设置JSON格式的提交内容。
参数:
obj:要提交的动态对象。
DynamicObjectExt obj = new DynamicObjectExt();
obj.Author = "softwaier";
HttpClientExt client = Xmtool.Web.Client();
client.SetJsonContnent(obj);
// TODO
9. Clear方法
public HttpClientExt Clear()
说明:清除仅在下一次请求中生效的提交内容和请求头信息。
10. Get方法
public HttpResponseExt Get(string requestUri)
说明:以Get方式发起一个HTTP请求。
参数:
requestUri:HTTP请求地址,可以是相对地址或绝对地址;如果是相对地址将使用BaseAddress进行拼接。
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt rep = client.Get("https://www.baidu.com");
// TODO
11. GetAsync方法
public async Task<HttpResponseExt> GetAsync(string requestUri)
说明:Get方法的异步版本。
12. Post方法
public HttpResponseExt Post(string requestUri)
说明:以Post方式发起一个HTTP请求。
参数:
requestUri:HTTP请求地址,可以是相对地址或绝对地址;如果是相对地址将使用BaseAddress进行拼接。
// 新增一条人员信息
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt rep = client.SetJsonContent("{\"user\": \"admin", \"password\": \"Admin123\"}")
.Post("https://www.ceshi.com/person");
// TODO
13. PostAsync方法
public async Task<HttpResponseExt> PostAsync(string requestUri)
说明:Post方法的异步版本。
14. Put方法
public HttpResponseExt Put(string requestUri)
说明:以Put方式发起一个HTTP请求。
参数:
requestUri:HTTP请求地址,可以是相对地址或绝对地址;如果是相对地址将使用BaseAddress进行拼接。
// 修改Id为1的人员住址
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt rep = client.SetJsonContent("{\"address\": \"BeiJing\"}")
.Put("https://www.ceshi.com/person/1");
// TODO
15. PutAsync方法
public async Task<HttpResponseExt> PutAsync(string requestUri)
说明:Put方法的异步版本。
16. Delete方法
public HttpResponseExt Delete(string requestUri)
说明:以Delete方式发起一个HTTP请求。
参数:
requestUri:HTTP请求地址,可以是相对地址或绝对地址;如果是相对地址将使用BaseAddress进行拼接。
// 删除Id为1的人员信息
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt rep = client.Delete("https://www.ceshi.com/person/1");
// TODO
17. DeleteAsync方法
public async Task<HttpResponseExt> DeleteAsync(string requestUri)
说明:Delete方法的异步版本。
18. Patch方法
public HttpResponseExt Patch(string requestUri)
说明:以Patch方式发起一个HTTP请求。
参数:
requestUri:HTTP请求地址,可以是相对地址或绝对地址;如果是相对地址将使用BaseAddress进行拼接。
// 修改Id为1的人员信息
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt rep = client.SetJsonContent("{\"name\":\"wangxm\", \"age\": 18}")
.Delete("https://www.ceshi.com/person/1");
// TODO
19. PatchAsync方法
public async Task<HttpResponseExt> PatchAsync(string requestUri)
说明:Patch方法的异步版本。
20. Head方法
public HttpResponseExt Head(string requestUri)
说明:以Head方式发起一个HTTP请求。
参数:
requestUri:HTTP请求地址,可以是相对地址或绝对地址;如果是相对地址将使用BaseAddress进行拼接。
21. HeadAsync方法
public async Task<HttpResponseExt> HeadAsync(string requestUri)
说明:Head方法的异步版本。
22. Options方法
public HttpResponseExt Options(string requestUri)
说明:以Options方式发起一个HTTP请求。
参数:
requestUri:HTTP请求地址,可以是相对地址或绝对地址;如果是相对地址将使用BaseAddress进行拼接。
23. OptionsAsync方法
public async Task<HttpResponseExt> OptionsAsync(string requestUri)
说明:Options方法的异步版本。
HTTP安全
HTTP安全在类库中目前仅提供了一个应对XSS攻击的处理方法,该方法会对传入参数进行二次,将内容中有风险部分进行处理并返回。
使用时需要首先获取HttpSecurity对象:
HttpSecurity security = Xmtool.Web.Security();
1. Xss方法
public string Xss(string str)
说明:对指定字符内容进行Xss风险处理并返回处理结果。
参数:
str:需要进行处理的字符串内容。
string str = "<script>alert(123);</script><div>hello world.</div>";
string str2 = Xmtool.Web.Security().Xss(str);
Console.Writeline(str2); // 输出<div>hello world.</div>
//TODO
附加说明
一、DynamicObjectExt对象
说明:DynamicObjectExt动态对象是Xmtool工具库中最具特色的一项功能;通过该对象可以无需事先定义就能像使用实体类一样进行数据对象的赋值和操作;且比系统自带的dynamic对象更加灵活友好。如果你熟悉Javascript的话,它就像Javascript中的变量一样可以任意使用;更加详细的说明请参考《DynamicObjectExt详细说明》。
二、HttpResponseExt对象
HttpResponseExt对象用于接收HTTP请求返回结果,封装了响应码、响应头、响应内容 3 部分内容。
1. StatusCode属性
说明:HTTP请求的响应状态码。
2. Headers属性
说明:HTTP请求的响应头信息。
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt resp = client.Get("https://www.baidu.com");
if (resp.Headers.ContainsKey("user"))
{
string user = resp.Headers["user"];
// TODO
}
3. Content属性
说明:HTTP请求的响应内容。
4. Json属性
说明:HTTP请求返回的JSON格式的内容;如果返回内容不是合法的JSON格式,将返回异常。
// https://www.ceshi.com/person/1 请求返回内容
{
"Name": "softwaiter",
"Age": 18,
"Address": "BeiJing"
}
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt resp = client.Get("https://www.ceshi.com/person/1");
if (resp.Json.Name == "softwaiter")
{
// TODO
}
5. Xml属性
说明:HTTP请求返回的XML格式的内容;如果返回内容不是合法的XML格式,将返回异常。
【Github源码】
开源.NetCore通用工具库Xmtool使用连载 - HTTP请求篇的更多相关文章
- 开源.NetCore通用工具库Xmtool使用连载 - 加密解密篇
[Github源码] <上一篇>详细介绍了Xmtool工具库中的正则表达式类库,今天我们继续为大家介绍其中的加密解密类库. 在开发过程中我们经常会遇到需要对数据进行加密和解密的需求,例如密 ...
- 最好的.NET开源免费ZIP库DotNetZip(.NET组件介绍之三)
在项目开发中,除了对数据的展示更多的就是对文件的相关操作,例如文件的创建和删除,以及文件的压缩和解压.文件压缩的好处有很多,主要就是在文件传输的方面,文件压缩的好处就不需要赘述,因为无论是开发者,还是 ...
- Win10 UWP开发系列——开源控件库:UWPCommunityToolkit
在开发应用的过程中,不可避免的会使用第三方类库.之前用过一个WinRTXamlToolkit.UWP,现在微软官方发布了一个新的开源控件库—— UWPCommunityToolkit 项目代码托管在G ...
- Cowboy 开源 WebSocket 网络库
Cowboy.WebSockets 是一个托管在 GitHub 上的基于 .NET/C# 实现的开源 WebSocket 网络库,其完整的实现了 RFC 6455 (The WebSocket Pro ...
- java开源时间/日期库Joda-Time
任何企业应用程序都需要处理时间问题.应用程序需要知道当前的时间点和下一个时间点,有时它们还必须计算这两个时间点之间的路径.使用 JDK 完成这项任务将非常痛苦和繁琐.现在来看看 Joda Time,一 ...
- fastjson是阿里巴巴的开源JSON解析库
fastjson的API十分简洁. String text = JSON.toJSONString(obj); //序列化 VO vo = JSON.parseObject("{...}&q ...
- 人生维艰,何不利用开源.NET函数库让工作更轻松
今天推荐的文章会谈到一些让你工作更轻松的开源.NET函数库. 即使业界有时候认为.NET开源社区不太健康,很多开发团队都更多依赖于微软提供的东西来开发.不过最近在.NET世界中还是诞生了一些优秀和有意 ...
- ios开发与安卓开源项目及库
自己总结的iOS.mac开源项目及库 https://github.com/Tim9Liu9/TimLiu-iOS 自己总结的Android开源项目及库 https://github.com/Tim9 ...
- 1. Android 系统上一款开源的图表库
1. MPAndroidChart MPAndroidChart 是 Android 系统上一款开源的图表库.目前提供线图和饼图,支持选择.缩放和拖放. 一个可以拖动缩放的图表库,包含曲线图.直方图 ...
- 使用C++的开源序列化(Serialization)库cereal
博客搬到了fresky.github.io - Dawei XU,请各位看官挪步.最新的一篇是:使用C++的开源序列化(Serialization)库cereal.
随机推荐
- Jan 2023-Prioritizing Samples in Reinforcement Learning with Reducible Loss
1 Introduction 本文建议根据样本的可学习性进行抽样,而不是从经验回放中随机抽样.如果有可能减少代理对该样本的损失,则认为该样本是可学习的.我们将可以减少样本损失的数量称为其可减少损失(R ...
- ABP - 依赖注入(1)
依赖注入实现了系统之间.模块之间和对象之间依赖关系的解耦,基本上是现代应用程序框架必不可少的一个组成部分. ABP的依赖注入系统是基于Microsoft的依赖注入扩展库(Microsoft.Exten ...
- SpringMVC 简单的开始
SpringMVC简单的开始 利用Spring模板配置写一个web项目. 1.核心配置文件(模板代码) <?xml version="1.0" encoding=" ...
- < Python全景系列-7 > 提升Python编程效率:模块与包全面解读
欢迎来到我们的系列博客<Python全景系列>!在这个系列中,我们将带领你从Python的基础知识开始,一步步深入到高级话题,帮助你掌握这门强大而灵活的编程语法.无论你是编程新手,还是有一 ...
- java开发学习框架
Java基础 1.1. Java简介与安装 1.2. Java基本语法 1.3. 数据类型与变量 1.4. 运算符与表达式 1.5. 流程控制(分支与循环) 1.6. 数组 面向对象编程 2.1. 类 ...
- YOLOV5实时检测屏幕
YOLOV5实时检测屏幕 目录 YOLOV5实时检测屏幕 思考部分 先把原本的detect.py的代码贴在这里 分析代码并删减不用的部分 把屏幕的截图通过OpenCV进行显示 写一个屏幕截图的文件 用 ...
- FTL潜规则:调优,才是算法精华
前言 在存储领域中有一个FTL的概念,这是一种Flash的内存管理算法,属于各个厂商的核心机密,每个厂商的处理方式不同,有的处理简单,有的处理复杂. FTL,即Flash Translations l ...
- mybatis-plus-generator-ui 可视化代码生成器!
它提供交互式的Web UI用于生成兼容mybatis-plus框架的相关功能代码,包括Entity,Mapper,Mapper.xml,Service,Controller等. 可以自定义模板以及各类 ...
- 一文了解Go语言的函数
1. 引言 函数是编程中不可或缺的组成部分,无论是在Go语言还是其他编程语言中,函数都扮演着重要的角色.函数能够将一系列的操作封装在一起,使得代码更加模块化.可重用和易于维护. 在本文中,我们将详细介 ...
- java反射机制原理及应用
java反射机制 反射机制原理示意图 Class.forName(字节码文件) 类.class 对象.getClass() 用法: 根据配置的properties文件(不仅是properties) ...