Cara Menggunakan HotChocolate untuk Menerapkan Petunjuk Kunci ke Tipe Objek di GraphQL

Mengoptimalkan Jenis Objek dengan Petunjuk Kunci di HotChocolate

Saat menggunakan GraphQL dengan HotChocolate, Anda mungkin perlu memperluas tipe objek dengan arahan, seperti @kunci arahan, untuk memastikan kompatibilitas dengan Federasi Apollo. Hal ini sangat penting untuk skema gabungan, di mana kunci mengidentifikasi entitas di beberapa layanan. Memahami cara mendesain tipe objek dengan tepat menggunakan arahan ini sangatlah penting.

Artikel ini akan menunjukkan cara menggunakannya Cokelat Panas untuk menghias jenis objek menggunakan @kunci direktif. Kita juga akan melihat contoh tertentu yang menggunakan kode C# untuk membuat struktur sederhana Induk kelas dan cara mengubah skema GraphQL yang dihasilkan. Penekanannya adalah pada tindakan nyata yang mungkin Anda ambil untuk membuat fungsi ini.

Saat menggunakan HotChocolate untuk membuat tipe objek GraphQL, file @kunci arahan mungkin tidak diterapkan secara instan seperti yang diharapkan. Sebaliknya, skema tersebut mungkin menghasilkan struktur tipe sederhana yang tidak memiliki fitur penting yang diperlukan untuk federasi. Kami akan membahas cara mengatasinya dan membuat skema Anda berfungsi seperti yang diharapkan.

Kami juga akan membahas tugas-tugas konfigurasi penting, seperti memodifikasi pengaturan server GraphQL Anda dan menggunakan hak Cokelat Panas Dan Federasi Apollo paket. Dengan konfigurasi yang tepat, Anda dapat dengan mudah menerapkan arahan dan memastikan federasi skema yang tepat untuk layanan Anda.

Memahami Peran Petunjuk Utama dalam HotChocolate

Skrip pertama menjelaskan cara mengimplementasikan @kunci direktif menggunakan HotChocolate di C#. Skrip ini menjamin bahwa skema GraphQL yang dibuat berisi @kunci arahan untuk federasi dengan Federasi Apollo. Script dimulai dengan membuat a Induk kelas dan menugaskan [Kunci] Dan [PENGENAL] atribut ke bidangnya. Properti ini penting untuk menginformasikan HotChocolate untuk menandai pengenal bidang sebagai pengidentifikasi unik entitas. Hal ini penting ketika membuat layanan GraphQL gabungan di mana entitas dapat dibagikan ke beberapa layanan. Menandai bidang ini memungkinkan layanan GraphQL menyelesaikan entitas dalam kueri gabungan.

Itu ReferensiResolver fungsi juga merupakan komponen penting dari skrip. Fungsi statis ini memungkinkan HotChocolate menyelesaikan entitas dengan mencari Induk objek dalam repositori. Itu Repositori Induk terdaftar di server GraphQL, dan Mendapatkan metode mengambil orang tua dengan itu pengenal. Dalam kode bootstrap, file .AddQueryType instruksi mendaftarkan Pertanyaan objek, yang digunakan untuk mengeksekusi kueri GraphQL.RegisterService memungkinkan memasukkan dependensi seperti ParentRepository ke dalam penyelesai GraphQL. Desain ini menyederhanakan pengambilan data sekaligus menjaga pemisahan kekhawatiran yang jelas.

Contoh kedua menggunakan pendekatan skema pertama, memanfaatkan GraphQL SDL (Schema Definition Language) untuk mendefinisikan @kunci arahan dalam skema. Solusi ini sangat efektif untuk tim yang sudah familiar dengan sintaks SDL GraphQL. Dalam contoh ini, @kunci arahan diterapkan pada Induk jenis, dengan jelas menunjukkan pengenal bidang sebagai pengidentifikasi unik. Menggunakan skema yang mengutamakan skema memungkinkan pengembang memiliki kontrol lebih besar atas bagaimana skema GraphQL dibuat dan memodifikasinya tanpa harus masuk ke kode C#, menjadikannya opsi yang lebih fleksibel untuk tim yang lebih besar.

Terakhir, komponen pengujian unit memvalidasi bahwa kode berfungsi sebagaimana mestinya. Menggunakan kerangka pengujian xUnit, Assert.The Berisi perintah memastikan bahwa skema yang dihasilkan menyertakan @kunci direktif. Tes ini memvalidasi skema untuk keberadaan @kunci arahan, mengonfirmasi bahwa layanan dikonfigurasi dengan benar untuk federasi. Pengujian unit adalah praktik terbaik untuk memastikan bahwa perubahan pada skema GraphQL atau metode penyelesaian Anda tidak mengganggu fungsionalitas, terutama dalam sistem gabungan di mana beberapa layanan harus beroperasi bersama dengan lancar.

using HotChocolate;
using HotChocolate.Types;
using HotChocolate.Types.Relay;
using Microsoft.Extensions.DependencyInjection;
public class Parent
{
    public Parent(string id, string name)
    {
        Id = id;
        Name = name;
    }
    [Key]
    [ID]
    public string Id { get; }
    public string Name { get; }
    [ReferenceResolver]
    public static Parent? Get(ParentRepository repository, string id)
    {
        return repository.GetParent(id);
    }
}
public class Query
{
    public Parent GetParent(string id, [Service] ParentRepository repository)
    {
        return repository.GetParent(id);
    }
}
public void ConfigureServices(IServiceCollection services)
{
    services.AddGraphQLServer()
        .AddQueryType<Query>()
        .RegisterService<ParentRepository>()
        .AddApolloFederation();
}

type Parent @key(fields: "id") {
    id: ID!
    name: String!
}
extend type Query {
    parent(id: ID!): Parent
}
extend type Mutation {
    createParent(id: ID!, name: String!): Parent
}
directive @key(fields: String!) on OBJECT | INTERFACE

schema {
    query: Query
    mutation: Mutation
}

using Xunit;
using HotChocolate.Execution;
using Microsoft.Extensions.DependencyInjection;
public class ParentTests
{
    [Fact]
    public async Task ParentSchema_ContainsKeyDirective()
    {
        var serviceCollection = new ServiceCollection();
        serviceCollection.AddGraphQLServer()
            .AddQueryType<Query>()
            .AddApolloFederation();
        var serviceProvider = serviceCollection.BuildServiceProvider();
        var schema = await serviceProvider.GetRequiredService<ISchemaAsync>().ExecuteAsync();
        Assert.Contains("@key(fields: \"id\")", schema.ToString());
    }
}

Meningkatkan GraphQL dengan Apollo Federation dan HotChocolate

Menggunakan GraphQL dengan HotChocolate di lingkungan gabungan memerlukan penggabungan skema yang terstruktur dengan baik. Federasi Apollo memungkinkan pengembang untuk mempartisi skema di beberapa layanan sambil mempertahankan antarmuka yang seragam. Menggunakan @kunci direktif dengan HotChocolate, Anda dapat menentukan bagaimana entitas GraphQL diselesaikan di beberapa layanan. Hal ini membuat API Anda lebih modular dan terukur, yang sangat bermanfaat dalam sistem terdistribusi besar di mana banyak tim mengontrol berbagai aspek skema GraphQL.

Dalam skema federasi yang khas, entitas seperti Induk mungkin ada di banyak layanan. Federasi Apollo menggunakan @kunci arahan untuk mengidentifikasi secara unik suatu entitas berdasarkan bidang tertentu, seperti pengenal. Dukungan HotChocolate untuk Apollo Federation memastikan bahwa layanan Anda terintegrasi dengan mudah ke dalam infrastruktur yang lebih besar. Selain mengatur kunci, Anda dapat menggunakan arahan federasi seperti sebagai @meluas atau @luar untuk mengelola bidang data yang tersebar di beberapa layanan mikro, memberikan fleksibilitas lebih besar untuk penyiapan GraphQL Anda.

Faktor kunci lainnya saat menggunakan HotChocolate adalah optimalisasi kinerja. Pengambilan data yang berlebihan adalah masalah umum pada API GraphQL, khususnya dalam konteks gabungan. Menggunakan penyelesai yang benar, seperti ReferensiResolver dijelaskan dalam contoh sebelumnya, menjamin bahwa API Anda hanya memberikan data yang diperlukan tanpa pencarian berlebihan. Selain itu, HotChocolate mendukung algoritma batching dan caching kueri tingkat lanjut, yang dapat meningkatkan kecepatan dan efisiensi respons API dalam skema gabungan.