1 RPC框架原理
目的:让服务调用更加的简单和透明。
方法:由RPC 框架负责屏蔽底层的传输方式(TCP 或者 UDP)、序列化方式(XML/Json/ 二进制)和通信细节。服务调用者可以像调用本地接口一样调用远程的服务提供者,而不需要关心底层通信细节和调用过程。通过近一段时间的使用体验可以发现相比于传统的HTTP服务的开发和使用确实要方便不少,只需要ip+port就可以调用另外一个服务。
RPC框架调用原理图:
2 gRPC框架
gRPC 是一个高性能、开源和通用的 RPC 框架,面向服务端和移动端,基于 HTTP/2 设计。
2.1 gRPC特点
- 语言中立,支持多种语言;
- 基于 IDL 文件定义服务,通过 proto3 工具生成指定语言的数据结构、服务端接口以及客户端 Stub;
- 通信协议基于标准的 HTTP/2 设计,支持双向流、消息头压缩、单 TCP 的多路复用、服务端推送等特性,这些特性使得 gRPC 在移动端设备上更加省电和节省网络流量;
- 序列化支持 PB(Protocol Buffer)和 JSON,PB 是一种语言无关的高性能序列化框架,基于 HTTP/2 + PB, 保障了 RPC 调用的高性能。
2.2 gRPC 服务创建示例
以golang语言为例进行演示
- 安装 golang
wget https://golang.org/dl/go1.17.linux-amd64.tar.gz
sha256sum go1.17.linux-amd64.tar.gz
tar -C /usr/local -xzf go1.17.linux-amd64.tar.gz
# 修改环境变量, 即在~/.bashrc文件末尾添加如下语句即可:
export PATH=$PATH:/usr/local/go/bin
export GO111MODULE=on
export GOPROXY=https://mirrors.tencent.com/go/,goproxy.cn,direct
export GOSUMDB=off
- 安装依赖
- 安装protoc,保证版本大于3.0
源码安装:
执行此操作前,先确保安装了相应的工具链,如:make、autoconf、aclocal。
git clone https://github.com/protocolbuffers/protobuf
# v3.6.0+以上版本支持map解析,syntax=2、3消息序列化后是二进制兼容的,用root执行以下命令
cd protobuf
git checkout v3.6.1.3
./autogen.sh
./configure
make -j8
make install
- 安装gprc protocol插件
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.26
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.1
- 配置环境变量
追加配置 `export PATH=$PATH:$GOPATH/bin` 至 `~/.bashrc`
- 编写pb文件helloworld.proto
syntax = "proto3";
option go_package = "github.com/botao/helloworld";
package helloworld;
// The greeting service definition.
service Greeter {
// Sends a greeting
rpc SayHello (HelloRequest) returns (HelloReply) {}
rpc SayHelloAgain (HelloRequest) returns (HelloReply) {}
}
// The request message containing the user's name.
message HelloRequest {
string name = 1;
}
// The response message containing the greetings
message HelloReply {
string message = 1;
}
- 编写自动生成框架代码脚本
#!/bin/bash
cd $(dirname $0) || exit 1
mkdir -p v1
protoc --go_out ./v1 --go_opt paths=source_relative \
--go-grpc_out ./v1 --go-grpc_opt paths=source_relative helloworld.proto
# 当要使用grpc-gateway特性时可采取下列模版生成代码
# 替换成对应的目录,对应内容:https://github.com/googleapis/googleapis,https://github.com/protocolbuffers/protobuf
# PB_INCLUDE="-I/root/go/src/github.com/googleapis/ -I/root/go/src/github.com/protocolbuffers/protobuf/src"
# protoc -I . $PB_INCLUDE \
# --go_out ./v1 --go_opt paths=source_relative \
# --go-grpc_out ./v1 --go-grpc_opt paths=source_relative helloworld.proto
# 当要使用grpc-gateway特性时使用
# protoc -I . $PB_INCLUDE \
# --grpc-gateway_out ./v1 \
# --grpc-gateway_opt logtostderr=true \
# --grpc-gateway_opt paths=source_relative \
# --grpc-gateway_opt generate_unbound_methods=true helloworld.proto
- 编写服务端代码
package main
import (
"context"
"log"
"net"
pb "github.com/botao/helloworld/proto/v1"
"google.golang.org/grpc"
)
const (
port = ":50051"
)
// server is used to implement helloworld.GreeterServer.
type server struct {
pb.UnimplementedGreeterServer
}
// SayHello implements helloworld.GreeterServer
func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
log.Printf("Received: %v", in.GetName())
return &pb.HelloReply{Message: "Hello " + in.GetName()}, nil
}
func (s *server) SayHelloAgain(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
log.Printf("Received: %v", in.GetName())
return &pb.HelloReply{Message: "Hello again" + in.GetName()}, nil
}
func main() {
lis, err := net.Listen("tcp", port)
if err != nil {
log.Fatalf("failed to listen: %v", err)
}
s := grpc.NewServer()
pb.RegisterGreeterServer(s, &server{})
log.Printf("server listening at %v", lis.Addr())
if err := s.Serve(lis); err != nil {
log.Fatalf("failed to serve: %v", err)
}
}
- 编写客户端代码
package main
import (
"context"
"log"
"os"
"time"
"google.golang.org/grpc"
pb "github.com/botao/helloworld/proto/v1"
)
const (
address = "localhost:50051"
defaultName = "world"
)
func main() {
// Set up a connection to the server.
conn, err := grpc.Dial(address, grpc.WithInsecure(), grpc.WithBlock())
if err != nil {
log.Fatalf("did not connect: %v", err)
}
defer conn.Close()
c := pb.NewGreeterClient(conn)
// Contact the server and print out its response.
name := defaultName
if len(os.Args) > 1 {
name = os.Args[1]
}
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
r, err := c.SayHello(ctx, &pb.HelloRequest{Name: name})
if err != nil {
log.Fatalf("could not greet: %v", err)
}
log.Printf("Greeting: %s", r.GetMessage())
r, err = c.SayHelloAgain(ctx, &pb.HelloRequest{Name: name})
if err != nil {
log.Fatalf("could not greet: %v", err)
}
log.Printf("Greeting: %s", r.GetMessage())
}
- 执行测试
- 代码结构