当前位置：首页 > news >正文

ABP vNext 框架功能模块 - 动态API（Dynamic API）

news 2025/10/24 20:22:07

动态API（Dynamic API）

核心辅助类：

DynamicApiControllerBuilder：动态生成API控制器。
RemoteServiceAttribute：标记类/方法为远程服务（自动暴露API）。

在ABP框架中，DynamicApiControllerBuilder和RemoteServiceAttribute是实现动态API的核心工具，它们能自动将应用服务（Application Service）暴露为HTTP API接口，无需手动编写控制器代码，极大简化了API开发流程。以下是具体示例和讲解：

1. `RemoteServiceAttribute`：标记服务为远程服务（自动暴露API）

RemoteServiceAttribute用于标记类或方法为“远程服务”，ABP框架会自动识别这些标记，将其作为API接口暴露给客户端。它可以控制是否暴露服务、定义API前缀等。

示例：标记应用服务为远程服务

using Volo.Abp.Application.Services;
using Volo.Abp.RemoteServices;// 标记整个服务为远程服务（默认暴露所有公共方法）
[RemoteService(Name = "BookStore")] // 可选：指定API名称（影响路由）
public class BookAppService : ApplicationService, IBookAppService
{// 方法会自动暴露为API：GET /api/book-store/book/{id}public async Task<BookDto> GetAsync(Guid id){// 业务逻辑：查询书籍}// 标记此方法不暴露为API[RemoteService(IsEnabled = false)]public async Task InternalMethodAsync(){// 内部方法，不对外提供API}// 自定义HTTP方法和路由（默认按方法名推断，如Create->POST）[HttpPost("custom-create")] // 覆盖默认路由：POST /api/book-store/book/custom-createpublic async Task<BookDto> CreateWithSpecialLogicAsync(CreateBookDto input){// 业务逻辑：创建书籍}
}

讲解：

类级别标记：[RemoteService] 加在服务类上，表明该服务的公共方法默认会被暴露为API。Name属性可指定API的前缀（如示例中的BookStore，默认路由会包含该名称）。
方法级别标记：[RemoteService(IsEnabled = false)] 可单独禁用某个方法的API暴露，适用于内部调用的方法。
与HTTP特性结合：可通过[HttpGet]、[HttpPost]等特性自定义HTTP方法和路由，覆盖ABP的默认推断（默认规则：Get->GET、Create->POST、Update->PUT、Delete->DELETE）。

2. `DynamicApiControllerBuilder`：手动配置动态API生成

DynamicApiControllerBuilder用于手动配置动态API的生成规则，通常在模块的ConfigureServices方法中使用。它可以批量处理程序集内的服务，自定义API路由、命名空间等。

示例：批量配置程序集中的服务为动态API

using Volo.Abp.Application.Services;
using Volo.Abp.Http.Configuration;public class MyAppModule : AbpModule
{public override void ConfigureServices(ServiceConfigurationContext context){// 批量处理指定程序集中的所有应用服务DynamicApiControllerBuilder.ForAssembly(typeof(MyAppModule).Assembly) // 扫描当前模块所在程序集.AddControllers(options =>{// 自定义API前缀（默认是"api"）options.RootPath = "api/v2"; // 过滤需要暴露的服务（仅包含实现了IApplicationService的类）options.TypePredicate = type => typeof(IApplicationService).IsAssignableFrom(type);});// 单独配置某个服务（更精细的控制）DynamicApiControllerBuilder.For<IBookAppService>("book-store/custom-books") // 指定API路由前缀：/api/book-store/custom-books.Build(); // 生成控制器}
}

讲解：

批量配置：ForAssembly方法扫描整个程序集，自动将实现了IApplicationService（应用服务接口）的类暴露为API。AddControllers中的选项可全局设置路由前缀（如api/v2）、过滤服务类型等。
单独配置：For<TService>方法针对单个服务接口进行配置，通过参数指定路由前缀（如book-store/custom-books），生成的API路由会变为/api/book-store/custom-books/[方法名]。
默认路由规则：若不手动指定，ABP会按“服务名称+方法名”生成路由。例如BookAppService的GetAsync方法，默认路由为/api/app/book/get（app是默认前缀，book是服务名缩写）。