Skip to content

cjgriscom/protobuf-teavm

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Maven Central

Protocol Buffers - Google's data interchange format

Copyright 2008 Google Inc.

https://developers.google.com/protocol-buffers/

protobuf-teavm

This repository contains a modified version of protobuf-java 3.7.1 that compiles and runs successfully under TeaVM, a JavaScript compiler for Java bytecode.

The following modifications have been made for compatibility:

  • Removed all references to sun.misc.Unsafe
    • Unsafe was used to implement optional direct ByteBuffer optimizations in the original library.
  • Removed support for direct buffers in CodedInputStream
  • Replaced WeakHashMap usage with regular HashMap
    • WeakHashMap was used in protobuf enums to avoid permanently caching <Integer, EnumValueDescriptor> entries. This change shouldn't negatively affect the majority of use cases where proto schemas are loaded and kept in use for the lifetime of an application.
  • Incorporated ISO_8859_1 support from Apache Harmony
    • As of writing, TeaVM only supports UTF-8 charset. Protobuf-java requires ISO_8859_1 in its conversion of strings from byte arrays.

Important considerations:

  • The standard protoc 3.7.1 remains compatible with this library without modification.
  • Protobuf-java appears to fail when ADVANCED or FULL optimizations are turned on in TeaVM. Optimization mode should not exceed SIMPLE.

protobuf-teavm is deployed to Maven Central.

<dependency>
    <groupId>io.chandler</groupId>
    <artifactId>protobuf-java</artifactId>
    <version>3.7.1-teavm1</version>
</dependency>

Overview

Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. You can find protobuf's documentation on the Google Developers site.

This README file contains protobuf installation instructions. To install protobuf, you need to install the protocol compiler (used to compile .proto files) and the protobuf runtime for your chosen programming language.

Protocol Compiler Installation

The protocol compiler is written in C++. If you are using C++, please follow the C++ Installation Instructions to install protoc along with the C++ runtime.

For non-C++ users, the simplest way to install the protocol compiler is to download a pre-built binary from our release page:

https://github.com/protocolbuffers/protobuf/releases

In the downloads section of each release, you can find pre-built binaries in zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary as well as a set of standard .proto files distributed along with protobuf.

If you are looking for an old version that is not available in the release page, check out the maven repo here:

https://repo1.maven.org/maven2/com/google/protobuf/protoc/

These pre-built binaries are only provided for released versions. If you want to use the github master version at HEAD, or you need to modify protobuf code, or you are using C++, it's recommended to build your own protoc binary from source.

If you would like to build protoc binary from source, see the C++ Installation Instructions.

Protobuf Runtime Installation

Protobuf supports several different programming languages. For each programming language, you can find instructions in the corresponding source directory about how to install protobuf runtime for that specific language:

Language Source Ubuntu MacOS Windows
C++ (include C++ runtime and protoc) src Build status Build status Build status
Build status
Build status
Java java Build status
Build status
Build status
Python python Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Objective-C objectivec Build status
Build status
Build status
Build status
C# csharp Build status Build status
JavaScript js Build status Build status
Ruby ruby Build status
Build status
Build status
Build status
Build status
Build status
Go golang/protobuf
PHP php Build status
Build status
Build status
Build status
Dart dart-lang/protobuf Build Status

Quick Start

The best way to learn how to use protobuf is to follow the tutorials in our developer guide:

https://developers.google.com/protocol-buffers/docs/tutorials

If you want to learn from code examples, take a look at the examples in the examples directory.

Documentation

The complete documentation for Protocol Buffers is available via the web at:

https://developers.google.com/protocol-buffers/

Languages

  • C++ 41.6%
  • C# 12.6%
  • Objective-C 12.2%
  • Java 9.4%
  • C 7.9%
  • Python 5.9%
  • Other 10.4%