Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nmorel/gwt-jackson
gwt-jackson is a JSON parser for GWT. It uses Jackson 2.x annotations to customize the serialization/deserialization process.
https://github.com/nmorel/gwt-jackson
gwt jackson json
Last synced: 20 days ago
JSON representation
gwt-jackson is a JSON parser for GWT. It uses Jackson 2.x annotations to customize the serialization/deserialization process.
- Host: GitHub
- URL: https://github.com/nmorel/gwt-jackson
- Owner: nmorel
- License: apache-2.0
- Created: 2013-08-24T09:24:43.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-07-15T21:05:14.000Z (over 2 years ago)
- Last Synced: 2024-01-09T11:10:23.364Z (11 months ago)
- Topics: gwt, jackson, json
- Language: Java
- Homepage:
- Size: 2.12 MB
- Stars: 112
- Watchers: 20
- Forks: 52
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- gwt-boot-awesome-lili - gwt-jackson - Jackson library (Jackson Library)
- gwt-boot-awesome-lili - gwt-jackson - Jackson library (Jackson Library)
README
gwt-jackson [](https://travis-ci.org/nmorel/gwt-jackson)
=====
gwt-jackson is a JSON parser for [GWT](http://www.gwtproject.org/). It uses [Jackson 2.x annotations](https://github.com/FasterXML/jackson-annotations) to customize the serialization/deserialization process.
Most of the [Jackson 2.x annotations](https://github.com/FasterXML/jackson-annotations) are supported. You can find an up-to-date list [here](https://github.com/nmorel/gwt-jackson/wiki/Jackson-annotations-support).
You can also find a lot of use cases in the [tests](gwt-jackson/src/test/java/com/github/nmorel/gwtjackson).
Jackson 1.x annotations (`org.codehaus.jackson.*`) are not supported.
Check the [wiki](https://github.com/nmorel/gwt-jackson/wiki) for more informations.
Quick start
-------------
Add `` to your module descriptor XML file.
Then just create an interface extending `ObjectReader`, `ObjectWriter` or `ObjectMapper` if you want to read JSON, write an object to JSON or both.
Here's an example without annotation :
```java
public class TestEntryPoint implements EntryPoint {
public static interface PersonMapper extends ObjectMapper {}
public static class Person {
private String firstName;
private String lastName;
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
}
@Override
public void onModuleLoad() {
PersonMapper mapper = GWT.create( PersonMapper.class );
String json = mapper.write( new Person( "John", "Doe" ) );
GWT.log( json ); // > {"firstName":"John","lastName":"Doe"}
Person person = mapper.read( json );
GWT.log( person.getFirstName() + " " + person.getLastName() ); // > John Doe
}
}
```
And if you want to make your class immutable for example, you can add some Jackson annotations :
```java
public class TestEntryPoint implements EntryPoint {
public static interface PersonMapper extends ObjectMapper {}
public static class Person {
private final String firstName;
private final String lastName;
@JsonCreator
public Person( @JsonProperty( "firstName" ) String firstName,
@JsonProperty( "lastName" ) String lastName ) {
this.firstName = firstName;
this.lastName = lastName;
}
public String getFirstName() {
return firstName;
}
public String getLastName() {
return lastName;
}
}
@Override
public void onModuleLoad() {
PersonMapper mapper = GWT.create( PersonMapper.class );
String json = mapper.write( new Person( "John", "Doe" ) );
GWT.log( json ); // > {"firstName":"John","lastName":"Doe"}
Person person = mapper.read( json );
GWT.log( person.getFirstName() + " " + person.getLastName() ); // > John Doe
}
}
```
With Maven
-------------
```xml
com.github.nmorel.gwtjackson
gwt-jackson
0.15.4
provided
```
You can also get maven snapshots using the following repository :
```xml
oss-sonatype-snapshots
https://oss.sonatype.org/content/repositories/snapshots
true
```
Without Maven
-------------
In addition of gwt-jackson jar you can find [here](https://github.com/nmorel/gwt-jackson/releases), you also need
- [jackson-annotations-2.7.2.jar](http://search.maven.org/remotecontent?filepath=com/fasterxml/jackson/core/jackson-annotations/2.7.2/jackson-annotations-2.7.2.jar)
- [jackson-annotations-2.7.2-sources.jar](http://search.maven.org/remotecontent?filepath=com/fasterxml/jackson/core/jackson-annotations/2.7.2/jackson-annotations-2.7.2-sources.jar) for the GWT compilation only
- [javapoet-1.0.0.jar](http://search.maven.org/remotecontent?filepath=com/squareup/javapoet/1.0.0/javapoet-1.0.0.jar) for the GWT compilation only
Server communication
-------------
If you need to communicate with your server using REST/Json payload, you can check these framework which integrates gwt-jackson :
- [GWTP Rest Dispatch](http://dev.arcbees.com/gwtp/communication/index.html). Check the [example](https://github.com/nmorel/gwt-jackson/tree/master/examples/gwtp).
- [RestyGWT](http://resty-gwt.github.io/). Check the [example](https://github.com/nmorel/gwt-jackson/tree/master/examples/restygwt).
- [Requestor](http://reinert.io/requestor/latest/). Check the [example](https://github.com/nmorel/gwt-jackson/tree/master/examples/requestor).
- [gwt-jackson-rest](https://github.com/nmorel/gwt-jackson-rest). Check the [example](https://github.com/nmorel/gwt-jackson-rest/tree/master/examples/simple).
- [GWT RequestBuilder](http://www.gwtproject.org/javadoc/latest/com/google/gwt/http/client/RequestBuilder.html). Check the [example](https://github.com/nmorel/gwt-jackson/tree/master/examples/hello).
Copyright and license
-------------
Copyright 2014 Nicolas Morel under the [Apache 2.0 license](LICENSE).