asp.net core webapi 异步和返回值

持久的胜利

已于 2022-10-07 16:32:48 修改

阅读量2.5k

点赞数

分类专栏： .NET 文章标签： c# .net

于 2022-09-30 16:31:22 首次发布

本文链接：https://blog.csdn.net/q8812345qaz/article/details/127125018

版权

.NET 专栏收录该内容

67 篇文章 3 订阅

订阅专栏

"本文介绍了ASP.NET Core中WebAPI的使用方法，包括同步和异步方法的实现，如`[HttpGet]`与`[HttpGet("[Action]")]`的区别。同时展示了不继承`ControllerBase`时如何配置API控制器，以及WebAPI返回不同类型数据的处理，如普通类、`IActionResult`和`ActionResult<T>`。通过实例代码详细解析了各种用法。"

摘要由CSDN通过智能技术生成

1. webapi的方法可以同步也可以异步如下测试代码

有异步 [httpget]要加上 [action] 。否则报错

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace aspnetcore004.Controllers
{
    //有异步 [httpget]要加上 [action] 否则报错
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class TestController : ControllerBase
    {
        //下面为同步方法
        [HttpGet]
        public int Add(int i , int j)
        {
            return i+j;
        }
        //下面为异步方法，框架调用，直接使用
        [HttpGet]
        public async Task<string> Test()
        {
            string s =await System.IO.File.ReadAllTextAsync("D:/1.txt");
            return s;
        }
    }
}

2. webapi 控制器可以不继承 ControllerBase也可以使用，主要方便单元测试如下代码

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace aspnetcore004.Controllers
{
    //不继承 controllerbase 需要写下面 两个 特性 框架可以识别出api接口
    [Route("api/[controller]")]
    [ApiController]
    public class Test2Controller
    {
        [HttpGet]
        public int Add(int i ,int j)
        {
            return i + j;
        }
    }
}

3.webapi 返回普通类类型默认为json格式

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace aspnetcore004.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class Test3Controller : ControllerBase
    {
        [HttpGet]
        public Person GetPerson()
        {
            return new Person(1, "张三");
        }
    }
}


//返回结果为
{
  "id": 1,
  "name": "张三"
}

4. webapi 可以返回 IActionResult 和 ActionResult<类型>

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace aspnetcore004.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class Test4Controller : ControllerBase
    {
        //第一种写法
        public IActionResult GetGrade(int id)
        {
            if(id == 1)
            {
                //返回的是int 这里只能用 ok函数做为转换 
                return Ok(88);
            }else if (id == 2)
            {
                return Ok(99);
            }
            else
            {
                //重点是这里 ，如果 webapi不返回 IActionResult 则不可使用NotFound
                //这个是 返回一个 404 错误 并且显示错误信息。
                return NotFound("id错误，没有找到");
            }
        }

        //第二种写法
        public ActionResult<int> GetGrade2(int id)
        {
            if (id == 1)
            {
                //第二种方法 直接 返回 int 因为 IActionResult 派生 ActionResult
                return 88;
            }
            else if (id == 2)
            {
                return 99;
            }
            else
            {
                //它的返回值 继承 ActionResult
                return NotFound("id错误，没有找到");
            }
        }
    }
}