簡介

Protobuf是google 的一種數(shù)據(jù)交換的格式，它獨立于語言，獨立于平臺。google 提供了多種語言的實現(xiàn)：java、c#、c++、go 和 python，每一種實現(xiàn)都包含了相應(yīng)語言的編譯器以及庫文件。由于它是一種二進制的格式，比使用 xml 進行數(shù)據(jù)交換快許多?？梢园阉糜赱分布式應(yīng)用]

• GitHub
  Protobuf

接入

將protobuf有兩種方式，一種就是常用的配置build.gradle文件，引入庫，使用protobuf插件來編譯.proto（protobuf定義數(shù)據(jù)格式的文件）生成相應(yīng)的平臺類文件。第二種就是下載相應(yīng)的protobuf版本的jar文件，放入工程，然后用google提供的編譯工具，編譯.proto生成相應(yīng)的平臺類文件，然后放入工程中。我使用的是第二種方式，因為這樣可以加深對protobuf學習，當然第一種方式，我也會給出，但是可能遇到的問題就要自己去解決了。

• 第一種接入方式
  更多Protobuf插件使用參考：
  protobuf-gradle-plugin

  1. 在項目的build.gradle文件中添加如下內(nèi)容：

  buildscript {
     ...
     dependencies {
         ...
         // Protobuf插件
         classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.0'
     }
  }
  

  2. 在module使用插件

  apply plugin: 'com.android.application'
  // Protobuf插件
  apply plugin: 'com.google.protobuf'
  

  3. 在module配置Protobuf信息

  android {
   ...
   protobuf{
       protoc {
           // 也可以配置本地編譯器路徑
           artifact = 'com.google.protobuf:protoc:3.5.1'
       }
  
       generateProtoTasks {
           all().each { task ->
               task.builtins {
                   remove java
               }
               task.builtins {
                   // 生產(chǎn)java源碼
                   java {}
               }
           }
       }
   }
   sourceSets {
       main {
           java {
               srcDir 'src/main/java'
           }
           proto {
               //指定.proto文件路徑
               srcDir 'src/main/proto'
           }
       }
   }
  }
  

  4. 在module添加依賴

  dependencies {
     ...
     // protobuf依賴庫
     api 'com.google.protobuf:protobuf-java:3.5.1'
     api 'com.google.protobuf:protoc:3.5.1'
  }
  

  5. 編譯工程
     在對應(yīng)目錄找到編譯文件，如果還不明白的，請自行百度。

• 第二種接入方式
  如果你喜歡將jar放在工程的libs目錄的形式，不想要每次編譯都去執(zhí)行Protobuf編譯腳本。那么下面的這種方式更加適合你。并且，通過這種方式，對Protobuf的用法會更加熟悉。

  1. 下載需要的jar包
     我下載的版本如下，protobuf-java-3.9.1.jar必須有，其它兩個可以不下載。

  dependencies {
      ...
      // 用implementation 運行工程報錯 要用api
      api files('libs/protobuf-java-3.9.1.jar')
      implementation files('libs/protobuf-java-format-1.4.jar')
      implementation files('libs/protobuf-java-util-3.9.1.jar')
  }
  

  maven倉庫下載
  百度maven，找到maven倉庫并打開，搜索protobuf，結(jié)果如下：
  

  maven_protobuf.png

細心的人發(fā)現(xiàn)，Protobuf有個lite版本，lite版本是谷歌Protobuf支持庫的精簡版本。

2. 下載編譯.proto文件工具
   注意：下載的工具版本，要和使用的Protobuf jar包版本相同。
   GitHub下載
   

   protobuf_compile_tools.png
   
   maven repo下載

3. 創(chuàng)建.proto數(shù)據(jù)格式文件

4. 執(zhí)行編譯程序，生成對于的類文件。

編譯

• 創(chuàng)建.proto格式文件
  首先需要創(chuàng)建一個.proto結(jié)尾的文件，用來定義我們需要的數(shù)據(jù)結(jié)構(gòu)。字段都是定義在message節(jié)點下，message后面是名稱，如果不明白，生成相應(yīng)的類文件后，自己查看類文件。

• proto語法
  參考官網(wǎng)proto3語法

• 舉例：
  下面是我創(chuàng)建的proto文件
  第一個.proto文件：socket.proto

  /* socket數(shù)據(jù) 結(jié)構(gòu)*/
  // 不加默認使用proto2
  syntax = "proto3";
  //  包名，如果不指定，這生成文件在輸出路徑的根目錄
  package google.protobuf;
  // 引入其它proto文件，使用其中的message
  import  "body.proto";
  import  "header.proto";
  //  生成的java文件包名
  option java_package = "blog.pds.com.data.protobuf";
  // 自定生成的class類名
  option java_outer_classname = "SocketPackage";
  // 是否將proto中的message編譯成多個文件
  // option java_multiple_files = true;
  message Package{
      Header header = 1;
      Body body = 2;
  }
  

  第二個.proto文件：header.proto

  syntax = "proto3";
  option java_package = "blog.pds.com.data.protobuf";
  option java_outer_classname = "SocketHeader";
  message Header {
      // singular默認規(guī)則，message可以擁有一個或者零個該字段
      int32 type = 1;
      int32 length = 2;
  }
  

  第三個.proto文件：body.proto

  syntax = "proto3";
  option java_package = "blog.pds.com.data.protobuf";
  option java_outer_classname = "SocketBody";
  message Body {
      uint64 id = 1;
      string content = 2;
      string ext = 3;
      // 保留字段編號
      reserved 7, 15, 9 to 11;
      // 保留字段
      reserved "type", "source";
  }
  

  這里一共三個proto文件，每一個文件都要經(jīng)過編譯，不是只編譯第一個文件就可以了。

• 編譯
  這個過程，將我們定義好的proto文件生成我們需要的類文件，比我java，生成class文件，然后放入工程中使用，這個過程還是要注意一下包路徑。
  參考：
  proto編譯
  編譯命令

  protoc -I=$SRC_DIR --java_out=$DST_DIR $SRC_DIR/addressbook.proto
  
  比如:./protoc_mac -I=../ --java_out=../java ../socket.proto
  

  然后在輸出目錄找到你要的文件，導入到工程就可以了。

  
  
  proto_java_class.png

• 使用
  使用可以自己試一試，下面給我簡單的使用示范：

  val dataS = "-----------socket connect success------------"
  val socketProtoBody = SocketBody.Body
        .newBuilder()
        .setId(1111)
        .setContent(dataS)
        .build()
  val socketProtoHeader = SocketHeader.Header
         .newBuilder()
         .setType(1)
         .setLength(socketProtoBody.serializedSize)
         .build()
  
  val socketPackage = SocketPackage.Package
         .newBuilder()
         .setHeader(socketProtoHeader)
         .setBody(socketProtoBody)
         .build()
   val d = socketPackage.toByteArray()
  

  override fun onReceive(type: Int, data: ByteArray?) {
     val  pk = SocketPackage.Package.parseFrom(data)         
  }
  

遇到的問題

• 項目使用了tink，這是google的一款數(shù)據(jù)加密的開源庫，里面也使用了Protobuf，所以，如果項目使用了該庫，編譯一只會報protobuf庫里面的類已經(jīng)存在。
• implementation導致的問題

   // 用implementation 運行工程報錯 要用api
   api files('libs/protobuf-java-3.9.1.jar')
  

  compile implementation 和api的區(qū)別可以百度。
• socket服務(wù)端寫N個字節(jié)，客戶端接收到的字節(jié)數(shù)不為N，導致protobuf格式化失敗。
  這是因為，String和byte數(shù)組轉(zhuǎn)換過程中，牽涉到編碼問題，導致長度發(fā)生變化，所以在socket寫數(shù)據(jù)的時候，把proto對象轉(zhuǎn)成byte數(shù)組后，直接寫到流里面。