blob: 34ca0cfd1fa148bec5f1606155379cd3eebfc217 [file] [log] [blame] [view]
---
title: Basic Serialization
sidebar_position: 2
id: basic_serialization
license: |
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
---
This page covers basic serialization patterns and Fory instance creation.
## Creating Fory Instances
### Single-Thread Fory
For single-threaded applications:
```java
Fory fory = Fory.builder()
.withLanguage(Language.JAVA)
// enable reference tracking for shared/circular reference.
// Disable it will have better performance if no duplicate reference.
.withRefTracking(false)
.withCompatibleMode(CompatibleMode.SCHEMA_CONSISTENT)
// enable type forward/backward compatibility
// disable it for small size and better performance.
// .withCompatibleMode(CompatibleMode.COMPATIBLE)
// enable async multi-threaded compilation.
.withAsyncCompilation(true)
.build();
byte[] bytes = fory.serialize(object);
System.out.println(fory.deserialize(bytes));
```
### Thread-Safe Fory
For multi-threaded applications:
```java
ThreadSafeFory fory = Fory.builder()
.withLanguage(Language.JAVA)
// enable reference tracking for shared/circular reference.
// Disable it will have better performance if no duplicate reference.
.withRefTracking(false)
// compress int for smaller size
// .withIntCompressed(true)
// compress long for smaller size
// .withLongCompressed(true)
.withCompatibleMode(CompatibleMode.SCHEMA_CONSISTENT)
// enable type forward/backward compatibility
// disable it for small size and better performance.
// .withCompatibleMode(CompatibleMode.COMPATIBLE)
// enable async multi-threaded compilation.
.withAsyncCompilation(true)
.buildThreadSafeFory();
byte[] bytes = fory.serialize(object);
System.out.println(fory.deserialize(bytes));
```
## Object Deep Copy
Fory provides efficient deep copy functionality:
### With Reference Tracking
```java
Fory fory = Fory.builder().withRefCopy(true).build();
SomeClass a = xxx;
SomeClass copied = fory.copy(a);
```
### Without Reference Tracking (Better Performance)
When disabled, deep copy will ignore circular and shared references. Same reference of an object graph will be copied into different objects in one `Fory#copy`:
```java
Fory fory = Fory.builder().withRefCopy(false).build();
SomeClass a = xxx;
SomeClass copied = fory.copy(a);
```
## Serialization APIs
### Basic Serialize/Deserialize
```java
// Serialize object to byte array
byte[] bytes = fory.serialize(object);
// Deserialize byte array to object
Object obj = fory.deserialize(bytes);
```
### Serialize/Deserialize with Type
```java
// Serialize with explicit type
byte[] bytes = fory.serializeJavaObject(object);
// Deserialize with expected type
MyClass obj = fory.deserializeJavaObject(bytes, MyClass.class);
```
### Serialize/Deserialize with Type Info
```java
// Serialize with type information
byte[] bytes = fory.serializeJavaObjectAndClass(object);
// Deserialize with embedded type info
Object obj = fory.deserializeJavaObjectAndClass(bytes);
```
## Best Practices
1. **Reuse Fory instances**: Creating Fory is expensive, always reuse instances
2. **Use appropriate thread safety**: Choose between single-thread and thread-safe based on your needs
3. **Register classes**: Register frequently used classes for better performance
4. **Configure reference tracking**: Disable if you don't have circular/shared references
## Related Topics
- [Configuration Options](configuration.md) - All ForyBuilder options
- [Type Registration](type-registration.md) - Class registration
- [Troubleshooting](troubleshooting.md) - Common API usage issues