grpc后端服务间通信开发实践

本章将完成一个grpc客户端和服务端的开发示例，模拟在日常场景下，后端服务之间的通信，此次示例客户端使用php，服务端使用golang。php需要安装grpc、protobuf拓展

一、开发流程

1. 服务端与客户端开发人员设计和确认proto 接口数据结构文件
2. 双方使用protoc 命令生成具体的接口数据结构代码，安装protobuf
3. 服务端实现逻辑
4. 客户端调用

二、流程

2.1 定义proto文件

Auth.proto 文件

syntax = "proto3";

package system.auth;

// 指定go包路径，generate所需
option go_package = "./system/auth";

// 鉴权服务
service AuthService {
  // 检测授权状态 一元rpc模式
  rpc CheckAuthState (AuthRequest) returns (AuthResponse) {}
  rpc Example(ExampleRequest) returns (ExampleResponse) {}
}

message ExampleRequest {
  string name = 1;
  int32 age = 2;
}

message ExampleResponse {
  int32 code = 1;
  string msg = 2;
  repeated UserData data = 3;
}

// 鉴权服务请求体
message AuthRequest {
  string token = 1;
}
// 用户data结构
message UserData {
  double user_id = 1;
  string username = 2;
  string role_key = 3;
}

// 鉴权服务响应体
message AuthResponse {
  int32 code = 1;
  string msg = 2;
  UserData data = 3;
}

2.2 使用protoc生成数据结构代码

php生成

protoPath="../protobuf"
outputPath="../client/grpc"

protoc --proto_path=${protoPath}/ ${protoPath}/*.proto \
--php_out=${outputPath} \
--grpc_out=${outputPath} \
--plugin=protoc-gen-grpc=/usr/local/bin/grpc_php_plugin

go生成

protoPath="../protobuf"
outputPath="../server/grpc"

protoc --proto_path=${protoPath}/ ${protoPath}/*.proto \
--go_out=${outputPath} \
--go-grpc_out=${outputPath}

2.3 服务端实现

package main

import (
	"auth/grpc/system/auth"
	"context"
	"google.golang.org/grpc"
	"log"
	"net"
	"github.com/dgrijalva/jwt-go"
	"errors"
)

const port = ":9091"
const jwtKey = "7972BAF176E16C86"
var whiteList = []string{
    "/system.auth.AuthService/CheckAuthState",
}
// 检索字符串是否包含在数组中
func inArray(str string, arr []string) bool {
    for _, v := range arr {
        if str == v {
            return true
        }
    }
    return false
}

type server struct {
	auth.UnimplementedAuthServiceServer
}

// 检测授权状态
func (s *server) CheckAuthState(ctx context.Context, req *auth.AuthRequest) (*auth.AuthResponse, error) {
	token, _ := jwt.Parse(req.GetToken(), func(token *jwt.Token) (interface{}, error) {
		secret := []byte(jwtKey)
		return secret, nil
	})

	userData := &auth.UserData{}
    // jwt解析
	if claims, ok := token.Claims.(jwt.MapClaims); ok && token.Valid {
		user := claims["user"].(map[string]interface{})
		userData.UserId, _ = user["user_id"].(float64)
		userData.Username, _ = user["username"].(string)
		userData.RoleKey, _ = user["role_key"].(string)
	}

	return &auth.AuthResponse{
		Code: 200,
		Msg:  "ok",
		Data: userData,
	}, nil
}
// 访问拦截器
func AccessInterceptor(
    ctx context.Context,
    req interface{},
    info *grpc.UnaryServerInfo,
    handler grpc.UnaryHandler) (interface{}, error) {

    log.Printf("interceptor: %v", info.FullMethod)
    if !inArray(info.FullMethod, whiteList) {
        authReq, ok := req.(*auth.AuthRequest)
        log.Println("check token: %v", authReq.Token)
        if !ok {
            return nil, errors.New("无效的请求token")
        }
    }

    return handler(ctx, req)
}

func main() {
    log.SetFlags(log.Lshortfile | log.LstdFlags | log.Lmicroseconds)
	conn, err := net.Listen("tcp", port)
	if err != nil {
		log.Fatalf("connect to server err: %v", err)
	}

	s := grpc.NewServer(grpc.UnaryInterceptor(AccessInterceptor))
	auth.RegisterAuthServiceServer(s, &server{})
	log.Printf("Listen to server at: 127.0.0.1%v", port)
	if err := s.Serve(conn); err != nil {
		log.Fatalf("listen to server err: %v", err)
	}
}

2.4 客户端调用

<?php

require __DIR__ . '/vendor/autoload.php';

use Grpc\ChannelCredentials;
use System\Auth\AuthRequest;
use System\Auth\AuthServiceClient;

$client = new AuthServiceClient('127.0.0.1:9091', [
    'credentials' => ChannelCredentials::createInsecure()
]);

$request = new AuthRequest();
$request->setToken('eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MTY2Mjg2NDgsInVzZXIiOnsidXNlcl9pZCI6MTEsInVzZXJuYW1lIjoidGVzdDAwMSIsInJvbGVfa2V5IjoidXNlciJ9fQ.eqKQ2b8XUcV1pDRyjUiWI_Ra8Vy2J0Cvd82Jl_8lSks');

list($response, $status) = $client->CheckAuthState($request)->wait();

printf(
    "code: %s\nmsg: %s\ndata: %s\n",
    $response->getCode(),
    $response->getMsg(),
    $response->getData()->serializeToJsonString()
);

三、相关链接

1. protobuf官网
2. grpc官网

赏

谢谢你请我喝咖啡

BTC

USDT_TRC20

• 本文作者： 暮秋人
• 本文链接： https://muqiuren.pages.dev/2023/06/grpc-services-dev-example/
• 版权声明： 本博客所有文章除特别声明外，均采用 MIT 许可协议。转载请注明出处！