[RAILS] Implémenter le client gRPC dans Ruby

Notez la procédure d'implémentation du client gRPC dans Ruby à titre de rappel.

Tout d'abord, insérez la gemme

--Installez la gemme grpc pour utiliser gRPC dans Ruby

• En incluant cela, vous pourrez utiliser les classes requises pour l'implémentation du client.

gem 'grpc', '~> X.XX.X'

Obtenir et compiler des fichiers .proto

• Il existe plusieurs façons de gérer les fichiers .proto, mais consultez cet article pour plus de détails. --Utilisez un Gem appelé grpc_tools pour compiler .proto dans un fichier rb

$ gem install grpc-tools

• La commande compile ressemble à ce qui suit

$ grpc_tools_ruby_protoc -I ./proto \--ruby_out=lib --grpc_out=lib ./proto/hoge_proto/*.proto

--Spécifiez le répertoire dans lequel rechercher les fichiers .proto avec l'option -I --Spécifiez le répertoire de destination de sortie après la compilation avec l'option --ruby_out ――C'est bien n'importe où, mais il semble qu'il y en ait beaucoup / lib

• Le premier argument de l'option --grpc_out spécifie la destination de sortie du fichier de classe qui sera le stub après la compilation, et le deuxième argument spécifie le répertoire contenant le fichier .proto à compiler.
• Si la compilation réussit, le fichier pb.rb correspondant à chaque proto et le fichier hoge_services_pb.rb qui les importe tous et les modularise sont générés. --Ce hoge_services_pb.rb a la définition de la méthode rpc et la définition de Stub, et cette classe sera utilisée pour l'appel.

Implémentation du stub client

Maintenant que les préparatifs sont terminés, nous allons le mettre en œuvre à partir d'ici. Tout d'abord, créez l'instance stub requise pour effectuer l'appel gRPC. En ce qui concerne la création d'instances de stub, je vois souvent la méthode de création d'un fichier sous / initializer et d'en créer un nouveau, mais je ne voulais pas creuser dans les variables globales, donc cette fois j'ai coupé la classe de modèle et appliqué le modèle singleton. Mis en œuvre en. Pour être honnête, je suis toujours à la recherche des meilleures pratiques ici.

model/grpc/hoge_service_client.rb

require 'proto/hoge_services_pb'
require 'singleton'

#Il est préférable de le faire à partir du fichier de configuration de chaque environnement
END_POINT = "localhost:50051"

class Grpc::HogeServiceClient
  include Singleton

  attr_reader :stub

  def initialize
    @stub = HogeProto::HogeService::Stub.new(END_POINT, :this_channel_is_insecure)
  end
end

• Pour la partie de création d'instance de stub, comme mentionné ci-dessus, le stub décrit dans hoge_services_pb.rb est créé en tant que nouvelle instance.
• Le premier argument de new spécifie le point de terminaison du serveur gRPC
• Le deuxième argument est un argument pour le chiffrement lors de la communication rpc, et si vous voulez le faire fonctionner correctement, vous devrez spécifier le chemin du certificat SSL, etc.

Appelez en fait le serveur gRPC

Essayez d'appeler rpc en utilisant le stub créé ci-dessus

grpc/hoge.rb

class Grpc::Hoge
  def get_name(params)
    #Créer une instance de modèle qui a une instance de stub
    client = Grpc::HogeServiceClient.instance
    #Créer les données de demande requises pour l'appel RPC
    req = get_name_request(params)
    #Créez des métadonnées si nécessaire
    meta = Hash.new
    meta["x-app-id"] = "hogeghoge"
    meta["x-app-password"] = "fugafuga"

    begin
      #Ici appel RPC
      client.stub.get_name(req, {metadata: meta})
      res = "success"
    rescue GRPC::BadStatus => ex
      res = "error"
    rescue ex
      res = "unexpected error"
    end

    res
  end

  private

  def get_name_request(params)
    HogeProto::GetNameRequest.new(
      id: params[:id]
    )
  end

--Rpc est appelé dans la partie de client.stub.get_name --Si le résultat de cet appel est une erreur (Status.Codes n'est pas OK), une exception se produira, donc mettez-la dans begin et rescue s'il s'agit d'une erreur. --Pour «meta», les métadonnées sont définies au moment de l'appel gRPC.

• Ici, l'ID et le mot de passe sont définis, mais il semble préférable d'initialiser les éléments nécessaires communs en tant que variables d'instance du côté du modèle qui crée le stub. --Il semble que vous puissiez définir la valeur au format Hash normalement. ―― Cependant, notez que vous ne pouvez pas utiliser de lettres majuscules pour les touches.

À propos de la gestion des erreurs

Comme je l'ai mentionné précédemment, lorsqu'un appel rpc renvoie une réponse d'état d'erreur, une exception de la classe GRPC :: BadStatus se produit. Par conséquent, il est nécessaire de toujours commencer ~ sauvetage. De plus, si le côté serveur retourne avec error_details compressé, il est nécessaire de l'implémenter pour le récupérer. Référence: https://www.rubydoc.info/gems/grpc/GRPC/BadStatus