Migrace z webového rozhraní API ASP.NET na ASP.NET Core

ASP.NET Core kombinuje modely MVC a webového rozhraní API ASP.NET 4.x do jednoho programovacího modelu označovaného jako ASP.NET Core MVC.

Tento článek ukazuje, jak migrovat kontroler Products vytvořený v části Začínáme s webovým rozhraním API 2 ASP.NET do ASP.NET Core.

Předpoklady

Visual Studio

• Sada Visual Studio 2022 se sadou funkcí Vývoj pro ASP.NET a web
• Sada .NET 6.0 SDK

Visual Studio Code

• Visual Studio Code
• Jazyk C# pro Visual Studio Code (nejnovější verze)
• Sada .NET 6.0 SDK

V pokynech pro Visual Studio Code se pro vývojové funkce ASP.NET Core, jako je vytvoření projektu, používá .NET CLI. Podle těchto pokynů můžete postupovat v systému macOS, Linux nebo Windows a v jakémkoli editoru kódu. Pokud použijete jiný editor než Visual Studio Code, možná budete muset provést menší změny.

Vytvoření nového projektu webového rozhraní API ASP.NET Core

Visual Studio

1. V nabídce Soubor vyberte Nový>projekt.
2. Do vyhledávacího pole zadejte webové rozhraní API .
3. Vyberte šablonu ASP.NET Základní webové rozhraní API a vyberte Další.
4. V dialogovém okně Konfigurovat nový projekt pojmenujte projekt ProductsCore a vyberte Další.
5. V dialogovém okně Další informace :
   1. Ověřte, že rozhraní je .NET 6.0 (dlouhodobá podpora).
   2. Ověřte, že je zaškrtnuté políčko Použít kontrolery (zrušení zaškrtnutí pro použití minimálních rozhraní API).
   3. Zrušte zaškrtnutí políčka Povolit podporu OpenAPI.
   4. Vyberte Vytvořit.

Visual Studio Code

1. Otevřete integrovaný terminál.

2. Změňte adresáře (cd) na složku, která bude obsahovat složku projektu.

3. Spuštěním následujících příkazů vytvořte nový projekt webového rozhraní API a otevřete ho v editoru Visual Studio Code:

   dotnet new webapi -o ProductsCore --no-openapi
   cd ProductsCore
   code -r ../ProductsCore
   

Odebrání souborů šablony WeatherForecast

1. WeatherForecast.cs Odeberte z nového projektu ProductsCore soubory a Controllers/WeatherForecastController.cs ukázkové soubory.
2. Otevřete vlastnosti\launch Nastavení.json.
3. Změňte launchUrl vlastnosti z weatherforcast na productscore.

Konfigurace pro webové rozhraní API ASP.NET Core

ASP.NET Core nepoužívá složku App_Start ani soubor Global.asax . Soubor web.config se přidá při publikování. Další informace naleznete v souboru web.config.

Soubor Program.cs:

• Nahradí Global.asax.
• Zpracovává všechny úlohy po spuštění aplikace.

Další informace najdete v tématu Spuštění aplikace v ASP.NET Core.

Následuje příklad spouštěcího kódu aplikace v souboru ASP.NET Core Program.cs :

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();

var app = builder.Build();

// Configure the HTTP request pipeline.

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

Zkopírování modelu produktu

Visual Studio

1. V Průzkumník řešení klikněte pravým tlačítkem myši na projekt. Vyberte Přidat>novou složku. Pojmenujte složku Models.
2. Klikněte pravým tlačítkem myši na složku Modely . Vyberte Přidat>třídu. Pojmenujte produkt třídy a vyberte Přidat.
3. Nahraďte kód modelu šablony následujícím kódem:

Visual Studio Code

1. Přidejte složku s názvem Models.
2. Do složky Models přidejte třídu Product s následujícím kódem:

namespace ProductsCore.Models
{
    public class Product
    {
        public int Id { get; set; }
        public string? Name { get; set; }
        public string? Category { get; set; }
        public decimal Price { get; set; }
    }
}

Předchozí zvýrazněný kód změní následující:

• Poznámka ? byla přidána pro deklaraci a Category vlastnosti jako odkazové typy s možnou Name hodnotou null.

Díky použití funkce s možnou hodnotou Null zavedenou v jazyce C# 8 může ASP.NET Core poskytovat další analýzu toku kódu a bezpečnost kompilace při zpracování referenčních typů. Například ochrana před null výjimkami odkazu.

V tomto případě je záměrem, že jde Category o typy s možnou Name hodnotou null.

ASP.NET projekty Core 6.0 ve výchozím nastavení umožňují odkazové typy s možnou hodnotou null. Další informace naleznete v tématu Odkazové typy s možnou hodnotou Null.

Zkopírování controlleru ProductsController

Visual Studio

1. Klikněte pravým tlačítkem myši na složku Kontrolery .
2. Vyberte Přidat > kontroler....
3. V dialogovém okně Přidat novou vygenerovanou položku vyberte kontroler Mvc – prázdný a pak vyberte Přidat.
4. Pojmenujte kontroler ProductsController a vyberte Přidat.
5. Kód kontroleru šablony nahraďte následujícím kódem:

Visual Studio Code

1. Přidejte třídu ProductsController do složky Controllers s následujícím kódem:

using Microsoft.AspNetCore.Mvc;
using ProductsCore.Models;

namespace ProductsCore.Controllers;

[Route("api/[controller]")]
[ApiController]
public class ProductsController : ControllerBase
{
    Product[] products = new Product[]
    {
            new Product
            {
                Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1
            },
            new Product
            {
                Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M
            },
            new Product
            {
                Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M
            }
    };

    [HttpGet]
    public IEnumerable<Product> GetAllProducts()
    {
        return products;
    }

    [HttpGet("{id}")]
    public ActionResult<Product> GetProduct(int id)
    {
        var product = products.FirstOrDefault((p) => p.Id == id);
        if (product == null)
        {
            return NotFound();
        }
        return product;
    }
}

Předchozí zvýrazněný kód změní následující změny, aby se migrovali na ASP.NET Core:

• Odebere příkazy using pro následující komponenty ASP.NET 4.x, které v ASP.NET Core neexistují:

  • Třída ApiController
  • System.Web.Http Obor názvů
  • IHttpActionResult Rozhraní

• Změní příkaz using ProductsApp.Models; na using ProductsCore.Models;.

• Nastaví kořenový obor názvů na ProductsCore.

• Změny ApiController v souboru ControllerBase.

• Přidá using Microsoft.AspNetCore.Mvc; k vyřešení ControllerBase odkazu.

• Změní návratový GetProduct typ akce z IHttpActionResult na ActionResult<Product>. Další informace najdete v tématu Návratové typy akcí kontroleru.

• GetProduct Zjednodušuje příkaz akce return na následující příkaz:

  return product;
  

• Přidá následující atributy, které jsou vysvětleny v dalších částech:

  • [Route("api/[controller]")]
  • [ApiController]
  • [HttpGet]
  • [HttpGet("{id}")]

Směrování

ASP.NET Core poskytuje minimální model hostování, ve kterém middleware směrování koncového bodu zabalí celý kanál middlewaru, a proto je možné trasy přidat přímo do WebApplication bez explicitního volání UseEndpoints nebo UseRouting registrace tras.

UseRouting se dá i nadále použít k určení, kde se provádí porovnávání tras, ale UseRouting není nutné je explicitně volat, pokud by se trasy měly shodovat na začátku kanálu middlewaru.

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();

var app = builder.Build();

// Configure the HTTP request pipeline.

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

Poznámka: Trasy přidané přímo ke WebApplication spuštění na konci kanálu.

Směrování v migrovaném ProductsController

Migrovaný ProductsController soubor obsahuje následující zvýrazněné atributy:

using Microsoft.AspNetCore.Mvc;
using ProductsCore.Models;

namespace ProductsCore.Controllers;

[Route("api/[controller]")]
[ApiController]
public class ProductsController : ControllerBase
{
    Product[] products = new Product[]
    {
            new Product
            {
                Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1
            },
            new Product
            {
                Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M
            },
            new Product
            {
                Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M
            }
    };

    [HttpGet]
    public IEnumerable<Product> GetAllProducts()
    {
        return products;
    }

    [HttpGet("{id}")]
    public ActionResult<Product> GetProduct(int id)
    {
        var product = products.FirstOrDefault((p) => p.Id == id);
        if (product == null)
        {
            return NotFound();
        }
        return product;
    }
}

• Atribut [Route] konfiguruje model směrování atributů kontroleru.

• Atribut [ApiController] zajišťuje směrování atributů jako požadavek na všechny akce v tomto kontroleru.

• Směrování atributů podporuje tokeny, například [controller] a [action]. Za běhu se každý token nahradí názvem kontroleru nebo akce, na který byl atribut použit. Tokeny:

  • Snižuje nebo eliminuje potřebu používat pevně zakódované řetězce pro trasu.
  • Zajistěte, aby trasy zůstaly synchronizované s odpovídajícími řadiči a akcemi při použití automatického refaktoringu přejmenování.

• Požadavky HTTP Get jsou povolené pro ProductController akce s následujícími atributy:

  • [HttpGet] atribut použitý na GetAllProducts akci.
  • [HttpGet("{id}")] atribut použitý na GetProduct akci.

Spusťte migrovaný projekt a přejděte na /api/products. Příklad: https://localhost:<port>/api/products. Zobrazí se úplný seznam tří produktů. Přejděte na /api/products/1. Zobrazí se první produkt.

Zobrazení nebo stažení ukázkového kódu (postup stažení)

Další materiály

• Vytváření webových rozhraní API pomocí ASP.NET Core
• Návratové typy akcí kontroleru ve webovém rozhraní API ASP.NET Core
• Verze kompatibility pro ASP.NET Core MVC