栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Android Studio 配置并使用Protocol Buffer生成java文件

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Android Studio 配置并使用Protocol Buffer生成java文件

一、android studio配置 1.1、 Project的build.gradle
buildscript {
  repositories {
    mavenCentral()
  }
  dependencies {
    classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.17'
  }
}

目前Protobuf Plugin for Gradle最版本是0.8.17,安装该版本的插件需要Gradle 5.6 和 Java 8,在Maven Central可用

1.2、Module的build.gradle 声明依赖的protobuf插件(有两种方式)

1.2.1、采用apply方法

apply plugin: 'com.android.application'  // or 'com.android.library'
apply plugin: 'com.google.protobuf' //必须apply plugin: 'com.android.application'语句后,再声明
....

1.2.2、采用Gradle plugin DSL

plugins {
    id 'com.android.application'
    id 'com.google.protobuf' //这个没有先后顺序
}
指定被编译proto文件所在的路径
android {
	.....
    sourceSets {
        main {
            java {
                srcDir 'src/main/java'
            }
            proto {
                srcDir 'src/main/proto'
            }
        }
    }
    ....
}

注意:不指定时,默认与java同级的目录(即${ProjectName}/app/src/main/java)

添加protobuf依赖与proto生成任务 采用版本为3.0.x~3.7.x的Protobuf
dependencies {
  // You need to depend on the lite runtime library, not protobuf-java
  implementation 'com.google.protobuf:protobuf-lite:3.0.0'
}

protobuf {
  protoc {
    // You still need protoc like in the non-Android case
    artifact = 'com.google.protobuf:protoc:3.7.0'
  }
  plugins {
    javalite {
      // The codegen for lite comes as a separate artifact
      artifact = 'com.google.protobuf:protoc-gen-javalite:3.0.0'
    }
  }
  generateProtoTasks {
    all().each { task ->
      task.builtins {
        // In most cases you don't need the full Java output
        // if you use the lite output.
        remove java
      }
      task.plugins {
        javalite { }
      }
    }
  }
}
采用版本为3.8.0之后的Protobuf
dependencies {
  // You need to depend on the lite runtime library, not protobuf-java
  //implementation 'com.google.protobuf:protobuf-javalite:3.8.0'
  //目前protobuf-javalite的最新版本
  implementation 'com.google.protobuf:protobuf-javalite:3.18.1'  
}

protobuf {
  protoc {
    //指定protobuf compile版本  
    //artifact = 'com.google.protobuf:protoc:3.8.0'
    //目前protoc的最新版本
    artifact = 'com.google.protobuf:protoc:3.18.1'  
  }
  generateProtoTasks {
    all().each { task ->
      task.builtins {
        java {
          option "lite"
        }
      }
    }
  }
}

注意:protobuf-javalit与protoc的最新版本可在maven仓库搜索该两个字眼得到

二、编写proto文件

${ProjectName}/app/src/main/proto/addressbook.proto

syntax = "proto2";

package tutorial;

option java_multiple_files = true;
option java_package = "com.example.tutorial.protos";
option java_outer_classname = "AddressBookProtos";

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

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

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

  repeated PhoneNumber phones = 4;
}

message AddressBook {
  repeated Person people = 1;
}

最后编译产物路径:${ProjectName}/app/build/generated/source/proto

protobuf 语法教程

三、使用proto编译产物
Person john =
                Person.newBuilder()
                        .setId(1234)
                        .setName("John Doe")
                        .setEmail("jdoe@example.com")
                        .addPhones(
                                Person.PhoneNumber.newBuilder()
                                        .setNumber("555-4321")
                                        .setType(Person.PhoneType.HOME))
                        .build();
AddressBook.Builder addressBookBuilder = AddressBook.newBuilder();
addressBookBuilder.addPeople(john);
AddressBook addressBook = addressBookBuilder.build();
参考

android studio 配置protobuf 参考
Demo

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/305746.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号