Protocol Buffer (一)使用篇

笔者之前是做即时通讯类软件的,项目初始的时候用的是JSON进行数据传输,后来发现用JSON传输数据,数据包还是大了一些,后来了解到Protocol buffer的数据包会比JSON小很多,就对Protocol buffer进行了学习,发现这种通信格式确实比JSON数据包要小很多,更难得的是,采用这种格式,数据的序列化和发序列化比JSON和XML格式还要好很多,缺点虽然也有,最明显的就是可读性差了点,不过考虑到用JSON传输的时候,我们也要做加密处理,这个缺点对我们来说基本上可以算是忽略不计了。

一、编写.proto 文件
我们平时使用JSON传输数据的时候,一般都是我们自己编写类,然后手动或者采用fastJson之类的东西自动序列化和反序列化。而使用Protocol buffer则是通过编写后缀为.proto 的文件约定好类的属性,然后由Protocol程序根据.proto 文件自动生成类文件。生成的类里面有序列化和反序列化的方法,我们直接拿来就可以用。

既然文章是发表在简书上面,那咱们就写一个描述简书用户的.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) {
        //创建一个用户的Builder
        JianshuUserMsg.JianshuUser.Builder userBuilder
                = JianshuUserMsg.JianshuUser.newBuilder();
        
        //使用userBuilder设置属性
        userBuilder.setName("Magiccoder");
        userBuilder.setIndex("http://www.jianshu.com/users/b34f19f1554e/");
        userBuilder.setFollow(4);
        userBuilder.setFans(2);
        userBuilder.setIntroduction("大道至简");

        //创建一个文章的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);

        //创建用户实例
        JianshuUserMsg.JianshuUser jianshuUser = userBuilder.build();

        //序列化
        byte[] data = jianshuUser.toByteArray();
        System.out.println("序列化之后的数组");
        //循环输出
        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.jianshu.com/users/b34f19f1554e/
2
4
大道至简
文章数目:2
文章1
我是文章1的内容
文章2
我是文章2的内容
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345

推荐阅读更多精彩内容