Kā izmantot HotChocolate, lai piemērotu galveno direktīvu GraphQL objektu veidiem

Objektu tipu optimizēšana, izmantojot HotChocolate galveno direktīvu

Izmantojot GraphQL ar HotChocolate, iespējams, vajadzēs paplašināt objektu tipus ar direktīvām, piemēram, @atslēga direktīvu, lai nodrošinātu savietojamību ar Apollo Federāciju. Tas ir īpaši svarīgi apvienotajām shēmām, kurās atslēgas identificē entītijas vairākos pakalpojumos. Izpratne par to, kā atbilstoši izstrādāt objektu tipus, izmantojot šīs direktīvas, ir ļoti svarīga.

Šajā rakstā tiks parādīts, kā to izmantot HotChocolate lai dekorētu objektu tipus, izmantojot @atslēga direktīva. Mēs arī aplūkosim konkrētus piemērus, izmantojot C# kodu, lai izveidotu vienkāršu Vecāks klase un kā mainīt izveidoto GraphQL shēmu. Uzsvars tiks likts uz faktiskajām darbībām, kuras varat veikt, lai izveidotu šo funkcionalitāti.

Izmantojot HotChocolate, lai izveidotu GraphQL objektu tipus, @atslēga direktīva var netikt piemērota uzreiz, kā paredzēts. Tā vietā shēma var radīt vienkārša tipa struktūru, kurai trūkst svarīgu funkciju, kas nepieciešamas federācijai. Mēs apskatīsim, kā to atrisināt un panākt, lai jūsu shēma darbotos, kā paredzēts.

Mēs apskatīsim arī būtiskus konfigurācijas uzdevumus, piemēram, GraphQL servera iestatījumu pārveidošanu un pareizo izmantošanu HotChocolate un Apollo federācija iepakojumiem. Izmantojot pareizu konfigurāciju, varat viegli piemērot direktīvas un nodrošināt pareizu shēmu federāciju saviem pakalpojumiem.

Izpratne par galveno direktīvu lomu HotChocolate

Pirmajā skriptā ir paskaidrots, kā ieviest @atslēga direktīva, izmantojot HotChocolate C#. Šis skripts garantē, ka izveidotā GraphQL shēma satur @atslēga direktīva federācijai ar Apollo federāciju. Skripts sākas, izveidojot a Vecāks klasē un piešķirot [Atslēga] un [ID] atribūtus saviem laukiem. Šīs īpašības ir svarīgas, lai informētu HotChocolate, lai atzīmētu id kā entītijas unikālo identifikatoru. Tas ir ļoti svarīgi, veidojot federētu GraphQL pakalpojumu, kurā entītijas var koplietot vairākos pakalpojumos. Atzīmējot šo lauku, GraphQL pakalpojums var atrisināt entītiju apvienotajos vaicājumos.

The ReferenceResolver funkcija ir arī būtiska skripta sastāvdaļa. Šī statiskā funkcija ļauj HotChocolate atrisināt entītiju, meklējot Vecāks objekts repozitorijā. The ParentRepository ir reģistrēts GraphQL serverī, un Saņem metode izgūst vecāku pēc tās id. Sāknēšanas kodā .AddQueryType instrukcija reģistrē Vaicājums objekts, kas tiek izmantots GraphQL vaicājumu izpildei.RegisterService ļauj GraphQL atrisinātājos ievadīt atkarības, piemēram, ParentRepository. Šis dizains vienkāršo datu izguvi, vienlaikus saglabājot skaidru problēmu nošķiršanu.

Otrajā piemērā ir izmantota shēmas pirmā pieeja, izmantojot GraphQL SDL (shēmas definīcijas valodu), lai definētu @atslēga direktīva shēmā. Šis risinājums ir īpaši efektīvs komandām, kuras jau pārzina GraphQL SDL sintaksi. Šajā piemērā @atslēga direktīva tiek piemērota Vecāks veidu, skaidri norādot id kā unikālais identifikators. Shēmas izmantošana vispirms ļauj izstrādātājiem vairāk kontrolēt GraphQL shēmas izveidi un modificēt to, neiedziļinoties C# kodā, padarot to par elastīgāku iespēju lielākām komandām.

Visbeidzot, vienības testēšanas komponents apstiprina, ka kods darbojas, kā paredzēts. Izmantojot xUnit testēšanas sistēmu, Assert.The Contains komanda nodrošina, ka iegūtā shēma ietver @atslēga direktīva. Šis tests apstiprina shēmu, lai noteiktu @atslēga direktīvu, kas apstiprina, ka pakalpojums ir pareizi konfigurēts federācijai. Vienību testēšana ir labākā prakse, lai nodrošinātu, ka GraphQL shēmas vai atrisinātāja metožu izmaiņas netraucē funkcionalitāti, jo īpaši federētajā sistēmā, kur vairākiem pakalpojumiem ir jādarbojas nevainojami.

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 uzlabošana ar Apollo Federation un HotChocolate

GraphQL izmantošanai ar HotChocolate apvienotā vidē ir nepieciešama labi strukturēta shēmas savienošana. Apollo Federation ļauj izstrādātājiem sadalīt shēmas vairākos pakalpojumos, vienlaikus saglabājot vienotu saskarni. Izmantojot @atslēga direktīvu ar HotChocolate, varat norādīt, kā GraphQL entītijas tiek atrisinātas vairākos pakalpojumos. Tas padara jūsu API modulārāku un mērogojamāku, kas ir īpaši izdevīgi lielās, sadalītās sistēmās, kur vairākas komandas kontrolē dažādus GraphQL shēmas aspektus.

Tipiskā apvienotajā shēmā tādas entītijas kā Vecāks var pastāvēt daudzos pakalpojumos. Apollo Federation izmanto @atslēga direktīvu, lai unikāli identificētu entītiju, pamatojoties uz noteiktu lauku, piemēram id. HotChocolate atbalsts Apollo federācijai nodrošina, ka jūsu pakalpojums bez piepūles tiek integrēts lielākā infrastruktūrā. Papildus taustiņu iestatīšanai varat izmantot federācijas direktīvas, piemēram, kā @pagarinās vai @ārējais lai pārvaldītu datu laukus, kas izkliedēti vairākos mikropakalpojumos, nodrošinot lielāku elastību jūsu GraphQL iestatīšanai.

Vēl viens svarīgs faktors, izmantojot HotChocolate, ir veiktspējas optimizācija. Pārmērīga datu ielāde ir izplatīta problēma ar GraphQL API, jo īpaši apvienotajos kontekstos. Izmantojot pareizos atrisinātājus, piemēram, ReferenceResolver aprakstīts iepriekšējos gadījumos, garantē, ka jūsu API nodrošina tikai nepieciešamos datus bez pārmērīgas meklēšanas. Turklāt HotChocolate atbalsta uzlabotus vaicājumu komplektēšanas un kešatmiņas algoritmus, kas var palielināt API atbildes ātrumu un efektivitāti apvienotajā shēmā.