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#中的StringSplitOptions枚举

一文解析C#中的StringSplitOptions枚举

《一文解析C#中的StringSplitOptions枚举》StringSplitOptions是C#中的一个枚举类型,用于控制string.Split()方法分割字符串时的行为,核心作用是处理分割后... 目录C#的StringSplitOptions枚举1.StringSplitOptions枚举的常用
阅读更多...
C#自动化实现检测并删除PDF文件中的空白页面

C#自动化实现检测并删除PDF文件中的空白页面

《C#自动化实现检测并删除PDF文件中的空白页面》PDF文档在日常工作和生活中扮演着重要的角色,本文将深入探讨如何使用C#编程语言,结合强大的PDF处理库,自动化地检测并删除PDF文件中的空白页面,感... 目录理解PDF空白页的定义与挑战引入Spire.PDF for .NET库核心实现：检测并删除空白页
阅读更多...
C#利用Free Spire.XLS for .NET复制Excel工作表

C#利用Free Spire.XLS for .NET复制Excel工作表

《C#利用FreeSpire.XLSfor.NET复制Excel工作表》在日常的.NET开发中,我们经常需要操作Excel文件,本文将详细介绍C#如何使用FreeSpire.XLSfor.NET... 目录1. 环境准备2. 核心功能3. android示例代码3.1 在同一工作簿内复制工作表3.2 在不同
阅读更多...
C#中通过Response.Headers设置自定义参数的代码示例

C#中通过Response.Headers设置自定义参数的代码示例

《C#中通过Response.Headers设置自定义参数的代码示例》：本文主要介绍C#中通过Response.Headers设置自定义响应头的方法,涵盖基础添加、安全校验、生产实践及调试技巧,强... 目录一、基础设置方法1. 直接添加自定义头2. 批量设置模式二、高级配置技巧1. 安全校验机制2. 类型
阅读更多...
PyQt6 键盘事件处理的实现及实例代码

PyQt6 键盘事件处理的实现及实例代码

《PyQt6键盘事件处理的实现及实例代码》本文主要介绍了PyQt6键盘事件处理的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起... 目录一、键盘事件处理详解1、核心事件处理器2、事件对象 QKeyEvent3、修饰键处理（1）、修饰键类
阅读更多...
C#使用iText获取PDF的trailer数据的代码示例

C#使用iText获取PDF的trailer数据的代码示例

《C#使用iText获取PDF的trailer数据的代码示例》开发程序debug的时候,看到了PDF有个trailer数据,挺有意思,于是考虑用代码把它读出来,那么就用到我们常用的iText框架了,所... 目录引言iText 核心概念C# 代码示例步骤 1: 确保已安装 iText步骤 2: C# 代码程
阅读更多...
C#实现高性能拍照与水印添加功能完整方案

C#实现高性能拍照与水印添加功能完整方案

《C#实现高性能拍照与水印添加功能完整方案》在工业检测、质量追溯等应用场景中,经常需要对产品进行拍照并添加相关信息水印,本文将详细介绍如何使用C#实现一个高性能的拍照和水印添加功能,包含完整的代码实现... 目录1. 概述2. 功能架构设计3. 核心代码实现python3.1 主拍照方法3.2 安全HBIT
阅读更多...
C#实现SHP文件读取与地图显示的完整教程

C#实现SHP文件读取与地图显示的完整教程

《C#实现SHP文件读取与地图显示的完整教程》在地理信息系统(GIS)开发中,SHP文件是一种常见的矢量数据格式,本文将详细介绍如何使用C#读取SHP文件并实现地图显示功能,包括坐标转换、图形渲染、平... 目录概述功能特点核心代码解析1. 文件读取与初始化2. 坐标转换3. 图形绘制4. 地图交互功能缩放
阅读更多...
Python实现简单封装网络请求的示例详解

Python实现简单封装网络请求的示例详解

《Python实现简单封装网络请求的示例详解》这篇文章主要为大家详细介绍了Python实现简单封装网络请求的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录安装依赖核心功能说明1. 类与方法概览2.NetHelper类初始化参数3.ApiResponse类属性与方法使用实
阅读更多...
C#使用SendMessage实现进程间通信的示例代码

C#使用SendMessage实现进程间通信的示例代码

《C#使用SendMessage实现进程间通信的示例代码》在软件开发中,进程间通信（IPC）是关键技术之一,C#通过调用WindowsAPI的SendMessage函数实现这一功能,本文将通过实例介绍... 目录第一章：SendMessage的底层原理揭秘第二章：构建跨进程通信桥梁2.1 定义通信协议2.2
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2