我的编程空间,编程开发者的网络收藏夹
学习永远不晚

Golang安装和使用protocol-buffer流程介绍

短信预约 -IT技能 免费直播动态提醒
省份

北京

  • 北京
  • 上海
  • 天津
  • 重庆
  • 河北
  • 山东
  • 辽宁
  • 黑龙江
  • 吉林
  • 甘肃
  • 青海
  • 河南
  • 江苏
  • 湖北
  • 湖南
  • 江西
  • 浙江
  • 广东
  • 云南
  • 福建
  • 海南
  • 山西
  • 四川
  • 陕西
  • 贵州
  • 安徽
  • 广西
  • 内蒙
  • 西藏
  • 新疆
  • 宁夏
  • 兵团
手机号立即预约

请填写图片验证码后获取短信验证码

看不清楚,换张图片

免费获取短信验证码

Golang安装和使用protocol-buffer流程介绍

前言

protocol buffer是Google发布的一种独立的数据交换格式,类似于json,用于数据的序列化和解析。不同点是不能直接在各编程语言中使用,需要先在一个proto文件中定义需要传输的数据格式,然后使用proto工具把proto文件编译成想要的语言,如java、go、php等。然后在代码中,使用语言对应的protocol buffer包调用proto工具生成的文件,完成数据的序列化

安装protoc编译工具

首先安装protoc编译工具,在http://github.com/google/protobuf/releases,根据自己的系统选择包,下载后解压。我是win10 64,所以选择protoc-21.4-win64.zip,解压后放在了E盘。

添加环境变量,让系统命令可以识别protoc命令。

配置环境变量

PB_PATH=E:\protoc-3.21.4-win64

PATH=%PB_PATH%\bin

添加后,在命令行执行 protoc,返回信息,表示安装成功

编写proto文件

创建一个user.proto文件,该文件下可以定义一些user相关的需要加密的字段

//引入其他proto文件,就可以使用该文件中定义的message类型,定义本文件中的message下的字段
import "myproject/other_protos.proto";
// 指定的当前proto语法的版本
syntax = "proto3";
// 指定生成出来的文件的package,用来避免同一个文件调同名的消息时冲突
// 包说明符对生成代码的影响取决于您选择的语言,php会生成命名空间,go会生成package
package service;
//根据编程语言不同,参数名不同
//下面代码指定了生成go文件的生成目录,文件的包名。不设置包名时,包名默认为go文件所在目录名。会覆盖package设置的go的包名
//路径以执行命令的目录为当前目录,寻找相对路径
option go_package="./;service";
//定义消息类型,通过关键字message字段指定的,消息就是需要传输的数据格式的定义
message User {
// required必传;optional 可选;repeated 可重复初入。不写前缀默认为required
// 字段名后的数字不是默认值,是标识。标识号是[0,2^29-1]范围内的一个整数。[1-15]内的标识号在编码时只占用一个字节,包含标识符和字段类型,[16-2047]之间的标识符占用2个字节。建议为频繁出现的字段使用[1-15]间的标识符。
//字段类型除了除了常规类型,也可使用import引入文件中定义的message类型
	required string sername = 1;
	optional int32 age = 2;
	repeated int32 height = 3;
}
//定义服务类型,用作rpc通讯
service SearchService {
    //rpc 服务的函数名 (传入参数)返回(返回参数)
    //传入和返回参数,需要使用proto中定义的message
    rpc Search (SearchRequest) returns (SearchResponse);
}

生成指定语言的proto文件

protoc内置9中语言的编译插件,如下

我们以go为例。protoc没有内置go的编译器,需要引入外部插件protoc-gen-go

我们使用命令

go get github.com/golang/protobuf/protoc-gen-go

下载并编译了包,包中有main.go文件,所以在GOPATH/bin目录下生成了可执行文件protoc-gen-go.exe,这个文件就是我们在protoc中用到的插件

我们也可以自定义自己的插件。插件名必须以protoc-gen-插件名.exe命名

在调用时以:插件_out=参数 调用,之后回讲到如何制作插件

我们以go_out插件为例,执行命令

命令行后的第一个参数为输出目录。但是我们已经在go_package中指定了目录,所以第一个参数是无效的,填当前目录.即可。第二个参数是,要编译的文件路径和文件名(以命令执行目录为当前目录的相对路径)

protoc后可以追加1个或多个 -I=path 指定解析import指令时要在其中查找.proto文件的目录,若文件没有使用import,则不需要该参数

protoc --go_out=. proto_type/hello.proto

报错

protoc默认会从环境变量path下的路径中寻找插件,没找到报错。

查看发现path中只配置了go的安装GOROOT目录下的bin,而protoc-gen-go.exe在GOPATH的bin目录下

我们把protoc-gen-go.exe复制到GOROOT的bin目录下,即可。或者在环境变量path中添加gopath/bin目录。再次执行命令即可

调用proto

import (
	"fmt"
	"github.com/golang/protobuf/proto"
)
func main() {
	//定义一个要加密的变量
	msg := &protoc_type.User{
		Username:"zhangsan",
		Age:12,
	}
	//加密
	marshal,err := proto.Marshal(msg)
	if err!=nil{
		fmt.Println(err.Error())
	}else{
		fmt.Println(marshal)
	}
	//定义一个变量,用于接收解码的值,类型必须用加密的值类型一样
	unmarshal := &protoc_type.User{}
	//解码
	err2 := proto.Unmarshal(marshal,unmarshal)
	if err2 == nil{
		fmt.Println(unmarshal)
		fmt.Println(unmarshal.Username)
		fmt.Printf("%T",unmarshal)
	}
}	

制作插件

我们上文中提到,生成go用到了一个protoc的外部插件。插件的工作原理其实就是读取proto文件内容,并根据文件内容生成指定文件。文件中保存了定义的字段类型和方法之间的关系,以便编码和解码时使用

当我们在proto文件中定义了service,说明我们需要用到rpc服务。protoc内置的插件和一些官方的外部插件,只是提供了service中方法与参数类型的绑定,用于校验调用方法时类型是否正确。在service中定义的方法,我们需要自己创建。

当方法较多时,我们需要打开proto文件,一一对应的创建func,效率不高也容易出错。这种情况下,我们制作一个插件,读取service内容,自动创建方法,方法内的代码之后根据业务需求填充即可。

go官方提供了一个包,可以自动解析读取命令行传入proto文件,代码如下

package main
import (
	"fmt"
	"strings"
	"google.golang.org/protobuf/compiler/protogen"
)
type rpc struct{}
func main() {
	g := rpc{}
	protogen.Options{}.Run(g.Generate)
}
// Generate generate service code
func (md *rpc) Generate(plugin *protogen.Plugin) error {
	//遍历读取的命令行中传入的proto文件
	for _, f := range plugin.Files {
		//如果文件中没有定义service,跳过
		if len(f.Services) == 0 {
			continue
		}
		//根据proto文件名,生成一个自定义的文件,保存该proto中定义的func
		fileName := f.GeneratedFilenamePrefix + ".svr.go"
		//把该文件保存在proto文件的所在目录
		t := plugin.NewGeneratedFile(fileName, f.GoImportPath)
		//写入文字
		t.P("// Code generated by protoc-gen-tinyrpc.")
		//写入空行
		t.P()
		//写入包名
		pkg := fmt.Sprintf("package %s", f.GoPackageName)
		t.P(pkg)
		t.P()
		//遍历一个文件下所有service,自动生成方法
		for _, s := range f.Services {
			//插入注释,定义service类型
			serviceCode := fmt.Sprintf(`%stype %s struct{}`,
				getComments(s.Comments), s.Desc.Name())
			t.P(serviceCode)
			t.P()
			//遍历一个service下的方法,生成方法
			for _, m := range s.Methods {
				funcCode := fmt.Sprintf(`%sfunc(this *%s) %s(args *%s,reply *%s)error{
					// define your service ...
					return nil
				}
				`, getComments(m.Comments), s.Desc.Name(),
					m.Desc.Name(), m.Input.Desc.Name(), m.Output.Desc.Name())
				t.P(funcCode)
			}
		}
	}
	return nil
}
// getComments get comment details
func getComments(comments protogen.CommentSet) string {
	c := make([]string, 0)
	c = append(c, strings.Split(string(comments.Leading), "\n")...)
	c = append(c, strings.Split(string(comments.Trailing), "\n")...)
	res := ""
	for _, comment := range c {
		if strings.TrimSpace(comment) == "" {
			continue
		}
		res += "//" + comment + "\n"
	}
	return res
}

执行 go install 编译该文件,生成exe文件,文件名称设置为protoc-gen-gofunc.exe。然后再次执行protoc命令,如下

protoc --go_out=. proto_type/hello.proto --gofunc_out=. proto_type/hello.proto

执行后,会在proto_type目录下生成两个文件,hello.pd.go, hello.srv.go

到此这篇关于Golang安装和使用protocol-buffer方法介绍的文章就介绍到这了,更多相关Golang protocol-buffer内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

Golang安装和使用protocol-buffer流程介绍

下载Word文档到电脑,方便收藏和打印~

下载Word文档

猜你喜欢

C++中Protocol Buffer怎么安装和使用

要在C++中使用Protocol Buffer,您需要进行以下步骤来安装和使用它:下载和安装 Protocol Buffer 编译器(protoc):在 Linux 上:您可以从 Protocol Buffer 的 GitHub 仓库(ht
2023-10-23

miniconda3介绍、安装以及使用教程

Miniconda是一款小巧的python环境管理工具,安装包大约只有50M多点,其安装程序中包含conda软件包管理器和Python,下面这篇文章主要给大家介绍了关于miniconda3介绍、安装以及使用的相关资料,需要的朋友可以参考下
2023-02-14

python cx_Oracle模块的安装和使用详细介绍

python cx_Oracle模块的安装 最近需要写一个数据迁移脚本,将单一Oracle中的数据迁移到MySQL Sharding集群,在linux下安装cx_Oracle感觉还是有一点麻烦的,整理一下,做个总结。 对于Oracle客户端
2022-06-04

Ubuntu基础设定:openssh-server的安装和使用介绍

记录一下Ubuntu17.10的openssh-server的安装和使用。安装之后就可以使用ssh登陆Ubuntu了,所以是Ubuntu的基础设定之一。 事前准备Ubuntu版本:17.10 devops@ubuntu:~$ cat /et
2022-06-04

Python使用Selenium WebDriver的入门介绍及安装教程

Selenium是一个用于自动化Web应用程序测试的工具,它可以模拟用户在浏览器中的操作,比如点击、填写表单、提交等。Python是一种常用的编程语言,可以通过使用Selenium的Python绑定库来实现自动化测试。安装Selenium
2023-08-22

AI 代码生成工具 Cursor 安装和使用介绍大全

1: 概述 嘿,小伙伴们,听说你们要了解一款基于 AI 技术的代码生成工具 Cursor,让我们来一起看看如何安装和使用吧! Cursor 是一款基于 AI 技术的代码生成工具,它可以帮助开发人员自动生成代码,提高开发效率。下面是安装和使用
2023-08-18

Python使用SeleniumWebDriver的入门介绍及安装教程(最新推荐)

这篇文章主要介绍了Python使用SeleniumWebDriver的入门介绍及安装教程,本文使用环境为python3.11+win1064位+firefox浏览器,所以本文使用的浏览器驱动是Firefox的geckodriver,如果你使用的是其他浏览器,那么选择自己对应的浏览器驱动程序即可,需要的朋友可以参考下
2023-05-15

【MySQL基础教程】图形化界面工具介绍、安装与使用

前言 本文为 【MySQL基础教程】图形化界面工具介绍、安装与使用 相关介绍,下边将对图形化界面工具介绍,DataGrip的安装与DataGrip的使用进行详尽介绍~ 📌博主主页:小新要变强 的主页 👉Ja
2023-08-21

NoSQL和Redis简介及Redis在Windows下的安装和使用教程

NoSQL简介 介绍redis前,我想还是先认识下NoSQL,即not only sql, 是一种非关系型的数据存储,key/value键值对存储。现有Nosql DB 产品: Redis/MongoDB/Memcached/Hbase/C
2022-06-04

win8系统下安装电源管理8.0风扇除尘方法使用教程介绍

Idea系列新的笔记本如Y400、Z400等机型并无物理的风扇除尘按钮,风扇除尘功能已经整合到了电源管理8.0的界面,需要通过打开电源管理程序来开启风扇除尘功能。 Win8系统安装电源管理8.0风扇除尘如何使用? 1. 安装Win8系统下电
2022-06-04

编程热搜

  • Python 学习之路 - Python
    一、安装Python34Windows在Python官网(https://www.python.org/downloads/)下载安装包并安装。Python的默认安装路径是:C:\Python34配置环境变量:【右键计算机】--》【属性】-
    Python 学习之路 - Python
  • chatgpt的中文全称是什么
    chatgpt的中文全称是生成型预训练变换模型。ChatGPT是什么ChatGPT是美国人工智能研究实验室OpenAI开发的一种全新聊天机器人模型,它能够通过学习和理解人类的语言来进行对话,还能根据聊天的上下文进行互动,并协助人类完成一系列
    chatgpt的中文全称是什么
  • C/C++中extern函数使用详解
  • C/C++可变参数的使用
    可变参数的使用方法远远不止以下几种,不过在C,C++中使用可变参数时要小心,在使用printf()等函数时传入的参数个数一定不能比前面的格式化字符串中的’%’符号个数少,否则会产生访问越界,运气不好的话还会导致程序崩溃
    C/C++可变参数的使用
  • css样式文件该放在哪里
  • php中数组下标必须是连续的吗
  • Python 3 教程
    Python 3 教程 Python 的 3.0 版本,常被称为 Python 3000,或简称 Py3k。相对于 Python 的早期版本,这是一个较大的升级。为了不带入过多的累赘,Python 3.0 在设计的时候没有考虑向下兼容。 Python
    Python 3 教程
  • Python pip包管理
    一、前言    在Python中, 安装第三方模块是通过 setuptools 这个工具完成的。 Python有两个封装了 setuptools的包管理工具: easy_install  和  pip , 目前官方推荐使用 pip。    
    Python pip包管理
  • ubuntu如何重新编译内核
  • 改善Java代码之慎用java动态编译

目录