Git Product home page Git Product logo

grpc_starter's Introduction

grpc_starter

假设有一个使用gRPC的项目有这几个proto文件path3/path4/demo.protopath1/path2/demo.proto,path1/path2/lib.proto,目标语言是Go,Java,Python,Typescript/Javascript

gRPC Protobuf package 最佳实践

准备

# General
# install protobuf,gRPC

## Go
go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
go get -u google.golang.org/grpc

# Python
pip install protobuf grpcio grpcio grpcio-tools

# Java
## Compiling grpc java codegen
export GRPC_JAVA_SRC_ROOT="指定一个目录,保存gRPC java的代码"
git clone https://github.com/grpc/grpc-java.git ${GRPC_JAVA_SRC_ROOT}
cd ${GRPC_JAVA_SRC_ROOT}/compiler
../gradlew java_pluginExecutable
export PROTOC_GEN_GRPC_JAVA=${GRPC_JAVA_SRC_ROOT}/build/exe/java_plugin/protoc-gen-grpc-java

# Typescript
npm install -g grpc-tools
# 在项目根目录
yarn add google-protobuf @types/google-protobuf  grpc-web-client ts-protoc-gen

proto package 声明

syntax = "proto3";

// message 的name space, 如果需要使用的message和当前package不同,需要加上message前要加package
package path3.path4;

// GO
// 目标文件将放入github.com/myname/myproj/path3/path4
// import此文件的proto,也将根据此生成引入path
option go_package = "package_path:package_name";
option go_package = "github.com/myname/myproj/path3/path4:path4";

// Java
// 目标文件将放入src/main/java/com/github/biolee/path3/path4/
// import此文件的proto,也将根据此生成引入path
option java_package = "com.github.biolee.path3.path4";

// Python,Javascript
// 生成的Python import 根据proto的import语句生成
// import "path1/path2/lib.proto";-> Python
from path1.path2 import lib_pb2 as path1_dot_path2_dot_lib__pb2
// import "path1/path2/lib.proto";-> Javascript
var path1_path2_lib_pb = require('../../path1/path2/lib_pb.js');
import * as path1_path2_lib_pb from "../../path1/path2/lib_pb";

compile

# go
## go的protoc一行命令只能compile一个package
protoc --go_out=. --go_out=plugins=grpc:. path1/path2/*.proto
protoc --go_out=. --go_out=plugins=grpc:. path3/path4/*.proto

# Python
python -m grpc_tools.protoc -I=. --python_out=. --grpc_python_out=. \
	path1/path2/*.proto path3/path4/*.proto

# Java
protoc -I=. \
	--plugin=protoc-gen-grpc-java=${PROTOC_GEN_GRPC_JAVA} \
	--java_out=src/main/java \
	--grpc-java_out=src/main/java \
	path1/path2/*.proto path3/path4/*.proto

# Typescript
protoc -I=. \
	--plugin=protoc-gen-ts=./node_modules/.bin/protoc-gen-ts \
	--js_out=import_style=commonjs,binary:. \
	--ts_out=service=true:. \
	path1/path2/*.proto path3/path4/*.proto

grpc_starter's People

Contributors

unship avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.