다음으로 ASP.NET Core Demystified 시리즈에서IActionResult인터페이스 를 구현 하고 해당ActionResult클래스 에서 상속 하는 모든 클래스를 논의하고 시연합니다 . 이러한 클래스는 컨트롤러 작업의 응답으로 사용되며 다른 사이트로 리디렉션, 다른 컨트롤러 작업으로 리디렉션, JSON 객체 반환 및 파일을 브라우저로 반환하는 것을 포함합니다.
이 글에서는 먼저 IActionResult인터페이스와 인터페이스에 대해 논의한 다음 인터페이스의 사용 가능한 여러 구현 및 각 인터페이스를 사용할 수있는 시나리오에 대한 데모를 보게됩니다.
샘플 프로젝트
코드가 많은 게시물 과 마찬가지로 GitHub에는이 게시물에서 논의 할 작업 결과를 보여주는 실제 프로젝트가 있습니다. 확인 해봐!
https://github.com/exceptionnotfound/AspNetCoreActionResultsDemo
행동 결과는 무엇입니까?
엄밀히 말하자면 Action Results는 IActionResultASP.NET Core MVC 의 인터페이스 를 구현하는 클래스입니다 . 그러나이 게시물에서 보게 될 모든 작업 결과는 ActionResult클래스 에서 상속됩니다 .
간단히 말해 Action Results는 컨트롤러 작업의 결과로 클라이언트가해야 할 일을 나타내는 클래스입니다. 파일을 가져 오거나 리디렉션하거나 무수히 많은 것들이 필요할 수 있습니다. 일부 조치 결과는 HTTP 상태 코드 만 리턴합니다. 요컨대, 컨트롤러 조치를 호출 한 후 클라이언트가 원할 수있는 가장 일반적인 작업은 조치 결과로 표시됩니다.
주간 뉴스 레터 "캐치 블록"을 받으십시오!
콘텐츠 협상
요청 에 Accept 헤더 가 있는 경우 컨텐츠 협상 ( 약칭 연결 )이 발생합니다 . 서버가 응답을 보낼 형식을 결정하는 프로세스입니다. 기본적으로 ASP.NET Core는 응답에 JSON을 사용하지만 요청 Accept 헤더는 다른 형식 (예 : XML)을 지정할 수 있으며 서버는 지정된 형식으로 응답을 반환하려고 시도합니다.
이미지는 폴란드 바르샤바 협상 라운드 상원 2014 01 이며 위키 미디어에서 발견되며 라이센스에 따라 사용됩니다
서버 가 요청에서 Accept 헤더를 감지 하면 서버가 지원하는 헤더를 찾기 위해 해당 헤더의 미디어 유형을 열거합니다. 서버가 지원할 수있는 미디어 유형이없는 경우 서버는 요청을 생성 할 수있는 지원되는 첫 번째 미디어 유형을 사용합니다 (따라서이 프로세스를 컨텐츠 협상 이라고 하며이 형식을 지금 제게 하지 마십시오 ).
액션 결과 세트
5 가지 주요 작업 결과 세트가 있습니다.
- 상태 코드 결과
- 객체 결과가있는 상태 코드
- 결과 리디렉션
- 파일 결과
- 컨텐츠 결과
이러한 각 세트를 개별적으로 논의하고 그 결과의 종류에 대한 예를 보여줍니다. 이 게시물에서 볼 수있는 모든 데모는 GitHub 의 샘플 프로젝트 에도 있으므로 확인하십시오!
상태 코드 결과
아마도 ASP.NET Core MVC에 의해 정의 된 가장 간단한 종류의 작업 결과는 상태 코드 결과 모음입니다. 이 결과는 단지 클라이언트에게 HTTP 상태 코드를 반환합니다.
OkResult
OkResult(짧은 방법 : Ok()) 반환 200 OK의 상태 코드를.
public IActionResult OkResult()
{
return Ok();
}
CreatedResult
CreatedResult(짧은 방법 : Created()) 반환 만든 201 생성 된 리소스에 URL과 함께합니다.
public IActionResult CreatedResult()
{
return Created("http://example.org/myitem", new { name = "testitem" });
}
NoContentResult
NoContentResult(짧은 방법 : NoContent())를 반환 (204) 내용 없음 서버가 요청을 성공적으로 처리되었음을 나타내는 상태 코드 만 반환에 아무것도 없다는 것을.
public IActionResult NoContentResult()
{
return NoContent();
}
BadRequestResult
BadRequestResult(짧은 방법 BadRequest()) 창 400 잘못된 요청 서버는 상기 요청에 의한 오류로 상기 요청을 처리 할 수 있음을 나타낸다. 요청의 유효성 검사가 실패하고 더 적합한 코드가없는 경우 API에서 종종 사용됩니다.
public IActionResult BadRequestResult()
{
return BadRequest();
}
무단 결과
UnauthorizedResult(짧은 방법 : Unauthorized()) 반환 무단 (401)를 요청하는 사용자가 (정말라고되어 있어야합니다이 상태 코드를 의미 그렇게 할 수있는 적절한 인증이 없기 때문에 요청을 처리 할 수 없음을 나타내는, 401 인증되지 않은를 ).
public IActionResult UnauthorizedResult()
{
return Unauthorized();
}
NotFoundResult
NotFoundResult(짧은 방법 : NotFound())을 반환 (404) 찾을 수 없음 요청 된 자원이, 어떤 이유로, 서버에서 찾을 수 없음을 나타내는 상태 코드.
public IActionResult NotFoundResult()
{
return NotFound();
}
지원되지 않는 MediaTypeResult
UnsupportedMediaTypeResult글을 쓰는 시점에서 짧은 방법이없는 이는, 반환 415 지원되지 않는 미디어 유형 미디어 유형 (요청에 예를 들어, Content-Type 헤더는)이 서버에서 지원하지 않는 것을 나타냅니다. 예를 들어, 사용자가 .bmp 형식으로 이미지를 업로드하려고 시도 할 때 서버는이 상태 코드를 리턴 할 수 있지만 서버는 .jpeg 만 허용 합니다.
public IActionResult UnsupportedMediaTypeResult()
{
return new UnsupportedMediaTypeResult();
}
기타 상태 코드
위의 상태 코드 결과는 가능한 모든 HTTP 상태 코드를 포함하지는 않습니다. 전용 작업 결과가 제공되지 않은 상태 코드를 반환해야하는 상황에서는 일반 StatusCodeResult(짧은 방법 :)을 사용할 수 있습니다 StatusCode().
public IActionResult StatusCodeResult(int statusCode)
{
return StatusCode(statusCode);
}
객체 결과가있는 상태 코드
이러한 작업 결과는 대부분 이전 섹션에서 본 결과의 과부하입니다. 그러나 컨텐츠 협상으로 인해 브라우저 또는 다른 요청자가 다르게 처리합니다.
OkObjectResult
OkObjectResult수익률 200 OK 뿐만 아니라 객체입니다.
public IActionResult OkObjectResult()
{
var result = new OkObjectResult(new { message = "200 OK", currentDate = DateTime.Now });
return result;
}
CreateObjectResult
CreatedObjectResult반환 만든 (201) 및 사용자 정의 객체입니다.
public IActionResult CreatedObjectResult()
{
var result = new CreatedAtActionResult("createdobjectresult", "statuscodeobjects", "", new { message = "201 Created", currentDate = DateTime.Now });
return result;
}
BadRequestObjectResult
은 BadRequestObjectResult당신이하지 무슨 생각을 정확히 수행; 400 잘못된 요청 과 개체를 반환 합니다.
public IActionResult BadRequestObjectResult()
{
var result = new BadRequestObjectResult(new { message = "400 Bad Request", currentDate = DateTime.Now });
return result;
}
NotFoundObjectRequest
지금 당신이 패턴을보고 있다고 상상하십니까? NotFoundObjectRequest반환 (404) 찾을 수 없음 과 객체.
public IActionResult NotFoundObjectResult()
{
var result = new NotFoundObjectResult(new { message = "404 Not Found", currentDate = DateTime.Now });
return result;
}
ObjectResult
위 유형에서 다루지 않는 시나리오의 경우 ObjectResult클래스가 있습니다. 지정된 상태 코드와 객체를 반환합니다.
public IActionResult ObjectResult(int statusCode)
{
var result = new ObjectResult(new { statusCode = statusCode, currentDate = DateTime.Now });
result.StatusCode = statusCode;
return result;
}
결과 리디렉션
때로는 클라이언트 (예 : 브라우저)에게 다른 위치로 리디렉션하도록 지시해야합니다. 리디렉션 결과가 나오는 위치는 클라이언트에게 리디렉션 위치를 알려줍니다. 때로는 동일한 프로젝트에서 다른 작업으로 이동해야하는 경우도 있지만 외부 리소스로 리디렉션해야하는 경우도 있습니다.
RedirectResult
기본 RedirectResult클래스 (short method Redirect():)는 지정된 URL로 리디렉션됩니다.
public IActionResult RedirectResult()
{
return Redirect("https://www.exceptionnotfound.net");
}
LocalRedirectResult
LocalRedirectResult(짧은 방법 : LocalRedirect()) 동일한 응용 프로그램 내에서 URL로 리디렉션. 예를 들어 사이트가 http://www.mysite.com 이고 URL http://www.mysite.com/redirects/target (예 : "redirects"컨트롤러의 "target"작업) 으로 리디렉션하려는 경우 ), 당신은 이렇게 할 수 있습니다 :
public IActionResult LocalRedirectResult()
{
return LocalRedirect("/redirects/target");
}
RedirectToActionResult
매우 일반적인 RedirectToActionResult클래스 (short method RedirectToAction():)는 클라이언트를 동일한 응용 프로그램 내의 특정 작업 및 컨트롤러로 리디렉션합니다. LocalRedirectResult예제 에서와 동일한 리디렉션을 수행하려면 다음을 수행하십시오.
public IActionResult RedirectToActionResult()
{
return RedirectToAction("target");
}
RedirectToRouteResult
ASP.NET Core MVC에는 라우팅 개념이 있으며이를 통해 특정 컨트롤러 및 작업에 매핑되는 URL 템플릿을 만들 수 있습니다. 이에 따라 애플리케이션에 이미 정의 된 특정 경로로 리디렉션되는 결과 RedirectToRouteResult(짧은 방법 :)도 있습니다 RedirectToRoute().
Startup.cs 클래스에 다음 경로가 정의되어 있다고 가정 해 봅시다.
app.UseMvc(routes =>
{
routes.MapRoute(
name: "default",
template: "{controller=Home}/{action=Index}/{id?}");
});
특정 경로와 RedirectToRoute()짧은 방법을 사용하여 리디렉션 하고 이전 두 예제와 동일한 대상 작업으로 끝날 수 있습니다.
public IActionResult RedirectToRouteResult()
{
return RedirectToRoute("default", new { action = "target", controller = "redirects" });
}
파일 결과
요청자에게 파일을 반환해야하는 경우 파일 결과를 통해 다양한 형식을 사용할 수 있습니다.
이 데모에서는 wwwroot / downloads 폴더에 pdf-sample.pdf라는 파일이 있으며이 파일을 사용하여 다양한 파일 결과 클래스의 작동 방식을 보여줍니다.
FileResult
기본 FileResult클래스 (short method File():)는 주어진 경로에서 파일을 반환합니다. 이 경우 경로는 / wwwroot / downloads이므로 작업은 다음과 같습니다.
public IActionResult FileResult()
{
return File("~/downloads/pdf-sample.pdf", "application/pdf");
}
"application / pdf"는 이 파일과 관련된 MIME 유형 입니다.
FileContentResult
주어진 파일의 내용 만 byte[]전체 파일이 아닌 바이트 배열 ( ) 로 반환하려는 경우가 있습니다. 이 시나리오에서는 FileContentResult클래스를 사용할 수 있습니다 . 여전히 MIME 유형을 지정해야합니다.
public IActionResult FileContentResult()
{
//Get the byte array for the document
var pdfBytes = System.IO.File.ReadAllBytes("wwwroot/downloads/pdf-sample.pdf");
//FileContentResult needs a byte array and returns a file with the specified content type.
return new FileContentResult(pdfBytes, "application/pdf");
}
VirtualFileResult
VirtualFileResult클래스를 사용하여 프로젝트의 / wwwroot 폴더에서 파일을 가져올 수도 있습니다 .
public IActionResult VirtualFileResult()
{
//Paths given to the VirtualFileResult are relative to the wwwroot folder.
return new VirtualFileResult("/downloads/pdf-sample.pdf", "application/pdf");
}
PhysicalFileResult
마지막으로 프로젝트의 일부가 아닌 서버의 실제 경로에서 파일을 가져와야 할 경우 PhysicalFileResult클래스를 사용할 수 있습니다 .
public IActionResult PhysicalFileResult()
{
return new PhysicalFileResult(_hostingEnvironment.ContentRootPath + "/wwwroot/downloads/pdf-sample.pdf", "application/pdf");
}
참고 _hostingEnvironment.ContentRootPath응용 프로그램 루트가 아닌 /의 wwwroot 폴더의 경로입니다.
컨텐츠 결과
최종 결과 클래스 세트는 다양한 종류의 컨텐츠를 컨트롤러에 리턴하도록 설계된 컨텐츠 결과 클래스입니다.
ViewResult
아마도 모든 ASP.NET Core MVC에서 가장 기본적인 Result 클래스는 ViewResult클래스 (short method :)이며 View()뷰를 반환합니다.
public IActionResult Index()
{
return View();
}
기본적 View()으로이 메소드는 컨트롤러와 이름이 같은 폴더에서 호출 된 조치와 이름이 같은보기를 리턴합니다. 이 경우 컨트롤러는 "Content"이고 작업은 "Index"이므로 ASP.NET Core MVC는 /Views/Content/Index.cshtml에서 파일을 찾습니다. View()short 메소드의 오버로드를 사용하여 다른 뷰가 리턴되도록 지정할 수 있습니다 .
PartialViewResult
다음 과 같이 클래스 (short method :)를 사용하여 액션에서 부분 뷰 를 반환 할 수도 있습니다 .PartialViewResultPartialView()
public IActionResult PartialViewResult()
{
return PartialView();
}
데모에서 위의 코드는 / Views / Content 디렉토리와 / Views / Shared 디렉토리 모두에서 "PartialViewResult"라는 이름의 뷰를 찾고 / Views / Shared에서 찾습니다.
JsonResult
클래스 를 사용하여 애플리케이션에서 JSON (JavaScript Object Notation) 컨텐츠를 쉽게 리턴 할 수 있습니다 JsonResult(짧은 메소드 :) Json().
public IActionResult JsonResult()
{
return Json(new { message = "This is a JSON result.", date = DateTime.Now });
}
ContentResult
위 카테고리 중 하나에 속하지 않는 컨텐츠를 리턴해야하는 경우 일반 ContentResult오브젝트 (짧은 메소드 Content():)를 사용하여 컨텐츠를 리턴 할 수 있습니다. 데모에서는 간단한 메시지를 리턴하지만이 클래스를 사용하여 MediaTypeHeaderValue 또는 컨텐츠 유형 을 지정하여보다 복잡한 컨텐츠를 리턴 할 수 있습니다 .
public IActionResult ContentResult()
{
return Content("Here's the ContentResult message.");
}
요약
ASP.NET Core MVC의 작업 결과 클래스는 컨트롤러에서 사용할 기능의 상당 부분을 제공합니다. 상태 코드, 객체, 파일, 기타 컨텐츠를 반환하고 클라이언트를 리디렉션합니다. ASP.NET Core MVC와 그 기능에 익숙해 짐에 따라 이러한 클래스는 두 번째 특성이됩니다. 그때까지이 게시물을 빠른 참조로 사용하여 코드를 작성하십시오.
내 자습서와 마찬가지로 GitHub 에는 ASP.NET Core MVC에서 사용할 수있는 모든 동작 결과를 익히는 데 사용할 수 있는 작동 코드 샘플 이 있습니다.
의견 에이 게시물과 데모 프로젝트에 대해 어떻게 생각했는지 알려주세요!
행복한 코딩!
'ASP.NET > .Net Core' 카테고리의 다른 글
| Asp.net core postgreSql 사용하기 (0) | 2020.06.08 |
|---|---|
| .NET Core REST API 서버, 테스트 부터 배포까지 (1) | 2020.04.27 |
| ASP.NET Core 에서 @Scripts.Render 사용법 (0) | 2020.04.24 |