Im vorherigen Artikel habe ich eine einfache RPC-Schnittstelle mithilfe des Pakets „net/rpc“ implementiert und die Gob-Kodierung ausprobiert, die mit „net/rpc“ und der JSON-Kodierung geliefert wird, um einige Grundlagen von Golang zu erlernen RPC. In diesem Beitrag kombiniere ich net/rpc mit protobuf und erstelle mein protobuf-Plugin, um uns beim Generieren von Code zu helfen, also fangen wir an.

Dieser Artikel wurde zuerst im Medium MPP-Plan veröffentlicht. Wenn Sie ein Medium-Benutzer sind, folgen Sie mir bitte auf Medium. Vielen Dank.

Wir müssen während unserer Arbeit gRPC und Protobuf verwendet haben, aber sie sind nicht gebunden. gRPC kann mit JSON codiert werden und Protobuf kann in anderen Sprachen implementiert werden.

Protocol Buffers (Protobuf) ist ein kostenloses und plattformübergreifendes Open-Source-Datenformat, das zur Serialisierung strukturierter Daten verwendet wird. Es ist nützlich bei der Entwicklung von Programmen, die über ein Netzwerk miteinander kommunizieren, oder zum Speichern von Daten. Die Methode umfasst eine Schnittstellenbeschreibungssprache, die die Struktur einiger Daten beschreibt, und ein Programm, das aus dieser Beschreibung Quellcode generiert, um einen Bytestrom zu generieren oder zu analysieren, der die strukturierten Daten darstellt.

Ein Beispiel für die Verwendung von Protobuf

Zuerst schreiben wir eine Proto-Datei hello-service.proto, die eine Nachricht „String“ definiert

syntax = "proto3";
package api;
option  go_package="api";

message String {
  string value = 1;
}

Verwenden Sie dann das Protoc-Dienstprogramm, um den Go-Code für die Nachrichtenzeichenfolge zu generieren

protoc --go_out=. hello-service.proto

Dann ändern wir die Argumente der Hello-Funktion, um den von der Protobuf-Datei generierten String zu verwenden.

type HelloServiceInterface = interface {  
    Hello(request api.String, reply *api.String) error  
}  

Die Verwendung unterscheidet sich nicht von zuvor, auch wenn sie nicht so praktisch ist wie die direkte Verwendung von Zeichenfolgen. Warum sollten wir also Protobuf verwenden? Wie ich bereits sagte, in der Verwendung von Protobuf zum Definieren sprachunabhängiger RPC-Dienstschnittstellen und -Nachrichten und der anschließenden Verwendung des Protoc-Tools zum Generieren von Code in verschiedenen Sprachen liegt der wahre Wert darin. Verwenden Sie beispielsweise das offizielle Plugin protoc-gen-go, um gRPC-Code zu generieren.

protoc --go_out=plugins=grpc. hello-service.proto

Plugin-System für Protokoll

Um Code aus Protobuf-Dateien zu generieren, müssen wir das Protokoll installieren, aber das Protokoll kennt unsere Zielsprache nicht, daher benötigen wir Plugins, die uns beim Generieren von Code helfen. Wie funktioniert das Plugin-System von Protoc? Nehmen Sie den obigen grpc als Beispiel.

Hier gibt es einen Parameter --go_out. Da das Plugin, das wir aufrufen, protoc-gen-go ist, heißt der Parameter go_out; Wenn der Name XXX wäre, würde der Parameter XXX_out heißen.

Wenn Protoc ausgeführt wird, analysiert es zunächst die Protobuf-Datei und generiert einen Satz von Protokollpuffern codierten beschreibenden Daten. Es wird zunächst feststellen, ob das Go-Plugin in Protoc enthalten ist oder nicht, und dann wird versucht, in $PATH nach Protoc-Gen-Go zu suchen. Wenn es es nicht finden kann, wird ein Fehler gemeldet, und dann wird es angezeigt wird protoc-gen-go ausführen. protoc-gen-go-Befehl und sendet die Beschreibungsdaten über stdin an den Plugin-Befehl. Nachdem das Plugin den Dateiinhalt generiert hat, gibt es mit Protocol Buffers codierte Daten in stdout ein, um protoc anzuweisen, die spezifische Datei zu generieren.

Plugins=grpc ist ein Plugin, das mit protoc-gen-go geliefert wird, um es aufzurufen. Wenn Sie es nicht verwenden, wird nur eine Nachricht in Go generiert. Sie können dieses Plugin jedoch verwenden, um grpc-bezogenen Code zu generieren.

Passen Sie ein Protokoll-Plugin an

Wenn wir das Hello-Interface-Timing zu Protobuf hinzufügen, können wir dann ein Protoc-Plugin anpassen, um Code direkt zu generieren?

syntax = "proto3";  
package api;  
option  go_package="./api";  
service HelloService {  
  rpc Hello (String) returns (String) {}  
}  
message String {  
  string value = 1;
}

Objektiv

Für diesen Artikel war es mein Ziel, ein Plugin zu erstellen, das dann zum Generieren von serverseitigem und clientseitigem RPC-Code verwendet wird, der etwa so aussieht.

// HelloService_rpc.pb.go
type HelloServiceInterface interface {  
    Hello(String, *String) error  
}  

func RegisterHelloService(  
    srv *rpc.Server, x HelloServiceInterface,  
) error {  
    if err := srv.RegisterName("HelloService", x); err != nil {  
       return err  
    }  
    return nil  
}  

type HelloServiceClient struct {  
    *rpc.Client  
}  

var _ HelloServiceInterface = (*HelloServiceClient)(nil)  

func DialHelloService(network, address string) (  
    *HelloServiceClient, error,  
) {  
    c, err := rpc.Dial(network, address)  
    if err != nil {  
       return nil, err  
    }  
    return &HelloServiceClient{Client: c}, nil  
}  

func (p *HelloServiceClient) Hello(  
    in String, out *String,  
) error {  
    return p.Client.Call("HelloService.Hello", in, out)  
}

Dies würde unseren Geschäftscode so ändern, dass er wie folgt aussieht

// service
func main() {  
    listener, err := net.Listen("tcp", ":1234")  
    if err != nil {  
       log.Fatal("ListenTCP error:", err)  
    }  
    _ = api.RegisterHelloService(rpc.DefaultServer, new(HelloService))  
    for {  
       conn, err := listener.Accept()  
       if err != nil {  
          log.Fatal("Accept error:", err)  
       }  
       go rpc.ServeConn(conn)  
    }  
}  

type HelloService struct{}  

func (p *HelloService) Hello(request api.String, reply *api.String) error {  
    log.Println("HelloService.proto Hello")  
    *reply = api.String{Value: "Hello:"   request.Value}  
    return nil  
}
// client.go
func main() {  
    client, err := api.DialHelloService("tcp", "localhost:1234")  
    if err != nil {  
       log.Fatal("net.Dial:", err)  
    }  
    reply := &api.String{}  
    err = client.Hello(api.String{Value: "Hello"}, reply)  
    if err != nil {  
       log.Fatal(err)  
    }  
    log.Println(reply)  
}

Basierend auf dem generierten Code ist unser Arbeitsaufwand bereits viel geringer und die Fehlerwahrscheinlichkeit bereits sehr gering. Ein guter Anfang.

Basierend auf dem obigen API-Code können wir eine Vorlagendatei abrufen:

const tmplService = `  
import (  
    "net/rpc")  
type {{.ServiceName}}Interface interface {  
func Register{{.ServiceName}}(  
    if err := srv.RegisterName("{{.ServiceName}}", x); err != nil {        return err    }    return nil}  
    *rpc.Client}  
func Dial{{.ServiceName}}(network, address string) (  
{{range $_, $m := .MethodList}}  
    return p.Client.Call("{{$root.ServiceName}}.{{$m.MethodName}}", in, out)}  
`

Die gesamte Vorlage ist klar und enthält einige Platzhalter wie MethodName, ServiceName usw., auf die wir später noch eingehen.

Wie entwickle ich ein Plug-in?

Google hat die Go-Sprach-API 1 veröffentlicht, die ein neues Paket google.golang.org/protobuf/compile R/protogen einführt, das die Schwierigkeit der Plugin-Entwicklung erheblich reduziert:

1. Zuerst erstellen wir ein Go-Sprachprojekt, wie zum Beispiel protoc-gen-go-spprpc
2. Dann müssen wir eine protogen.Options definieren, dann ihre Run-Methode aufrufen und einen func(*protogen.Plugin)-Fehlerrückruf übergeben. Dies ist das Ende des Hauptprozesscodes.
3. Wir können auch den ParamFunc-Parameter von protogen.Options festlegen, sodass Protogen die von der Befehlszeile übergebenen Parameter automatisch für uns analysiert. Vorgänge wie das Lesen und Dekodieren von Protobuf-Informationen aus der Standardeingabe, das Kodieren von Eingabeinformationen in Protobuf und das Schreiben von Stdout werden alle von Protogen übernommen. Was wir tun müssen, ist mit protogen.Plugin zu interagieren, um Codegenerierungslogik zu implementieren.

Das Wichtigste für jeden Dienst ist der Name des Dienstes, und dann verfügt jeder Dienst über eine Reihe von Methoden. Für die vom Dienst definierte Methode ist das Wichtigste der Name der Methode sowie der Name des Eingabeparameters und der Typ des Ausgabeparameters. Definieren wir zunächst ein ServiceData, um die Metainformationen des Dienstes zu beschreiben:

// ServiceData 
type ServiceData struct {  
    PackageName string  
    ServiceName string  
    MethodList  []Method  
}
// Method 
type Method struct {  
    MethodName     string  
    InputTypeName  string  
    OutputTypeName string  
}

Dann kommt die Hauptlogik und die Codegenerierungslogik und schließlich der Aufruf von tmpl, um den Code zu generieren.

func main() {  
    protogen.Options{}.Run(func(gen *protogen.Plugin) error {  
       for _, file := range gen.Files {  
          if !file.Generate {  
             continue  
          }  
          generateFile(gen, file)  
       }  
       return nil  
    })  
}  

// generateFile function definition
func generateFile(gen *protogen.Plugin, file *protogen.File) {  
    filename := file.GeneratedFilenamePrefix   "_rpc.pb.go"  
    g := gen.NewGeneratedFile(filename, file.GoImportPath)  
    tmpl, err := template.New("service").Parse(tmplService)  
    if err != nil {  
       log.Fatalf("Error parsing template: %v", err)  
    }  
    packageName := string(file.GoPackageName)  
// Iterate over each service to generate code
    for _, service := range file.Services {  
       serviceData := ServiceData{  
          ServiceName: service.GoName,  
          PackageName: packageName,  
       }  
       for _, method := range service.Methods {  
          inputType := method.Input.GoIdent.GoName  
          outputType := method.Output.GoIdent.GoName  

          serviceData.MethodList = append(serviceData.MethodList, Method{  
             MethodName:     method.GoName,  
             InputTypeName:  inputType,  
             OutputTypeName: outputType,  
          })  
       }  
// Perform template rendering
       err = tmpl.Execute(g, serviceData)  
       if err != nil {  
          log.Fatalf("Error executing template: %v", err)  
       }  
    }  
}

Debug-Plugin

Schließlich legen wir die kompilierte binäre Ausführungsdatei protoc-gen-go-spprpc in $PATH ab und führen dann protoc aus, um den gewünschten Code zu generieren.

protoc --go_out=.. --go-spprpc_out=.. HelloService.proto

Da protoc-gen-go-spprpc für die Ausführung auf protoc angewiesen ist, ist das Debuggen etwas schwierig. Wir können
verwenden

fmt.Fprintf(os.Stderr, "Fprintln: %v\n", err)

Zum Drucken des Fehlerprotokolls zum Debuggen.

Zusammenfassung

Das ist alles, was dieser Artikel zu bieten hat. Wir haben zunächst einen RPC-Aufruf mit protobuf implementiert und dann ein protobuf-Plugin erstellt, das uns bei der Generierung des Codes hilft. Dies öffnet uns die Tür zum Erlernen von Protobuf-RPC und ist unser Weg zu einem gründlichen Verständnis von gRPC. Ich hoffe, dass jeder diese Technologie beherrschen kann.

Referenz

1. https://taoshu.in/go/create-protoc-plugin.html
2. https://chai2010.cn/advanced-go-programming-book/ch4-rpc/ch4-02-pb-intro.html