Protocol Buffer (一)使用篇

筆者之前是做即時通訊類軟件的,項目初始的時候用的是JSON進行數據傳輸餐塘,后來發(fā)現用JSON傳輸數據妥衣,數據包還是大了一些,后來了解到Protocol buffer的數據包會比JSON小很多戒傻,就對Protocol buffer進行了學習税手,發(fā)現這種通信格式確實比JSON數據包要小很多,更難得的是需纳,采用這種格式芦倒,數據的序列化和發(fā)序列化比JSON和XML格式還要好很多,缺點雖然也有不翩,最明顯的就是可讀性差了點兵扬,不過考慮到用JSON傳輸的時候,我們也要做加密處理口蝠,這個缺點對我們來說基本上可以算是忽略不計了器钟。

一、編寫.proto 文件
我們平時使用JSON傳輸數據的時候亚皂,一般都是我們自己編寫類俱箱,然后手動或者采用fastJson之類的東西自動序列化和反序列化。而使用Protocol buffer則是通過編寫后綴為.proto 的文件約定好類的屬性灭必,然后由Protocol程序根據.proto 文件自動生成類文件狞谱。生成的類里面有序列化和反序列化的方法,我們直接拿來就可以用禁漓。

既然文章是發(fā)表在簡書上面跟衅,那咱們就寫一個描述簡書用戶的.proto文件吧。

//JianshuUserMsg.proto
message JianshuUser { 
    required string name = 1;   //用戶名
    required string index = 2;  //用戶主頁
    required int32 follow = 3;  //關注數
    required int32 fans = 4;    //粉絲數

    //文章
    message Article{
        required string name = 1; //文章標題
        required content = 2;     //文章內容
    }

    repeated Article article = 5; //文章
    optional string introduction = 6;//個人介紹
} 
    

簡書上面的用戶屬性不只這些播歼,咱們只是為了把關鍵字介紹一下伶跷,這些應該就夠了。
文件其實看上去還是蠻簡潔的秘狞,結構化的數據稱為message叭莫,required修飾必選字段,optional修飾可選字段烁试,repeated修飾可以重復出現的屬性雇初,也就是當前類和這個屬性是一對多的關系,repeated修飾的屬性是可選的减响。類里面的組合關系也可以用嵌套message的方式去實現靖诗。對于一個message而言郭怪,每個屬性對應的tag值,也就是等號后面的數字刊橘,是不可以重復的鄙才。

二、使用腳本程序生成類文件
筆者平時主要用Java語言促绵,在這里就介紹如何使用腳本程序生成Java文件攒庵,腳本使用方式如下所示。等號后面需要跟兩個屬性绞愚,第一個是生成的.java文件的存放路徑叙甸,第二個是.proto文件的位置。生成的java文件直接拷貝到自己的工程里面就可以直接使用了,生成的類文件有點太長了位衩,沒法直接粘到這邊給大家看裆蒸,大家可以嘗試自己寫一個腳本,或者把我的這個腳本直接拷貝過去生成Java代碼看一下糖驴。

//生成Java類
protoc --java_out=./ JianshuUserMsg.proto

三僚祷、生成類的使用
生成類的用法還是比較簡單的,我把使用的示例代碼放上來吧贮缕。大家略微看一下就知道用法了辙谜。

import com.google.protobuf.InvalidProtocolBufferException;

import java.util.List;

/**
 * Created by magiccoder on 16/12/25.
 */
public class Test {

    public static void main(String[] args) {
        //創(chuàng)建一個用戶的Builder
        JianshuUserMsg.JianshuUser.Builder userBuilder
                = JianshuUserMsg.JianshuUser.newBuilder();
        
        //使用userBuilder設置屬性
        userBuilder.setName("Magiccoder");
        userBuilder.setIndex("http://www.reibang.com/users/b34f19f1554e/");
        userBuilder.setFollow(4);
        userBuilder.setFans(2);
        userBuilder.setIntroduction("大道至簡");

        //創(chuàng)建一個文章的Builder
        JianshuUserMsg.JianshuUser.Article.Builder articleBuidler
                = JianshuUserMsg.JianshuUser.Article.newBuilder();
        
        //設置文章1的屬性
        articleBuidler.setName("文章1");
        articleBuidler.setContent("我是文章1的內容");
        //調用build()方法實例化一個Article對象
        JianshuUserMsg.JianshuUser.Article article1 = articleBuidler.build();
        
        //添加文章1
        userBuilder.addArticle(article1);

        //設置文章2的屬性
        articleBuidler.setName("文章2");
        articleBuidler.setContent("我是文章2的內容");
        //調用build()方法實例化第二個Article對象
        JianshuUserMsg.JianshuUser.Article article2 = articleBuidler.build();

        //添加文章2
        userBuilder.addArticle(article2);

        //創(chuàng)建用戶實例
        JianshuUserMsg.JianshuUser jianshuUser = userBuilder.build();

        //序列化
        byte[] data = jianshuUser.toByteArray();
        System.out.println("序列化之后的數組");
        //循環(huán)輸出
        for (int i = 0; i < data.length; i++) {
            System.out.print(data[i] + " ");
        }
        System.out.println("\n---------------------");


        //反序列化
        System.out.println("反序列化");
        try {
            JianshuUserMsg.JianshuUser user = JianshuUserMsg.JianshuUser.parseFrom(data);
            System.out.println(user.getName());
            System.out.println(user.getIndex());
            System.out.println(user.getFans());
            System.out.println(user.getFollow());
            System.out.println(user.getIntroduction());
            System.out.println("文章數目:" + user.getArticleCount());
            List<JianshuUserMsg.JianshuUser.Article> articles = user.getArticleList();
            for(JianshuUserMsg.JianshuUser.Article article:articles){
                System.out.println(article.getName());
                System.out.println(article.getContent());
            }
        } catch (InvalidProtocolBufferException e) {
            e.printStackTrace();
        }
    }

}

代碼輸出如下:

序列化之后的數組
10 10 77 97 103 105 99 99 111 100 101 114 18 42 104 116 116 112 58 47 47 119 119 119 46 106 105 97 110 115 104 117 46 99 111 109 47 117 115 101 114 115 47 98 51 52 102 49 57 102 49 53 53 52 101 47 24 4 32 2 42 33 10 7 -26 -106 -121 -25 -85 -96 49 18 22 -26 -120 -111 -26 -104 -81 -26 -106 -121 -25 -85 -96 49 -25 -102 -124 -27 -122 -123 -27 -82 -71 42 33 10 7 -26 -106 -121 -25 -85 -96 50 18 22 -26 -120 -111 -26 -104 -81 -26 -106 -121 -25 -85 -96 50 -25 -102 -124 -27 -122 -123 -27 -82 -71 50 12 -27 -92 -89 -23 -127 -109 -24 -121 -77 -25 -82 -128 
---------------------
反序列化
Magiccoder
http://www.reibang.com/users/b34f19f1554e/
2
4
大道至簡
文章數目:2
文章1
我是文章1的內容
文章2
我是文章2的內容
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市感昼,隨后出現的幾起案子装哆,更是在濱河造成了極大的恐慌,老刑警劉巖定嗓,帶你破解...
    沈念sama閱讀 211,042評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件蜕琴,死亡現場離奇詭異,居然都是意外死亡宵溅,警方通過查閱死者的電腦和手機凌简,發(fā)現死者居然都...
    沈念sama閱讀 89,996評論 2 384
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來恃逻,“玉大人雏搂,你說我怎么就攤上這事】芩穑” “怎么了凸郑?”我有些...
    開封第一講書人閱讀 156,674評論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長矛市。 經常有香客問我线椰,道長,這世上最難降的妖魔是什么尘盼? 我笑而不...
    開封第一講書人閱讀 56,340評論 1 283
  • 正文 為了忘掉前任憨愉,我火速辦了婚禮,結果婚禮上卿捎,老公的妹妹穿的比我還像新娘配紫。我一直安慰自己,他們只是感情好午阵,可當我...
    茶點故事閱讀 65,404評論 5 384
  • 文/花漫 我一把揭開白布躺孝。 她就那樣靜靜地躺著,像睡著了一般底桂。 火紅的嫁衣襯著肌膚如雪植袍。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,749評論 1 289
  • 那天籽懦,我揣著相機與錄音于个,去河邊找鬼。 笑死暮顺,一個胖子當著我的面吹牛厅篓,可吹牛的內容都是我干的。 我是一名探鬼主播捶码,決...
    沈念sama閱讀 38,902評論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼羽氮,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了惫恼?” 一聲冷哼從身側響起档押,我...
    開封第一講書人閱讀 37,662評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎祈纯,沒想到半個月后令宿,有當地人在樹林里發(fā)現了一具尸體,經...
    沈念sama閱讀 44,110評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡盆繁,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,451評論 2 325
  • 正文 我和宋清朗相戀三年掀淘,在試婚紗的時候發(fā)現自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片油昂。...
    茶點故事閱讀 38,577評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡革娄,死狀恐怖,靈堂內的尸體忽然破棺而出冕碟,到底是詐尸還是另有隱情拦惋,我是刑警寧澤,帶...
    沈念sama閱讀 34,258評論 4 328
  • 正文 年R本政府宣布安寺,位于F島的核電站厕妖,受9級特大地震影響,放射性物質發(fā)生泄漏挑庶。R本人自食惡果不足惜言秸,卻給世界環(huán)境...
    茶點故事閱讀 39,848評論 3 312
  • 文/蒙蒙 一软能、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧举畸,春花似錦查排、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,726評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至叛买,卻和暖如春砂代,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背率挣。 一陣腳步聲響...
    開封第一講書人閱讀 31,952評論 1 264
  • 我被黑心中介騙來泰國打工刻伊, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人难礼。 一個月前我還...
    沈念sama閱讀 46,271評論 2 360
  • 正文 我出身青樓娃圆,卻偏偏與公主長得像,于是被迫代替她去往敵國和親蛾茉。 傳聞我的和親對象是個殘疾皇子讼呢,可洞房花燭夜當晚...
    茶點故事閱讀 43,452評論 2 348

推薦閱讀更多精彩內容