-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a way to configure
DeserializerCache
Jackson uses (#4101)
- Loading branch information
1 parent
c0f01a5
commit 341f8d3
Showing
7 changed files
with
389 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
135 changes: 129 additions & 6 deletions
135
src/main/java/com/fasterxml/jackson/databind/cfg/DefaultCacheProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,142 @@ | ||
package com.fasterxml.jackson.databind.cfg; | ||
|
||
import com.fasterxml.jackson.databind.DeserializationConfig; | ||
import com.fasterxml.jackson.databind.JavaType; | ||
import com.fasterxml.jackson.databind.JsonDeserializer; | ||
import com.fasterxml.jackson.databind.deser.DeserializerCache; | ||
import com.fasterxml.jackson.databind.util.LRUMap; | ||
import com.fasterxml.jackson.databind.util.LookupCache; | ||
|
||
/** | ||
* Default implementation of {@link CacheProvider}. | ||
* | ||
* The default implementation of {@link CacheProvider}. | ||
* Configuration is builder-based via {@link DefaultCacheProvider.Builder}. | ||
* <p> | ||
* Users can either use this class or create their own {@link CacheProvider} implementation. | ||
* | ||
* @since 2.16 | ||
*/ | ||
public class DefaultCacheProvider | ||
implements CacheProvider | ||
{ | ||
private static final long serialVersionUID = 1L; | ||
|
||
public static DefaultCacheProvider defaultInstance() { | ||
return new DefaultCacheProvider(); | ||
} | ||
private final static DefaultCacheProvider DEFAULT | ||
= new DefaultCacheProvider(DeserializerCache.DEFAULT_MAX_CACHE_SIZE); | ||
|
||
/** | ||
* Maximum size of the {@link LookupCache} instance constructed by {@link #forDeserializerCache(DeserializationConfig)}. | ||
* | ||
* @see Builder#maxDeserializerCacheSize(int) | ||
*/ | ||
protected final int _maxDeserializerCacheSize; | ||
|
||
// To implement! | ||
/* | ||
/********************************************************************** | ||
/* Life cycle | ||
/********************************************************************** | ||
*/ | ||
|
||
protected DefaultCacheProvider(int deserializerCache) | ||
{ | ||
_maxDeserializerCacheSize = deserializerCache; | ||
} | ||
|
||
/* | ||
/********************************************************************** | ||
/* Defaults | ||
/********************************************************************** | ||
*/ | ||
|
||
/** | ||
* @return Default {@link DefaultCacheProvider} instance using default configuration values. | ||
*/ | ||
public static CacheProvider defaultInstance() { | ||
return DEFAULT; | ||
} | ||
|
||
/* | ||
/********************************************************** | ||
/* API implementation | ||
/********************************************************** | ||
*/ | ||
|
||
/** | ||
* Method to provide a {@link LookupCache} instance for constructing {@link DeserializerCache}. | ||
* Implementation should match {@link DeserializerCache#DeserializerCache(int)}. | ||
* | ||
* @return {@link LookupCache} instance for constructing {@link DeserializerCache}. | ||
*/ | ||
@Override | ||
public LookupCache<JavaType, JsonDeserializer<Object>> forDeserializerCache(DeserializationConfig config) { | ||
return _buildCache(_maxDeserializerCacheSize); | ||
} | ||
|
||
/* | ||
/********************************************************** | ||
/* Overridable factory methods | ||
/********************************************************** | ||
*/ | ||
|
||
protected <K,V> LookupCache<K,V> _buildCache(int maxSize) | ||
{ | ||
// Use 1/4 of maximum size (but at most 64) for initial size | ||
final int initialSize = Math.min(64, maxSize >> 2); | ||
return new LRUMap<>(initialSize, maxSize); | ||
} | ||
|
||
/* | ||
/********************************************************** | ||
/* Builder Config | ||
/********************************************************** | ||
*/ | ||
|
||
/** | ||
* @return {@link Builder} instance for configuration. | ||
*/ | ||
public static DefaultCacheProvider.Builder builder() { | ||
return new Builder(); | ||
} | ||
|
||
/** | ||
* Builder offering fluent factory methods to configure {@link DefaultCacheProvider}, keeping it immutable. | ||
*/ | ||
public static class Builder { | ||
|
||
/** | ||
* Maximum Size of the {@link LookupCache} instance created by {@link #forDeserializerCache(DeserializationConfig)}. | ||
* Corresponds to {@link DefaultCacheProvider#_maxDeserializerCacheSize}. | ||
*/ | ||
private int _maxDeserializerCacheSize; | ||
|
||
Builder() { } | ||
|
||
/** | ||
* Define the maximum size of the {@link LookupCache} instance constructed by {@link #forDeserializerCache(DeserializationConfig)}. | ||
* The cache is instantiated as: | ||
* <pre> | ||
* return new LRUMap<>(Math.min(64, maxSize >> 2), maxSize); | ||
* </pre> | ||
* | ||
* @param maxDeserializerCacheSize Size for the {@link LookupCache} to use within {@link DeserializerCache} | ||
* @return this builder | ||
* @throws IllegalArgumentException if {@code maxDeserializerCacheSize} is negative | ||
* @since 2.16 | ||
*/ | ||
public Builder maxDeserializerCacheSize(int maxDeserializerCacheSize) { | ||
if (maxDeserializerCacheSize < 0) { | ||
throw new IllegalArgumentException("Cannot set maxDeserializerCacheSize to a negative value"); | ||
} | ||
_maxDeserializerCacheSize = maxDeserializerCacheSize; | ||
return this; | ||
} | ||
|
||
/** | ||
* Constructs a {@link DefaultCacheProvider} with the provided configuration values, using defaults where not specified. | ||
* | ||
* @return A {@link DefaultCacheProvider} instance with the specified configuration | ||
*/ | ||
public DefaultCacheProvider build() { | ||
return new DefaultCacheProvider(_maxDeserializerCacheSize); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.