Kubernetes官方java客户端之二：序列化和反序列化问题

今天药忘吃喽~ 2023-03-01 03:23 9阅读 0赞

### 欢迎访问我的GitHub ###

[https://github.com/zq2599/blog\_demos][https_github.com_zq2599_blog_demos]

### 问题场景 ###

本文是《Kubernetes官方java客户端》的第二篇，在进入编码实战章节之前，有个问题需要大家有足够的了解，避免在后面的实战中耗费精力处理此类问题，来看看究竟是什么问题：

1.  SpringBoot是常用的应用框架，《Kubernetes官方java客户端》系列的应用都是基于SpringBoot-2.3.1版本的；
2.  下图是SpringBoot-2.3.1.RELEASE的官方文档，红框表明默认的JSON处理库是Jackson：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70]
3.  看到这里您是否有种不祥预感：K8S官方java客户端是谷歌的，涉及到JSON处理时会不会首选自家的Gson？
4.  V1HTTPGetAction.java是java客户端中常用到的数据结构，用来封装http请求相关的参数，来看看其源码，如下图，果然用上了Gson的注解：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 1]
5.  上图提到的IntOrString类要重点关注，用处广泛，打开其源码如下图，请记下红框2中的代码，后面提到的问题就来源于此：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 2]

*  小结：SpringBoot默认的JSON处理类是Jackson，K8S官方java客户端内的Bean在涉及到JSON相关的序列化和反序列化处理时，使用了Gson注解，因此上述Bean实例在SpringBoot中涉及到JSON处理时，可能会有问题(这时只能说可能)，例如RestController返回对象，会被Jackson转为JSON；

### 复现问题 ###

1.  这里用一个SpringBoot工程来演示此问题（该工程名为OutsideclusterApplication，下一篇文章会详细说明），如下代码是个http接口响应，可见V1PodList实例作为接口返回时，会被SpringBoot用Jackson转为JSON返回给前端：

@RequestMapping(value = "/hello")
        public V1PodList hello() throws Exception { 
            // 存放K8S的config文件的全路径
            String kubeConfigPath = "/Users/zhaoqin/temp/202007/05/config";
    
            // 以config作为入参创建的client对象，可以访问到K8S的API Server
            ApiClient client = ClientBuilder
                    .kubeconfig(KubeConfig.loadKubeConfig(new FileReader(kubeConfigPath)))
                    .build();
    
            Configuration.setDefaultApiClient(client);
    
            CoreV1Api api = new CoreV1Api();
    
            // 调用客户端API取得所有pod信息
            V1PodList v1PodList = api.listPodForAllNamespaces(null, null, null, null, null, null, null, null, null);
    
            return v1PodList;
        }

1.  上述代码运行起来，在浏览器访问该接口时，控制台抛出以下错误，IntOrString.getStrValue方法，就是前面咱们看过的那段，IntOrString中实际上保存的是int数据，但是Jackson执行了其getStrValue方法：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 3]
2.  至于为什么Jackson会执行getStrValue方法，篇幅原因就不在此展开了，简单提一下，在java客户端的BeanPropertyWriter类中，选择方法的逻辑如下图，红框中展示了判定逻辑，此处getStrValue方法命中了该逻辑，如果您尝试用在红框处打上断点观察，会发现有很多方法都符合此条件：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 4]

### 解决问题的思路 ###

我这里，解决问题的思路有两个：

1.  让Jackson在序列化的时候，能够调用正确的方法，以IntOrString为例，如果此时内部保存int型数据，就应该执行其getIntValue方法即可；
2.  Bean中使用了Gson注释，就是打算用Gson来处理序列化和反序列化操作的，因此序列化和反序列化的地方都改用Gson处理；

*  上述两个思路，我选择了第二种，毕竟第一种太难了…

### 解决问题 ###

1.  问题解决起来并不难，先看SpringBoot-2.3.1.RELEASE官方文档：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 5]
2.  结合官方文档，我们要做两件事情：

*  首先，classpath中有Gson，这个已经有了，因为K8S官方java客户端会依赖Gson；
 *  其次，classpath中不要出现Jackson，为了达到这个目的我们需要做以下操作，排除spring-boot-starter-web的依赖(为什么不直接排除jackson的库呢？您可以执行mvn dependency:tree命令细看依赖树，会发现对jackson的依赖并非单一关系)：

<dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-web</artifactId>
    		<exclusions>
    			<exclusion>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-starter-json</artifactId>
    			</exclusion>
    		</exclusions>
    </dependency>

1.  建议您执行mvn dependency:tree命令细看整个项目的依赖树，确保jackson依赖已经全部去掉；
2.  再次运行上述项目，如下图，服务端不再报错，页面上返回数据正常：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 6]

### 使用Jackson的场景 ###

*  上述方式虽然可行，但并非所有项目都能坚持使用Gson而放弃Jackson，对于使用Jackson的项目，请避免Jackson参与K8S官方java客户端bean的序列化和反序列化操作，以上面出现的Controller代码为例，不要直接将V1PodList实例返回，您可以选择先用Gson序列化成JSON字符串，再返回字符串给前端，也可以自己定义VO对象，将V1PodList实例转成VO对象再返回；
 *  至此，使用K8S官方java客户端之前要注意的问题已经弄明白了，接下来的进入精彩的实战章节吧，一起体验kubernetes官方为java程序员精心准备的工具；

[https_github.com_zq2599_blog_demos]: https://github.com/zq2599/blog_demos
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70]: /images/20230209/b9f9a43fdc1a42adb985914d25695150.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 1]: /images/20230209/cf935aef0bc44141977790ec120c5cf5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 2]: /images/20230209/6c2722c044864289a72820393530c60c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 3]: /images/20230209/821f12ac11d4494db6c8230428a367a0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 4]: /images/20230209/10ad04f5578d4b529b7098b1c6c0f87d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 5]: /images/20230209/4e21c5f5345b4dee85e59fe4cb674d2d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 6]: /images/20230209/a5ab0874818942bda723fc94bf3495e6.png