ABP静态客户端代理报错：未找到GetListAsync方法API描述

报错信息 #

未找到App.AdministrationService.Sequences.ISequencesAppService.GetListAsync方法的API描述！

已确认的相关内容 #

1. 代理生成文件条目 #

在AdministrationService-generate-proxy.json中找到对应条目：

"GetListAsyncByInput": {
  "uniqueName": "GetListAsyncByInput",
  "name": "GetListAsync",
  "httpMethod": "GET",
  "url": "api/administration-service/sequences",
  "supportedVersions": [],
  "parametersOnMethod": [
    { ....

2. AppService接口定义 #

public interface ISequencesAppService : IApplicationService
{
    Task<PagedResultDto<SequenceDto>> GetListAsync(GetSequencesInput input);

    Task<SequenceDto> GetAsync(Guid id);

    Task DeleteAsync(Guid id);

    Task<SequenceDto> CreateAsync(SequenceCreateDto input);

    Task<SequenceDto> UpdateAsync(Guid id, SequenceUpdateDto input);
}

3. 控制器代码 #

[RemoteService(Name = AdministrationServiceRemoteServiceConsts.RemoteServiceName)]
[Area("administrationService")]
[ControllerName("Sequence")]
[Route("api/administration-service/sequences")]
public class SequenceController : AbpController, ISequencesAppService
{
    private readonly ISequencesAppService _sequencesAppService;

    public SequenceController(ISequencesAppService sequencesAppService)
    {
        _sequencesAppService = sequencesAppService;
    }

    [HttpGet]
    public virtual Task<PagedResultDto<SequenceDto>> GetListAsync(GetSequencesInput input)
    {
        return _sequencesAppService.GetListAsync(input);
    } ...

4. 客户端模块配置 #

[DependsOn(
    typeof(AdministrationServiceApplicationContractsModule),
    typeof(AbpPermissionManagementHttpApiClientModule),
    typeof(AbpFeatureManagementHttpApiClientModule),
    typeof(AbpSettingManagementHttpApiClientModule),
    typeof(AbpAuditLoggingHttpApiClientModule),
    typeof(LanguageManagementHttpApiClientModule),
    typeof(TextTemplateManagementHttpApiClientModule),
    typeof(AbpHttpClientModule)
)]
public class AdministrationServiceHttpApiClientModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        context.Services.AddHttpClientProxies(
            typeof(AdministrationServiceApplicationContractsModule).Assembly,
            AdministrationServiceRemoteServiceConsts.RemoteServiceName
        );
        
        context.Services.AddStaticHttpClientProxies(
            typeof(AdministrationServiceApplicationContractsModule).Assembly,
            AdministrationServiceRemoteServiceConsts.RemoteServiceName
        );
    }
}

背景与已尝试操作 #

通过ABP Suite生成CRUD代码，在AdministrationService模块构建静态客户端代理，WPF客户端使用带C#参数的客户端代理。已多次清理并重建项目，问题仍未解决。

问题分析与解决建议 #

可能原因 #

1. 静态代理生成不匹配：代理文件中该方法的唯一名称是GetListAsyncByInput，但客户端代理匹配时仍使用原始方法名GetListAsync，导致映射失败。ABP处理带复杂参数的GET请求时会自动生成带后缀的唯一名称，但静态代理生成可能未同步映射关系。
2. 两种代理注册冲突：客户端同时注册了动态代理（AddHttpClientProxies）和静态代理（AddStaticHttpClientProxies），机制冲突导致静态代理元数据未正确加载。
3. 输入参数序列化配置错误：GetSequencesInput作为GET请求的复杂参数，若缺少[FromQuery]标记或序列化设置错误，会导致代理元数据生成异常。

解决办法 #

1. 重新生成静态代理：

   • 删除已生成的静态代理文件，执行代理生成命令（如abp generate-proxy -t csharp -u https://你的API地址），确保生成的代码中GetListAsync正确映射到GetListAsyncByInput对应的API路径。

2. 移除冲突的代理注册：

   • 客户端模块中只保留静态代理注册，删除动态代理调用，避免冲突：

     public override void ConfigureServices(ServiceConfigurationContext context)
     {
         context.Services.AddStaticHttpClientProxies(
             typeof(AdministrationServiceApplicationContractsModule).Assembly,
             AdministrationServiceRemoteServiceConsts.RemoteServiceName
         );
     }
     

3. 修正输入参数标记：

   • 在GetSequencesInput类的属性或控制器方法参数上添加[FromQuery]标记，确保参数能被正确解析为查询字符串：

     // 方式1：在参数类属性上添加
     public class GetSequencesInput : PagedAndSortedResultRequestDto
     {
         [FromQuery]
         public string Filter { get; set; }
         // 其他属性同理添加
     }
     
     // 方式2：在控制器方法参数上添加
     [HttpGet]
     public virtual Task<PagedResultDto<SequenceDto>> GetListAsync([FromQuery] GetSequencesInput input)
     {
         return _sequencesAppService.GetListAsync(input);
     }
     

4. 清理并重建元数据：

   • 删除服务端的AdministrationService-generate-proxy.json文件，重启服务端让ABP重新生成元数据；客户端清理bin、obj目录后重新构建，确保静态代理文件为最新版本。

内容的提问来源于stack exchange，提问作者Jim Pusta Buot