Protobuf系列-2.在Java項目中使用

在上一篇文章中,我們介紹了如何安裝Protoc,以及編譯一個proto文件.

在這篇文章中,我們將會介紹如何在項目中使用這些編譯出來的文件.

創建一個maven項目

通過下面這條命令創建一個最簡單的maven項目就好:
mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

它會在當前目錄下生成一個名為my-app的項目.

這個項目的初始結構如下:

我們可以看到,其中生成的的App.java以及AppTest.java,我們并不需要,所以直接給刪掉就好了.

然后,我們需要向其中添加一個protobuf的依賴,因為生成的Java文件需要這個依賴中的內容.

pom.xml中添加如下內容:

    <dependency>
      <groupId>com.google.protobuf</groupId>
      <artifactId>protobuf-java</artifactId>
      <version>3.4.0</version>
    </dependency>

注意上面的那個版本應該跟你安裝的protoc版本一致.

創建proto文件并生成Java文件

我們在項目的根目錄下,創建一個src/main/java/proto文件夾,并編寫一個名為addressbook.proto的文件:

syntax = "proto3";

package com.mycompany.app;

option java_package = "com.mycompany.app";
option java_multiple_files = true;
option java_outer_classname = "AddressBookProtos";

message Person {

    string name = 1;
    int32 id = 2;
    string email = 3;

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

    message PhoneNumber {

        string number = 1;
        PhoneType type = 2;

    }

    repeated PhoneNumber phones = 4;

}

message AddressBook {

    repeated Person people = 1;

}

注意上面的這個文件中,option java_package部分,應該給你的項目中你想存放生成的文件的包名一致.

通過protoc --java_out=. addressbook.proto命令,可以生成Java源文件.

然后,我們需要將生成的這些源文件拷貝到項目根目錄下的src/main/java/com/mycompany/app目錄中.

這里需要注意的是,如果你在寫proto文件時,其中option java_package選項指定的目錄跟你想存放的目錄不一樣的話,需要手動修改一下生成的文件中的包名.

然后,我們在src/main/java/com/mycompany/app下,創建一個Java源文件,其內容如下:

package com.mycompany.app;

import java.io.*;

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 telephone = stdin.readLine();
            if (telephone.length() == 0)
                break;

            Person.PhoneNumber.Builder phoneNumber = Person.PhoneNumber.newBuilder();
            phoneNumber.setNumber(telephone);

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

            person.addPhones(phoneNumber);

        }

        return person.build();

    }

    public static void main(String[] args) throws Exception {

        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] + " doesn't exist. Creating file.");
        }

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

        FileOutputStream fileOutputStream = new FileOutputStream(args[0]);
        addressBook.build().writeTo(fileOutputStream);
        fileOutputStream.close();

    }

}

它的作用是,讓你輸入一個Person的信息,并且保存到你指定的文件中.

那么如何編譯這個文件呢?

進入到src/main/java這個目錄下,執行下面的命令:

** javac -cp .:/opt/mvn/resp/com/google/protobuf/protobuf-java/3.4.0/protobuf-java-3.4.0.jar com/mycompany/app/AddPerson.java**

其中你需要把protbuf-java的路徑換成你的機器上的路徑.

編譯完成后,通過java -cp .:/opt/mvn/resp/com/google/protobuf/protobuf-java/3.4.0/protobuf-java-3.4.0.jar com/mycompany/app/AddPerson hello這條命令來運行剛剛AddPerson文件.輸入完Person的信息后,我們會看到在當前目錄下,會生成一個十六進制的hello文件.

我們打開這個16進制文件,可以看到其中的內容為:

0A 08 0A 04 66 73 64 61 10 01

其中保存了一些元數據以及我輸入的數據的十六進制編碼.

就這樣就完成了.

總結

在這篇文章中,我們一步步介紹了如何創建一個Java并和protobuf結合.

這篇文章中,我只介紹了一部分用法,很不全面.

請去查看官方文檔來獲取更加全面的信息.

關于Protobuf的官方文檔,后續我可能會翻譯出來,也是放在這個系列中.

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,923評論 6 535
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,740評論 3 420
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,856評論 0 380
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,175評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,931評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,321評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,383評論 3 443
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,533評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,082評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,891評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,067評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,618評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,319評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,732評論 0 27
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,987評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,794評論 3 394
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,076評論 2 375

推薦閱讀更多精彩內容

  • 由于工程項目中擬采用一種簡便高效的數據交換格式,百度了一下發現除了采用 xml、JSON 還有 ProtoBuf(...
    黃海佳閱讀 48,786評論 1 23
  • 前面翻譯了谷歌的Proto3 語言指南 這一篇講實戰應用先總結一下 Protocol Buffer 一、什么是Pr...
    黃海佳閱讀 4,131評論 1 1
  • 遇見你,我很感激,我從未想過有一天我會遇見一個我以為只活在我想象中的你。我愛你,在這過程里,我變得細膩且溫柔。我想...
    Zn0211閱讀 407評論 0 0
  • 你牽著我的手 奔走在山野鄉間 我枕著你的臂 夜夜有酣睡夢甜 清晨黃昏 灶頭田邊 拔節的莊稼 飄香的炊煙 我一張全優...
    肥馬駒閱讀 128評論 0 1
  • 人本主義心理學的代表之一,美國心理學家卡爾·羅杰斯曾經這樣說:“在我與他人的交往中我發現,從長遠來看,自己表...
    Sunflower新晴閱讀 507評論 0 0