Protobuf在安卓中的简单使用之序列化与反序列化

最新推荐文章于 2024-08-06 13:22:33 发布
最新推荐文章于 2024-08-06 13:22:33 发布
阅读量720 收藏 1
点赞数
分类专栏： android日常 文章标签： android protobuf java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/y645633369/article/details/118365033
版权

Protobuf简单使用笔记

本次使用的环境信息:

gradle: 6.5
ide: android studio 4.1.3

1.引入Protobuf编译插件

在项目根目录(build.gradle)中引入protobuf-gradle-plugin插件

classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.16'

完整文件:

buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.1.3"
        classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.16'
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {
    repositories {
        google()
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

注意:
这里引入的版本这里有一个坑,刚开始接触时,网上说的都是引入0.8.2或其他低版本,我第一次引入后编译是没有问题的,但是当我进行的第二步(就是下一步)时,提示了一个一次,

Unable to find method 'org.gradle.api.internal.file.DefaultSourceDirectorySet.<init>(Ljava/lang/String;Ljava/lang/String;Lorg/gradle/api/internal/file/FileResolver;Lorg/gradle/api/internal/file/collections/DirectoryFileTreeFactory;)V'
org.gradle.api.internal.file.DefaultSourceDirectorySet.<init>(Ljava/lang/String;Ljava/lang/String;Lorg/gradle/api/internal/file/FileResolver;Lorg/gradle/api/internal/file/collections/DirectoryFileTreeFactory;)V

Gradle's dependency cache may be corrupt (this sometimes occurs after a network connection timeout.)

Re-download dependencies and sync project (requires network)
The state of a Gradle build process (daemon) may be corrupt. Stopping all Gradle daemons may solve this problem.

Stop Gradle build processes (requires restart)
Your project may be using a third-party plugin which is not compatible with the other plugins in the project or the version of Gradle requested by the project.

In the case of corrupt Gradle processes, you can also try closing the IDE and then killing all Java processes.

尝试了各种版本后发现是这里引入的版本问题,应该是低版本插件与我的gradle环境不匹配导致的,当发现这个问题时自己去更改下版本试试,下方是插件仓库连接,拿走不谢

https://mvnrepository.com/artifact/com.google.protobuf/protobuf-gradle-plugin

2.声明插件

在app模块的gradle配置文件(app/build.gradle)中声明插件

apply plugin: 'com.android.application'

完整文件:

plugins {
    id 'com.android.application'
    id 'com.google.protobuf'  //这个是本次要新加入的代码
}
android {
    compileSdkVersion 30
    buildToolsVersion "30.0.3"

    defaultConfig {
        applicationId "com.fs.protobufdemo"
        minSdkVersion 16
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }


}

dependencies {

    implementation 'androidx.appcompat:appcompat:1.1.0'
    implementation 'com.google.android.material:material:1.1.0'
    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.1'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
}

以前声明都是apply plugin: 'com.android.application'这种的,可能是更新了,现在改写法了,都一样的东西.不影响

3.配置protobuf编译器

在app模块的gradle配置文件(app/build.gradle)中加入下方代码

protobuf {
    //配置protoc编译器
    protoc {
        artifact = 'com.google.protobuf:protoc:3.17.3'
    }
    //这里配置生成目录，编译后会在build的目录下生成对应的java文件
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                remove java
            }
            task.builtins {
                java {}
            }
        }
    }
}

完整文件:

plugins {
    id 'com.android.application'
    id 'com.google.protobuf'
}
android {
    compileSdkVersion 30
    buildToolsVersion "30.0.3"

    defaultConfig {
        applicationId "com.fs.protobufdemo"
        minSdkVersion 16
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }


}

protobuf {
    //配置protoc编译器
    protoc {
        artifact = 'com.google.protobuf:protoc:3.17.3'
    }
    //这里配置生成目录，编译后会在build的目录下生成对应的java文件
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                remove java
            }
            task.builtins {
                java {}
            }
        }
    }
}

dependencies {

    implementation 'androidx.appcompat:appcompat:1.1.0'
    implementation 'com.google.android.material:material:1.1.0'
    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.1'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
}

4.设置源码目录

在app模块的gradle配置文件(app/build.gradle)中加入下方代码

    sourceSets {
        main {
            java {
                srcDir 'src/main/java'
            }
            proto {
                srcDir 'src/main/proto'
            }
        }
    }

完整文件:

plugins {
    id 'com.android.application'
    id 'com.google.protobuf'
}
android {
    compileSdkVersion 30
    buildToolsVersion "30.0.3"

    defaultConfig {
        applicationId "com.fs.protobufdemo"
        minSdkVersion 16
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    sourceSets {
        main {
            java {
                srcDir 'src/main/java'
            }
            proto {
                srcDir 'src/main/proto'
            }
        }
    }

}
protobuf {
    //配置protoc编译器
    protoc {
        artifact = 'com.google.protobuf:protoc:3.17.3'
    }
    //这里配置生成目录，编译后会在build的目录下生成对应的java文件
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                remove java
            }
            task.builtins {
                java {}
            }
        }
    }
}


dependencies {

    implementation 'androidx.appcompat:appcompat:1.1.0'
    implementation 'com.google.android.material:material:1.1.0'
    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.1'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
    implementation 'com.google.protobuf:protobuf-java:3.17.3'
    implementation 'com.google.protobuf:protoc:3.17.3'
}

5.引入依赖

在app模块的gradle配置文件(app/build.gradle)中加入下方代码

    implementation 'com.google.protobuf:protobuf-java:3.17.3'
    implementation 'com.google.protobuf:protoc:3.17.3'

完整文件:

plugins {
    id 'com.android.application'
    id 'com.google.protobuf'
}
android {
    compileSdkVersion 30
    buildToolsVersion "30.0.3"

    defaultConfig {
        applicationId "com.fs.protobufdemo"
        minSdkVersion 16
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }


}

protobuf {
    //配置protoc编译器
    protoc {
        artifact = 'com.google.protobuf:protoc:3.17.3'
    }
    //这里配置生成目录，编译后会在build的目录下生成对应的java文件
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                remove java
            }
            task.builtins {
                java {}
            }
        }
    }
}


dependencies {

    implementation 'androidx.appcompat:appcompat:1.1.0'
    implementation 'com.google.android.material:material:1.1.0'
    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.1'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
    implementation 'com.google.protobuf:protobuf-java:3.17.3'
    implementation 'com.google.protobuf:protoc:3.17.3'
}

6.同步项目

我是在上方每一步完成都同步一次,只要到这一步as还没有报错,所有配置工作现在已经完成了

7.在as中安装protobuf插件

直接去file->setting ->plugins中搜索protobuf 找到全文匹配的那个(一般都是第一个)安装好后重启就好了

8.编写proto文件

在app/main/proto/目录下(没有就proto目录就自己创建一个,)新建Book.proto文件并编写内容

syntax = "proto3";
package com.fs.protobufdemo;

message Book {
    string name = 1;
    string author = 2;
    int32 pages =3;
}

9.生成Java文件

到这一步编译后就会在app/build/generated/source/proto/debug/java/包名/目录下面生成一个java文件,这个文件就是用来序列化与反序列化的文件,如果与后端对接的话就可以直接把此文件给到后端的小伙伴直接使用,自己在这个项目中不需要移动此文件(这个文件是根据Book.proto文件编译出来的,Book.proto文件改变的话他也会改变)就可以直接使用了.

10.初始化数据类对象关键代码

在序列化操作之前需要先有此数据类的对象

                BookOuterClass.Book.Builder builder = BookOuterClass.Book.newBuilder();
                BookOuterClass.Book book = builder.setAuthor("张三").setName("无敌风火轮").setPages(500).build();

11.序列化操作关键代码

    private byte[] bookSerialize(BookOuterClass.Book book) {
        byte[] bytes = new byte[book.getSerializedSize()];
        CodedOutputStream codedOutputStream = CodedOutputStream.newInstance(bytes);
        try {
            book.writeTo(codedOutputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return bytes;
    }

12.反序列化操作关键代码

    private BookOuterClass.Book bookDeserialization(byte[] data) {
        BookOuterClass.Book book = null;
        try {
            book = BookOuterClass.Book.parseFrom(data);
        } catch (InvalidProtocolBufferException e) {
            e.printStackTrace();
        }
        return book;
    }
JDBOY_DEBUG
关注
专栏目录
android studio ProtoBuf导入(附序列化与反序列化)windows版本
baidu_28220467的博客
01-11 1168
因要使用protobuf来通信所以就加呗，没想到还挺麻烦的，弄了一下午，网上一堆乱七八糟的教程，最后就找到一个靠谱的，但是写的不够详细，我就想来写一个适合新手的！是windows版哦！ 首先呢，要去https://github.com/google/protobuf/releases去下载2个东西protobuf-java-3.5.1.zip 和protoc-3.5.1-win32.zip，可以
protobuf文件的反序列化
07-03
通过proto工具编译的message结构被序列化，无法看出proto组织结构，通过这里的工具实现反序列化，清楚看到原messgae结构。注意：第六步运行的脚本操作过程按照其中的pdf文件最后的dos命令进行操作。
【Android Protobuf 序列化】Protobuf 使用 ( Protobuf 序列化 | Protobuf 反序列化 )
让 学习 成为一种 习惯 ( 韩曙亮 の 技术博客 )
04-27 1355
一、Protobuf 序列化、 二、Protobuf 反序列化、 三、完整代码、 四、参考资料、
Gradle出现Re-download dependencies and sync project (requires network)
最新发布
AndyTsui的专栏
08-06 485
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip改为。然后把目录下已生成的文件夹删掉，此例为下图的gradle-7.5-bin删除，然后sync就可以。
Android Studio 项目引入ProtoBuf(附序列化与反序列化)
zhangjianming2018的博客
09-12 1165
打开CMD 进入 protobuf-3.21.5\java 目录下， 输入命令: mvn package 也可以直接进入此文件夹中按住shift+鼠标右键选择在此处打开命令窗口再输入命令，然后要等待一会，最终出现了成功的窗口 如图。一直听说protobuf的优点 体积小 速度快 是这个的几十倍 那个的上百倍，一直以来的项目场景也很少遇到需要如此高性能的通信，但是也需要研究一下，万一哪天要写个 IM 呢，神器 就是神器。然后把这个文件放入工程里吧，要跟上面proto里包的目录一致！
protobuf 序列化和反序列化
小洁洁
03-14 5005
Protocol Buffers（protobuf）是一种轻量级的数据交换格式，可以用于结构化数据的序列化和反序列化。它使用二进制格式来编码数据，以提高传输效率和数据压缩比。在protobuf中，我们可以使用.proto文件来定义消息类型，并使用编译器生成针对各种编程语言的序列化和反序列化代码。序列化是将结构化数据转换为一系列字节的过程，反序列化则是将字节流解析为结构化数据的过程。序列化的过程通常涉及以下步骤：定义消息类型：使用.proto文件定义消息类型和字段。
Unity 中使用Protobuf进行序列化和反序列化的Demo
01-27
本Demo将展示如何在Unity中集成并使用Protobuf进行数据的序列化和反序列化操作。 首先，你需要了解什么是序列化和反序列化。序列化是将对象的状态转换为可以存储或传输的数据格式的过程，而反序列化则是将这些数据...
Google Protobuf基于Qt开发序列化与反序列化用QUdpSocket传输并显示。实例。
09-26
Google Protobuf基于Qt开发序列化与反序列化用QUdpSocket传输并显示。实例。 具体可查看了解:https://blog.csdn.net/automoblie0/article/details/101363526
protobuf序列化和反序列化技术
12-28
protobuf序列化和反序列化技术是大数据处理领域中不可或缺的一部分，尤其在实时大数据场景下，高效的数据传输和存储对性能有着直接影响。谷歌推出的Protocol Buffers（简称protobuf）是一种语言无关、平台无关的数据...
ProtoBuf的介绍以及在Java中使用protobuf将对象进行序列化与反序列化示例代码.rar
09-18
Netty提供了ChannelHandlerContext对象的writeAndFlush()方法，可以直接将ProtoBuf序列化的字节流写入网络通道。在接收端，可以使用ByteBuf的readBytes()方法获取字节流，然后反序列化为对象。 **总结** ProtoBuf...
protobuf常用序列化和反序列化API
06-29
在protobuf中，你可以使用以下API进行序列化： ```cpp // C++ 示例 std::string message; MyMessage my_message; my_message.set_field1(value1); my_message.set_field2(value2); // ... 设置其他字段 if (!my_...
安卓 Protobuf demo
04-28
安卓 Protobuf demo ，https://blog.csdn.net/qq_18983205/article/details/89607356 对应代码
protobuf-gradle-plugin:Protobuf Gradle插件
04-28
:red_exclamation_mark: 升级插件之前，请先，因为使用或兼容性要求可能会发生变化。 Protobuf Gradle插件 *.proto在您的项目中编译协议缓冲区（也称为Protobuf）定义文件（ *.proto ）的Gradle插件。 它的工作有两个部分： 它组装Protobuf编译器（ protoc ）命令行，并使用它从proto文件中生成Java源文件。 它将生成的Java源文件添加到相应的Java编译单元（Java项目中的sourceSet ； Android项目中的变体）的输入中，以便可以将它们与Java源代码一起进行编译。 请注意，如果生成的是非Java / Kotlin源文件，它们将不会自动包含在编译中，您需要将它们添加到特定于语言的编译源中。 请参阅“详细信息。 有关Protobuf编译器的更多信息，请访问 。 最新版本 最新版本是0.8.16 。 它至少需要Gradle 5.6和Jav
序列化、反序列化原理和Protobuf实现机制
长沙老码农
01-22 7486
（1）Java序列化是指把Java对象转换为字节序列的过程，而Java反序列化是指把字节序列恢复为Java对象的过程；（2）
Android中protoBuf使用实战，真实和后台交互！
qq137464739的博客
04-26 1999
在Android studio中配置使用protobuf，网上有很多资料，但几乎找不到与后台交互， 拿到数据后怎么进行反序列化的操作，下面记录下： 首先定义 .proto文件，我们跟后台交互是有请求头和请求体的。 //这是请求头 message MsgHead { fixed32 version = 1; ///< 协议版本号 fixed32 app = 2; //...
Android进阶——性能优化之一种更高效更轻量的序列化方案Protocol Buffer完全攻略（十一）
最美不过，心中有梦，身旁有你！
09-15 1442
文章大纲引言一、Protocol Buffer的使用步骤二、在Android Studio使用Protobuf1、在Android Studio项目中引入protobuf-gradle-plugin Gradle插件2、在需要使用Protobuf 的Module下的build.gradle使用插件并进行对应的配置3、创建proto文件4、使用protobuf 进行序列化和反序列化 引言 前一篇...
Protocol Buffer 序列化原理大揭秘 - 为什么Protocol Buffer性能这么好？
热门推荐
Carson带你学Android
04-24 8万+
前言 习惯用 Json、XML 数据存储格式的你们，相信大多都没听过Protocol Buffer Protocol Buffer 其实 是 Google出品的一种轻量 & 高效的结构化数据存储格式，性能比 Json、XML 真的强！太！多！ 由于 Google出品，我相信Protocol Buffer已经具备足够的吸引力今天，我将讲解为什么Protocol Buffer的性能如此的好： a.
【Android Protobuf 序列化】Protobuf 使用 ( protobuf-gradle-plugin 插件简介 | Android Studio 中配置插件 | AS 中编译源文件 )
让 学习 成为一种 习惯 ( 韩曙亮 の 技术博客 )
04-26 2795
一、protobuf-gradle-plugin 插件简介、 二、Android Studio 中配置 protobuf-gradle-plugin 插件、 三、Android Studio 中编译 Protobuf 源文件、 四、参考资料、
使用protobuf gradle plugin创建 protobuf-lite
weixin_34233618的博客
11-28 851
protobuf在android还推荐一种使用方式为protobuf-lite，使用protobuf gradle plugin在构建时生成代码的方式来使用protobuf。 Protobuf的使用上问题，可以参考 Protobuf在Android下的使用说明。 添加protobuf-gradle-plugin在项目根目录下的build.gradle文件中修改为如下代码： buildscrip...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值