如何在.NET Core中实现可跨项目复用的API模块及控制器动作重写

针对你想要创建可复用API模块、让控制器包含可重写动作的需求，我给你一套基于C#虚方法/抽象方法的实现方案，完全适配你现有的项目结构：

核心思路 #

利用C#的**虚方法（virtual）或抽象方法（abstract）**机制，在基类控制器中定义通用的API动作入口，同时留出可扩展的重写点，让派生控制器根据具体API的业务需求自定义实现逻辑。

1. 重构基类控制器（Module/Controllers/ModuleController.cs） #

将基类控制器定义为抽象类（或保留普通类但标记可重写方法为virtual），封装通用的API端点逻辑，把需要定制的业务逻辑抽成可重写的方法：

using Microsoft.AspNetCore.Mvc;

namespace Module.Controllers
{
    [ApiController]
    [Route("api/[controller]")]
    // 用抽象类强制派生控制器实现必要逻辑，或保留普通类用virtual方法提供默认实现
    public abstract class ModuleController : ControllerBase
    {
        // 定义可重写的核心业务方法，默认基于Module中的Model实现
        protected abstract Task<IActionResult> GetEntityByIdAsync(int id);
        
        // 通用API端点，调用可重写的业务方法
        [HttpGet("{id}")]
        public async Task<IActionResult> Get(int id)
        {
            return await GetEntityByIdAsync(id);
        }

        // 同理，封装POST动作的可重写入口
        protected abstract Task<IActionResult> CreateEntityAsync(IModel model);

        [HttpPost]
        public async Task<IActionResult> Post([FromBody] IModel model)
        {
            if (!ModelState.IsValid)
                return BadRequest(ModelState);
            
            return await CreateEntityAsync(model);
        }
    }
}

如果希望基类提供默认实现（比如通用的CRUD逻辑），可以把抽象方法改成virtual并添加默认代码：

protected virtual async Task<IActionResult> GetEntityByIdAsync(int id)
{
    // 这里写通用默认逻辑，比如从基础数据源获取Model
    var defaultModel = new Model { Id = id };
    return Ok(defaultModel);
}

2. 实现派生控制器（API/Controllers/DerivedModuleController.cs） #

在API项目中继承基类控制器，重写需要自定义的业务方法，适配当前API的模型和业务逻辑：

先假设API项目有自定义模型（实现IModel接口）：

// API/Models/CustomModel.cs
using Module.Interfaces;

namespace API.Models
{
    public class CustomModel : IModel
    {
        public int Id { get; set; }
        public string CustomField { get; set; } // API专属字段
    }
}

然后实现派生控制器：

using Microsoft.AspNetCore.Mvc;
using API.Models;

namespace API.Controllers
{
    [Route("api/[controller]")]
    public class DerivedModuleController : Module.Controllers.ModuleController
    {
        // 重写基类的获取方法，实现API专属逻辑
        protected override async Task<IActionResult> GetEntityByIdAsync(int id)
        {
            // 模拟API项目的数据源查询逻辑
            var customEntity = new CustomModel 
            { 
                Id = id, 
                CustomField = $"API专属数据 {id}" 
            };
            return Ok(customEntity);
        }

        // 重写创建方法，处理API自定义模型
        protected override async Task<IActionResult> CreateEntityAsync(Module.Interfaces.IModel model)
        {
            if (model is CustomModel customModel)
            {
                customModel.Id = new Random().Next(1000);
                customModel.CustomField ??= "默认值";
                return CreatedAtAction(nameof(Get), new { id = customModel.Id }, customModel);
            }
            return BadRequest("无效的模型类型");
        }
    }
}

3. 关键注意事项 #

• 抽象类 vs 虚方法：如果基类不需要默认实现，用抽象类+抽象方法强制派生类必须实现逻辑；如果有通用逻辑需要复用，用虚方法让派生类可选重写。
• 契约一致性：通过IModel接口保证基类和派生类的模型遵循统一契约，方便基类处理通用参数校验、路由等逻辑。
• 路由灵活性：派生控制器可以通过[Route]特性自定义路由，覆盖或继承基类的路由规则。

内容的提问来源于stack exchange，提问作者Duke Cyrillus