CacheEntry Failed to serialize object

[pinyht]

Description

When config and use client-side caching, then execute a json command like jsonGet, it throw a JedisCacheException, after debug, I found this problem is jsonGet return object type is JSONObject, JSONObject has not implements Serializable, it can't convert to bytes, exception throw in this file

// src/main/java/redis/clients/jedis/csc/CacheEntry.java

 private static byte[] toBytes(Object object) {
    try (ByteArrayOutputStream baos = new ByteArrayOutputStream();
        ObjectOutputStream oos = new ObjectOutputStream(baos)) {
      oos.writeObject(object);
      oos.flush();
      oos.close();
      return baos.toByteArray();
    } catch (IOException e) {
      throw new JedisCacheException("Failed to serialize object", e);
    }
  }

when execute oos.writeObject(object) will throw IOException

Error log

redis.clients.jedis.exceptions.JedisCacheException: Failed to serialize object
	at redis.clients.jedis.csc.CacheEntry.toBytes(CacheEntry.java:44)
	at redis.clients.jedis.csc.CacheEntry.<init>(CacheEntry.java:21)
	at redis.clients.jedis.csc.CacheConnection.executeCommand(CacheConnection.java:93)
	at redis.clients.jedis.executors.DefaultCommandExecutor.executeCommand(DefaultCommandExecutor.java:24)
	at redis.clients.jedis.UnifiedJedis.executeCommand(UnifiedJedis.java:314)
	at redis.clients.jedis.UnifiedJedis.jsonGet(UnifiedJedis.java:4325)
	at com.pinyht.youhuizhi.infrastructure.cache.utils.CacheUtils.jsonGet(CacheUtils.java:187)
	at com.pinyht.youhuizhi.application.admin.controller.TestController.testHttp(TestController.java:522)
	at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103)
	at java.base/java.lang.reflect.Method.invoke(Method.java:580)
	at org.springframework.aop.support.AopUtils.invokeJoinpointUsingReflection(AopUtils.java:360)
	at org.springframework.aop.framework.ReflectiveMethodInvocation.invokeJoinpoint(ReflectiveMethodInvocation.java:196)
	at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:163)
	at org.springframework.aop.aspectj.MethodInvocationProceedingJoinPoint.proceed(MethodInvocationProceedingJoinPoint.java:89)
	at com.pinyht.youhuizhi.infrastructure.auth.aspect.AuthSecretAspect.authSecret(AuthSecretAspect.java:80)
	at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103)
	at java.base/java.lang.reflect.Method.invoke(Method.java:580)
	at org.springframework.aop.aspectj.AbstractAspectJAdvice.invokeAdviceMethodWithGivenArgs(AbstractAspectJAdvice.java:649)
	at org.springframework.aop.aspectj.AbstractAspectJAdvice.invokeAdviceMethod(AbstractAspectJAdvice.java:631)
	at org.springframework.aop.aspectj.AspectJAroundAdvice.invoke(AspectJAroundAdvice.java:71)
	at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:184)
	at org.springframework.aop.aspectj.MethodInvocationProceedingJoinPoint.proceed(MethodInvocationProceedingJoinPoint.java:89)
	at com.pinyht.youhuizhi.infrastructure.auth.aspect.AuthLoginAspect.authLogin(AuthLoginAspect.java:70)
	at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103)
	at java.base/java.lang.reflect.Method.invoke(Method.java:580)
	at org.springframework.aop.aspectj.AbstractAspectJAdvice.invokeAdviceMethodWithGivenArgs(AbstractAspectJAdvice.java:649)
	at org.springframework.aop.aspectj.AbstractAspectJAdvice.invokeAdviceMethod(AbstractAspectJAdvice.java:631)
	at org.springframework.aop.aspectj.AspectJAroundAdvice.invoke(AspectJAroundAdvice.java:71)
	at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:184)
	at org.springframework.aop.interceptor.ExposeInvocationInterceptor.invoke(ExposeInvocationInterceptor.java:97)
	at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:184)
	at org.springframework.aop.framework.CglibAopProxy$DynamicAdvisedInterceptor.intercept(CglibAopProxy.java:728)
	at com.pinyht.youhuizhi.application.admin.controller.TestController$$SpringCGLIB$$0.testHttp(<generated>)
	at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103)
	at java.base/java.lang.reflect.Method.invoke(Method.java:580)
	at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:258)
	at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:191)
	at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:118)
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:991)
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:896)
	at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
	at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1089)
	at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:979)
	at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1014)
	at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:903)
	at jakarta.servlet.http.HttpServlet.service(HttpServlet.java:564)
	at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:885)
	at jakarta.servlet.http.HttpServlet.service(HttpServlet.java:658)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:195)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140)
	at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:51)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140)
	at org.springframework.web.filter.CorsFilter.doFilterInternal(CorsFilter.java:91)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:116)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140)
	at com.pinyht.youhuizhi.infrastructure.security.filter.RequestFilter.doFilter(RequestFilter.java:20)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140)
	at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:116)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140)
	at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:116)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140)
	at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:116)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:101)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140)
	at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:167)
	at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:90)
	at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:483)
	at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:116)
	at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:93)
	at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:74)
	at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:344)
	at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:398)
	at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:63)
	at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:903)
	at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1769)
	at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:52)
	at org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1189)
	at org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:658)
	at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:63)
	at java.base/java.lang.Thread.run(Thread.java:1583)
Caused by: java.io.NotSerializableException: org.json.JSONObject
	at java.base/java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1200)
	at java.base/java.io.ObjectOutputStream.writeObject(ObjectOutputStream.java:358)
	at redis.clients.jedis.csc.CacheEntry.toBytes(CacheEntry.java:39)
	... 90 common frames omitted

Test Example

// JedisConfig.java
@Configuration
public class JedisConfig {
    @Value("${spring.data.redis.host:}")
    private String host;
    @Value("${spring.data.redis.port:0}")
    private int port;
    @Value("${spring.data.redis.password:}")
    private String password;
    @Value("${spring.data.redis.database:0}")
    private int database;
    @Value("${spring.data.redis.jedis.pool.max-active:0}")
    private int maxActive;
    @Value("${spring.data.redis.jedis.pool.max-idle:0}")
    private int maxIdle;
    @Value("${spring.data.redis.timeout:0}")
    private int timeout;

    @Bean
    public JedisPooled jedisPooled() {
        HostAndPort hostAndPort = new HostAndPort(host, port);
        JedisClientConfig clientConfig = DefaultJedisClientConfig.builder()
                .password(password)
                .database(database)
                .timeoutMillis(timeout)
                .resp3()
                .build();
        CacheConfig cacheConfig = CacheConfig.builder()
                .maxSize(10000)
                .build();
        ConnectionPoolConfig poolConfig = new ConnectionPoolConfig();
        poolConfig.setJmxEnabled(false);
        poolConfig.setMaxTotal(maxActive);
        poolConfig.setMaxIdle(maxIdle);
        poolConfig.setMaxWait(Duration.ofMillis(timeout));
        JedisPooled jedis = new JedisPooled(hostAndPort, clientConfig, cacheConfig);
        return jedis;
    }
}

// Test.java
@RequiredArgsConstructor
public class Test {
    private final JedisPooled jedis;

    publict void test() {
        Object jsonCache = jedis.jsonGet("testKey", Path2.of("$.key"));
    }
}

Versions

jedis:

6.2.0

redis:

8.2.1

java:

21

springboot

3.5.5

[ggivo]

Hi @pinyht

Thanks a lot for the detailed report and the reproducible code example — that’s really helpful. 🙏
We haven’t had a chance to review it yet, but I’ll try to triage and provide feedback by the end of this week.

[ggivo]

@pinyht

This is a limitation of the current implementation. By default, Jedis uses the Gson library for JSON serialization/deserialization. The JSONObject instances returned by Gson are not serializable, which causes JedisCacheException: Failed to serialize object when used with Client-Side Caching (CSC).

Note:
jsonGet(String key, Path2... paths) is still bound to the default Gson implementation and does not use the configured JsonObjectMapper. Until this is resolved, the only alternative I can come up with is the deprecated jsonGet(String key, Path... paths) method instead.

Workaround: Use Custom JsonObjectMapper

Configure a custom JsonObjectMapper (e.g., Jackson) that returns serializable JSON objects:

Click to expand example code

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import redis.clients.jedis.DefaultJedisClientConfig;
import redis.clients.jedis.HostAndPort;
import redis.clients.jedis.JedisClientConfig;
import redis.clients.jedis.JedisPooled;
import redis.clients.jedis.csc.CacheConfig;
import redis.clients.jedis.exceptions.JedisException;
import redis.clients.jedis.json.JsonObjectMapper;
import redis.clients.jedis.json.Path;

class CSCJsonSerialisationError {

    public static void main(String[] args) {
        CacheConfig cacheConfig = CacheConfig.builder().build();
        JedisClientConfig clientConfig = DefaultJedisClientConfig.builder().resp3().build();
        HostAndPort hp = new HostAndPort("localhost", 6379);

        // Using Jackson
        System.out.println("======================================================= ");
        System.out.println("JedisPooled created with JsonObjectMapper - Jackson");
        try (JedisPooled jedis = new JedisPooled(hp, clientConfig, cacheConfig);) {
            jedis.setJsonObjectMapper(getCustomJacksonObjectMapper());

            jedis.del("testKey-custom-jackson");
            String resp1 = jedis.jsonSet("testKey-custom-jackson", Path.of("$"), "{\"key\":\"testKey-custom-jackson-value\"}");
            System.out.println(resp1);

            Object resp2 = jedis.jsonGet("testKey-custom-jackson", Path.of("$.key"));
            System.out.println("testKey-custom-jackson.key: " + resp2);
        } catch (Exception e) {
            System.err.println(e.getMessage());
        }
    }

    public static CustomJacksonObjectMapper getCustomJacksonObjectMapper() {
        ObjectMapper om = new ObjectMapper();
        om.registerModule(new JavaTimeModule());
        om.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
        return new CustomJacksonObjectMapper(om);
    }

    public static class CustomJacksonObjectMapper implements JsonObjectMapper {

        private final ObjectMapper om;

        CustomJacksonObjectMapper(ObjectMapper om) {
            this.om = om;
        }

        @Override
        public <T> T fromJson(String value, Class<T> valueType) {
            try {
                return om.readValue(value, valueType);
            } catch (JsonProcessingException e) {
                throw new JedisException(e);
            }
        }

        @Override
        public String toJson(Object value) {
            try {
                return om.writeValueAsString(value);
            } catch (JsonProcessingException e) {
                throw new JedisException(e);
            }
        }

    }
}

**Note:** Jedis also provides `JsonObjectMapperTestUtil` in the test utilities package (`redis.clients.jedis.util`) with pre-configured Jackson and Gson mappers that you can reference.