草庐IT

c# - 如何使用 AddMvcCore() 实现 "pure"ASP.NET Core Web API

coder 2023-07-09 原文

我见过很多使用默认的 ASP.NET Core Web API 项目 AddMvc()服务而没有意识到使用 AddMvcCore()由于对服务的控制,是一个更好的选择。

如何使用 AddMvcCore() 来实现 ASP.NET Core Web API和 为什么更好?

最佳答案

AddMvc()有什么区别和 AddMvcCore() ?

首先要了解的关键是AddMvc()只是AddMvcCore()的预装版本.您可以看到 AddMvc() 的确切实现分机地址为 GitHub repository .

我和下一个人一样喜欢使用默认的 VS 模板,但有时你需要知道什么时候是错误的选择。我在网上看到了几个指南,它们更倾向于尝试“撤消”这些默认服务,而不是仅仅使用一开始就没有实现它们的解决方案。

随着 ASP.NET Core 开源的出现,我们真的没有充分的理由不能剥离一层并在较低级别上工作而不担心失去“魔力”。

“最小”和“纯”的定义

注意:这些定义仅用于本答案的上下文。主要是为了清楚起见并帮助进一步理解。

这个答案更倾向于“纯粹”而不是“最小”。我想描述一下原因,这样我在说什么就更清楚了。

最小。 “最小”解决方案是实现 甚至不调用 AddMvcCore() 方法 .这样做的原因是 MVC 并不是组装您自己的 Web API 的真正“必需”组件,并且它肯定会为您的代码增加一些额外的依赖项。在这种情况下,由于您没有使用 AddMvcCore()方法,您也不会将其注入(inject)您的应用程序,这里

public void Configure(IApplicationBuilder app)
{
    app.UseMvc(); // you don't need this
}

这意味着映射您自己的路线并响应 context以你自己的方式。这真的一点也不具有挑战性,但我不想深入研究它,因为它非常离题,但是 这是一个最小实现的小味道 :
public void Configure(IApplicationBuilder app)
{
    app.Map("/api", HandleMapApi);
    // notice how we don't have app.UseMvc()?
}    

private static void HandleMapApi(IApplicationBuilder app)
{
    app.Run(async context =>
    {
        // implement your own response
        await context.Response.WriteAsync("Hello WebAPI!");
    });
}

对于许多项目,“最小”方法意味着我们放弃了 MVC 中的一些功能。你真的必须权衡你的选择,看看你这个设计路径是否是正确的选择,因为设计模式、便利性、可维护性、代码占用空间以及最重要的性能和延迟之间存在平衡。 简单地说:“最小”解决方案意味着最小化代码和请求之间的服务和中间件。

纯的。 “纯”解决方案(就本答案的上下文而言)是避免使用 AddMvc()“预捆绑”的所有默认服务和中间件|通过不首先实现它。相反,我们使用 AddMvcCore() ,这将在下一节中进一步解释:

使用 AddMvcCore() 实现我们自己的服务/中间件

开始的第一件事是设置 ConfigureServices使用 AddMvcCore() .如果你看 GitHub repository ,你可以看到 AddMvc()电话AddMvcCore()使用一组标准的服务/中间件:

以下是一些“不需要”的服务/中间件:

var builder = services.AddMvcCore();

builder.AddViews();
builder.AddRazorViewEngine();
builder.AddRazorPages();


许多这些默认服务非常适合一般的 Web 项目,但通常不适合“纯”Web API。

这是 ConfigureServices 的示例实现使用 AddMvcCore()对于 Web API:
public void ConfigureServices(IServiceCollection services)
{
    // Build a customized MVC implementation, without using the default AddMvc(),
    // instead use AddMvcCore(). The repository link is below:
    // https://github.com/aspnet/Mvc/blob/release/2.2/src/Microsoft.AspNetCore.Mvc/MvcServiceCollectionExtensions.cs

    services
        .AddMvcCore(options =>
        {
            options.RequireHttpsPermanent = true; // this does not affect api requests
            options.RespectBrowserAcceptHeader = true; // false by default
            //options.OutputFormatters.RemoveType<HttpNoContentOutputFormatter>();

            // these two are here to show you where to include custom formatters
            options.OutputFormatters.Add(new CustomOutputFormatter());
            options.InputFormatters.Add(new CustomInputFormatter());
        })
        //.AddApiExplorer()
        //.AddAuthorization()
        .AddFormatterMappings()
        //.AddCacheTagHelper()
        //.AddDataAnnotations()
        //.AddCors()
        .AddJsonFormatters();
}

上面的实现主要是 AddMvc() 的副本。扩展方法,但是我添加了一些新区域,以便其他人可以看到这样做的额外好处。
  • 自定义输入/输出格式化程序。 在这里,您可以执行自己的高度优化的序列化程序(例如 Protobuf、Thrift、Avro 等),而不是使用 JSON(或更糟的 XML)序列化。
  • 请求头处理。 您可以确保 Accept header 是否被识别。
  • 授权处理。 您可以实现自己的自定义授权,也可以利用内置功能。
  • 应用程序浏览器。 对于某些项目,您可能会包含它,否则某些 WebAPI 可能不需要此功能。
  • 跨域请求 (CORS)。 如果您需要更宽松的 WebAPI 安全性,您可以启用它。

  • 希望通过这个“纯”解决方案的例子,您可以看到使用 AddMvcCore() 的好处。并乐于使用它。

    如果您在 ASP.NET Core 的 Web 主机之上工作时认真对待对性能和延迟的控制,那么深入研究“最小”解决方案就是您在请求管道的边缘进行处理,而不是让它被 MVC 中间件所拖累。

    补充阅读

    中间件管道的可视化外观……根据我的定义,较少的层意味着“最小”,而“纯”只是 MVC 的一个干净版本。



    您可以在 Microsoft 文档中阅读更多相关信息:ASP.NET Core Middleware Fundamentals

    关于c# - 如何使用 AddMvcCore() 实现 "pure"ASP.NET Core Web API,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/42365275/

    有关c# - 如何使用 AddMvcCore() 实现 "pure"ASP.NET Core Web API的更多相关文章

    1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

      我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

    2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

      总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

    3. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

      我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

    4. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

      类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

    5. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

      很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

    6. ruby - 在 Ruby 中使用匿名模块 - 2

      假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

    7. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

      我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

    8. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

      关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

    9. ruby-on-rails - rails : "missing partial" when calling 'render' in RSpec test - 2

      我正在尝试测试是否存在表单。我是Rails新手。我的new.html.erb_spec.rb文件的内容是:require'spec_helper'describe"messages/new.html.erb"doit"shouldrendertheform"dorender'/messages/new.html.erb'reponse.shouldhave_form_putting_to(@message)with_submit_buttonendendView本身,new.html.erb,有代码:当我运行rspec时,它失败了:1)messages/new.html.erbshou

    10. ruby-on-rails - 由于 "wkhtmltopdf",PDFKIT 显然无法正常工作 - 2

      我在从html页面生成PDF时遇到问题。我正在使用PDFkit。在安装它的过程中,我注意到我需要wkhtmltopdf。所以我也安装了它。我做了PDFkit的文档所说的一切......现在我在尝试加载PDF时遇到了这个错误。这里是错误:commandfailed:"/usr/local/bin/wkhtmltopdf""--margin-right""0.75in""--page-size""Letter""--margin-top""0.75in""--margin-bottom""0.75in""--encoding""UTF-8""--margin-left""0.75in""-

    随机推荐