C#网络请求封装，HttpClient 静态单实例

2024-08-23 05:36
文章标签 c# 封装 请求 实例 网络 静态 .net httpclient netcore

本文主要是介绍C#网络请求封装，HttpClient 静态单实例，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

关于为什么使用单实例，请参考： HttpClient的错误使用

每次使用网络请求时都实例一个HttpClient，业务量小的时候不会存在问题，但是当请求足够大时，按照相关测试 短时间内(两分钟)当请求在3000-5000时请求响应将会下降 会存在大量的网络等待，当超过5000时会请求错误，显示socket连接耗尽，HttpClient默认释放时间是2-3分钟来着

该请求封装了基本的 异步post、get请求，文件的上传、下载。响应体压缩解码功能

完整代码

public static class HttpRequestHelper
{// 关于调整的原因，可查看：https://www.aspnetmonsters.com/2016/08/2016-08-27-httpclientwrong/// 这里将请求设置为全局的单例，这是安全的 因为HttpClient底层是线程安全的// 设置默认的超时时间，因为是单例 所以不能在执行中修改基础的实例信息private static readonly HttpClient _client = new HttpClient() { Timeout = TimeSpan.FromSeconds(120) };/// <summary>/// 发送异步post请求/// </summary>/// <param name="baseUrl"></param>/// <param name="headers">请不要在请求头中添加 Content-Type</param>/// <param name="data"></param>/// <param name="contentType"></param>/// <param name="parameters">Parameter 参数</param>/// <returns></returns>/// <exception cref="ArgumentException"></exception>public static async Task<string> HttpPostAsync(string baseUrl, Dictionary<string, string>? headers = null, object? data = null, ContentType contentType = ContentType.Json, Dictionary<string, string>? parameters = null){// 将参数添加到 URL 中var url = BuildUrl(baseUrl, parameters);using HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, url);if (headers != null){foreach (var header in headers){request.Headers.Add(header.Key, header.Value);}}if (data != null)request.Content = BuildContent(data, contentType);HttpResponseMessage response = await _client.SendAsync(request);string responseBody = await DeCodeResponse(response);EnsureSuccessStatus(response, responseBody, "Post请求", url, headers?.ToJson(), data?.ToJson());return responseBody;}/// <summary>/// 发送异步GET请求/// </summary>/// <param name="baseUrl"></param>/// <param name="parameters"></param>/// /// <param name="headers">请不要在请求头中添加 Content-Type</param>/// <returns></returns>public static async Task<string> HttpGetAsync(string baseUrl, Dictionary<string, string>? parameters = null, Dictionary<string, string>? headers = null, object? data = null,ContentType contentType = ContentType.Json){var url = BuildUrl(baseUrl, parameters);using HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, url);if (headers != null){foreach (var header in headers){request.Headers.Add(header.Key, header.Value);}}if (data != null)request.Content = BuildContent(data, contentType);var response = await _client.SendAsync(request);var content = await DeCodeResponse(response);EnsureSuccessStatus(response, content, "Get请求", url, headers?.ToJson(), data?.ToJson());return content;}/// <summary>/// 异步上传文件/// </summary>/// <param name="baseUrl">上传地址</param>/// <param name="filePath">文件地址</param>/// <param name="headers">请求头</param>/// <param name="parameters">query参数</param>/// <returns></returns>public static async Task<string> UploadFileAsync(string baseUrl, string filePath, Dictionary<string, string>? headers = null,Dictionary<string, string>? parameters = null){// 将参数添加到 URL 中var url = BuildUrl(baseUrl, parameters);using HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, url);if (headers != null){foreach (var header in headers){request.Headers.Add(header.Key, header.Value);}}// 构建多媒体请求内容var content = new MultipartFormDataContent();// 普通文件上传var fileContent = new StreamContent(File.OpenRead(filePath));content.Add(fileContent, "file", Path.GetFileName(filePath));// 读取文件内容并压缩.发现两个问题。如有需要再做压缩// 1、发现压缩上传会导致进程内存占用非常大 短期内无法释放// 2、压缩上传的文件 无法正常打开。可能是接收方没有解压缩导致//string fileContent = File.ReadAllText(filePath);//byte[] compressedData = CompressString(fileContent);//var compressedContent = new ByteArrayContent(compressedData);//content.Add(compressedContent, "file", Path.GetFileName(filePath));request.Content = content;// 发送 POST 请求var response = await _client.SendAsync(request);//response.EnsureSuccessStatusCode();string responseBody = await DeCodeResponse(response);EnsureSuccessStatus(response, responseBody, "文件上传", url, headers?.ToJson());return responseBody;}/// <summary>/// 异步下载文件/// </summary>/// <param name="url"></param>/// <param name="savePath"></param>/// <param name="method"></param>/// <param name="headers"></param>/// <param name="data"></param>/// <param name="contentType"></param>/// <returns></returns>/// <exception cref="Exception"></exception>public static async Task DownloadFileAsync(string url, string savePath, HttpMethod method,Dictionary<string, object>? headers = null, object? data = null, ContentType contentType = ContentType.Json){using HttpRequestMessage request = new HttpRequestMessage(method, url);if (headers != null){foreach (var header in headers){request.Headers.Add(header.Key, header.Value.ToString());}}if (data != null)request.Content = BuildContent(data, contentType);using var response = await _client.SendAsync(request, HttpCompletionOption.ResponseHeadersRead);EnsureSuccessStatus(response, "", "文件下载", url, headers?.ToJson(), data?.ToJson());// 获取文件总长度（可选，用于显示进度或检查文件大小）var totalBytes = response.Content.Headers.ContentLength;using var streamToReadFrom = await response.Content.ReadAsStreamAsync();using var streamToWriteTo = File.Create(savePath);await streamToReadFrom.CopyToAsync(streamToWriteTo);}/// <summary>/// 验证请求状态/// </summary>/// <param name="response"></param>/// <param name="responseBody"></param>/// <param name="method"></param>/// <exception cref="Exception"></exception>private static void EnsureSuccessStatus(HttpResponseMessage response, string responseBody, string method, string url, string? header, string? body = null){//response.EnsureSuccessStatusCode(); 检查响应是否是200 若不是 引发异常// 401 404 状态 应该交给上层业务处理if (!response.IsSuccessStatusCode&& ((int)response.StatusCode != 401 && (int)response.StatusCode != 404)){Exception exception = new Exception($"header:{header};body:{body};res:{responseBody}");throw new HttpRequestVerifyException($"{method} {url} ({(int)response.StatusCode}){response.StatusCode}", exception);}}/// <summary>/// 解码响应体，如果有编码或压缩的话/// </summary>/// <param name="response"></param>/// <returns></returns>private static async Task<string> DeCodeResponse(HttpResponseMessage response){// 解码信息if (response.Content.Headers != null && response.Content.Headers.ContentEncoding.Contains("gzip")){// 解码using var gzipStream = new GZipStream(await response.Content.ReadAsStreamAsync(), CompressionMode.Decompress);using var streamReader = new StreamReader(gzipStream, Encoding.UTF8);return await streamReader.ReadToEndAsync();}elsereturn await response.Content.ReadAsStringAsync();}/// <summary>/// 将请求数据绑定到url/// </summary>/// <param name="baseUrl"></param>/// <param name="parameters"></param>/// <returns></returns>private static string BuildUrl(string baseUrl, Dictionary<string, string>? parameters){if (parameters == null || parameters.Count == 0)return baseUrl;var queryStrings = new List<string>();foreach (var parameter in parameters){var encodedKey = Uri.EscapeDataString(parameter.Key);var encodedValue = Uri.EscapeDataString(parameter.Value);queryStrings.Add($"{encodedKey}={encodedValue}");}var queryString = string.Join("&", queryStrings);return $"{baseUrl}?{queryString}";}/// <summary>/// 绑定数据到请求体中/// </summary>/// <param name="data"></param>/// <param name="contentType"></param>/// <returns></returns>/// <exception cref="ArgumentException"></exception>private static HttpContent BuildContent(object data, ContentType contentType){HttpContent content;if (contentType == ContentType.FormUrlEncoded){var formData = new FormUrlEncodedContent(ObjectToKeyValue(data));content = formData;}else if (contentType == ContentType.Json){//var jsonData = JsonConvert.SerializeObject(data, new JsonSerializerSettings { DateFormatString = "yyyy-MM-dd HH:mm:ss" });content = new StringContent(data.ToString() ?? "", Encoding.UTF8, "application/json");}else if (contentType == ContentType.Xml){content = new StringContent(data.ToString() ?? "", Encoding.UTF8, "text/xml");}else if (contentType == ContentType.MultipartFormData){if (data is IDictionary<string, object> formDataDict){var formContent = new MultipartFormDataContent();foreach (var kvp in formDataDict){var value = kvp.Value?.ToString() ?? "";formContent.Add(new StringContent(value), kvp.Key);}content = formContent;}else{throw new ArgumentException("formData must be a Dictionary<string, object>.");}}else{throw new ArgumentException("Invalid contentType. Supported values are 'application/x-www-form-urlencoded','application/json','text/xml','multipart/form-data'.");}return content;}/// <summary>/// 压缩文件 返回压缩后的byte/// </summary>/// <param name="input"></param>/// <returns></returns>private static byte[] CompressString(string input){using MemoryStream output = new MemoryStream();using (GZipStream gzipStream = new GZipStream(output, CompressionMode.Compress, leaveOpen: true))using (StreamWriter writer = new StreamWriter(gzipStream)){writer.Write(input);}return output.ToArray();}private static IEnumerable<KeyValuePair<string, string>> ObjectToKeyValue(object obj){var properties = obj.GetType().GetProperties();foreach (var prop in properties){var value = prop.GetValue(obj)?.ToString() ?? string.Empty;yield return new KeyValuePair<string, string>(prop.Name, value);}}
}public enum ContentType
{Json,FormUrlEncoded, // application/x-www-form-urlencodedMultipartFormData,Xml
}

这篇关于C#网络请求封装，HttpClient 静态单实例的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1098498。

相关文章

C#使用Spire.Doc for .NET实现HTML转Word的高效方案

C#使用Spire.Doc for .NET实现HTML转Word的高效方案

《C#使用Spire.Docfor.NET实现HTML转Word的高效方案》在Web开发中,HTML内容的生成与处理是高频需求,然而,当用户需要将HTML页面或动态生成的HTML字符串转换为Wor... 目录引言一、html转Word的典型场景与挑战二、用 Spire.Doc 实现 HTML 转 Word1
阅读更多...
C#实现一键批量合并PDF文档

C#实现一键批量合并PDF文档

《C#实现一键批量合并PDF文档》这篇文章主要为大家详细介绍了如何使用C#实现一键批量合并PDF文档功能,文中的示例代码简洁易懂,感兴趣的小伙伴可以跟随小编一起学习一下... 目录前言效果展示功能实现1、添加文件2、文件分组（书签）3、定义页码范围4、自定义显示5、定义页面尺寸6、PDF批量合并7、其他方法
阅读更多...
SpringBoot 获取请求参数的常用注解及用法

SpringBoot 获取请求参数的常用注解及用法

《SpringBoot获取请求参数的常用注解及用法》SpringBoot通过@RequestParam、@PathVariable等注解支持从HTTP请求中获取参数,涵盖查询、路径、请求体、头、C... 目录SpringBoot 提供了多种注解来方便地从 HTTP 请求中获取参数以下是主要的注解及其用法：1
阅读更多...
C#下Newtonsoft.Json的具体使用

C#下Newtonsoft.Json的具体使用

《C#下Newtonsoft.Json的具体使用》Newtonsoft.Json是一个非常流行的C#JSON序列化和反序列化库,它可以方便地将C#对象转换为JSON格式,或者将JSON数据解析为C#对... 目录安装 Newtonsoft.json基本用法1. 序列化 C# 对象为 JSON2. 反序列化
阅读更多...
Debian 13升级后网络转发等功能异常怎么办? 并非错误而是管理机制变更

Debian 13升级后网络转发等功能异常怎么办? 并非错误而是管理机制变更

《Debian13升级后网络转发等功能异常怎么办?并非错误而是管理机制变更》很多朋友反馈，更新到Debian13后网络转发等功能异常，这并非BUG而是Debian13Trixie调整... 日前 Debian 13 Trixie 发布后已经有众多网友升级到新版本，只不过升级后发现某些功能存在异常，例如网络转
阅读更多...
SpringBoot请求参数传递与接收示例详解

SpringBoot请求参数传递与接收示例详解

《SpringBoot请求参数传递与接收示例详解》本文给大家介绍SpringBoot请求参数传递与接收示例详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋... 目录I. 基础参数传递i.查询参数（Query Parameters）ii.路径参数（Path Va
阅读更多...
C#文件复制异常："未能找到文件"的解决方案与预防措施

C#文件复制异常："未能找到文件"的解决方案与预防措施

《C#文件复制异常：未能找到文件的解决方案与预防措施》在C#开发中,文件操作是基础中的基础,但有时最基础的File.Copy()方法也会抛出令人困惑的异常,当targetFilePath设置为D:2... 目录一个看似简单的文件操作问题问题重现与错误分析错误代码示例错误信息根本原因分析全面解决方案1. 确保
阅读更多...
基于C#实现PDF转图片的详细教程

基于C#实现PDF转图片的详细教程

《基于C#实现PDF转图片的详细教程》在数字化办公场景中,PDF文件的可视化处理需求日益增长,本文将围绕Spire.PDFfor.NET这一工具,详解如何通过C#将PDF转换为JPG、PNG等主流图片... 目录引言一、组件部署二、快速入门：PDF 转图片的核心 C# 代码三、分辨率设置 - 清晰度的决定因
阅读更多...
C# LiteDB处理时间序列数据的高性能解决方案

C# LiteDB处理时间序列数据的高性能解决方案

《C#LiteDB处理时间序列数据的高性能解决方案》LiteDB作为.NET生态下的轻量级嵌入式NoSQL数据库,一直是时间序列处理的优选方案,本文将为大家大家简单介绍一下LiteDB处理时间序列数... 目录为什么选择LiteDB处理时间序列数据第一章：LiteDB时间序列数据模型设计1.1 核心设计原则
阅读更多...
使用Python的requests库来发送HTTP请求的操作指南

使用Python的requests库来发送HTTP请求的操作指南

《使用Python的requests库来发送HTTP请求的操作指南》使用Python的requests库发送HTTP请求是非常简单和直观的,requests库提供了丰富的API,可以发送各种类型的HT... 目录前言1. 安装 requests 库2. 发送 GET 请求3. 发送 POST 请求4. 发送
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2