Τρόπος χρήσης της HotChocolate για την εφαρμογή της βασικής Οδηγίας σε τύπους αντικειμένων στο GraphQL

Βελτιστοποίηση τύπων αντικειμένων με βασική οδηγία στη ζεστή σοκολάτα

Όταν χρησιμοποιείτε το GraphQL με HotChocolate, ίσως χρειαστεί να επεκτείνετε τους τύπους αντικειμένων σας με οδηγίες, όπως η @κλειδί οδηγία, για τη διασφάλιση της συμβατότητας με την Ομοσπονδία Apollo. Αυτό είναι ιδιαίτερα σημαντικό για τα ομοσπονδιακά σχήματα, στα οποία τα κλειδιά προσδιορίζουν οντότητες σε διάφορες υπηρεσίες. Η κατανόηση του τρόπου με τον οποίο μπορείτε να σχεδιάσετε κατάλληλα τους τύπους αντικειμένων σας με αυτές τις οδηγίες είναι κρίσιμης σημασίας.

Αυτό το άρθρο θα δείξει πώς να το χρησιμοποιήσετε Ζεστή Σοκολάτα για να διακοσμήσετε τους τύπους αντικειμένων χρησιμοποιώντας το @κλειδί διευθυντικός. Θα εξετάσουμε επίσης συγκεκριμένα παραδείγματα που χρησιμοποιούν κώδικα C# για την κατασκευή ενός απλού Μητρική εταιρεία τάξη και πώς να αλλάξετε το παραγόμενο σχήμα GraphQL. Η έμφαση θα δοθεί στις πραγματικές ενέργειες που μπορείτε να κάνετε για να δημιουργήσετε αυτήν τη λειτουργία.

Όταν χρησιμοποιείτε το HotChocolate για την κατασκευή τύπων αντικειμένων GraphQL, το @κλειδί η οδηγία ενδέχεται να μην εφαρμοστεί άμεσα όπως αναμένεται. Αντίθετα, το σχήμα μπορεί να παράγει μια δομή απλού τύπου που στερείται κρίσιμων χαρακτηριστικών που απαιτούνται για τη συνένωση. Θα εξετάσουμε πώς να το λύσουμε και θα κάνουμε το σχήμα σας να αποδώσει όπως αναμένεται.

Θα καλύψουμε επίσης κρίσιμες εργασίες διαμόρφωσης, όπως η τροποποίηση της ρύθμισης του διακομιστή GraphQL και η χρήση του σωστού Ζεστή Σοκολάτα και Ομοσπονδία Απόλλωνα πακέτα. Με την κατάλληλη διαμόρφωση, μπορείτε εύκολα να εφαρμόσετε οδηγίες και να εξασφαλίσετε τη σωστή ομοσπονδία σχημάτων για τις υπηρεσίες σας.

Κατανόηση του ρόλου των βασικών οδηγιών στη ζεστή σοκολάτα

Το πρώτο σενάριο εξηγεί πώς να εφαρμόσετε το @κλειδί οδηγία χρησιμοποιώντας HotChocolate σε C#. Αυτό το σενάριο εγγυάται ότι το δημιουργημένο σχήμα GraphQL περιέχει το @κλειδί οδηγία για ομοσπονδία με την Ομοσπονδία Απόλλωνα. Το σενάριο ξεκινά δημιουργώντας ένα Μητρική εταιρεία τάξη και ανάθεση των [Κλειδί] και [ΤΑΥΤΟΤΗΤΑ] χαρακτηριστικά στα πεδία του. Αυτές οι ιδιότητες είναι σημαντικές για την ενημέρωση της HotChocolate για την επισήμανση του ταυτότητα πεδίο ως μοναδικό αναγνωριστικό της οντότητας. Αυτό είναι ζωτικής σημασίας κατά τη δημιουργία μιας ενοποιημένης υπηρεσίας GraphQL στην οποία οι οντότητες μπορούν να κοινοποιηθούν σε πολλές υπηρεσίες. Η επισήμανση αυτού του πεδίου επιτρέπει στην υπηρεσία GraphQL να επιλύσει την οντότητα σε ομοσπονδιακά ερωτήματα.

Ο ReferenceResolver Η λειτουργία είναι επίσης βασικό συστατικό του σεναρίου. Αυτή η στατική συνάρτηση επιτρέπει στο HotChocolate να επιλύσει την οντότητα αναζητώντας το Μητρική εταιρεία αντικείμενο σε ένα αποθετήριο. Ο ParentRepository είναι καταχωρημένο στον διακομιστή GraphQL και το Παίρνω Η μέθοδος ανακτά έναν γονέα μέσω του ταυτότητα. Στον κώδικα εκκίνησης, το .AddQueryType η οδηγία καταχωρεί το Ερώτηση αντικείμενο, το οποίο χρησιμοποιείται για την εκτέλεση ερωτημάτων GraphQL.ΤοRegisterService επιτρέπει την εισαγωγή εξαρτήσεων όπως το ParentRepository σε αναλυτές GraphQL. Αυτός ο σχεδιασμός απλοποιεί την ανάκτηση δεδομένων, διατηρώντας παράλληλα έναν σαφή διαχωρισμό των ανησυχιών.

Το δεύτερο παράδειγμα ακολουθεί μια προσέγγιση πρώτου σχήματος, χρησιμοποιώντας GraphQL SDL (Γλώσσα ορισμού σχήματος) για να ορίσει @κλειδί οδηγία εντός του σχήματος. Αυτή η λύση είναι ιδιαίτερα αποτελεσματική για ομάδες που είναι ήδη εξοικειωμένες με τη σύνταξη SDL του GraphQL. Σε αυτό το παράδειγμα, το @κλειδί η οδηγία εφαρμόζεται στο Μητρική εταιρεία τύπου, υποδεικνύοντας σαφώς το ταυτότητα πεδίο ως μοναδικό αναγνωριστικό. Η χρήση του schema-first επιτρέπει στους προγραμματιστές να έχουν περισσότερο έλεγχο στον τρόπο κατασκευής του σχήματος GraphQL και να το τροποποιούν χωρίς να χρειάζεται να εισέλθουν σε κώδικα C#, καθιστώντας το μια πιο ευέλικτη επιλογή για μεγαλύτερες ομάδες.

Τέλος, το στοιχείο δοκιμής μονάδας επικυρώνει ότι ο κώδικας λειτουργεί όπως προβλέπεται. Χρησιμοποιώντας το πλαίσιο δοκιμής xUnit, το Assert.The Contains Η εντολή διασφαλίζει ότι το σχήμα που προκύπτει περιλαμβάνει το @κλειδί διευθυντικός. Αυτή η δοκιμή επικυρώνει το σχήμα για την παρουσία του @κλειδί οδηγία, επιβεβαιώνοντας ότι η υπηρεσία έχει ρυθμιστεί σωστά για ομοσπονδία. Η δοκιμή μονάδας είναι μια βέλτιστη πρακτική για τη διασφάλιση ότι οι αλλαγές στο σχήμα ή τις μεθόδους επίλυσης GraphQL δεν διαταράσσουν τη λειτουργικότητα, ειδικά σε ένα ομοσπονδιακό σύστημα όπου πολλές υπηρεσίες πρέπει να λειτουργούν απρόσκοπτα μαζί.

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 με Apollo Federation και HotChocolate

Η χρήση του GraphQL με HotChocolate σε ένα ομοσπονδιακό περιβάλλον απαιτεί καλά δομημένη συρραφή σχήματος. Η Ομοσπονδία Apollo επιτρέπει στους προγραμματιστές να κατατμήσουν σχήματα σε διάφορες υπηρεσίες διατηρώντας παράλληλα μια ομοιόμορφη διεπαφή. Χρησιμοποιώντας το @κλειδί οδηγία με HotChocolate, μπορείτε να καθορίσετε τον τρόπο επίλυσης των οντοτήτων GraphQL σε διάφορες υπηρεσίες. Αυτό κάνει το API σας πιο αρθρωτό και επεκτάσιμο, κάτι που είναι ιδιαίτερα ωφέλιμο σε μεγάλα, κατανεμημένα συστήματα όπου πολλές ομάδες ελέγχουν διαφορετικές πτυχές του σχήματος GraphQL.

Σε ένα τυπικό ομοσπονδιακό σχήμα, οντότητες όπως Μητρική εταιρεία μπορεί να υπάρχουν σε πολλές υπηρεσίες. Η Ομοσπονδία Απόλλων χρησιμοποιεί το @κλειδί οδηγία για τον μοναδικό προσδιορισμό μιας οντότητας με βάση ένα καθορισμένο πεδίο, π.χ ταυτότητα. Η υποστήριξη της HotChocolate για την Ομοσπονδία Apollo διασφαλίζει ότι η υπηρεσία σας ενσωματώνεται αβίαστα σε μια μεγαλύτερη υποδομή. Εκτός από τη ρύθμιση κλειδιών, μπορείτε να χρησιμοποιήσετε οδηγίες ομοσπονδίας όπως ως @εκτείνεται ή @εξωτερικός για τη διαχείριση πεδίων δεδομένων διασκορπισμένα σε πολλές μικροϋπηρεσίες, παρέχοντας μεγαλύτερη ευελιξία για τη ρύθμιση του GraphQL.

Ένας άλλος βασικός παράγοντας κατά τη χρήση της HotChocolate είναι η βελτιστοποίηση απόδοσης. Η υπερβολική ανάκτηση δεδομένων είναι ένα κοινό πρόβλημα με τα GraphQL API, ιδιαίτερα σε ομόσπονδα περιβάλλοντα. Χρησιμοποιώντας τους σωστές αναλυτές, όπως το ReferenceResolver που περιγράφεται σε προηγούμενες περιπτώσεις, εγγυάται ότι το API σας παρέχει μόνο τα απαιτούμενα δεδομένα χωρίς υπερβολικές αναζητήσεις. Επιπλέον, το HotChocolate υποστηρίζει προηγμένους αλγόριθμους ομαδοποίησης ερωτημάτων και προσωρινής αποθήκευσης, οι οποίοι μπορούν να αυξήσουν τις ταχύτητες απόκρισης και την αποτελεσματικότητα του API σε ένα ομοσπονδιακό σχήμα.