GOPATH/bin加入环境变量,json与protobuf做数据传输对

作者: 编程  发布:2019-11-20

5、在go语言中使用protobuf

(2)保存protobuf序列化数据到文件

0、跟Json相比,protobuf 的优缺点:

优点:

  • 性能更高,更加规范;
  • 编解码速度快,数据体积小;
  • 使用统一的规范,不用再担心大小写不同导致解析失败等问题。

缺点:

  • 失去了一些便利性;
  • 改动协议字段,需要重新生成文件;
  • 数据没有可读性;

Protocol Buffers是一种跨语言、跨平台用于序列化、反序列化结构数据的可扩展机制工具集。这里主要记录一下Java语言的使用。

地址:

syntax = "proto2";

package tutorial;

option java_package = "org.chench.test.protobuf";
option java_outer_classname = "AddressBookProtos";

message Person {
    required string name = 1;
    required int32 id = 2;
    optional string email = 3;

    enum PhoneType {
        MOBILE = 0;
        HOME = 1;
        WORK = 2;
    }

    message PhoneNumber {
        required string number = 1;
        optional PhoneType type = 2 [default = HOME];
    }

    repeated PhoneNumber phones = 4;
}

message AddressBook {
    repeated Person people = 1;
}

4、使用protoc编译.proto文件成.pd.go文件

命令行进入.proto文件所在路径,使用 命令:

protoc --go_out=. *.proto

会把.pd.go文件生成到当前目录下,即完成编译过程。

一、下载

      首先下载protocol buffers,使用Java语言,下载Java版本protobuf-java-版本号.zip,然后再下载对应版本的compiler,我们是Windows平台,下载protoc-版本号-win32.zip。

      ☆.注意,下载的protobuf-java的版本号一定要和compiler版本一致

> go get -u github.com/golang/protobuf/protoc-gen-go
Execute failed: java.io.IOException: Cannot run program ...

3、protobuf的编译器protoc

在go中使用protobuf,有两个可选用的包goprotobuf(go官方出品)和gogoprotobuf(二选一即可)。
gogoprotobuf完全兼容google protobuf,它生成的代码质量和编解码性能均比goprotobuf高一些。
使用protobuf:

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

使用gogoprotobuf:(待验证)
gogoprotobuf有两个插件可以使用(二选一即可):

  • protoc-gen-gogo:和protoc-gen-go生成的文件差不多,性能也几乎一样(稍微快一点点)
  • protoc-gen-gofast:生成的文件更复杂,性能也更高(快5-7倍)

//gogo
go get github.com/gogo/protobuf/protoc-gen-gogo
//gofast
go get github.com/gogo/protobuf/protoc-gen-gofast
//安装gogoprotobuf库文件
go get github.com/gogo/protobuf/proto
9159.com,go get github.com/gogo/protobuf/gogoproto //这个不装也没关系
//生成编译文件
//gogo
protoc --gogo_out=. *.proto
//gofast
protoc --gofast_out=. *.proto

成功后会在GOPATH的第一个目录的bin文件夹下生成protoc-gen-go可执行文件(如果该路径没在系统的环境变量中,则需要将改路径也加入到环境变量的path中去)。

二、编译jar包配置

      1>.比如,我下载了protobuf-java-3.1.0.zip和protoc-3.1.0-win32.zip,把它们解压到同一目录E:protobuf,目录分别为E:protobufprotobuf-3.1.0和E:protobufprotoc-3.1.0-win32

      在E:protobufprotoc-3.1.0-win32中找到protoc.exe,在path里配置它的环境变量,并在命令行里执行"protoc --version",能正常执行,并显示版本号,表示配置成功

9159.com 1

protoc

           2>.因为protobuf是使用maven编译,如果没有配置maven环境,需要先下载Maven,并配置环境变量。在命令行执行“mvn --version ”,正常显示版本号,表示配置成功。

9159.com 2

mvn

             3>.这一步很关键

                    ①、把protoc.exe复制到E:protobufprotobuf-3.1.0src 目录下

                    ②、在cmd命令行窗口,cd重定位到“E:protobufprotobuf-3.1.0java”目录,然后执行"mvn package",编译jar文件,如果 没有出错,会在"E:runtimeprotobuf-3.1.0javacore"目录      下生成"target"文件夹,编译的jar文件就在此目录下

9159.com 3

jar

https://developers.google.com/protocol-buffers/

--下载链接

https://github.com/google/protobuf/releases

--编译jar参考

http://blog.csdn.net/u013656135/article/details/52194248

会生成一个test.pb.go的文件,具体的文件内容我就不截图了。

【参考】
protobuf简单使用
protobuf官方手册

1、安装protobuf库文件

方法(1)使用go get

go get github.com/golang/protobuf/proto(待验证)

方法(2)下载文件
或者直接通过protobuf下载链接,戳这里上下载或git clone下来对应放到到 $GOPATHsrcgolang.orgxprotobuf 中(可用)

 

1. protobuf概述
protobuf是Google开发一种数据描述格式,能够将结构化数据序列化,可用于数据存储通信协议等方面。
protobuf是以二进制来存储数据的。相对于JSON和XML具有以下优点:

2、protobuf的编译器protoc

在protoc下载链接,戳这里上找到protoc的压缩包下载。并放到$GOROOT的bin目录下。

4、运行如下命令

3. 使用protobuf
新建一个空的maven项目,并添加protobuf运行时依赖:
pom.xml:

json与protobuf做数据传输对比:
json用起来的确很方便。但相对于protobuf数据量更大些。做一个移动端应用,为用户省点流量还是很有必要的。正好也可以学习一下protobuf的使用

9159.com 4

package org.chench.test.protobuf;

import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintStream;

import org.chench.test.protobuf.AddressBookProtos.AddressBook;
import org.chench.test.protobuf.AddressBookProtos.Person;
import org.chench.test.protobuf.AddressBookProtos.Person.PhoneNumber;
import org.chench.test.protobuf.AddressBookProtos.Person.PhoneType;

/**
 * 使用protobuf类示例: <br />
 * 从控制台输入相关信息,然后将数据序列化到文件。
 * @desc org.chench.test.protobuf.AddPerson
 * @author chench9@lenovo.com
 * @date 2017年6月7日
 */
public class AddPerson {

    static Person PromptForAddress(BufferedReader stdin,
            PrintStream stdout) throws IOException {
        Person.Builder person = Person.newBuilder();

        stdout.print("Enter person ID: ");
        person.setId(Integer.valueOf(stdin.readLine()));

        stdout.print("Enter name: ");
        person.setName(stdin.readLine());

        stdout.print("Enter email address (blank for none): ");
        String email = stdin.readLine();
        if(email.length() > 0) {
            person.setEmail(email);
        }

        while(true) {
            stdout.print("Enter a phone number (or leave blank to finish): ");

            String number = stdin.readLine();
            if(number.length() == 0) {
                break;
            }

            PhoneNumber.Builder phoneNumber = PhoneNumber.newBuilder();
            phoneNumber.setNumber(number);

            stdout.print("Is this a mobile, home, or work phone? ");
            String type = stdin.readLine();
            if("mobile".equalsIgnoreCase(type)) {
                phoneNumber.setType(PhoneType.MOBILE);
            }else if("home".equalsIgnoreCase(type)) {
                phoneNumber.setType(PhoneType.HOME);
            }else if("work".equalsIgnoreCase(type)) {
                phoneNumber.setType(PhoneType.WORK);
            }

            person.addPhones(phoneNumber);
        }

        return person.build();
    }

    /**
     * @param args
     * @throws IOException 
     */
    public static void main(String[] args) throws IOException {
        if (args.length != 1) {
            System.err.println("Usage:  AddPerson ADDRESS_BOOK_FILE");
            System.exit(-1);
        }

        AddressBook.Builder addressBook = AddressBook.newBuilder();
        try {
            // 从指定文件读取数据
            addressBook.mergeFrom(new FileInputStream(args[0]));
        } catch (FileNotFoundException e) {
            System.out.println(args[0] + ": File not found.  Creating a new file.");
            e.printStackTrace();
        }

        addressBook.addPeople(PromptForAddress(new BufferedReader(new InputStreamReader(System.in)),
                System.out));

        FileOutputStream out = new FileOutputStream(args[0]);
        addressBook.build().writeTo(out);
    }

}

 

完毕!示例代码详见:

2、获取protobuf的编译器插件protoc-gen-go
    进入GOPATH目录
    运行

(3)从protobuf序列化文件中读取之前保存进去的数据。

    如果成功,会在GOPATH/bin下生成protoc-gen-go.exe文件

编译addressbook.proto,在windows控制台进入addressbook.proto文件所在目录路径下,执行如下编译操作:

> protoc --go_out=. *.proto

生成java class:org.chench.test.protobuf.AddressBookProtos.java,将生成的java文件拷贝到前面新建的maven项目中。

3、创建一个test.proto文件

protoc -I=. --java_out=. ./addressbook.proto
//指定版本
//注意proto3与proto2的写法有些不同
syntax = "proto3";

//包名,通过protoc生成时go文件时
package test;

//手机类型
//枚举类型第一个字段必须为0
enum PhoneType {
    HOME = 0;
    WORK = 1;
}

//手机
message Phone {
    PhoneType type = 1;
    string number = 2;
}

//人
message Person {
    //后面的数字表示标识号
    int32 id = 1;
    string name = 2;
    //repeated表示可重复
    //可以有多个手机
    repeated Phone phones = 3;
}

//联系簿
message ContactBook {
    repeated Person persons = 1;
}

环境:windows,java

1、下载protobuf的编译器protoc

(1)protobuf编译器下载:。
对于windows平台,下载:protoc-${version}-win32.zip。在此以protoc-3.3.0-win32.zip为例。
解压到指定目录,如:D:protoc-3.3.0-win32。添加到windows环境变量:D:protoc-3.3.0-win32bin。

https://github.com/google/protobuf/releases

cd D:protobufjava
mvn install(如果不想执行单元测试,可以执行:mvn install -Dmaven.test.skip=true)

 

官网:
9159.com 5

package main;

import (
 "github.com/golang/protobuf/proto"
 "protobuf/test"
 "io/ioutil"
 "os"
 "fmt"
)

func write() {
 p1 := &test.Person{
  Id:   1,
  Name: "小张",
  Phones: []*test.Phone{
   {test.PhoneType_HOME, "111111111"},
   {test.PhoneType_WORK, "222222222"},
  },
 };
 p2 := &test.Person{
  Id:   2,
  Name: "小王",
  Phones: []*test.Phone{
   {test.PhoneType_HOME, "333333333"},
   {test.PhoneType_WORK, "444444444"},
  },
 };

 //创建地址簿
 book := &test.ContactBook{};
 book.Persons = append(book.Persons, p1);
 book.Persons = append(book.Persons, p2);

 //编码数据
 data, _ := proto.Marshal(book);
 //把数据写入文件
 ioutil.WriteFile("./test.txt", data, os.ModePerm);
}

func read() {
 //读取文件数据
 data, _ := ioutil.ReadFile("./test.txt");
 book := &test.ContactBook{};
 //解码数据
 proto.Unmarshal(data, book);
 for _, v := range book.Persons {
  fmt.Println(v.Id, v.Name);
  for _, vv := range v.Phones {
   fmt.Println(vv.Type, vv.Number);
  }
 }
}

func main() {
 write();
 read();
}

(2)protobuf运行时下载:protobuf运行时环境是区分不同语言的,针对不同语言的安装方式不同。
下载protobuf到指定目录:git clone
对于java语言而言,可以通过maven将protobuf运行时依赖安装到本地仓库,详见:。
需要注意的是,在执行:mvn install 之前,需要将protobuf编译器(在此即:D:protoc-3.3.0-win32binprotoc.exe)拷贝到protobuf目录下的src路径下,即:D:protobufsrc。
否则,在编译安装protobuf运行时环境时报错:

window:
    下载: protoc-3.3.0-win32.zip
    解压,把bin目录下的protoc.exe复制到GOPATH/bin下,GOPATH/bin加入环境变量。
    当然也可放在其他目录,需加入环境变量,能让系统找到protoc.exe
linux:
    下载:protoc-3.3.0-linux-x86_64.zip 或 protoc-3.3.0-linux-x86_32.zip
    解压,把bin目录下的protoc复制到GOPATH/bin下,GOPATH/bin加入环境变量。
    如果喜欢编译安装的,也可下载源码自行安装,最后将可执行文件加入环境变量。

2. 下载,安装
在使用protobuf之前,需要安装protobuf编译器和运行时环境。
由于protobuf是跨平台,跨语言的,所以需要下载和安装对应版本的编译器和运行时依赖。

将在maven本地仓库安装protobuf运行时依赖jar包(注意:下载protobuf编译器和运行时环境的版本要保持一致!在此下载的是最新版本:3.3.0),包括:

<dependencies>
    <!-- 添加protobuf运行时依赖 -->
    <dependency>
        <groupId>com.google.protobuf</groupId>
        <artifactId>protobuf-java</artifactId>
        <version>3.3.0</version>
    </dependency>
</dependencies>
  • protobuf-java: The core Java Protocol Buffers library. Most users only need this artifact.
  • protobuf-lite: The lite version of core Java Protobuf Buffers library. It is a subset of the core library and is used together with the 'lite' code generator flag to reduce generated code size for mobile.
  • protobuf-java-util: Utilities to work with protos. It contains JSON support as well as utilities to work with proto3 well-known types.
package org.chench.test.protobuf;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;

import org.chench.test.protobuf.AddressBookProtos.AddressBook;
import org.chench.test.protobuf.AddressBookProtos.Person;
import org.chench.test.protobuf.AddressBookProtos.Person.PhoneNumber;

/**
 * 从protobuf序列化文件读取数据。
 * @desc org.chench.test.protobuf.ListPeople
 * @author chench9@lenovo.com
 * @date 2017年6月7日
 */
public class ListPeople {

    static void Print(AddressBook addressBook) {
        for(Person p : addressBook.getPeopleList()) {
            System.out.println("Person ID: " + p.getId());
            System.out.println("  Name: " + p.getName());
            if (p.hasEmail()) {
                System.out.println("  E-mail address: " + p.getEmail());
            }

            for(PhoneNumber pn : p.getPhonesList()) {
                switch (pn.getType()) {
                    case MOBILE:
                        System.out.print("  Mobile phone #: ");
                        break;
                    case HOME:
                        System.out.print("  Home phone #: ");
                        break;
                    case WORK:
                        System.out.print("  Work phone #: ");
                        break;
                }
                System.out.println(pn.getNumber());
            }
        }
    }

    /**
     * @param args
     * @throws IOException 
     * @throws FileNotFoundException 
     */
    public static void main(String[] args) throws IOException {
        if (args.length != 1) {
            System.err.println("Usage:  ListPeople ADDRESS_BOOK_FILE");
            System.exit(-1);
        }

        try {
            AddressBook addressBook = AddressBook.parseFrom(new FileInputStream(args[0]));
            Print(addressBook);
        } catch (FileNotFoundException e) {
            System.out.println(args[0] + ": File not exists");
            e.printStackTrace();
        }

    }

}
  • 简洁
  • 体积小:消息大小只需要XML的1/10 ~ 1/3
  • 速度快:解析速度比XML快20 ~ 100倍
  • 使用protobuf的编译器,可以生成更容易在编程中使用的数据访问代码

    更好的兼容性,protobuf设计的一个原则就是要能够很好的支持向下或向上兼容

 

(1)新建protobuf数据描述文件:addressbook.proto

本文由9159.com发布于编程,转载请注明出处:GOPATH/bin加入环境变量,json与protobuf做数据传输对

关键词:

上一篇:WinForm可以操作客户端文件 Client
下一篇:没有了