gRPC-koodin generointi

Tervetuloa takaisin! Edellisessä oppitunnissa opimme määrittelemään tietorakenteita ja palveluita Protocol Buffersin (Protobuf) avulla.

Miten näitä määrittelyjä sitten käytetään valitsemassamme ohjelmointikielessä? Tässä kohtaa koodin generointi astuu kuvaan!

Se tarkoittaa lähdekoodin automaattista luomista skeemasta, joten toistuvaa runkokoodia ei tarvitse kirjoittaa käsin.

gRPC perustuu vahvasti generoituun koodiin, josta käytetään usein nimityksiä tyngät tai välityspalvelimet. Nämä toimivat siltana sovelluslogiikkasi ja gRPC:n taustalla olevien viestintämekanismien välillä.

• Asiakkaan tyngät: tarjoavat metodeja, jotka vastaavat .proto-tiedostossa määriteltyä palvelua. Kun kutsut asiakkaan tynkämetodia, se pakkaa tiedot, lähettää ne verkon yli ja purkaa vastauksen.
• Palvelimen tyngät: määrittävät rajapinnan, jonka palvelintoteutuksen on täytettävä. Ne käsittelevät pyyntöjen vastaanottamisen, välittävät ne koodillesi ja lähettävät vastaukset takaisin.

Näiden tynkien luonnin taustalla on Protobuf Compiler, joka tunnetaan yleisesti nimellä protoc.

protoc on komentorivityökalu, joka lukee .proto-tiedostosi ja luo lähdekoodia eri kielillä määrittämiesi liitännäisten perusteella.

Se on olennainen osa jokaista gRPC-projektia, sillä se varmistaa vahvan tyypityksen ja yhdenmukaiset viestintärajapinnat eri palveluiden ja ohjelmointikielten välillä.

protoc-komennon yleinen syntaksi näyttää tältä:

protoc --<LANG>_out=. --grpc_out=. my_service.proto

• --<LANG>_out=.: Tämä valitsin käskee protoc-ohjelmaa luomaan Protobuf-viestiluokat tietylle kielelle (esimerkiksi --java_out tai --python_out) ja määrittää niiden sijainnin (. tarkoittaa nykyistä hakemistoa).
• --grpc_out=.: Tämä valitsin, jota käytetään usein gRPC-kohtaisen liitännäisen kanssa, luo gRPC-palvelurajapinnan ja tynkäluokat.
• my_service.proto: Protobuf-määritystiedoston polku.

Ennen kuin voit luoda koodia, sinun on asennettava protoc. Asennusprosessi vaihtelee käyttöjärjestelmän mukaan:

• Binäärin lataaminen: Voit ladata valmiiksi käännettyjä binäärejä viralliselta Protobufin GitHub-julkaisut-sivulta.
• Pakettienhallinta: Linuxissa voit käyttää komentoa apt-get install protobuf-compiler. macOS:ssä komento on brew install protobuf.
• Lähdekoodista kääntäminen: Edistyneet käyttäjät voivat kääntää ohjelman sen lähdekoodista.

Varmista aina, että protoc löytyy järjestelmäsi PATH-muuttujasta.

Käytetään yksinkertaista greet.proto-tiedostoa koodin luonnin havainnollistamiseen. Tämä tiedosto määrittelee Greeter-palvelun ja sen viestit:

syntax = "proto3";

package greeter;

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

Tämä toimii protoc-kääntäjämme syötteenä.

Luodaksemme Java-koodia greet.proto-tiedostostamme käyttäisimme tyypillisesti esimerkiksi seuraavaa komentoa:

protoc \
  --plugin=protoc-gen-grpc-java=/path/to/grpc-java-plugin \
  --java_out=. \
  --grpc_out=. \
  greet.proto

Tässä --plugin kertoo protoc-ohjelmalle tarkasti, mistä gRPC Java -liitännäinen löytyy. Liitännäinen tarvitaan gRPC-palvelurajapintojen luomiseen.

Kun olet suorittanut protoc-komennon, määrittämääsi tuloshakemistoon ilmestyy uusia Java-tiedostoja. greet.proto-esimerkkimme yhteydessä näet tyypillisesti seuraavat tiedostot:

• GreeterGrpc.java: Sisältää abstraktin GreeterImplBase-palvelun ja asiakkaan tynkäluokat (esimerkiksi GreeterBlockingStub ja GreeterFutureStub).
• Greet.java: Säilöluokka, joka sisältää luodut Protobuf-viestiluokat, kuten HelloRequest- ja HelloReply-luokat, sekä niiden rakentajat ja aksessorit.

Nämä tiedostot huolehtivat kaikista sarjallistamiseen, sarjallistamisen purkamiseen ja verkkoviestintään liittyvistä yksityiskohdista.

On tärkeää ymmärtää, että protoc luo itsessään vain Protobuf-viestien perusluokat.

gRPC-kohtaisten palvelurajapintojen ja tynkien luomiseen se käyttää liitännäisiä. Javaa varten tarvitaan esimerkiksi protoc-gen-grpc-java-liitännäinen.

Jokaisella gRPC:n tukemalla kielellä (Python, Go, C++, Node.js ja muut) on oma liitännäisensä, joka yhdistyy protoc-ohjelmaan ja tuottaa tarvittavan gRPC-koodin.

Hienoa työtä! Olet oppinut gRPC-koodin luonnin perusprosessin:

• Ymmärsit, miksi tyngät ovat välttämättömiä gRPC-viestinnässä.
• Tutustuit protoc-kääntäjään, joka suorittaa koodin luonnin.
• Näimme, kuinka liitännäiset laajentavat protoc-ohjelmaa kielikohtaisen gRPC-koodin luomiseksi.
• Kävimme läpi esimerkin Java-koodin luomisesta .proto-määrityksen perusteella.

Seuraavaksi käytämme luotua koodia yksinkertaisen yksisuuntaisen gRPC-palvelun ja asiakkaan toteuttamiseen!