Jak używać HotChocolate do stosowania kluczowej dyrektywy do typów obiektów w GraphQL

Optymalizacja typów obiektów za pomocą kluczowych dyrektyw w HotChocolate

Używając GraphQL z HotChocolate, może być konieczne rozszerzenie typów obiektów za pomocą dyrektyw, takich jak @klawisz dyrektywę, aby zapewnić kompatybilność z Apollo Federation. Jest to szczególnie ważne w przypadku schematów stowarzyszonych, w których klucze identyfikują jednostki w kilku usługach. Zrozumienie, jak odpowiednio projektować typy obiektów za pomocą tych dyrektyw, ma kluczowe znaczenie.

W tym artykule pokażemy, jak używać Gorąca Czekolada do dekorowania typów obiektów za pomocą @klawisz dyrektywa. Przyjrzymy się także konkretnym przykładom wykorzystania kodu C# do skonstruowania prostego pliku Roślina mateczna class i jak zmienić utworzony schemat GraphQL. Nacisk zostanie położony na rzeczywiste działania, które możesz podjąć, aby utworzyć tę funkcjonalność.

Używając HotChocolate do konstruowania typów obiektów GraphQL, @klawisz dyrektywa może nie zostać zastosowana natychmiast, zgodnie z oczekiwaniami. Zamiast tego schemat może utworzyć prostą strukturę typów, w której brakuje kluczowych funkcji wymaganych do federacji. Omówimy, jak rozwiązać ten problem i sprawić, aby schemat działał zgodnie z oczekiwaniami.

Omówimy także kluczowe zadania konfiguracyjne, takie jak modyfikacja konfiguracji serwera GraphQL i korzystanie z praw Gorąca Czekolada I Federacja Apollo pakiety. Dzięki odpowiedniej konfiguracji możesz łatwo zastosować dyrektywy i zapewnić odpowiednią federację schematów dla swoich usług.

Zrozumienie roli kluczowych dyrektyw w HotChocolate

Pierwszy skrypt wyjaśnia, jak zaimplementować plik @klawisz dyrektywa używająca HotChocolate w C#. Ten skrypt gwarantuje, że utworzony schemat GraphQL zawiera plik @klawisz dyrektywa dla federacji z Federacją Apollo. Skrypt rozpoczyna się od utworzenia pliku Roślina mateczna klasę i przypisanie [Klawisz] I [ID] atrybuty do swoich pól. Te właściwości są istotne dla poinformowania HotChocolate o oznaczeniu id pole jako unikalny identyfikator podmiotu. Ma to kluczowe znaczenie przy tworzeniu stowarzyszonej usługi GraphQL, w której jednostki mogą być współużytkowane przez kilka usług. Zaznaczenie tego pola umożliwia usłudze GraphQL rozpoznawanie encji w zapytaniach stowarzyszonych.

The Rozwiązanie referencyjne Funkcja jest również istotnym elementem skryptu. Ta funkcja statyczna umożliwia HotChocolate rozpoznanie jednostki poprzez wyszukiwanie Roślina mateczna obiekt w repozytorium. The Repozytorium nadrzędne jest zarejestrowany na serwerze GraphQL, a plik Dostawać Metoda pobiera rodzica przez jego id. W kodzie startowym plik .DodajTypZapytania instrukcja rejestruje Zapytanie obiekt, który służy do wykonywania zapytań GraphQL.RegisterService umożliwia wstrzykiwanie zależności takich jak ParentRepository do programów tłumaczących GraphQL. Taka konstrukcja upraszcza wyszukiwanie danych, zachowując jednocześnie wyraźny podział problemów.

W drugim przykładzie zastosowano podejście oparte na schemacie, wykorzystując GraphQL SDL (język definicji schematu) do zdefiniowania @klawisz dyrektywa w schemacie. To rozwiązanie jest szczególnie skuteczne dla zespołów, które znają już składnię SDL GraphQL. W tym przykładzie @klawisz dyrektywa ma zastosowanie do Roślina mateczna typu, wyraźnie wskazując id pole jako unikalny identyfikator. Korzystanie ze schematu pozwala programistom mieć większą kontrolę nad sposobem budowania schematu GraphQL i modyfikować go bez konieczności przechodzenia do kodu C#, co czyni go bardziej elastyczną opcją dla większych zespołów.

Na koniec komponent testów jednostkowych sprawdza, czy kod działa zgodnie z oczekiwaniami. Korzystając ze środowiska testowego xUnit, Assert.The Zawiera polecenie gwarantuje, że wynikowy schemat będzie zawierał plik @klawisz dyrektywa. Ten test sprawdza poprawność schematu pod kątem obecności @klawisz dyrektywy, potwierdzając, że usługa jest poprawnie skonfigurowana dla federacji. Testowanie jednostkowe to najlepsza praktyka zapewniająca, że ​​zmiany w schemacie GraphQL lub metodach rozpoznawania nazw nie zakłócają funkcjonalności, szczególnie w systemie stowarzyszonym, w którym wiele usług musi bezproblemowo współpracować.

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());
    }
}

Ulepszanie GraphQL za pomocą Apollo Federation i HotChocolate

Używanie GraphQL z HotChocolate w środowisku stowarzyszonym wymaga dobrze zorganizowanego łączenia schematów. Apollo Federation umożliwia programistom dzielenie schematów na kilka usług przy zachowaniu jednolitego interfejsu. Korzystanie z @klawisz dyrektywę w HotChocolate, możesz określić sposób rozpoznawania encji GraphQL w kilku usługach. Dzięki temu Twoje API jest bardziej modułowe i skalowalne, co jest szczególnie korzystne w dużych, rozproszonych systemach, w których wiele zespołów kontroluje różne aspekty schematu GraphQL.

W typowym schemacie stowarzyszonym elementy takie jak Roślina mateczna mogą występować w wielu usługach. Federacja Apollo korzysta z @klawisz dyrektywa umożliwiająca jednoznaczną identyfikację jednostki na podstawie określonego pola, np id. Wsparcie HotChocolate dla Apollo Federation zapewnia bezproblemową integrację Twojej usługi z większą infrastrukturą. Oprócz ustawiania kluczy możesz używać dyrektyw federacyjnych, takich jak as @rozszerza Lub @zewnętrzny do zarządzania polami danych rozproszonymi w kilku mikrousługach, zapewniając większą elastyczność konfiguracji GraphQL.

Kolejnym kluczowym czynnikiem podczas korzystania z HotChocolate jest optymalizacja wydajności. Nadmierne pobieranie danych jest częstym problemem w interfejsach API GraphQL, szczególnie w kontekstach federacyjnych. Używanie odpowiednich programów rozpoznawania nazw, takich jak Rozwiązanie referencyjne opisanych we wcześniejszych przypadkach, gwarantuje, że Twoje API dostarczy tylko wymagane dane bez nadmiernych wyszukiwań. Co więcej, HotChocolate obsługuje zaawansowane algorytmy przetwarzania wsadowego zapytań i buforowania, co może zwiększyć szybkość odpowiedzi API i wydajność w schemacie stowarzyszonym.