ASP.NET Core MVC/WebAPi如何构建路由?

前言

本节我们来讲讲ASP.NET Core中的路由,在讲路由之前我们首先回顾下之前所讲在ASP.NET Core中的模型绑定这其中有一个问题是我在项目当中遇见的,我们下面首先来看看这个问题。

回顾ASP.NET Core模型绑定

我们有这样一个场景:修改个人资料中的各个属性,此时每个属性的值的类型肯定是不一样的,所以我们将值定义为object,如下model。

    public class BlogViewModel
    {
        public string prop { get; set; }
        public object value { get; set; }
    }

我们在前台进行提交,如下:

<script type="text/javascript">
        $(function () {
            var model = { prop: "Jeffcky", value: "cnblogs" };
            $("#btn").on("click", function () {
                $.ajax({
                    url: "/home/index",
                    type: "post",
                    contentType: "application/x-www-form-urlencoded;charset=utf-8",
                    dataType: "json",
                    data: model,
                    success: function (data) {

                     }
                });
            });
        });
</script>

我们在后台接收传递的对象。

       [HttpPost]
        public IActionResult Index(BlogViewModel model)
        {
            return View();
        } 

此时我们看到将值类型定义为object根本接收不到值,当我将其修改为string肯定是好使的。之前以为利用表单接收任何对象都是好使的,在实际应用时却不如我们所期望的那样(对于此种情况暂时未找到解决方案)。在这种情况下我只好利用contentType:"application/json"来解决,如下:

       $(function () {
            var model = { prop: "Jeffcky", value: "cnblogs" };
            $("#btn").on("click", function () {
                $.ajax({
                    url: "/home/index",
                    type: "post",
                    contentType: "application/json;charset=utf-8",
                    dataType: "json",
                    data: JSON.stringify(model),
                    success: function (data) {

                     }
                });
            });
        });
        [HttpPost]
        public IActionResult Index([FromBody] BlogViewModel model)
        {
            return View();
        }

只能转换思维来解决,好了到了这里我们对于对象利用模型绑定遇到的问题到此结束,接下来我们开始讲述路由。 

ASP.NET Core MVC/WebAPi路由作用 

无论是在ASP.NET MVC/WebAPi还是ASP.NET Core MVC/WebAPi,我们都一直在讲路由,为什么每次都要拿出来说呢,因为它重要,从前台到后台的数据交互需要通过路由解决,所以我们需要在ASP.NET Core重点拿出来讲,我们得好好说说路由的好处是什么呢,请往下看。

(1)SEO

SEO即Search Engine Optimization,我们翻译过来就是搜索引擎优化,引入路由就是为了呈现友好的SEO,一个友好的SEO即能够非常准确的描述需要请求的资源,对于用户而言它能更好的去获取想要的内容,可以增加网址访问的次数,当然了也可以是网址易于收录到搜索引擎中。

(2)URL不需要映射到文件

如果没有路由的话,如果过来一个请求此时需要映射到磁盘上真实存在的物理文件,有了路由我们可以完全控制过来的请求,当一个确定的HTTP请求过来时我们可以引导到其到某个控制器上对应的action方法。

(3)长的URL和扩展都将会被淘汰

我们能够知道当我们访问一个页面时有些直接以扩展名为.aspx或者html呈现,现在我们有了路由,完全不需要扩展名并且会缩短URL的长度。

好了我们讲完路由的好处,我们就要看看在ASP.NET Core中的路由到底是怎样的呢。

ASP.NET Core MVC/WebAPi路由方式

创建默认路由

这个就不用多讲了,当我们创建ASP.NET Core应用程序时在Startup中就会创建默认的路由如下:

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc();
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
    {
        app.UseMvc(routes =>
        {
            routes.MapRoute(
                name: "default",
                template: "{controller=Home}/{action=Index}/{id?}");
        });
    }
}

这是默认给我们创建的,看着有点不太舒服,我还是习惯将其修改如下等同的路由配置。

        app.UseMvc(routes =>
        {
             routes.MapRoute(
                name: "default",
                template: "{controller}/{action}/{id?}",
                defaults: new { controller = "Home", action = "Index" });
        });

扩展默认路由

上述只是我们创建的默认路由,当我们需要额外进行自定义扩展对于特定需求,所以我们如上类似再来扩展一个路由。

            app.UseMvc(routes =>
            {         //扩展路由
                routes.MapRoute(
                    name: "about-route",
                    template: "about",
                    defaults: new { controller = "Home", action = "About" });

                routes.MapRoute(
                    name: "default",
                    template: "{controller}/{action}/{id?}",
                    defaults: new { controller = "Home", action = "Index" });
            });

使用路由特性

我们也可以配置路由特性针对控制器和Action方法,如下:

    [Route("[controller]")]
    public class HomeController : Controller
    {
        private IBlogRepository _blogRepository;
        public HomeController(IBlogRepository blogRepository)
        {
            _blogRepository = blogRepository;
        }

        [Route("[action]")]
        public IActionResult Index()
        {

            return View();
        }

        [Route("Index")]
        [HttpPost]
        public IActionResult Index([FromBody] BlogViewModel model)
        {
            return View();
        }
    }

上述[Route("[controller]")]和[Route("[action]")])都是引用的声明的控制器名称和方法名称,即Home控制器和Index方法,所以上述两个action方法都是匹配的/Home/Index只是请求方式不同而已。在官网中有使用路由中间件的方式,有需要的可以参考一下:【https://docs.microsoft.com/en-us/aspnet/core/fundamentals/routing

RESTful风格路由 

对于RESTful风格路由我们更多的是用在请求ASP.NET Core WebAPi接口上,如下:

    [Route("api/[controller]")]
    public class Blog : Controller
    {
        [HttpGet]  // api/blog
        public IEnumerable<string> Get()
        {
            return new string[] { "hello", "world!" };
        }

        [HttpPost("Post")]  //  api/blog/post
        public IActionResult PostBlog([FromBody] BlogViewModel model)
        {
            return View();
        }
    }

那么问题来了,如果是有参数我们该进行如何传递呢,当然有解决方案,如下:

        [HttpPost("{id}")]
        public void PostUpdate(int id, [FromBody] string value)
        {

        }

此时前台请求如下:

          $("#btn").on("click", function () {
                $.ajax({
                    url: "/api/blog/2",
                    type: "post",
                    contentType: "application/json;charset=utf-8",
                    dataType: "json",
                    data: JSON.stringify("Jeffcky"),
                    success: function (data) {

                    }
                });
            });

使用约束 

对于参数类型是否非法,我们通过对参数进行约束来达到我们得目的,如下:

        [HttpPost("{id:int}")]
        public void PostUpdate(int id, [FromBody] string value)
        {

        }

或者对参数约束为guid,如下:

        [HttpPost("{id:guid}")]
        public void PostUpdate(string id, [FromBody] string value)
        {

        }

当然还有其他类型参数约束就不一一列举了。

总结 

本节我们讲解了ASP.NET Core中的路由使用,比较基础性的东西,更深入的东西参看官网资料,如若有不太理解和有所疑惑的地方请在评论中指出看到会马上回复。

时间: 2024-09-20 11:40:49

ASP.NET Core MVC/WebAPi如何构建路由?的相关文章

ASP.NET Core MVC/WebAPi 模型绑定探索

前言 相信一直关注我的园友都知道,我写的博文都没有特别枯燥理论性的东西,主要是当每开启一门新的技术之旅时,刚开始就直接去看底层实现原理,第一会感觉索然无味,第二也不明白到底为何要这样做,所以只有当你用到了,你再去看理论性的文章时才会豁然开朗,这是我一直以来学习技术的方法.本文我们来讲解.NET Core中的模型绑定. 话题 在ASP.NET Core之前MVC和Web APi被分开,也就说其请求管道是独立的,而在ASP.NET Core中,WebAPi和MVC的请求管道被合并在一起,当我们建立控

ASP.NET Core MVC 配置全局路由前缀_实用技巧

ASP.NET Core MVC 配置全局路由前缀 前言 大家好,今天给大家介绍一个 ASP.NET Core MVC 的一个新特性,给全局路由添加统一前缀.严格说其实不算是新特性,不过是Core MVC特有的. 应用背景 不知道大家在做 Web Api 应用程序的时候,有没有遇到过这种场景,就是所有的接口都是以 /api 开头的,也就是我们的api 接口请求地址是像这样的: http://www.example.com/api/order/333 或者是这样的需求 http://www.exa

【翻译】在Visual Studio中使用Asp.Net Core MVC创建你的第一个Web API应用(一)

HTTP is not just for serving up web pages. It's also a powerful platform for building APIs that expose services and data. HTTP is simple, flexible, and ubiquitous. Almost any platform that you can think of has an HTTP library, so HTTP services can re

解决ASP.NET Core Mvc文件上传限制问题实例_实用技巧

一.简介 在ASP.NET Core MVC中,文件上传的最大上传文件默认为20MB,如果我们想上传一些比较大的文件,就不知道怎么去设置了,没有了Web.Config我们应该如何下手呢? 二.设置上传文件大小 1.应用程序级别设置 我们需要在 ConfigureServices方法中添加如下代码,设置文件上传的大小限制为60 MB. public void ConfigureServices(IServiceCollection services) { servicesConfigure<For

ASP.NET Core MVC上传、导入、导出功能详解

前言 本君已成夜猫子,本节我们来讲讲ASP.NET Core MVC中的上传,这两天在研究批量导入功能,本节顺便简单搞搞导入.导出,等博主弄妥当了再来和大家一并分享. .NET Core MVC上传 首先我们来看看官网的上传的例子,再然后进行拓展训练,官网的表单是这样的. <form method="post" enctype="multipart/form-data" asp-controller="UploadFiles" asp-ac

ASP.NET Core MVC压缩样式、脚本及总是复制文件到输出目录

前言 在.NET Core之前对于压缩样式文件和脚本我们可能需要借助第三方工具来进行压缩,但在ASP.NET MVC Core中则无需借助第三方工具来完成,本节我们来看看ASP.NET Core MVC为我们提供了哪些方便. 自动压缩样式和脚本 当我们在测试环境中肯定不需要压缩脚本的,如果一旦压缩脚本的话,若在控制台出现错误不利于我们调试,但是在生产环境中我们通过压缩脚本或者样式一来可以减少传输流量,二来可以加速页面加载时间,换句话说,此时我们需要测试环境和生产环境对应的原生版本和压缩版本,那么

ASP.NET Core MVC之Serilog日志处理,你了解多少?

前言 本节我们来看看ASP.NET Core MVC中比较常用的功能,对于导入和导出目前仍在探索中,项目需要自定义列合并,所以事先探索了如何在ASP.NET Core MVC进行导入.导出,更高级的内容还需等我学习再给出. EntityFramework Core 在学习ASP.NET Core MVC之前我们来看看在EF Core中如何更新对象指定属性,这个问题之前我们已经探讨过,但是还是存在一点问题,请往下看. public void Update(T entity, params Expr

ASP.NET Core MVC之ViewComponents(视图组件)知多少?

前言 大概一个来星期未更新博客了,久违了各位,关于SQL Server性能优化会和ASP.NET Core MVC穿插来讲,如果你希望我分享哪些内容可以在评论下方提出来,我会筛选并看看技术文档来对你的内容进行解答,借此希望我们能共同进步和学习.本节我们来讲讲ASP.NET Core  MVC中的视图组件. Web应用程序下管理ViewComponents 我是奔着项目用到了哪些就会去写对应的技术博客,在我们项目中利用视图组件来加载权限菜单,这一块是我老大所做,我也就粗略看了看使用方法并未深入借此

ASP.NET Core MVC上传、导入、导出知多少

前言 本君已成夜猫子,本节我们来讲讲ASP.NET Core MVC中的上传,这两天在研究批量导入功能,本节顺便简单搞搞导入.导出,等博主弄妥当了再来和大家一并分享. .NET Core MVC上传 首先我们来看看官网的上传的例子,再然后进行拓展训练,官网的表单是这样的. <form method="post" enctype="multipart/form-data" asp-controller="UploadFiles" asp-ac