Wire 2 is a backwards-incompatible release. It makes breaking changes to the compiler, runtime, extensions, and generated code. These changes aren’t made lightly as we’ve endured the upgrade in our own projects! We believe the cost of migration is worth the benefits.
We’ve created the wire-schema
library that models .proto
schema definitions. This is a
capable library that packs several neat features. You can load a Schema
from .proto
files
located on the local file system, a ZIP or JAR file, or any java.nio.FileSystem
like
Jimfs. You can prune this schema with includes or excludes, allowing you to reuse .proto
definitions with minimal code. And you can decode data directly from a schema: no code generation
is necessary!
We’ve flattened extensions. Wire 2.0 combines the fields defined directly on messages with fields defined far away in extensions. In the generated code, extension fields look just like every other field! One limitation of this approach is that it’s no longer possible to compile extensions separately from the messages they extend. For this reason we now recommend always generating all Wire code in a single step.
We’ve rearranged the runtime. Types related to the protocol buffers format are now prefixed
Proto
and types related to our implementation are prefixed Wire
. To encode and decode messages
you must first get an adapter either from the ADAPTER
constant or from ProtoAdapter.get()
. You
no longer need a Wire
instance!
- New
ADAPTER
constant on most messages gives access to encode & decode values. This replaces the encoding and decoding methods onWire
. - Guard against null lists. Code that passes
null
to builder methods expecting aList
used to accept that; now Wire throws aNullPointerException
. Similarly list elements must also be non-null. - New
Message.newBuilder()
API. This replaces the previous copy constructor onBuilder
. - Fix: Always throw
ProtocolException
when there are decoding problems. - Fix: Stricter checking for oneof fields. Previously it was possible to create instances with multiple values set!
- Fix: Improve redacting of repeated fields.
- Fix:
ProtoReader
now silently unpacks packed values. - Fix:
ProtoReader
doesn’t return groups to callers. - New:
Message.withoutUnknownFields()
strips unknown fields.
- The Java generator is now standalone. Use these APIs programmatically to build plugins without delegating to the command line interface.
- New: Prune schemas using includes and excludes. The
IdentifierSet
can be used to configure which types and members are retained and which are pruned. - New: Encode and decode values directly from the schema.
- New: Improved error messages for validation.
- Fix: Strict imports.
- Fix: Detect and forbid conflicts on extension tags.
- New: Always use Wire’s bundled
descriptor.proto
. Previously to define custom options you needed to import a potentially-inconsistent descriptor. - New: Emit all types when no
.proto
files are explicitly specified. - New: Generate code for encoding and decoding messages. The previous, reflection-based
encoder and decoder are accessible with
--compact
. - New:
ServiceFactory
has been removed. To generate code for your services, load a schema withwire-schema
and then use a library like JavaPoet to generate your own code. TheJavaGenerator
class can be used to look up Java names of message types. - New: Compiler will load all
.proto
files if none are explicitly specified. - New: Load
.proto
files from ZIP and JAR files. - New: The
--android
flag causes Wire messages to implementParcelable
. - New: Support multiple
--proto_path
arguments
- Extensions have been flattened.
- Fix: Better field resolution for options.
- Fix: Extension fields may not be required.
- New:
oneof
support! - Fix: Correct serialization of repeated unknown fields.
- Fix: Removed superfluous
private
modifier on enum constructor. - Warning: The 'protoparser' library was updated to version 4.0. This changes the type passed to
any
ServiceWriter
implementations.
- New: Messages implement
Serializable
. The serialized form follows protobuf encoding, so renaming fields is safe as long as tags are consistent. (Renaming classes is unsafe, however). Note that extension fields are deserialized as unknown fields.
- New:
--quiet
and--dry-run
command-line arguments. - Fix: Handle an extension registry with zero or only one item.
- Okio dependency bumped to 1.2.0.
- Fix: Correctly throw
IOException
when parsing bad input fails. - Fix: Ensure emitted code references to
Arrays.asList
correctly compiles in some edge cases. - 'UNDEFINED' enum value has been removed.
- New: 'UNDEFINED' enum value represents values that the generated code is unable to handle.
- New: Service writer implementation can now be specified on the command-line.
- New: Generate interface definition for a
Service
with a partial list of methods. - Okio dependency bumped to 1.0.0.
- New: Options on enums and enum values are now supported.
- New: Options ending with
.redacted
on fields will omit values fromtoString
. - New:
Redactor
creates copies of messages with redacted fields omitted. - Various internal serialization improvements and memory reduction.
- Okio dependency bumped to 0.9.0.
-
Replace Wire's ByteString class with the one from Okio (https://github.com/square/okio). This is a breaking API change.
-
Add a new static method
Wire.parseFrom(okio.Source input, Class<M> messageClass)
. -
Reimplement Wire's input handling to use Okio internally.
-
Provide basic support for generating code from service declarations (see README.md).
-
Improve deserialization performance.
-
Fix a bug where no some extension dependencies were not detected.
- New: Support service declarations as roots. The request and response types of their methods will be included.
- Fix: Enum value duplicate check now correctly looks at names instead of values.
- New: Automatically add Maven plugin's generated source as a compilation root.
- Fix: Correct Maven plugin's 'no arguments' flag to work properly.
- Fix: Support extend declarations nested inside message types.
- New: Empty repeated fields are now initialized to an empty collection.
- New: Emit field options. Use
--no_options
flag to disable. - New:
@Deprecated
is now added to fields and setters on the builder. - New: Maven plugin for running the compiler as part of a build.
- Fix: Treat empty and null repeated fields the same in
equals()
andhashCode()
.
Note: This version is not backwards compatible with code generated from previous versions.
- New:
--registry_class
compiler argument emits a class with a list of extensions suitable for passing to theWire
constructor. - Fix: Ensure all trailing whitespace is trimmed on documentation.
- Fix: Correct parsing and emission of multi-line documentation.
- New: Support for message options.
- New: Check for duplicate field tag numbers.
- New: Emit Javadoc on messages, enum values, and builder methods.
- Fix: Emit imports for extension fields and classes outside of package.
- Fix: Correctly generate sources for protos with the same basename.
- Fix: Do not generate default constants for message types.
- Fix: Avoid shadowing fields named "result", "other", or "o".
- New: Support reading directly from
InputStream
. - New: Add '
other == this
' shortcut in generatedequals()
methods.
Initial version.