Sdílet prostřednictvím

Otevření typů v OData v4 pomocí webového rozhraní API ASP.NET

  • Článek

od Microsoftu

V OData v4 je otevřený typ strukturovaný typ, který obsahuje dynamické vlastnosti, kromě všech vlastností, které jsou deklarovány v definici typu. Otevřené typy umožňují dodat vašim datovým modelům flexibilitu. V tomto kurzu se dozvíte, jak používat otevřené typy v ASP.NET webovém rozhraní API OData.

V tomto kurzu se předpokládá, že už víte, jak vytvořit koncový bod OData v ASP.NET webovém rozhraní API. Pokud ne, začněte nejprve vytvořením koncového bodu OData v4 .

Verze softwaru použité v tomto kurzu

  • Webové rozhraní API OData 5.3
  • OData v4

Za prvé, určitá terminologie OData:

  • Typ entity: Strukturovaný typ s klíčem.
  • Komplexní typ: Strukturovaný typ bez klíče.
  • Otevřený typ: Typ s dynamickými vlastnostmi. Můžou být otevřené typy entit i komplexní typy.

Hodnota dynamické vlastnosti může být primitivní typ, komplexní typ nebo typ výčtu; nebo kolekci některého z těchto typů. Další informace o otevřených typech najdete ve specifikaci OData v4.

Instalace webových knihoven OData

Pomocí Správce balíčků NuGet nainstalujte nejnovější knihovny OData webového rozhraní API. V okně konzoly Správce balíčků:

Install-Package Microsoft.AspNet.OData
Install-Package Microsoft.AspNet.WebApi.OData

Definování typů CLR

Začněte definováním modelů EDM jako typů CLR.

public enum Category
{
    Book,
    Magazine,
    EBook
}

public class Address
{
    public string City { get; set; }
    public string Street { get; set; }
}

public class Customer
{
    public int Id { get; set; }
    public string Name { get; set; }
    public Address Address { get; set; }
}

public class Press
{
    public string Name { get; set; }
    public string Email { get; set; }
    public Category Category { get; set; }
    public IDictionary<string, object> DynamicProperties { get; set; }
}

public class Book
{
    [Key]
    public string ISBN { get; set; }
    public string Title { get; set; }
    public Press Press { get; set; }
    public IDictionary<string, object> Properties { get; set; }
}

Při vytvoření modelu Entity Data Model (EDM)

  • Category je typ výčtu.
  • Address je komplexní typ. (Nemá klíč, takže se nejedná o typ entity.)
  • Customer je typ entity. (Má klíč.)
  • Press je otevřený komplexní typ.
  • Book je typ otevřené entity.

Pokud chcete vytvořit otevřený typ, typ CLR musí mít vlastnost typu IDictionary<string, object>, která obsahuje dynamické vlastnosti.

Sestavení modelu EDM

Pokud použijete ODataConventionModelBuilder k vytvoření EDM a PressBook jsou automaticky přidány jako otevřené typy na základě přítomnosti IDictionary<string, object> vlastnosti.

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
        builder.EntitySet<Book>("Books");
        builder.EntitySet<Customer>("Customers");
        var model = builder.GetEdmModel();

        config.MapODataServiceRoute(
            routeName: "ODataRoute",
            routePrefix: null,
            model: model);

    }
}

EDM můžete také sestavit explicitně pomocí ODataModelBuilder.

ODataModelBuilder builder = new ODataModelBuilder();

ComplexTypeConfiguration<Press> pressType = builder.ComplexType<Press>();
pressType.Property(c => c.Name);
// ...
pressType.HasDynamicProperties(c => c.DynamicProperties);

EntityTypeConfiguration<Book> bookType = builder.EntityType<Book>();
bookType.HasKey(c => c.ISBN);
bookType.Property(c => c.Title);
// ...
bookType.ComplexProperty(c => c.Press);
bookType.HasDynamicProperties(c => c.Properties);

// ...
builder.EntitySet<Book>("Books");
IEdmModel model = builder.GetEdmModel();

Přidání kontroleru OData

Dále přidejte kontroler OData. V tomto kurzu použijeme zjednodušený kontroler, který podporuje jenom požadavky GET a POST a k ukládání entit používá seznam v paměti.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http;
using System.Web.OData;

namespace MyApp.Controllers
{
    public class BooksController : ODataController
    {
        private IList<Book> _books = new List<Book>
        {
            new Book
            {
                ISBN = "978-0-7356-8383-9",
                Title = "SignalR Programming in Microsoft ASP.NET",
                Press = new Press
                {
                    Name = "Microsoft Press",
                    Category = Category.Book
                }
            },

            new Book
            {
                ISBN = "978-0-7356-7942-9",
                Title = "Microsoft Azure SQL Database Step by Step",
                Press = new Press
                {
                    Name = "Microsoft Press",
                    Category = Category.EBook,
                    DynamicProperties = new Dictionary<string, object>
                    {
                        { "Blog", "https://blogs.msdn.com/b/microsoft_press/" },
                        { "Address", new Address { 
                              City = "Redmond", Street = "One Microsoft Way" }
                        }
                    }
                },
                Properties = new Dictionary<string, object>
                {
                    { "Published", new DateTimeOffset(2014, 7, 3, 0, 0, 0, 0, new TimeSpan(0))},
                    { "Authors", new [] { "Leonard G. Lobel", "Eric D. Boyd" }},
                    { "OtherCategories", new [] {Category.Book, Category.Magazine}}
                }
            }
        };

        [EnableQuery]
        public IQueryable<Book> Get()
        {
            return _books.AsQueryable();
        }

        public IHttpActionResult Get([FromODataUri]string key)
        {
            Book book = _books.FirstOrDefault(e => e.ISBN == key);
            if (book == null)
            {
                return NotFound();
            }

            return Ok(book);
        }

        public IHttpActionResult Post(Book book)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            } 
            // For this sample, we aren't enforcing unique keys.
            _books.Add(book);
            return Created(book);
        }
    }
}

Všimněte si, že první Book instance nemá žádné dynamické vlastnosti. Druhá Book instance má následující dynamické vlastnosti:

  • "Publikováno": Primitivní typ
  • "Autoři": Kolekce primitivních typů
  • "OtherCategories": Kolekce typů výčtu.

Press Vlastnost této Book instance má také následující dynamické vlastnosti:

  • "Blog": Primitivní typ
  • "Adresa": Komplexní typ

Dotazování na metadata

Pokud chcete získat dokument metadat OData, odešlete požadavek GET na adresu ~/$metadata. Text odpovědi by měl vypadat nějak takto:

<?xml version="1.0" encoding="utf-8"?>
<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">
  <edmx:DataServices>
    <Schema Namespace="MyApp.Models" xmlns="http://docs.oasis-open.org/odata/ns/edm">
      <EntityType Name="Book" OpenType="true">
        <Key>
          <PropertyRef Name="ISBN" />
        </Key>
        <Property Name="ISBN" Type="Edm.String" Nullable="false" />
        <Property Name="Title" Type="Edm.String" />
        <Property Name="Press" Type="MyApp.Models.Press" />
      </EntityType>
      <EntityType Name="Customer">
        <Key>
          <PropertyRef Name="Id" />
        </Key>
        <Property Name="Id" Type="Edm.Int32" Nullable="false" />
        <Property Name="Name" Type="Edm.String" />
        <Property Name="Address" Type="MyApp.Models.Address" />
      </EntityType>
      <ComplexType Name="Press" OpenType="true">
        <Property Name="Name" Type="Edm.String" />
        <Property Name="Category" Type="MyApp.Models.Category" Nullable="false" />
      </ComplexType>
      <ComplexType Name="Address">
        <Property Name="City" Type="Edm.String" />
        <Property Name="Street" Type="Edm.String" />
      </ComplexType>
      <EnumType Name="Category">
        <Member Name="Book" Value="0" />
        <Member Name="Magazine" Value="1" />
        <Member Name="EBook" Value="2" />
      </EnumType>
    </Schema>
    <Schema Namespace="Default" xmlns="http://docs.oasis-open.org/odata/ns/edm">
      <EntityContainer Name="Container">
        <EntitySet Name="Books" EntityType="MyApp.Models.Book" />
        <EntitySet Name="Customers" EntityType="MyApp.Models.Customer" />
      </EntityContainer>
    </Schema>
  </edmx:DataServices>
</edmx:Edmx>

Z dokumentu metadat vidíte, že:

  • Book U typů a Press je hodnota atributu OpenType true. Typy Customer a Address tento atribut nemají.
  • Typ Book entity má tři deklarované vlastnosti: ISBN, Title a Press. Metadata OData nezahrnují Book.Properties vlastnost z třídy CLR.
  • Podobně Press má komplexní typ pouze dvě deklarované vlastnosti: Name (Název) a Category (Kategorie). Metadata nezahrnují Press.DynamicProperties vlastnost z třídy CLR.

Dotazování na entitu

Pokud chcete získat knihu s hodnotou ISBN rovnou "978-0-7356-7942-9", odešlete požadavek GET na ~/Books('978-0-7356-7942-9')adresu . Text odpovědi by měl vypadat podobně jako následující. (Odsazený, aby byl čitelnější.)

{
  "@odata.context":"http://localhost:37141/$metadata#Books/$entity",
    "ISBN":"978-0-7356-7942-9",
    "Title":"Microsoft Azure SQL Database Step by Step",
    "Press":{
      "Name":"Microsoft Press",
      "Category":"EBook",
      "Blog":"https://blogs.msdn.com/b/microsoft_press/",
      "Address":{
        "@odata.type":"#MyApp.Models.Address",
        "City":"Redmond",
        "Street":"One Microsoft Way"
      }
  },
  "Published":"2014-07-03T00:00:00Z",
  "Authors@odata.type":"#Collection(String)",
  "Authors":[
    "Leonard G. Lobel","Eric D. Boyd"
  ],
  "OtherCategories@odata.type":"#Collection(MyApp.Models.Category)",
  "OtherCategories":[
    "Book","Magazine"
  ]
}

Všimněte si, že dynamické vlastnosti jsou součástí deklarovaných vlastností.

POST an Entity

Pokud chcete přidat entitu Book, odešlete požadavek POST na adresu ~/Books. Klient může nastavit dynamické vlastnosti v datové části požadavku.

Tady je příklad požadavku. Všimněte si vlastností Price (Cena) a Published (Publikováno).

POST http://localhost:37141/Books HTTP/1.1
User-Agent: Fiddler
Host: localhost:37141
Content-Type: application/json
Content-Length: 191

{
  "ISBN":"978-0-7356-8383-9","Title":"Programming Microsoft ASP.NET MVC","Press":{
  "Name":"Microsoft Press","Category":"Book"
   }, "Price": 49.99, "Published":"2014-02-15T00:00:00Z"
}

Pokud nastavíte zarážku v metodě kontroleru, uvidíte, že webové rozhraní API přidalo tyto vlastnosti do slovníku Properties .

Snímek obrazovky s kódem, který odesílá požadavek POST a zvýrazňuje část kódu

Další materiály

Ukázka otevřeného typu OData