如何在ASP.NET Core 2.1环境下实现在API内部调用另一个API

ASP.NET Core 2.1原生支持IHttpClientFactory，无需额外引入第三方包即可实现稳定的HTTP调用，避免手动实例化HttpClient导致的资源泄漏问题，以下是完整实现步骤：

1. 注册必要服务 #

在依赖注入配置部分添加IHttpClientFactory、业务服务、数据库上下文的注册，示例代码如下：

public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
        .ConfigureServices(services =>
        {
            // 注册HttpClientFactory
            services.AddHttpClient();
            // 注册自定义业务同步服务
            services.AddScoped<IDataSyncService, DataSyncService>();
            // 保留你现有数据库上下文的注册逻辑
            services.AddDbContext<YourDbContext>(options => 
                options.UseSqlServer(Configuration.GetConnectionString("YourDatabaseConn")));
            // 保留原有MVC/控制器注册
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
        })
        .UseStartup<Startup>();

2. 封装外部API调用与数据处理逻辑 #

创建业务服务类，完成调用外部接口、JSON反序列化、数据整理、入库的全流程逻辑：

// 先定义服务接口
public interface IDataSyncService
{
    Task SyncExternalDataAsync();
}

public class DataSyncService : IDataSyncService
{
    private readonly IHttpClientFactory _httpClientFactory;
    private readonly YourDbContext _dbContext;

    // 注入依赖
    public DataSyncService(IHttpClientFactory httpClientFactory, YourDbContext dbContext)
    {
        _httpClientFactory = httpClientFactory;
        _dbContext = dbContext;
    }

    public async Task SyncExternalDataAsync()
    {
        // 创建HttpClient实例
        var client = _httpClientFactory.CreateClient();
        // 配置外部接口基础信息，也可以存入配置文件读取
        client.BaseAddress = new Uri("https://你要调用的外部接口域名/");
        // 按需添加请求头，比如认证信息
        client.DefaultRequestHeaders.Add("Authorization", "Bearer 外部接口要求的访问令牌");

        try
        {
            // 发起请求，根据外部接口要求调整为POST/PUT等方法
            var response = await client.GetAsync("外部接口的具体路径，比如/api/public/data");
            // 校验请求是否成功
            response.EnsureSuccessStatusCode();
            // 读取返回的JSON字符串
            var jsonResult = await response.Content.ReadAsStringAsync();
            // 反序列化为匹配外部接口返回结构的DTO，需要你提前定义对应结构的类
            var externalData = JsonConvert.DeserializeObject<ExternalApiResultDto>(jsonResult);

            // 编写你自己的字段映射、数据整理逻辑，生成对应各数据表的实体类
            var table1Item = new Table1Entity
            {
                Field1 = externalData.FieldA,
                Field2 = externalData.FieldB
            };
            var table2Item = new Table2Entity
            {
                FieldX = externalData.FieldC,
                FieldY = externalData.FieldD
            };

            // 批量写入数据库
            _dbContext.Table1.Add(table1Item);
            _dbContext.Table2.Add(table2Item);
            await _dbContext.SaveChangesAsync();
        }
        catch (HttpRequestException ex)
        {
            // 按需添加异常处理、日志记录逻辑
            Console.WriteLine($"调用外部接口失败：{ex.Message}");
            throw;
        }
    }
}

3. 新增暴露的API接口 #

在控制器中注入业务服务，提供触发同步的入口：

[Route("api/[controller]")]
[ApiController]
public class DataSyncController : ControllerBase
{
    private readonly IDataSyncService _syncService;

    public DataSyncController(IDataSyncService syncService)
    {
        _syncService = syncService;
    }

    [HttpPost("sync-external-data")]
    public async Task<IActionResult> SyncExternalData()
    {
        await _syncService.SyncExternalDataAsync();
        return Ok("数据同步完成");
    }
}

注意事项 #

• 提前定义和外部接口返回JSON结构完全匹配的ExternalApiResultDto，避免反序列化失败
• 如果需要发送POST请求提交参数，可以用以下示例构造请求内容：

  var postParam = new { QueryId = 123, Size = 100 };
  var content = new StringContent(JsonConvert.SerializeObject(postParam), Encoding.UTF8, "application/json");
  var response = await client.PostAsync("接口路径", content);
  

• 可以在注册HttpClient的时候统一配置超时、重试规则：

  services.AddHttpClient("ExternalApi", client =>
  {
      client.BaseAddress = new Uri("https://外部接口域名/");
      client.Timeout = TimeSpan.FromSeconds(30);
  });
  

  使用时通过_httpClientFactory.CreateClient("ExternalApi")获取实例即可复用配置。

内容的提问来源于stack exchange，提问作者Sthefany Rangel