FabianTerhorst/fast-serialization


FST: fast java serialization drop in-replacement http://ruedigermoeller.github.io/fast-serialization/

Download


Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"
        
    

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]
        
    

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.fabianterhorst:fast-serialization:3.1.1'
	}
	dependencies {
		implementation("com.github.fabianterhorst:fast-serialization:3.1.1")
	}
	<dependency>
	    <groupId>com.github.fabianterhorst</groupId>
	    <artifactId>fast-serialization</artifactId>
	    <version>3.1.1</version>
	</dependency>

                            
    libraryDependencies += "com.github.fabianterhorst" % "fast-serialization" % "3.1.1"
        
        

                            
    :dependencies [[com.github.fabianterhorst/fast-serialization "3.1.1"]]
        
        

Readme


fast-serialization

  • up to 10 times faster 100% JDK Serialization compatible drop-in replacement (Ok, might be 99% ..). As an example: Lambda Serialization which came with 1.8 worked instantly.
  • Android compatible since version >= 2.17 (use FSTConfiguration.createAndroidConfiguration() both on server and client side. The configuration object has to be passed into FSTObjectIn/Output constructors)
  • OffHeap Maps, Persistent OffHeap maps
  • FSTStructs is very similar to IBM's packed objects. Difference is: You can run it with Oracle JDK today.
  • optionally en/decode any Serializable object graph to JSON (incl. shared references) (since 2.29) for interop
  • Apache 2.0 license since 2.17

###Docs:

Fast JDK-compatible Serialization

Json Serialization

OffHeap + Persistent Maps

MinBin cross platform binary format

Kson: a JSon extension

Struct Emulation (currently not covered by tests)

###mvn

note: maven.org might lag 1 day behind after releasing.

2.0 version

<dependency>
    <groupId>de.ruedigermoeller</groupId>
    <artifactId>fst</artifactId>
    <version>2.47</version>
</dependency>

Older version (different package name, 1.6 compatible ..). Fixes are not backported anymore, unsupported.

<dependency>
    <groupId>de.ruedigermoeller</groupId>
    <artifactId>fst</artifactId>
    <version>1.63</version>
</dependency>

###Who uses FST ?

I am not actively tracking use, maven.org reports more than 12000 downloads from 5000 distinct IP accesses triggered by maven builds world wide per month.

Notable also:

  • used in production in Eurex Exchange's trading back end's middleware
  • JUptr.io's distributed system / NLP engine uses FST
  • Popular Apache Wicket supplementals use FST to speed up Wicket

alt tag

###how to build

  • master contains dev branch/trunk.
  • 1.x contains old version
  • The maven build should work out of the box and reproduces the artifact hosted on maven.org
  • To use the gradle build, you need to configure the proxy server in settings.properties (or just set empty if you do not sit behind a proxy).

<b>Note</b> that instrumentation done for fst-structs works only if debug info is turned on during compile. Reason is that generating methods at runtime with javassist fails (probably a javassist bug ..). <b>This does not affect the serialization implementation. </b>

<b>JDK 1.6 Build</b> 1.x build since v1.62 are still jdk 6 compatible