如何在.NET类库中添加ASP.NET Core控制器与视图并解决加载问题

一、修复类库视图加载问题 #

如果坚持使用Razor视图，需确保嵌入资源配置正确，并添加视图定位逻辑：

1. 标记视图为嵌入资源
   在类库的.csproj文件中添加以下配置，确保所有视图文件被嵌入到程序集：

   <ItemGroup>
     <EmbeddedResource Include="Views/**/*.cshtml" />
     <Content Remove="Views/**/*.cshtml" />
   </ItemGroup>
   

2. 实现自定义视图定位器
   创建IViewLocationExpander的实现，让ASP.NET Core能够定位到类库中的嵌入视图：

   public class ClassLibraryViewExpander : IViewLocationExpander
   {
       public IEnumerable<string> ExpandViewLocations(ViewLocationExpanderContext context, IEnumerable<string> viewLocations)
       {
           // 添加类库专属的视图路径模板
           var libraryViewPaths = new[]
           {
               "/LibViews/{1}/{0}.cshtml",
               "/LibViews/Shared/{0}.cshtml"
           };
           return libraryViewPaths.Concat(viewLocations);
       }
   
       public void PopulateValues(ViewLocationExpanderContext context)
       {
           // 无需额外参数，留空即可
       }
   }
   

3. 注册视图定位器与控制器
   创建扩展方法，让引用项目一键注册类库UI服务，同时通过路由前缀避免冲突：

   public static class LibraryUiServiceExtensions
   {
       public static IServiceCollection AddLibraryConfigUi(this IServiceCollection services)
       {
           // 注册视图定位器
           services.Configure<RazorViewEngineOptions>(opts =>
           {
               opts.ViewLocationExpanders.Add(new ClassLibraryViewExpander());
           });
   
           // 注册类库中的控制器
           services.AddControllersWithViews()
                   .AddApplicationPart(typeof(LibraryUiServiceExtensions).Assembly);
   
           return services;
       }
   
       public static IApplicationBuilder UseLibraryConfigUi(this IApplicationBuilder app)
       {
           // 给类库控制器添加专属路由前缀，彻底避免冲突
           app.UseEndpoints(endpoints =>
           {
               endpoints.MapControllerRoute(
                   name: "libraryConfigUi",
                   pattern: "lib-config/{controller=Config}/{action=Index}/{id?}");
           });
           return app;
       }
   }
   

二、无需视图的替代方案（推荐） #

参考Swashbuckle的实现思路，采用静态前端资源+API的模式，完全避开视图加载问题：

1. 打包静态UI为嵌入资源
   用React/Vue等框架编写配置UI页面，打包为静态文件（HTML/CSS/JS），然后在类库.csproj中标记为嵌入资源：

   <ItemGroup>
     <EmbeddedResource Include="wwwroot/**/*" />
   </ItemGroup>
   

2. 实现静态资源中间件
   创建中间件，从嵌入资源中读取静态文件并返回给客户端，同时设置专属路由前缀：

   public class LibraryUiMiddleware
   {
       private readonly RequestDelegate _next;
       private readonly string _routePrefix;
   
       public LibraryUiMiddleware(RequestDelegate next, string routePrefix = "lib-config-ui")
       {
           _next = next;
           _routePrefix = routePrefix.StartsWith("/") ? routePrefix : $"/{routePrefix}";
       }
   
       public async Task InvokeAsync(HttpContext context)
       {
           var requestPath = context.Request.Path.Value;
           if (!requestPath.StartsWith(_routePrefix, StringComparison.OrdinalIgnoreCase))
           {
               await _next(context);
               return;
           }
   
           // 处理根路径，默认返回index.html
           if (requestPath == _routePrefix || requestPath == $"{_routePrefix}/")
           {
               context.Request.Path = $"{_routePrefix}/index.html";
           }
   
           // 拼接嵌入资源的路径
           var resourcePath = $"YourLibraryNamespace.wwwroot{context.Request.Path.Value.Replace(_routePrefix, "")}";
           using var resourceStream = typeof(LibraryUiMiddleware).Assembly.GetManifestResourceStream(resourcePath);
           
           if (resourceStream == null)
           {
               await _next(context);
               return;
           }
   
           // 设置正确的Content-Type
           context.Response.ContentType = GetContentType(context.Request.Path.Value);
           await resourceStream.CopyToAsync(context.Response.Body);
       }
   
       private string GetContentType(string path)
       {
           var ext = Path.GetExtension(path).ToLowerInvariant();
           return ext switch
           {
               ".html" => "text/html",
               ".css" => "text/css",
               ".js" => "application/javascript",
               ".json" => "application/json",
               _ => "application/octet-stream"
           };
       }
   }
   
   // 扩展方法注册中间件
   public static class LibraryUiMiddlewareExtensions
   {
       public static IApplicationBuilder UseLibraryConfigUi(this IApplicationBuilder app, string routePrefix = "lib-config-ui")
       {
           return app.UseMiddleware<LibraryUiMiddleware>(routePrefix);
       }
   }
   

3. 搭配API接口处理配置逻辑
   在类库中创建无视图的API控制器，负责配置的读写，同样添加路由前缀避免冲突：

   [Route("lib-config-api/[controller]")]
   [ApiController]
   public class ConfigController : ControllerBase
   {
       [HttpGet]
       public IActionResult GetCurrentConfig()
       {
           // 返回当前配置数据
           return Ok(new { MaxItems = 100, EnableLogging = true });
       }
   
       [HttpPost]
       public IActionResult UpdateConfig([FromBody] ConfigDto dto)
       {
           // 执行配置更新逻辑
           return Ok("配置已保存");
       }
   }
   

这种方案和Swashbuckle的实现逻辑一致，既解决了视图加载问题，又通过路由前缀彻底避免了路由冲突。

内容的提问来源于stack exchange，提问作者Matthew Groves