Kuidas kasutada HotChocolate'i põhidirektiivi rakendamiseks GraphQL-i objektitüüpidele

Objektitüüpide optimeerimine HotChocolate'i võtmedirektiiviga

Kui kasutate GraphQL-i koos HotChocolate'iga, peate võib-olla laiendama oma objektitüüpe käskkirjadega, näiteks @võti direktiiviga, et tagada ühilduvus Apollo Föderatsiooniga. See on eriti oluline liitskeemide puhul, kus võtmed tuvastavad olemid mitmes teenuses. Oluline on mõista, kuidas oma objektitüüpe nende juhiste abil õigesti kujundada.

See artikkel näitab, kuidas seda kasutada Kuum šokolaad objektitüüpide kaunistamiseks kasutades @võti direktiiv. Vaatame ka konkreetseid näiteid, mis kasutavad lihtsa loomiseks C# koodi Lapsevanem klass ja kuidas toodetud GraphQL skeemi muuta. Rõhk on tegelikel toimingutel, mida võite selle funktsiooni loomiseks teha.

Kui kasutate GraphQL-i objektitüüpide loomiseks HotChocolate'i, @võti direktiivi ei pruugita oodatult koheselt rakendada. Selle asemel võib skeem luua lihtsa tüübistruktuuri, millel puuduvad liitmiseks vajalikud kriitilised funktsioonid. Vaatame, kuidas seda lahendada ja teie skeemi ootuspäraselt toimima panna.

Samuti käsitleme olulisi konfigureerimisülesandeid, nagu GraphQL-i serveri seadistuse muutmine ja õige kasutamine Kuum šokolaad ja Apollo Föderatsioon paketid. Õige konfiguratsiooniga saate hõlpsalt rakendada direktiive ja tagada oma teenuste jaoks õige skeemi liitmise.

HotChocolate'i põhidirektiivide rolli mõistmine

Esimene skript selgitab, kuidas seda rakendada @võti käsk HotChocolate'i abil C#-s. See skript garanteerib, et loodud GraphQL-i skeem sisaldab @võti direktiiv föderatsioonile Apollo Föderatsiooniga. Skript algab a Lapsevanem klassi ja määrates [võti] ja [ID] omistab selle väljadele. Need omadused on olulised, et teavitada HotChocolate'i, et märkida id väljale olemi kordumatu identifikaatorina. See on ülioluline ühendatud GraphQL-teenuse loomisel, kus üksusi saab jagada mitme teenuse vahel. Selle välja märkimine võimaldab GraphQL-i teenusel lahendada olemi ühendatud päringutes.

The ReferenceResolver funktsioon on ka skripti oluline komponent. See staatiline funktsioon võimaldab HotChocolate'il olemi lahendada, otsides seda Lapsevanem objekt hoidlas. The ParentRepository on registreeritud GraphQL serveris ja Hangi meetod otsib vanema selle järgi id. Alglaadimiskoodis on .AddQueryType käsk registreerib Päring objekt, mida kasutatakse GraphQL-i päringute täitmiseks.RegisterService võimaldab sisestada GraphQL-i lahendajatesse sõltuvusi, nagu ParentRepository. See disain lihtsustab andmete otsimist, säilitades samal ajal probleemide selge lahususe.

Teises näites kasutatakse skeemipõhist lähenemist, kasutades GraphQL SDL-i (Schema Definition Language). @võti direktiiv skeemi sees. See lahendus on eriti tõhus meeskondade jaoks, kes on juba tuttavad GraphQL-i SDL-i süntaksiga. Selles näites on @võti direktiivi kohaldatakse Lapsevanem tüüp, mis näitab selgelt id unikaalse identifikaatorina. Skeemi esmane kasutamine võimaldab arendajatel omada rohkem kontrolli GraphQL-i skeemi loomise üle ja muuta seda ilma C#-koodi kasutamata, muutes selle suuremate meeskondade jaoks paindlikumaks.

Lõpuks kinnitab üksuse testimise komponent, et kood toimib ettenähtud viisil. Kasutades xUnit testimisraamistikku, on Assert.The Contains käsk tagab, et saadud skeem sisaldab @võti direktiiv. See test kinnitab skeemi olemasolu @võti käsk, mis kinnitab, et teenus on liitmiseks õigesti konfigureeritud. Üksuse testimine on parim tava tagamaks, et teie GraphQL-i skeemi või lahendamismeetodite muudatused ei häiri funktsionaalsust, eriti liitsüsteemis, kus mitu teenust peavad sujuvalt koos töötama.

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

GraphQL-i täiustamine Apollo Federationi ja HotChocolate'iga

GraphQL-i kasutamine koos HotChocolate'iga liitkeskkonnas nõuab hästi struktureeritud skeemi õmblemist. Apollo Federation võimaldab arendajatel jagada skeeme mitme teenuse vahel, säilitades samal ajal ühtse liidese. Kasutades @võti HotChocolate'iga, saate määrata, kuidas GraphQL-i olemid lahendatakse mitmes teenuses. See muudab teie API modulaarsemaks ja skaleeritavamaks, mis on eriti kasulik suurtes hajutatud süsteemides, kus mitu meeskonda juhivad GraphQL-i skeemi erinevaid aspekte.

Tüüpilises liitskeemis on sellised olemid nagu Lapsevanem võib esineda paljudes teenustes. Apollo Föderatsioon kasutab @võti käsk üksuse unikaalseks identifitseerimiseks määratud välja alusel, nt id. HotChocolate'i tugi Apollo Föderatsioonile tagab teie teenuse hõlpsa integreerimise suuremasse infrastruktuuri. Lisaks võtmete seadistamisele saate kasutada liitmisjuhiseid nagu as @pikendab või @väline mitme mikroteenuse vahel hajutatud andmeväljade haldamiseks, pakkudes teie GraphQL-i seadistamisel suuremat paindlikkust.

Teine oluline tegur HotChocolate'i kasutamisel on jõudluse optimeerimine. Andmete ülelaadimine on GraphQL API-de puhul tavaline probleem, eriti liitkontekstis. Kasutades õigeid lahendajaid, näiteks ReferenceResolver Varasematel juhtudel kirjeldatud, tagab, et teie API edastab ainult nõutavad andmed ilma liigsete otsinguteta. Lisaks toetab HotChocolate täiustatud päringute komplekteerimise ja vahemällu salvestamise algoritme, mis võivad liitskeemis suurendada API reageerimiskiirust ja tõhusust.