动态 API 控制器生成 — 功能与实现原理一、核心功能动态 API 控制器生成是 Furion/JNPF 框架的核心特性之一它允许开发者创建普通的服务类Service无需继承ControllerBase也无需手动写[Route]和[HttpMethod]特性框架会自动将这些服务类转换为完整的 API 控制器。核心价值零配置路由服务类自动注册为 API 接口命名约定驱动方法名前缀自动映射 HTTP 方法自动参数绑定智能识别[FromBody]、[FromRoute]等模块化支持支持外部程序集和插件动态加载二、实现流程1. 服务注册阶段在 [Startup.cs]中调用services.AddControllers().AddDynamicApiControllers();[DynamicApiControllerServiceCollectionExtensions.cs]的核心逻辑步骤操作说明1加载程序集部件将所有项目程序集添加到ApplicationPartManager2注册特性提供器添加DynamicApiControllerFeatureProvider3注册应用模型转换器添加DynamicApiControllerApplicationModelConvention4注册配置选项添加DynamicApiControllerSettingsOptions2. 控制器识别机制[DynamicApiControllerFeatureProvider.cs]继承自ControllerFeatureProvider重写IsController()方法protectedoverrideboolIsController(TypeInfotypeInfo){returnPenetrates.IsApiController(typeInfo);}[Penetrates.cs]中的识别规则internalstaticboolIsApiController(Typetype){// 排除非公开、抽象类、接口、泛型类等if(!type.IsPublic||type.IsAbstract||type.IsInterface||type.IsGenericType)returnfalse;// 识别条件满足任一即可if(typeof(ControllerBase).IsAssignableFrom(type)// 继承 ControllerBase||typeof(IDynamicApiController).IsAssignableFrom(type)// 实现 IDynamicApiController||type.IsDefined(typeof(DynamicApiControllerAttribute))// 贴有 [DynamicApiController] 特性||type.IsDefined(typeof(RouteAttribute)))// 贴有 [Route] 特性{returntrue;}returnfalse;}3. 路由与 HTTP 方法自动生成[DynamicApiControllerApplicationModelConvention.cs]实现了IApplicationModelConvention在 MVC 应用模型构建阶段自动配置HTTP 方法映射规则方法名前缀HTTP 方法Post、Add、Create、Insert、SubmitPOSTGet、Find、Fetch、QueryGETPut、UpdatePUTDelete、Remove、ClearDELETEPatchPATCH路由模板生成逻辑// 默认路由格式{DefaultRoutePrefix}/{Module}/[controller]/[action]// 默认值api/system/userinfo/get三、实际应用示例假设你有一个服务类publicclassUserInfoService{publicUserInfoOutputGetUserInfo(stringuserId){...}publicvoidCreateUser(UserInfoInputinput){...}publicvoidUpdateUser(UserInfoInputinput){...}publicvoidDeleteUser(stringuserId){...}}框架会自动生成以下 APIHTTP 方法路由路径说明GET/api/system/userinfo/userinfo获取用户信息POST/api/system/userinfo创建用户PUT/api/system/userinfo更新用户DELETE/api/system/userinfo删除用户注意默认会移除Service后缀和方法名中的谓词前缀Get/Post等四、配置选项[DynamicApiControllerSettingsOptions.cs]提供了丰富的配置项配置项默认值说明DefaultRoutePrefixapi默认路由前缀DefaultHttpMethodPOST默认 HTTP 方法LowercaseRoutetrue小写路由AbandonControllerAffixesService,Controller等需要移除的控制器后缀AbandonActionAffixesAsync需要移除的方法后缀KeepVerbfalse是否保留方法名中的谓词五、整体架构图┌─────────────────────────────────────────────────────────────┐ │ 应用启动阶段 │ ├─────────────────────────────────────────────────────────────┤ │ 1. AddControllers() │ │ └── 注册 MVC 服务 │ ├─────────────────────────────────────────────────────────────┤ │ 2. AddDynamicApiControllers() │ │ ├── 加载所有程序集到 ApplicationPartManager │ │ ├── 注册 DynamicApiControllerFeatureProvider │ │ └── 注册 DynamicApiControllerApplicationModelConvention │ └─────────────────────────────────────────────────────────────┘ │ ▼ ┌─────────────────────────────────────────────────────────────┐ │ MVC 应用模型构建阶段 │ ├─────────────────────────────────────────────────────────────┤ │ 1. ControllerFeatureProvider.IsController() │ │ └── 扫描所有程序集识别符合条件的类 │ ├─────────────────────────────────────────────────────────────┤ │ 2. DynamicApiControllerApplicationModelConvention.Apply() │ │ ├── 配置控制器名称移除后缀 │ │ ├── 生成路由模板 │ │ ├── 根据方法名前缀映射 HTTP 方法 │ │ ├── 配置参数绑定FromBody/FromRoute │ │ └── 添加统一结果特性 │ └─────────────────────────────────────────────────────────────┘ │ ▼ ┌─────────────────────────────────────────────────────────────┐ │ API 路由注册完成 │ │ (可通过 Swagger 查看) │ └─────────────────────────────────────────────────────────────┘六、总结核心设计思想通过命名约定和应用模型约定将普通服务类自动转换为 API 控制器大幅减少样板代码。关键技术点ASP.NET Core MVC 扩展点利用ControllerFeatureProvider和IApplicationModelConvention两个扩展点反射扫描在应用启动时扫描所有程序集识别符合条件的服务类约定优于配置通过方法名前缀、类名后缀等约定自动生成路由和 HTTP 方法模块化支持支持外部程序集和插件动态加载