Skip to content
Shimo is an adapter for Moshi which randomizes the order of keys when serializing and deserializing
Java
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper
shimo
.gitignore
CHANGELOG.md
LICENSE.txt
README.md
RELEASING.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

Shimo

Shimo is a JsonAdapter.Factory for Moshi which randomizes the order of keys when serializing objects to JSON and when deserializing objects from JSON.

For example, given the following type:

final class Simple {
  final String one;
  final String two;

  Simple(String one, String two) {
    this.one = one;
    this.two = two;
  }
}

When serializing an instance, new Simple("one", "two"), the JSON might be serialized normally

{"one":"one","two":"two"}

or the keys might be reversed

{"two":"two","one":"one"}

Similarly, when deserializing {"one":"one","two":"two"}, the adapter for Simple might see "one" and then "two" or it might see "two" and then "one".

By randomizing the keys in both directions, you ensure that your servers do not rely on order and that your adapters do not rely on order.

Shimo should only be installed on non-release builds because it dramatically reduces the performance of both serialization and deserialization.

Install the Shimo randomizer first before any custom adapters.

Moshi moshi = new Moshi.Builder()
    .add(ObjectOrderRandomizer.create())
    // other adapters here
    .build();

If you want deterministic randomness, you can pass in a Random instance.

Download

Download the latest JAR or depend via Gradle:

implementation("com.jakewharton.moshi:shimo:0.1.0")

or Maven:

<dependency>
  <groupId>com.jakewharton.moshi</groupId>
  <artifactId>shimo</artifactId>
  <version>0.1.0</version>
</dependency>

Snapshots of the development version are available in Sonatype's snapshots repository.

License

Copyright 2020 Jake Wharton

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
You can’t perform that action at this time.