GraphQL mit Golang: Ein tiefer Sprung von den Grundlagen zum Fortgeschrittenen

GraphQL hat sich in den letzten Jahren zu einem Schlagwort entwickelt, nachdem Facebook es als Open Source veröffentlicht hat. Ich habe GraphQL mit Node.js ausprobiert und bin mit der ganzen Begeisterung über die Vorteile und die Einfachheit von GraphQL einverstanden.

Was ist GraphQL? Dies ist, was die offizielle GraphQL-Definition sagt:

GraphQL ist eine Abfragesprache für APIs und zur Laufzeit, um diese Abfragen mit Ihren vorhandenen Daten zu erfüllen. GraphQL bietet eine vollständige und verständliche Beschreibung der Daten in Ihrer API, gibt Kunden die Möglichkeit, genau zu fragen, was sie benötigen, und nicht mehr, erleichtert die Entwicklung von APIs im Laufe der Zeit und ermöglicht leistungsstarke Entwicklertools.

Ich bin kürzlich für ein neues Projekt, an dem ich arbeite (von Node.js), zu Golang gewechselt und habe beschlossen, GraphQL damit auszuprobieren. Es gibt nicht viele Bibliotheksoptionen mit Golang, aber ich habe es mit Thunder, graphql, graphql-go und gqlgen versucht. Und ich muss sagen, dass gqlgen unter allen Bibliotheken, die ich ausprobiert habe, gewinnt.

gqlgen befindet sich zum Zeitpunkt des Schreibens dieses Artikels noch in der Beta-Version mit der neuesten Version 0.7.2 und entwickelt sich rasant weiter. Ihre Roadmap finden Sie hier. Und jetzt sponsert 99designs sie offiziell, sodass wir eine noch bessere Entwicklungsgeschwindigkeit für dieses großartige Open-Source-Projekt sehen werden. vektah und neelance tragen maßgeblich dazu bei, und neelance hat auch graphql-go geschrieben.

Tauchen wir also in die Bibliothekssemantik ein, vorausgesetzt, Sie verfügen über grundlegende GraphQL-Kenntnisse.

Höhepunkte

Wie ihre Überschrift besagt,

Dies ist eine Bibliothek zum schnellen Erstellen streng typisierter GraphQL-Server in Golang.

Ich denke, das ist das vielversprechendste an der Bibliothek: Sie werden es hier nie sehen map[string]interface{}, da es einen streng typisierten Ansatz verwendet.

Abgesehen davon wird ein Schema-First-Ansatz verwendet : Sie definieren Ihre API mithilfe der graphql Schema Definition Language. Dies hat seine eigenen leistungsstarken Tools zur Codegenerierung, die Ihren gesamten GraphQL-Code automatisch generieren, und Sie müssen nur die Kernlogik dieser Schnittstellenmethode implementieren.

Ich habe diesen Artikel in zwei Phasen unterteilt:

  • Die Grundlagen: Konfiguration, Mutationen, Abfragen und Abonnement
  • Fortgeschrittene: Authentifizierung, Datenlader und Abfragekomplexität

Phase 1: Die Grundlagen - Konfiguration, Mutationen, Abfragen und Abonnements

Wir werden eine Video-Publishing-Site als Beispiel verwenden, in der ein Benutzer ein Video veröffentlichen, Screenshots hinzufügen, eine Bewertung hinzufügen und Videos und verwandte Videos abrufen kann.

mkdir -p $GOPATH/src/github.com/ridhamtarpara/go-graphql-demo/

Erstellen Sie das folgende Schema im Projektstamm:

Hier haben wir unsere Grundmodelle und eine Mutation zum Veröffentlichen neuer Videos sowie eine Abfrage zum Abrufen aller Videos definiert. Weitere Informationen zum graphql-Schema finden Sie hier. Wir haben auch einen benutzerdefinierten Typ (Skalar) definiert, da graphql standardmäßig nur 5 Skalartypen hat, darunter Int, Float, String, Boolean und ID.

Wenn Sie also einen benutzerdefinierten Typ verwenden möchten, können Sie einen benutzerdefinierten Skalar in schema.graphql(wie von uns definiert Timestamp) definieren und dessen Definition im Code bereitstellen. In gqlgen müssen Sie Marschall- und Unmarschall-Methoden für alle benutzerdefinierten Skalare bereitstellen und diesen zuordnen gqlgen.yml.

Eine weitere wichtige Änderung in gqlgen in der letzten Version besteht darin, dass die Abhängigkeit von kompilierten Binärdateien entfernt wurde. Fügen Sie Ihrem Projekt unter scripts / gqlgen.go die folgende Datei hinzu.

und initialisiere dep mit:

dep init

Jetzt ist es an der Zeit, die Codegen-Funktion der Bibliothek zu nutzen, die den gesamten langweiligen (aber für einige interessante) Skelettcode generiert.

go run scripts/gqlgen.go init

Dadurch werden die folgenden Dateien erstellt:

gqlgen.yml - Konfigurationsdatei zur Steuerung der Codegenerierung.

generate.go - Der generierte Code, den Sie möglicherweise nicht sehen möchten.

models_gen.go - Alle Modelle für die Eingabe und den Typ Ihres bereitgestellten Schemas.

resolver.go - Sie müssen Ihre Implementierungen schreiben.

server / server.go - Einstiegspunkt mit einem http.Handler zum Starten des GraphQL-Servers.

Schauen wir uns eines der generierten Modelle des VideoTyps an:

Wie Sie sehen, wird ID hier als Zeichenfolge definiert und CreatedAt ist auch eine Zeichenfolge. Andere verwandte Modelle werden entsprechend zugeordnet, aber in der realen Welt möchten Sie dies nicht. Wenn Sie einen SQL-Datentyp verwenden, möchten Sie, dass Ihr ID-Feld je nach Datenbank int oder int64 ist.

Zum Beispiel verwende ich PostgreSQL für die Demo, also möchte ich natürlich ID als int und CreatedAt als time.Time . Wir müssen also unser eigenes Modell definieren und gqlgen anweisen, unser Modell zu verwenden, anstatt ein neues zu generieren.

und aktualisieren Sie gqlgen, um diese Modelle wie folgt zu verwenden:

Der Schwerpunkt liegt also auf den benutzerdefinierten Definitionen für ID und Zeitstempel mit den Marshall- und Unmarschall-Methoden und deren Zuordnung in einer Datei gqlgen.yml. Wenn der Benutzer eine Zeichenfolge als ID angibt, konvertiert UnmarshalID eine Zeichenfolge in eine int. Während des Sendens der Antwort konvertiert MarshalID int in string. Gleiches gilt für den Zeitstempel oder einen anderen von Ihnen definierten benutzerdefinierten Skalar.

Jetzt ist es Zeit, echte Logik zu implementieren. Öffnen Sie resolver.godie Definition für Mutationen und Abfragen und geben Sie sie an. Die Stubs werden bereits automatisch mit einer nicht implementierten Panikanweisung generiert. Lassen Sie uns dies überschreiben.

und treffen Sie die Mutation:

Ohh es hat funktioniert ... aber warte, warum ist mein Benutzer leer? Hier gibt es also ein ähnliches Konzept wie faules und eifriges Laden. Da graphQL erweiterbar ist, müssen Sie definieren, welche Felder Sie eifrig und welche träge füllen möchten.

I have created this golden rule for my organization team working with gqlgen:

Don’t include the fields in a model which you want to load only when requested by the client.

For our use-case, I want to load Related Videos (and even users) only if a client asks for those fields. But as we have included those fields in the models, gqlgen will assume that you will provide those values while resolving video — so currently we are getting an empty struct.

Sometimes you need a certain type of data every time, so you don’t want to load it with another query. Rather you can use something like SQL joins to improve performance. For one use-case (not included in the article), I needed video metadata every time with the video which is stored in a different place. So if I loaded it when requested, I would need another query. But as I knew my requirements (that I need it everywhere on the client side), I preferred it to load eagerly to improve the performance.

So let’s rewrite the model and regenerate the gqlgen code. For the sake of simplicity, we will only define methods for the user.

So we have added UserID and removed User struct and regenerated the code:

go run scripts/gqlgen.go -v

This will generate the following interface methods to resolve the undefined structs and you need to define those in your resolver:

And here is our definition:

Now the result should look something like this:

So this covers the very basics of graphql and should get you started. Try a few things with graphql and the power of Golang! But before that, let’s have a look at subscription which should be included in the scope of this article.

Subscriptions

Graphql provides subscription as an operation type which allows you to subscribe to real tile data in GraphQL. gqlgen provides web socket-based real-time subscription events.

You need to define your subscription in the schema.graphql file. Here we are subscribing to the video publishing event.

Regenerate the code by running: go run scripts/gqlgen.go -v.

As explained earlier, it will make one interface in generated.go which you need to implement in your resolver. In our case, it looks like this:

Now, you need to emit events when a new video is created. As you can see on line 23 we have done that.

And it’s time to test the subscription:

GraphQL comes with certain advantages, but everything that glitters is not gold. You need to take care of a few things like authorizations, query complexity, caching, N+1 query problem, rate limiting, and a few more issues — otherwise it will put you in performance jeopardy.

Phase 2: The advanced - Authentication, Dataloaders, and Query Complexity

Every time I read a tutorial like this, I feel like I know everything I need to know and can get my all problems solved.

But when I start working on things on my own, I usually end up getting an internal server error or never-ending requests or dead ends and I have to dig deep into that to carve my way out. Hopefully we can help prevent that here.

Let’s take a look at a few advanced concepts starting with basic authentication.

Authentication

In a REST API, you have a sort of authentication system and some out of the box authorizations on particular endpoints. But in GraphQL, only one endpoint is exposed so you can achieve this with schema directives.

You need to edit your schema.graphql as follows:

We have created an isAuthenticated directive and now we have applied that directive to createVideo subscription. After you regenerate code you need to give a definition of the directive. Currently, directives are implemented as struct methods instead of the interface so we have to give a definition.

I have updated the generated code of server.go and created a method to return graphql config for server.go as follows:

We have read the userId from the context. Looks strange right? How was userId inserted in the context and why in context? Ok, so gqlgen only provides you the request contexts at the implementation level, so you can not read any of the HTTP request data like headers or cookies in graphql resolvers or directives. Therefore, you need to add your middleware and fetch those data and put the data in your context.

So we need to define auth middleware to fetch auth data from the request and validate.

I haven’t defined any logic there, but instead I passed the userId as authorization for demo purposes. Then chain this middleware in server.go along with the new config loading method.

Now, the directive definition makes sense. Don’t handle unauthorized users in your middleware as it will be handled by your directive.

Demo time:

You can even pass arguments in the schema directives like this:

directive @hasRole(role: Role!) on FIELD_DEFINITIONenum Role { ADMIN USER }

Dataloaders

This all looks fancy, doesn’t it? You are loading data when needed. Clients have control of the data, there is no under-fetching and no over-fetching. But everything comes with a cost.

So what’s the cost here? Let’s take a look at the logs while fetching all the videos. We have 8 video entries and there are 5 users.

query{ Videos(limit: 10){ name user{ name } }}
Query: Videos : SELECT id, name, description, url, created_at, user_id FROM videos ORDER BY created_at desc limit $1 offset $2Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1

Why 9 queries (1 videos table and 8 users table)? It looks horrible. I was just about to have a heart attack when I thought about replacing our current REST API servers with this…but dataloaders came as a complete cure for it!

This is known as the N+1 problem, There will be one query to get all the data and for each data (N) there will be another database query.

This is a very serious issue in terms of performance and resources: although these queries are parallel, they will use your resources up.

We will use the dataloaden library from the author of gqlgen. It is a Go- generated library. We will generate the dataloader for the user first.

go get github.com/vektah/dataloadendataloaden github.com/ridhamtarpara/go-graphql-demo/api.User

This will generate a file userloader_gen.go which has methods like Fetch, LoadAll, and Prime.

Now, we need to define the Fetch method to get the result in bulk.

Here, we are waiting for 1ms for a user to load queries and we have kept a maximum batch of 100 queries. So now, instead of firing a query for each user, dataloader will wait for either 1 millisecond for 100 users before hitting the database. We need to change our user resolver logic to use dataloader instead of the previous query logic.

After this, my logs look like this for similar data:

Query: Videos : SELECT id, name, description, url, created_at, user_id FROM videos ORDER BY created_at desc limit $1 offset $2Dataloader: User : SELECT id, name, email from users WHERE id IN ($1, $2, $3, $4, $5)

Now only two queries are fired, so everyone is happy. The interesting thing is that only five user keys are given to query even though 8 videos are there. So dataloader removed duplicate entries.

Query Complexity

In GraphQL you are giving a powerful way for the client to fetch whatever they need, but this exposes you to the risk of denial of service attacks.

Let’s understand this through an example which we’ve been referring to for this whole article.

Now we have a related field in video type which returns related videos. And each related video is of the graphql video type so they all have related videos too…and this goes on.

Consider the following query to understand the severity of the situation:

{ Videos(limit: 10, offset: 0){ name url related(limit: 10, offset: 0){ name url related(limit: 10, offset: 0){ name url related(limit: 100, offset: 0){ name url } } } }}

If I add one more subobject or increase the limit to 100, then it will be millions of videos loading in one call. Perhaps (or rather definitely) this will make your database and service unresponsive.

gqlgen provides a way to define the maximum query complexity allowed in one call. You just need to add one line (Line 5 in the following snippet) in your graphql handler and define the maximum complexity (300 in our case).

gqlgen assigns fix complexity weight for each field so it will consider struct, array, and string all as equals. So for this query, complexity will be 12. But we know that nested fields weigh too much, so we need to tell gqlgen to calculate accordingly (in simple terms, use multiplication instead of just sum).

Just like directives, complexity is also defined as struct, so we have changed our config method accordingly.

I haven’t defined the related method logic and just returned the empty array. So related is empty in the output, but this should give you a clear idea about how to use the query complexity.

Final Notes

This code is on Github. You can play around with it, and if you have any questions or concerns let me know in the comment section.

Thanks for reading! A few (hopefully 50) claps? are always appreciated. I write about JavaScript, the Go Language, DevOps, and Computer Science. Follow me and share this article if you like it.

Reach out to me on @Twitter @Linkedin. Visit www.ridham.me for more.