Common.HttpClients 1.3.0-beta9

Common.HttpClients

一个功能丰富的HTTP客户端库，支持日志记录、请求拦截、配置管理等特性。

主要特性

• 🚀 高性能HTTP客户端
• 📝 智能日志记录和审计
• ⚙️ 灵活的配置管理
• 🔒 请求/响应拦截
• 📊 响应内容长度控制
• 🎯 请求级别的日志控制

安装

dotnet add package Common.HttpClients

快速开始

1. 注册服务

// 使用默认配置
services.AddHttpClientServices();

// 或自定义配置
services.AddHttpClientServices(config =>
{
    config.AuditLog = true;
    config.FailThrowException = false;
    config.Timeout = 100;
    config.MaxOutputResponseLength = 1024 * 1024; // 1MB
});

2. 使用HTTP客户端

public class MyService
{
    private readonly IHttpHelper _httpHelper;

    public MyService(IHttpHelper httpHelper)
    {
        _httpHelper = httpHelper;
    }

    public async Task<string> GetDataAsync()
    {
        var result = await _httpHelper.GetAsync<string>(Host + "/get?q1=11&q2=22");

        return result;
    }
}

配置选项HttpConfig

请求

下面示例已经注入IHttpHelper

Get

var result = await _httpHelper.GetAsync<string>(Host + "/get?q1=11&q2=22");

还支持传递token以及传递请求头

Post

Json格式

支持传递字符串以及对象

var content = "{\"q\":\"123456\",\"a\":\"222\"}";
var result = await _httpHelper.PostAsync<string>(Host + "/post", content);

PostFormData

• Task<T> PostFormDataAsync<T>(string url, MultipartFormDataContent formDataContent);

请求示例

using var form = new MultipartFormDataContent();

// bytes为文件字节数组
using var fileContent = new ByteArrayContent(bytes);
fileContent.Headers.ContentDisposition = new ContentDispositionHeaderValue("form-data")
                                         {
                                             Name = "file", // 表单字段名称
                                             FileName = fileName // 文件名
                                         };
fileContent.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
form.Add(fileContent);

// 其他参数
using var content = new StringContent("其他参数值");
form.Add(content, "其他参数名称");

var requestUrl = $"{_difyApiBase}/v1/files/upload";
var response = await _httpHelper.PostFormDataAsync<FileUploadResponse>(requestUrl, form,
    new Dictionary<string, string> { { "Authorization", $"Bearer {_difyApiKey}" } });

日志

可以设置配置AuditLog来设置是否启用审计日志，默认为启用状态。

builder.Services.AddHttpClientService();

也可以为指定地址请求设置关闭审计日志，例如

var result = await _httpHelper.PostAsync<string>(Host + "/anything", list,
    headers: new Dictionary<string, string>() { { "X-Logger", "skip" } });

var result2 = await _httpHelper.PostAsync<string>(Host + "/anything", list,
    headers: new Dictionary<string, string>() { { "X-Skip-Logger", "" } });

可以通过在请求头设置X-Skip-Logger或者设置X-Logger值为none、skip进行跳过日志

版本更新记录

• 1.3.0-beta9
  • 更新响应日志输出内容
  • 增加支持CancellationToken
  • 移除对.NetStandard2.1支持
• 1.3.0-beta8
  • 优化单独请求的日志输出
• 1.3.0-beta7
  • 修复调用接口报错在忽略异常的情况下扔抛出错误
• 1.3.0-beta6
  • 优化审计日志
• 1.3.0-beta5
  • 增加全局设置超时时间以及针对指定请求设置超时时间
• 1.3.0-beta4
  • 修改PostFormDataAsync方法，增加直接传递jwtToken入参
• 1.3.0-beta3
  • 修复LoggingHandler被错误重用的问题，将其生命周期改为Transient
• 1.3.0-beta2
  • 增加流式响应PostGetStreamAsync
  • 暴漏基础的SendAsync
• 1.3.0-beta1
  • 支持.Net9
  • 增加请求审计日志
• 1.2.3
  • 注入的时候支持设置是否异常直接抛出
• 1.2.2
  • 增加x-www-form-urlencoded请求方式代码
  • 升级支持.Net8
• 1.2.1
  • 增加get获取文件流的方法
• 1.2.0
  • 升级支持.net7
• 1.1.5
  • 修改put请求命名问题
  • 增加patch请求
• 1.1.4
  • 处理多个构造函数的报错
  • 增加更加灵活的请求方式Send
• 1.1.3
  • 增加http请求FormData形式去提交文件
  • 支持框架netstandard2.1、net6.0
• 1.1.2
  • 更新post方法同时兼容string和其他类型
• 1.1.1
  • 更新post方法,配置多个目标框架
• 1.1.0
  • 更新框架版本为5.0
• 1.0.0
  • 3.1版本的http请求公共库