This is the home page of the Jackson Project, formerly known as the standard JSON library for Java (or JVM platform in general), or, as the "best JSON parser for Java." Or simply as "JSON for Java." More than that, Jackson is a suite of data-processing tools for Java (and the JVM platform), including the flagship streaming JSON parser / generator library, matching data-binding library (POJOs to and from JSON) and additional data format modules to process data encoded in Avro, BSON, CBOR, CSV, Smile, (Java) Properties, Protobuf, XML or YAML; and even the large set of data format modules to support data types of widely used data types such as Guava, Joda, PCollections and many, many more (see below).
While the actual core components live under their own projects -- including the three core packages (streaming, databind, annotations; data format libraries; data type libraries; JAX-RS provider; and a miscellaneous set of other extension modules -- this project act as the central hub for linking all the pieces together.
A good companion to this README is the Jackson Project FAQ.
First things first: unless you know what you are doing, DO NOT FILE ISSUES ON THE ISSUE TRACKER OF THIS REPO.
Instead, do one of the following:
- For Jackson usage questions (for core components or modules), please use the Jackson-user Google group
- or, StackOverflow,
#jackson
- or, StackOverflow,
- For reporting issues on Jackson implementation, report it against one of the components
- The most common issue you will have is with Jackson databind
- For suggestions and new ideas, try Jackson Future Ideas
Jackson suite has two major branches: 1.x is in maintenance mode, and only bug-fix versions are released; 2.x is the actively developed version. These two major versions use different Java packages and Maven artifact ids, so they are not mutually compatible, but can peacefully co-exist: a project can depend on both Jackson 1.x and 2.x, without conflicts. This is by design and was chosen as the strategy to allow smoother migration from 1.x to 2.x.
The latest stable versions from these branches are:
Recommended way to use Jackson is through Maven repositories; releases are made to Central Maven Repository (CMR). Individual project pages typically contain download links, leading to CMR.
Release notes found from Jackson Releases page.
Most projects listed below are lead by Jackson development team; but some by other at-large Jackson community members. We try to keep versioning of modules compatible to reduce confusion regarding which versions work together.
Core modules are the foundation on which extensions (modules) build upon. There are 3 such modules currently (as of Jackson 2.6):
- Streaming (docs) ("jackson-core") defines low-level streaming API, and includes JSON-specific implementations
- Annotations (docs) ("jackson-annotations") contains standard Jackson annotations
- Databind (docs) ("jackson-databind") implements data-binding (and object serialization) support on
streamingpackage; it depends both onstreamingandannotationspackages
These extensions are plug-in Jackson Modules (registered with ObjectMapper.registerModule()),
and add support for datatypes of various commonly used Java libraries, by adding
serializers and deserializers so that Jackson databind package (ObjectMapper / ObjectReader / ObjectWriter) can read and write these types.
Datatype modules directly maintained by Jackson team are:
- Standard Collections datatype modules:
- HPPC: support for High-Performance Primitive Containers containers
- PCollections: support for PCollections datatypes (NEW in Jackson 2.7!)
- Guava: support for many of Guava datatypes.
- Hibernate: support for Hibernate features (lazy-loading, proxies)
- Joda: support for types of Joda date/time library datatypes
- JDK7: support for JDK 7 data types not included in previous versions
- Deprecated in 2.7, as baseline JDK becomes 7, support to be included in
jackson-databind
- Deprecated in 2.7, as baseline JDK becomes 7, support to be included in
- JDK8: support for JDK 8 data types not included in previous versions, including
Optional(but excluding new Date types which are in JSR-310 module below) - JSR-310 (Java 8 Date): support for "Java 8 Dates" (ones added in JDK 8)
- Also, for pre-Java8 users can use one of alternate pre-Java8 backports:
- JSR-353: support for "Java JSON API" types (specifically, its tree model objects)
- org.json: support for "org.json JSON lib" types like
JSONObject,JSONArray
In addition, we are aware of additional modules that are not directly maintained by core Jackson team:
- jackson-datatype-bolts support for reading/writing types defined by Yandex Bolts collection types (Functional Programming inspired immutable collections)
- jackson-datatype-commons-lang3 for types of Apache Commons Lang v3
- jackson-datatype-money for "Java Money", see javax.money
- javaslang-jackson for Javaslang support (Feature-rich & self-contained functional programming in Java™ 8 and above)
- jackson-datatype-json-lib for supporting types defined by "net.sf.json" library (aka "json-lib")
- jackson-datatype-jts (JTS Geometry) for GeoJSON support
- jackson-lombok for better support of Lombok classes
- jackson-datatype-mongo for MongoDB types
- NOTE: there are a few alternatives to handling MongoDB datatypes
- jackson-module-objectify for datatypes of Objectify
- jackson-datatype-protobuf for handling datatypes defined by the standard Java protobuf library, developed by HubSpot
- NOTE! This is different from
jackson-dataformat-protobufwhich adds support for encoding/decoding protobuf content but which does NOT depend on standard Java protobuf library
- NOTE! This is different from
- TinyTypes includes Jackson module (group id
com.github.caligin.tinytypes, artifacttinytypes-jackson) - jackson-datatype-vertx for reading/writing Vert.x
org.vertx.java.core.json.JsonObjectobjects (repackagedorg.jsonnode types)
Jackson JAX-RS Providers has handlers to add dataformat
support for JAX-RS implementations (like Jersey, RESTeasy, CXF).
Providers implement MessageBodyReader and MessageBodyWriter.
Supported formats currently include JSON, Smile, XML, YAML and CBOR.
Data format modules offer support for data formats other than JSON.
Most of them simply implement streaming API abstractions, so that databinding component can be used as is; some offer (and few require) additional databind level functionality for handling things like schemas.
Currently following data format modules are fully usable and supported:
- Avro: supports Avro data format, with
streamingimplementation plus additionaldatabind-level support for Avro Schemas - CBOR: supports CBOR data format (a binary JSON variant).
- CSV: supports Comma-separated values format --
streamingapi, with optional conveniencedatabindadditions - (Java) Properties (NEW with Jackson 2.7.2!): creating nested structure out of implied notation (dotted by default, configurable), flattening similarly on serialization
- Protobuf (NEW with Jackson 2.6): supported similar to
Avro - Smile: supports Smile (binary JSON) -- 100% API/logical model compatible via
streamingAPI, no changes fordatabind - XML: supports XML; provides both
streaminganddatabindimplementations. Similar to JAXB' "code-first" mode (no support for "XML Schema first", but can use JAXB beans) - YAML: supports YAML, which being similar to JSON is fully supported with simple
streamingimplementation
There are also other data format modules, provided by developers outside Jackson core team:
- BEncode: support for reading/writing BEncode (BitTorrent format) encoded data
- bson4jackson: adds support for BSON data format (by Mongo project).
- Implemented as full streaming implementation, which allows full access (streaming, data-binding, tree-model)
- Also see [MongoJack] library below; while not a dataformat module, it allows access to BSON data as well.
- EXIficient supports Efficient XML Interchange
- jackson-dataformat-msgpack adds support MessagePack (aka
MsgPack) format- Implemented as full streaming implementation, which allows full access (streaming, data-binding, tree-model)
- HOCON: experimental, partial implementation to support HOCON format -- work in progress
- Rison: Jackson backend to support Rison)
- Kotlin to handle native types of Kotlin
- Scala to handle native Scala types (including but not limited to Scala collection/map types, case classes)
- Currently (December 2015) Scala 2.10 and 2.11 supported (2.9 was supported up to Jackson 2.3)
Jackson annotations define intended properties and expected handling for POJOs, and in addition to Jackson itself using this for reading/writing JSON and other formats, it also allows generation of external schemas. Some of this functionality is included in above-mentioned data-format extensions; but there are also many stand-alone Schema tools, such as:
- Ant Task for JSON Schema Generation: Generate JSON Schemas from your Java classes with Apache Ant using the Jackson library and extension modules.
- JSON Schema generator module: programmatically generate JSON Schema, based on Jackson POJO introspection, including annotations
- Maven plug-in for JSON Schema generation (based on JSON Schema module)
- Ember Schema Generator: Generate schemas for Ember.js
Other fully usable modules by FasterXML team include:
- JAXB Annotations: allow use of
JAXBannotations as an alternative (in addition to or instead of) standard Jackson annotations - JDK 8 Parameter names: Module that adds support for using a new JDK8 feature: ability to access names of constructor and method parameters.
- Base modules:
- Afterburner: speed up databinding by 30-40% with bytecode generation to replace use of Reflection for field access, method/constructor calls
- Guice: extension that allows injection values from Guice injectors (and basic Guice annotations), instead of standard
@JacksonInject(or in addition to) - Mr Bean: "type materialization" -- let Mr Bean generate implementation classes on-the-fly (NO source code generation), to avoid monkey code
- OSGi: allows injection of values from OSGi registry, via standard Jackson
@JacksonInjectannotation - Paranamer: tiny extension for automatically figuring out creator (constructor, factory method) parameter names, to avoid having to specify
@JsonProperty.
While Jackson databind is a good choice for general-purpose data-binding, its footprint and startup overhead may be problematic in some domains, such as mobile phones; and especially for light usage (couple of reads or writes). In addition, some developers find full Jackson API overwhelming.
For all these reasons, we decided to create a much simpler, smaller library, which supports a subset of functionality, called Jackson jr. It builds on Jackson Streaming API, but does not depend on databind. As a result its size (both jar, and runtime memory usage) is considerably smaller; and its API is very compact.
- Jackson Ant path filter adds powerful filtering of properties to serialize, using Ant Path notation for hierarchic filtering
The easiest ways to participate beyond using Jackson is to join one of Jackson mailing lists (Jackson google groups):
- Jackson Announce: Announcement-only list for new Jackson releases, meetups and other events related to Jackson
- Jackson User: List dedicated for discussion on Jackson usage
- Jackson Dev: List for developers of Jackson core components and modules, discussing implementation details, API changes.
There are other related lists and forums as well:
- Smile Format Discussion: List for discussing details of the binary JSON format called Smile (see Smile Specification)
- Jackson Users is a Jackson-specific discussion forum for usage questions.
- Pyckson is a Python library that aims for same goals as Java Jackson, such as Convention over Configuration
- Rackson is a Ruby library that offers Jackson-like functionality on Ruby platform
- jackson-docs is our Github Jackson documentation hub
- Jackson Wiki contains older documentation (some 1.x specific; but mostly relevant for both 1.x and 2.x)
- CowTalk -- Blog with lots of Jackson-specific content
Jackson bugs need to be reported against component they affect: for this reason, issue tracker
is not enabled for this project.
If you are unsure which specific project issue affects, the most likely component
is jackson-databind, so you would use
Jackson Databind Issue Tracker.
- Contributor License Agreement, needed by core team to accept contributions. There are 2 options:
- Standard Jackson Contributor License Agreement (CLA) is a one-page document we need from every contributor of code (we will request it for pull requests), used mostly by individual contributors
- Corporate CLA is used by Corporations to avoid individual employees from having to send separate CLAs; it is also favored by corporate IP lawyers.
Note that the first option is available for corporations as well, but most companies have opted to use the second option instead. Core team has no preference over which one gets used; both work; we care more about actual contributions.
Since you probably want opinions by Java developers NOT related to Jackson project, regarding which library to use, here are links to some of existing independent comparisons:
- Top 7 Open-Source JSON-binding providers (April 2014)
- Be a Lazy but a Productive Android Developer, Part 3: JSON Parsing Library (April 2014)
- "Can anyone recommend a good Java JSON library" (Linked-In group) (March 2013)
- "Which JSON library to use on Android?" (September 2012)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent