Penahanan di OData v4 Menggunakan Web API 2.2

oleh Jinfu Tan

Secara tradisional, entitas hanya dapat diakses jika dienkapsulasi di dalam set entitas. Tetapi OData v4 menyediakan dua opsi tambahan, Singleton dan Containment, yang keduanya didukung WebAPI 2.2.

Topik ini menunjukkan cara menentukan penahanan di titik akhir OData di WebApi 2.2. Untuk informasi selengkapnya tentang penahanan, lihat Penahanan disertakan dengan OData v4. Untuk membuat titik akhir OData V4 di API Web, lihat Membuat Titik Akhir OData v4 Menggunakan ASP.NET Web API 2.2.

Pertama, kita akan membuat model domain penahanan di layanan OData, menggunakan model data ini:

Akun berisi banyak PaymentInstruments (PI), tetapi kami tidak menentukan entitas yang ditetapkan untuk PI. Sebaliknya, PI hanya dapat diakses melalui Akun.

Menentukan model data

1. Tentukan jenis CLR.

   public class Account     
   {         
       public int AccountID { get; set; }         
       public string Name { get; set; }         
       [Contained]         
       public IList<PaymentInstrument> PayinPIs { get; set; }     
   }     
   
   public class PaymentInstrument     
   {         
       public int PaymentInstrumentID { get; set; }        
       public string FriendlyName { get; set; }     
   }
   

   Atribut Contained digunakan untuk properti navigasi penahanan.

2. Hasilkan model EDM berdasarkan jenis CLR.

   public static IEdmModel GetModel()         
   {             
       ODataConventionModelBuilder builder = new ODataConventionModelBuilder();             
       builder.EntitySet<Account>("Accounts");             
       var paymentInstrumentType = builder.EntityType<PaymentInstrument>();             
       var functionConfiguration = 
           paymentInstrumentType.Collection.Function("GetCount");             
       functionConfiguration.Parameter<string>("NameContains");             
       functionConfiguration.Returns<int>();             
       builder.Namespace = typeof(Account).Namespace;             
       return builder.GetEdmModel();         
   }
   

   ODataConventionModelBuilder akan menangani pembuatan model EDM jika Contained atribut ditambahkan ke properti navigasi yang sesuai. Jika properti adalah jenis koleksi, GetCount(string NameContains) fungsi juga akan dibuat.

   Metadata yang dihasilkan akan terlihat seperti berikut ini:

   <EntityType Name="Account">   
     <Key>     
       <PropertyRef Name="AccountID" />   
     </Key>   
     <Property Name="AccountID" Type="Edm.Int32" Nullable="false" />   
     <Property Name="Name" Type="Edm.String" />   
     <NavigationProperty 
       Name="PayinPIs" 
       Type="Collection(ODataContrainmentSample.PaymentInstrument)" 
       ContainsTarget="true" /> 
   </EntityType>
   

   Atribut ContainsTarget menunjukkan bahwa properti navigasi adalah penahanan.

Menentukan pengontrol set entitas yang berisi

Entitas yang terkandung tidak memiliki pengontrol sendiri; tindakan didefinisikan dalam pengontrol set entitas yang berisi. Dalam sampel ini, ada AccountsController, tetapi tidak ada PaymentInstrumentsController.

public class AccountsController : ODataController     
{         
    private static IList<Account> _accounts = null;         
    public AccountsController()         
    {             
        if (_accounts == null)             
        {                 
            _accounts = InitAccounts();             
        }         
    }         
    // PUT ~/Accounts(100)/PayinPIs         
    [EnableQuery] 
    public IHttpActionResult GetPayinPIs(int key)         
    {             
        var payinPIs = _accounts.Single(a => a.AccountID == key).PayinPIs;             
        return Ok(payinPIs);         
    }         
    [EnableQuery]         
    [ODataRoute("Accounts({accountId})/PayinPIs({paymentInstrumentId})")]         
    public IHttpActionResult GetSinglePayinPI(int accountId, int paymentInstrumentId)         
    {             
        var payinPIs = _accounts.Single(a => a.AccountID == accountId).PayinPIs;             
        var payinPI = payinPIs.Single(pi => pi.PaymentInstrumentID == paymentInstrumentId);             
        return Ok(payinPI);         
    }         
    // PUT ~/Accounts(100)/PayinPIs(101)         
    [ODataRoute("Accounts({accountId})/PayinPIs({paymentInstrumentId})")]         
    public IHttpActionResult PutToPayinPI(int accountId, int paymentInstrumentId, [FromBody]PaymentInstrument paymentInstrument)         
    {             
        var account = _accounts.Single(a => a.AccountID == accountId);             
        var originalPi = account.PayinPIs.Single(p => p.PaymentInstrumentID == paymentInstrumentId);             
        originalPi.FriendlyName = paymentInstrument.FriendlyName;             
        return Ok(paymentInstrument);         
    }         
    // DELETE ~/Accounts(100)/PayinPIs(101)         
    [ODataRoute("Accounts({accountId})/PayinPIs({paymentInstrumentId})")]         
    public IHttpActionResult DeletePayinPIFromAccount(int accountId, int paymentInstrumentId)         
    {             
        var account = _accounts.Single(a => a.AccountID == accountId);             
        var originalPi = account.PayinPIs.Single(p => p.PaymentInstrumentID == paymentInstrumentId);             
        if (account.PayinPIs.Remove(originalPi))             
        {                 
            return StatusCode(HttpStatusCode.NoContent);             
        }             
        else             
        {                 
            return StatusCode(HttpStatusCode.InternalServerError);             
        }         
    }         
    // GET ~/Accounts(100)/PayinPIs/Namespace.GetCount() 
    [ODataRoute("Accounts({accountId})/PayinPIs/ODataContrainmentSample.GetCount(NameContains={name})")]         
    public IHttpActionResult GetPayinPIsCountWhoseNameContainsGivenValue(int accountId, [FromODataUri]string name)         
    {             
        var account = _accounts.Single(a => a.AccountID == accountId);             
        var count = account.PayinPIs.Where(pi => pi.FriendlyName.Contains(name)).Count();             
        return Ok(count);         
    }         
    private static IList<Account> InitAccounts()         
    {             
        var accounts = new List<Account>() 
        { 
            new Account()                 
            {                    
                AccountID = 100,                    
                Name="Name100",                    
                PayinPIs = new List<PaymentInstrument>()                     
                {                         
                    new PaymentInstrument()                         
                    {                             
                        PaymentInstrumentID = 101,                             
                        FriendlyName = "101 first PI",                         
                    },                         
                    new PaymentInstrument()                         
                    {                             
                        PaymentInstrumentID = 102,                             
                        FriendlyName = "102 second PI",                         
                    },                     
                },                 
            },             
        };            
        return accounts;         
    }     
}

Jika jalur OData adalah 4 segmen atau lebih, hanya perutean atribut yang berfungsi, seperti [ODataRoute("Accounts({accountId})/PayinPIs({paymentInstrumentId})")] di pengontrol di atas. Jika tidak, atribut dan perutean konvensional berfungsi: misalnya, GetPayInPIs(int key) cocok GET ~/Accounts(1)/PayinPIsdengan .

Terima kasih kepada Leo Hu untuk konten asli artikel ini.