简介
gRPC-Gateway是protoc的插件.它读取gRPC服务定义并生成反向代理服务器,将 RESTful JSON API转换为gRPC.此服务器是根据你的gRPC定义中的自定义选项生成的.
gRPC-Gateway可帮助你同时提供gRPC和RESTful风格的API.
GitHub地址;
文档地址
实现
编写yaml文件
type: google.api.Service
cofig_version: 3
http:
rules:
- selector: carcool.TripService.GetTrip
get: /trip/{id}
编写proto文件
syntax = "proto3";
package carcool;
option go_package = "carcoll/proto/gen/go;trippb";
message Location{
double latitude = 1;
double longitude = 2;
}
enum TripStatus{
TS_NOT_SPECIFIED = 0;
NOT_STARTED = 1;
IN_PROGRESS = 2;
FINISHED = 3;
PAID = 4;
}
message Trip{
string start = 1;
string end = 2;
int32 duration_sec = 3;
int32 fee_cent = 4;
Location start_pos = 5;
Location end_pos = 6;
repeated Location path_locations = 7;
TripStatus status = 8;
}
message GetTripRequest{
string id = 1;
}
message GetTripResponse{
string id = 1;
Trip trip = 2;
}
service TripService{
rpc GetTrip(GetTripRequest) returns(GetTripResponse);
}
使用protoc命令生成对应代码
命令
protoc -I=. --go-grpc_out=paths=source_relative:gen/go trip.proto
protoc -I=. --go_out=paths=source_relative:gen/go trip.proto
protoc -I=. --grpc-gateway_out=paths=source_relative,grpc_api_configuration=trip.yaml:gen/go trip.proto
生成的代码
trip.pb.go
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.27.1
// protoc v3.19.4
// source: trip.proto
package trippb
import (
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
reflect "reflect"
sync "sync"
)
const (
// Verify that this generated code is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
// Verify that runtime/protoimpl is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
type TripStatus int32
const (
TripStatus_TS_NOT_SPECIFIED TripStatus = 0
TripStatus_NOT_STARTED TripStatus = 1
TripStatus_IN_PROGRESS TripStatus = 2
TripStatus_FINISHED TripStatus = 3
TripStatus_PAID TripStatus = 4
)
// Enum value maps for TripStatus.
var (
TripStatus_name = map[int32]string{
0: "TS_NOT_SPECIFIED",
1: "NOT_STARTED",
2: "IN_PROGRESS",
3: "FINISHED",
4: "PAID",
}
TripStatus_value = map[string]int32{
"TS_NOT_SPECIFIED": 0,
"NOT_STARTED": 1,
"IN_PROGRESS": 2,
"FINISHED": 3,
"PAID": 4,
}
)
func (x TripStatus) Enum() *TripStatus {
p := new(TripStatus)
*p = x
return p
}
func (x TripStatus) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (TripStatus) Descriptor() protoreflect.EnumDescriptor {
return file_trip_proto_enumTypes[0].Descriptor()
}
func (TripStatus) Type() protoreflect.EnumType {
return &file_trip_proto_enumTypes[0]
}
func (x TripStatus) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use TripStatus.Descriptor instead.
func (TripStatus) EnumDescriptor() ([]byte, []int) {
return file_trip_proto_rawDescGZIP(), []int{0}
}
type Location struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Latitude float64 `protobuf:"fixed64,1,opt,name=latitude,proto3" json:"latitude,omitempty"`
Longitude float64 `protobuf:"fixed64,2,opt,name=longitude,proto3" json:"longitude,omitempty"`
}
func (x *Location) Reset() {
*x = Location{}
if protoimpl.UnsafeEnabled {
mi := &file_trip_proto_msgTypes[0]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *Location) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*Location) ProtoMessage() {}
func (x *Location) ProtoReflect() protoreflect.Message {
mi := &file_trip_proto_msgTypes[0]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use Location.ProtoReflect.Descriptor instead.
func (*Location) Descriptor() ([]byte, []int) {
return file_trip_proto_rawDescGZIP(), []int{0}
}
func (x *Location) GetLatitude() float64 {
if x != nil {
return x.Latitude
}
return 0
}
func (x *Location) GetLongitude() float64 {
if x != nil {
return x.Longitude
}
return 0
}
type Trip struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Start string `protobuf:"bytes,1,opt,name=start,proto3" json:"start,omitempty"`
End string `protobuf:"bytes,2,opt,name=end,proto3" json:"end,omitempty"`
DurationSec int32 `protobuf:"varint,3,opt,name=duration_sec,json=durationSec,proto3" json:"duration_sec,omitempty"`
FeeCent int32 `protobuf:"varint,4,opt,name=fee_cent,json=feeCent,proto3" json:"fee_cent,omitempty"`
StartPos *Location `protobuf:"bytes,5,opt,name=start_pos,json=startPos,proto3" json:"start_pos,omitempty"`
EndPos *Location `protobuf:"bytes,6,opt,name=end_pos,json=endPos,proto3" json:"end_pos,omitempty"`
PathLocations []*Location `protobuf:"bytes,7,rep,name=path_locations,json=pathLocations,proto3" json:"path_locations,omitempty"`
Status TripStatus `protobuf:"varint,8,opt,name=status,proto3,enum=carcool.TripStatus" json:"status,omitempty"`
}
func (x *Trip) Reset() {
*x = Trip{}
if protoimpl.UnsafeEnabled {
mi := &file_trip_proto_msgTypes[1]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *Trip) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*Trip) ProtoMessage() {}
func (x *Trip) ProtoReflect() protoreflect.Message {
mi := &file_trip_proto_msgTypes[1]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use Trip.ProtoReflect.Descriptor instead.
func (*Trip) Descriptor() ([]byte, []int) {
return file_trip_proto_rawDescGZIP(), []int{1}
}
func (x *Trip) GetStart() string {
if x != nil {
return x.Start
}
return ""
}
func (x *Trip) GetEnd() string {
if x != nil {
return x.End
}
return ""
}
func (x *Trip) GetDurationSec() int32 {
if x != nil {
return x.DurationSec
}
return 0
}
func (x *Trip) GetFeeCent() int32 {
if x != nil {
return x.FeeCent
}
return 0
}
func (x *Trip) GetStartPos() *Location {
if x != nil {
return x.StartPos
}
return nil
}
func (x *Trip) GetEndPos() *Location {
if x != nil {
return x.EndPos
}
return nil
}
func (x *Trip) GetPathLocations() []*Location {
if x != nil {
return x.PathLocations
}
return nil
}
func (x *Trip) GetStatus() TripStatus {
if x != nil {
return x.Status
}
return TripStatus_TS_NOT_SPECIFIED
}
type GetTripRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
}
func (x *GetTripRequest) Reset() {
*x = GetTripRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_trip_proto_msgTypes[2]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *GetTripRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*GetTripRequest) ProtoMessage() {}
func (x *GetTripRequest) ProtoReflect() protoreflect.Message {
mi := &file_trip_proto_msgTypes[2]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use GetTripRequest.ProtoReflect.Descriptor instead.
func (*GetTripRequest) Descriptor() ([]byte, []int) {
return file_trip_proto_rawDescGZIP(), []int{2}
}
func (x *GetTripRequest) GetId() string {
if x != nil {
return x.Id
}
return ""
}
type GetTripResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
Trip *Trip `protobuf:"bytes,2,opt,name=trip,proto3" json:"trip,omitempty"`
}
func (x *GetTripResponse) Reset() {
*x = GetTripResponse{}
if protoimpl.UnsafeEnabled {
mi := &file_trip_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *GetTripResponse) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*GetTripResponse) ProtoMessage() {}
func (x *GetTripResponse) ProtoReflect() protoreflect.Message {
mi := &file_trip_proto_msgTypes[3]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use GetTripResponse.ProtoReflect.Descriptor instead.
func (*GetTripResponse) Descriptor() ([]byte, []int) {
return file_trip_proto_rawDescGZIP(), []int{3}
}
func (x *GetTripResponse) GetId() string {
if x != nil {
return x.Id
}
return ""
}
func (x *GetTripResponse) GetTrip() *Trip {
if x != nil {
return x.Trip
}
return nil
}
var File_trip_proto protoreflect.FileDescriptor
var file_trip_proto_rawDesc = []byte{
0x0a, 0x0a, 0x74, 0x72, 0x69, 0x70, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x07, 0x63, 0x61,
0x72, 0x63, 0x6f, 0x6f, 0x6c, 0x22, 0x44, 0x0a, 0x08, 0x4c, 0x6f, 0x63, 0x61, 0x74, 0x69, 0x6f,
0x6e, 0x12, 0x1a, 0x0a, 0x08, 0x6c, 0x61, 0x74, 0x69, 0x74, 0x75, 0x64, 0x65, 0x18, 0x01, 0x20,
0x01, 0x28, 0x01, 0x52, 0x08, 0x6c, 0x61, 0x74, 0x69, 0x74, 0x75, 0x64, 0x65, 0x12, 0x1c, 0x0a,
0x09, 0x6c, 0x6f, 0x6e, 0x67, 0x69, 0x74, 0x75, 0x64, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x01,
0x52, 0x09, 0x6c, 0x6f, 0x6e, 0x67, 0x69, 0x74, 0x75, 0x64, 0x65, 0x22, 0xaf, 0x02, 0x0a, 0x04,
0x54, 0x72, 0x69, 0x70, 0x12, 0x14, 0x0a, 0x05, 0x73, 0x74, 0x61, 0x72, 0x74, 0x18, 0x01, 0x20,
0x01, 0x28, 0x09, 0x52, 0x05, 0x73, 0x74, 0x61, 0x72, 0x74, 0x12, 0x10, 0x0a, 0x03, 0x65, 0x6e,
0x64, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x65, 0x6e, 0x64, 0x12, 0x21, 0x0a, 0x0c,
0x64, 0x75, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x5f, 0x73, 0x65, 0x63, 0x18, 0x03, 0x20, 0x01,
0x28, 0x05, 0x52, 0x0b, 0x64, 0x75, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x53, 0x65, 0x63, 0x12,
0x19, 0x0a, 0x08, 0x66, 0x65, 0x65, 0x5f, 0x63, 0x65, 0x6e, 0x74, 0x18, 0x04, 0x20, 0x01, 0x28,
0x05, 0x52, 0x07, 0x66, 0x65, 0x65, 0x43, 0x65, 0x6e, 0x74, 0x12, 0x2e, 0x0a, 0x09, 0x73, 0x74,
0x61, 0x72, 0x74, 0x5f, 0x70, 0x6f, 0x73, 0x18, 0x05, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x11, 0x2e,
0x63, 0x61, 0x72, 0x63, 0x6f, 0x6f, 0x6c, 0x2e, 0x4c, 0x6f, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e,
0x52, 0x08, 0x73, 0x74, 0x61, 0x72, 0x74, 0x50, 0x6f, 0x73, 0x12, 0x2a, 0x0a, 0x07, 0x65, 0x6e,
0x64, 0x5f, 0x70, 0x6f, 0x73, 0x18, 0x06, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x63, 0x61,
0x72, 0x63, 0x6f, 0x6f, 0x6c, 0x2e, 0x4c, 0x6f, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x06,
0x65, 0x6e, 0x64, 0x50, 0x6f, 0x73, 0x12, 0x38, 0x0a, 0x0e, 0x70, 0x61, 0x74, 0x68, 0x5f, 0x6c,
0x6f, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x73, 0x18, 0x07, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x11,
0x2e, 0x63, 0x61, 0x72, 0x63, 0x6f, 0x6f, 0x6c, 0x2e, 0x4c, 0x6f, 0x63, 0x61, 0x74, 0x69, 0x6f,
0x6e, 0x52, 0x0d, 0x70, 0x61, 0x74, 0x68, 0x4c, 0x6f, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x73,
0x12, 0x2b, 0x0a, 0x06, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x18, 0x08, 0x20, 0x01, 0x28, 0x0e,
0x32, 0x13, 0x2e, 0x63, 0x61, 0x72, 0x63, 0x6f, 0x6f, 0x6c, 0x2e, 0x54, 0x72, 0x69, 0x70, 0x53,
0x74, 0x61, 0x74, 0x75, 0x73, 0x52, 0x06, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x22, 0x20, 0x0a,
0x0e, 0x47, 0x65, 0x74, 0x54, 0x72, 0x69, 0x70, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12,
0x0e, 0x0a, 0x02, 0x69, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x02, 0x69, 0x64, 0x22,
0x44, 0x0a, 0x0f, 0x47, 0x65, 0x74, 0x54, 0x72, 0x69, 0x70, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e,
0x73, 0x65, 0x12, 0x0e, 0x0a, 0x02, 0x69, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x02,
0x69, 0x64, 0x12, 0x21, 0x0a, 0x04, 0x74, 0x72, 0x69, 0x70, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b,
0x32, 0x0d, 0x2e, 0x63, 0x61, 0x72, 0x63, 0x6f, 0x6f, 0x6c, 0x2e, 0x54, 0x72, 0x69, 0x70, 0x52,
0x04, 0x74, 0x72, 0x69, 0x70, 0x2a, 0x5c, 0x0a, 0x0a, 0x54, 0x72, 0x69, 0x70, 0x53, 0x74, 0x61,
0x74, 0x75, 0x73, 0x12, 0x14, 0x0a, 0x10, 0x54, 0x53, 0x5f, 0x4e, 0x4f, 0x54, 0x5f, 0x53, 0x50,
0x45, 0x43, 0x49, 0x46, 0x49, 0x45, 0x44, 0x10, 0x00, 0x12, 0x0f, 0x0a, 0x0b, 0x4e, 0x4f, 0x54,
0x5f, 0x53, 0x54, 0x41, 0x52, 0x54, 0x45, 0x44, 0x10, 0x01, 0x12, 0x0f, 0x0a, 0x0b, 0x49, 0x4e,
0x5f, 0x50, 0x52, 0x4f, 0x47, 0x52, 0x45, 0x53, 0x53, 0x10, 0x02, 0x12, 0x0c, 0x0a, 0x08, 0x46,
0x49, 0x4e, 0x49, 0x53, 0x48, 0x45, 0x44, 0x10, 0x03, 0x12, 0x08, 0x0a, 0x04, 0x50, 0x41, 0x49,
0x44, 0x10, 0x04, 0x32, 0x4b, 0x0a, 0x0b, 0x54, 0x72, 0x69, 0x70, 0x53, 0x65, 0x72, 0x76, 0x69,
0x63, 0x65, 0x12, 0x3c, 0x0a, 0x07, 0x47, 0x65, 0x74, 0x54, 0x72, 0x69, 0x70, 0x12, 0x17, 0x2e,
0x63, 0x61, 0x72, 0x63, 0x6f, 0x6f, 0x6c, 0x2e, 0x47, 0x65, 0x74, 0x54, 0x72, 0x69, 0x70, 0x52,
0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x18, 0x2e, 0x63, 0x61, 0x72, 0x63, 0x6f, 0x6f, 0x6c,
0x2e, 0x47, 0x65, 0x74, 0x54, 0x72, 0x69, 0x70, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65,
0x42, 0x1d, 0x5a, 0x1b, 0x63, 0x61, 0x72, 0x63, 0x6f, 0x6c, 0x6c, 0x2f, 0x70, 0x72, 0x6f, 0x74,
0x6f, 0x2f, 0x67, 0x65, 0x6e, 0x2f, 0x67, 0x6f, 0x3b, 0x74, 0x72, 0x69, 0x70, 0x70, 0x62, 0x62,
0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33,
}
var (
file_trip_proto_rawDescOnce sync.Once
file_trip_proto_rawDescData = file_trip_proto_rawDesc
)
func file_trip_proto_rawDescGZIP() []byte {
file_trip_proto_rawDescOnce.Do(func() {
file_trip_proto_rawDescData = protoimpl.X.CompressGZIP(file_trip_proto_rawDescData)
})
return file_trip_proto_rawDescData
}
var file_trip_proto_enumTypes = make([]protoimpl.EnumInfo, 1)
var file_trip_proto_msgTypes = make([]protoimpl.MessageInfo, 4)
var file_trip_proto_goTypes = []interface{}{
(TripStatus)(0), // 0: carcool.TripStatus
(*Location)(nil), // 1: carcool.Location
(*Trip)(nil), // 2: carcool.Trip
(*GetTripRequest)(nil), // 3: carcool.GetTripRequest
(*GetTripResponse)(nil), // 4: carcool.GetTripResponse
}
var file_trip_proto_depIdxs = []int32{
1, // 0: carcool.Trip.start_pos:type_name -> carcool.Location
1, // 1: carcool.Trip.end_pos:type_name -> carcool.Location
1, // 2: carcool.Trip.path_locations:type_name -> carcool.Location
0, // 3: carcool.Trip.status:type_name -> carcool.TripStatus
2, // 4: carcool.GetTripResponse.trip:type_name -> carcool.Trip
3, // 5: carcool.TripService.GetTrip:input_type -> carcool.GetTripRequest
4, // 6: carcool.TripService.GetTrip:output_type -> carcool.GetTripResponse
6, // [6:7] is the sub-list for method output_type
5, // [5:6] is the sub-list for method input_type
5, // [5:5] is the sub-list for extension type_name
5, // [5:5] is the sub-list for extension extendee
0, // [0:5] is the sub-list for field type_name
}
func init() { file_trip_proto_init() }
func file_trip_proto_init() {
if File_trip_proto != nil {
return
}
if !protoimpl.UnsafeEnabled {
file_trip_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} {
switch v := v.(*Location); i {
case 0:
return &v.state
case 1:
return &v.sizeCache
case 2:
return &v.unknownFields
default:
return nil
}
}
file_trip_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} {
switch v := v.(*Trip); i {
case 0:
return &v.state
case 1:
return &v.sizeCache
case 2:
return &v.unknownFields
default:
return nil
}
}
file_trip_proto_msgTypes[2].Exporter = func(v interface{}, i int) interface{} {
switch v := v.(*GetTripRequest); i {
case 0:
return &v.state
case 1:
return &v.sizeCache
case 2:
return &v.unknownFields
default:
return nil
}
}
file_trip_proto_msgTypes[3].Exporter = func(v interface{}, i int) interface{} {
switch v := v.(*GetTripResponse); i {
case 0:
return &v.state
case 1:
return &v.sizeCache
case 2:
return &v.unknownFields
default:
return nil
}
}
}
type x struct{}
out := protoimpl.TypeBuilder{
File: protoimpl.DescBuilder{
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: file_trip_proto_rawDesc,
NumEnums: 1,
NumMessages: 4,
NumExtensions: 0,
NumServices: 1,
},
GoTypes: file_trip_proto_goTypes,
DependencyIndexes: file_trip_proto_depIdxs,
EnumInfos: file_trip_proto_enumTypes,
MessageInfos: file_trip_proto_msgTypes,
}.Build()
File_trip_proto = out.File
file_trip_proto_rawDesc = nil
file_trip_proto_goTypes = nil
file_trip_proto_depIdxs = nil
}
trip.pb.gw.go
// Code generated by protoc-gen-grpc-gateway. DO NOT EDIT.
// source: trip.proto
/*
Package trippb is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
*/
package trippb
import (
"context"
"io"
"net/http"
"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
"github.com/grpc-ecosystem/grpc-gateway/v2/utilities"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/grpclog"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/proto"
)
// Suppress "imported and not used" errors
var _ codes.Code
var _ io.Reader
var _ status.Status
var _ = runtime.String
var _ = utilities.NewDoubleArray
var _ = metadata.Join
func request_TripService_GetTrip_0(ctx context.Context, marshaler runtime.Marshaler, client TripServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var protoReq GetTripRequest
var metadata runtime.ServerMetadata
var (
val string
ok bool
err error
_ = err
)
val, ok = pathParams["id"]
if !ok {
return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "id")
}
protoReq.Id, err = runtime.String(val)
if err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "id", err)
}
msg, err := client.GetTrip(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
func local_request_TripService_GetTrip_0(ctx context.Context, marshaler runtime.Marshaler, server TripServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var protoReq GetTripRequest
var metadata runtime.ServerMetadata
var (
val string
ok bool
err error
_ = err
)
val, ok = pathParams["id"]
if !ok {
return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "id")
}
protoReq.Id, err = runtime.String(val)
if err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "id", err)
}
msg, err := server.GetTrip(ctx, &protoReq)
return msg, metadata, err
}
// RegisterTripServiceHandlerServer registers the http handlers for service TripService to "mux".
// UnaryRPC :call TripServiceServer directly.
// StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.
// Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterTripServiceHandlerFromEndpoint instead.
func RegisterTripServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TripServiceServer) error {
mux.Handle("GET", pattern_TripService_GetTrip_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
rctx, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/carcool.TripService/GetTrip", runtime.WithHTTPPathPattern("/trip/{id}"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
resp, md, err := local_request_TripService_GetTrip_0(rctx, inboundMarshaler, server, req, pathParams)
md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
ctx = runtime.NewServerMetadataContext(ctx, md)
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
forward_TripService_GetTrip_0(ctx, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
return nil
}
// RegisterTripServiceHandlerFromEndpoint is same as RegisterTripServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterTripServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.Dial(endpoint, opts...)
if err != nil {
return err
}
defer func() {
if err != nil {
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
}
return
}
go func() {
<-ctx.Done()
if cerr := conn.Close(); cerr != nil {
grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr)
}
}()
}()
return RegisterTripServiceHandler(ctx, mux, conn)
}
// RegisterTripServiceHandler registers the http handlers for service TripService to "mux".
// The handlers forward requests to the grpc endpoint over "conn".
func RegisterTripServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error {
return RegisterTripServiceHandlerClient(ctx, mux, NewTripServiceClient(conn))
}
// RegisterTripServiceHandlerClient registers the http handlers for service TripService
// to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "TripServiceClient".
// Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "TripServiceClient"
// doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in
// "TripServiceClient" to call the correct interceptors.
func RegisterTripServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TripServiceClient) error {
mux.Handle("GET", pattern_TripService_GetTrip_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
rctx, err := runtime.AnnotateContext(ctx, mux, req, "/carcool.TripService/GetTrip", runtime.WithHTTPPathPattern("/trip/{id}"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
resp, md, err := request_TripService_GetTrip_0(rctx, inboundMarshaler, client, req, pathParams)
ctx = runtime.NewServerMetadataContext(ctx, md)
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
forward_TripService_GetTrip_0(ctx, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
return nil
}
var (
pattern_TripService_GetTrip_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 1, 0, 4, 1, 5, 1}, []string{"trip", "id"}, ""))
)
var (
forward_TripService_GetTrip_0 = runtime.ForwardResponseMessage
)
生成的代码中清晰的注释了包 trippb是一个反向代理.它将 gRPC转换为RESTful JSON API.
trip_grpc.pb.go
// Code generated by protoc-gen-go-grpc. DO NOT EDIT.
// versions:
// - protoc-gen-go-grpc v1.2.0
// - protoc v3.19.4
// source: trip.proto
package trippb
import (
context "context"
grpc "google.golang.org/grpc"
codes "google.golang.org/grpc/codes"
status "google.golang.org/grpc/status"
)
// This is a compile-time assertion to ensure that this generated file
// is compatible with the grpc package it is being compiled against.
// Requires gRPC-Go v1.32.0 or later.
const _ = grpc.SupportPackageIsVersion7
// TripServiceClient is the client API for TripService service.
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
type TripServiceClient interface {
GetTrip(ctx context.Context, in *GetTripRequest, opts ...grpc.CallOption) (*GetTripResponse, error)
}
type tripServiceClient struct {
cc grpc.ClientConnInterface
}
func NewTripServiceClient(cc grpc.ClientConnInterface) TripServiceClient {
return &tripServiceClient{cc}
}
func (c *tripServiceClient) GetTrip(ctx context.Context, in *GetTripRequest, opts ...grpc.CallOption) (*GetTripResponse, error) {
out := new(GetTripResponse)
err := c.cc.Invoke(ctx, "/carcool.TripService/GetTrip", in, out, opts...)
if err != nil {
return nil, err
}
return out, nil
}
// TripServiceServer is the server API for TripService service.
// All implementations must embed UnimplementedTripServiceServer
// for forward compatibility
type TripServiceServer interface {
GetTrip(context.Context, *GetTripRequest) (*GetTripResponse, error)
mustEmbedUnimplementedTripServiceServer()
}
// UnimplementedTripServiceServer must be embedded to have forward compatible implementations.
type UnimplementedTripServiceServer struct {
}
func (UnimplementedTripServiceServer) GetTrip(context.Context, *GetTripRequest) (*GetTripResponse, error) {
return nil, status.Errorf(codes.Unimplemented, "method GetTrip not implemented")
}
func (UnimplementedTripServiceServer) mustEmbedUnimplementedTripServiceServer() {}
// UnsafeTripServiceServer may be embedded to opt out of forward compatibility for this service.
// Use of this interface is not recommended, as added methods to TripServiceServer will
// result in compilation errors.
type UnsafeTripServiceServer interface {
mustEmbedUnimplementedTripServiceServer()
}
func RegisterTripServiceServer(s grpc.ServiceRegistrar, srv TripServiceServer) {
s.RegisterService(&TripService_ServiceDesc, srv)
}
func _TripService_GetTrip_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(GetTripRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(TripServiceServer).GetTrip(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: "/carcool.TripService/GetTrip",
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(TripServiceServer).GetTrip(ctx, req.(*GetTripRequest))
}
return interceptor(ctx, in, info, handler)
}
// TripService_ServiceDesc is the grpc.ServiceDesc for TripService service.
// It's only intended for direct use with grpc.RegisterService,
// and not to be introspected or modified (even as a copy)
var TripService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "carcool.TripService",
HandlerType: (*TripServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetTrip",
Handler: _TripService_GetTrip_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "trip.proto",
}
编写示例服务
package trip
import (
trippb "carcool/proto/gen/go"
"context"
)
type Service struct {
trippb.UnimplementedTripServiceServer
}
func (s Service) GetTrip(ctx context.Context, request *trippb.GetTripRequest) (*trippb.GetTripResponse, error) {
return &trippb.GetTripResponse{
Id: request.Id,
Trip: &trippb.Trip{
Start: "123",
End: "456",
DurationSec: 3600,
FeeCent: 10000,
StartPos: &trippb.Location{
Latitude: 30,
Longitude: 120,
},
EndPos: &trippb.Location{
Latitude: 35,
Longitude: 115,
},
PathLocations: []*trippb.Location{
{
Latitude: 31,
Longitude: 119,
},
{
Latitude: 32,
Longitude: 118,
},
},
Status: trippb.TripStatus_IN_PROGRESS,
},
}, nil
}
gRPC-Gateway快速开始
package main
import (
trippb "carcool/proto/gen/go"
trip "carcool/tripservice"
"context"
"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
"google.golang.org/grpc"
"google.golang.org/protobuf/encoding/protojson"
"log"
"net"
"net/http"
)
func main() {
log.SetFlags(log.Llongfile)
go quickStartGRPCGateway()
listen, err := net.Listen("tcp", ":8081")
if err != nil {
log.Fatalf("failed to listen: %v", err)
}
server := grpc.NewServer()
trippb.RegisterTripServiceServer(server, &trip.Service{})
log.Fatal(server.Serve(listen))
}
func quickStartGRPCGateway() {
ctx := context.Background()
ctx, cancelFunc := context.WithCancel(ctx)
defer cancelFunc()
mux := runtime.NewServeMux(runtime.WithMarshalerOption(runtime.MIMEWildcard, &runtime.JSONPb{MarshalOptions: protojson.MarshalOptions{UseEnumNumbers: true, UseProtoNames: true}}))
err := trippb.RegisterTripServiceHandlerFromEndpoint(ctx, mux, "localhost:8081", []grpc.DialOption{grpc.WithInsecure()})
if err != nil {
log.Fatalf("cannot start grpc gateway: %v", err)
}
err = http.ListenAndServe(":8080", mux)
if err != nil {
log.Fatalf("cannot listen and server: %v", err)
}
}
测试结果
