如何在ABP Framework中基于客户端代理系统用access_token调用HTTP API

核心思路 #

ABP Client Proxy System基于HttpClient实现，只需为其底层HttpClient添加Bearer认证头，或利用ABP内置的Token提供机制，即可实现用外部access_token完成认证调用。

方法一：利用ABP内置的IAbpAccessTokenProvider（推荐） #

ABP框架内置了IAbpAccessTokenProvider服务，Client Proxy会自动从该服务获取token并添加到请求头。只需将外部获取的token注入到这个服务即可：

代码示例 #

// 在服务初始化或需要设置token的逻辑中
var tokenProvider = serviceProvider.GetRequiredService<IAbpAccessTokenProvider>();

// 设置外部获取的access_token
await tokenProvider.SetTokenAsync(new AbpAccessToken("your-external-access-token"));

之后直接使用自动注入的Client Proxy接口调用API即可：

public class MyBusinessService
{
    private readonly IYourRemoteAppService _remoteAppService;

    public MyBusinessService(IYourRemoteAppService remoteAppService)
    {
        _remoteAppService = remoteAppService;
    }

    public async Task FetchRemoteData()
    {
        // 调用时会自动携带已设置的access_token
        var result = await _remoteAppService.GetTargetDataAsync();
    }
}

方法二：自定义HttpMessageHandler添加认证头 #

如果不想依赖ABP内置的Token提供机制，可以自定义一个DelegatingHandler，在请求发送前自动添加Bearer认证头，再将其关联到Client Proxy使用的HttpClient。

1. 实现自定义TokenHandler #

public class TokenHandler : DelegatingHandler
{
    private readonly string _accessToken;

    // 若token需动态获取，可注入token获取服务替代直接传入
    public TokenHandler(string accessToken)
    {
        _accessToken = accessToken;
    }

    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        // 为请求添加Bearer认证头
        request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", _accessToken);
        return await base.SendAsync(request, cancellationToken);
    }
}

2. 配置动态Client Proxy #

注册关联了自定义Handler的HttpClient，再配置动态代理：

builder.Services.AddHttpClient("AbpApiClient")
    .AddHttpMessageHandler(() => new TokenHandler("your-external-access-token"));

builder.Services.AddAbpDynamicClientProxies(
    typeof(YourRemoteApiModule).Assembly,
    options =>
    {
        options.ClientName = "AbpApiClient";
        options.RemoteServiceName = "YourRemoteServiceName"; // 对应目标API的远程服务名称
    });

3. 配置静态Client Proxy #

如果使用静态生成的Client Proxy，直接为其HttpClient关联Handler即可：

// 注册静态代理客户端
builder.Services.AddHttpClient<IYourAppServiceClient, YourAppServiceClient>(client =>
{
    client.BaseAddress = new Uri("https://your-api-base-url.com");
})
.AddHttpMessageHandler(() => new TokenHandler("your-external-access-token"));

注意事项 #

• 确保外部获取的access_token的**受众（Audience）**与目标API的配置一致，否则会返回认证失败。
• 如果token存在过期逻辑，可在自定义Handler或IAbpAccessTokenProvider的实现中添加token刷新逻辑。
• 若使用ABP IdentityServer作为认证服务，需确保token包含目标API所需的Scope权限。

内容的提问来源于stack exchange，提问作者Omer Faruk KAYA