使用自定义ObjectMapper导致SpringBoot中的ObjectMapper失效问题

刺骨的言语ヽ痛彻心扉 2023-01-02 03:25 440阅读 0赞

### 使用自定义ObjectMapper导致原生ObjectMapper配置失效问题 ###

*  问题
 *  原因
 *  解决
 *   *  方法一
     *  方法二
     *  方法三
 *  总结

# 问题 #

*  当使用自定义的**ObjectMapper**注册为**Bean**之后,这样导致了**SpringBoot**原生的**ObjectMapper**的配置失效

# 原因 #

*  因为自定义的**ObjectMapper**覆盖了**SpringBoot**中原生的**ObjectMapper**配置,导致只有自定义的**ObjectMapper**生效

# 解决 #

## 方法一 ##

*  根据原生**ObjectMapper**中的源码里的 **@ConditionalOnMissingBean(ObjectMapper.class)** 可以知道:
    
     *  原生的**ObjectMapper**配置是要在项目中没有其余的**ObjectMapper**出现时才会生效
 *  所以可以在自定义**ObjectMapper**中添加 **@ConditionalOnBean**注解:
    
     *  使得自定义的**ObjectMapper**在原生的**ObjectMapper**出现之后才会注册
     *  由于原生的**ObjectMapper**带有 **@Primary,** 所以会优先使用原生的**ObjectMapper**

## 方法二 ##

*  通过使用 **@ConditionOnBean**注解可以使得**ObjectMapper**不会消失,但是却引出了一个**CrudMapper**消失的问题:
    
     *  可以使用 **@DependsOn**来控制**Bean**的初始化顺序.使得自定义的**ObjectMapper**在原生的**jsonHandler**加载之后再进行初始化,因为这个时候默认的**ObjectMapper**已经加载

## 方法三 ##

*  通过使用 **@DependsOn**解决了**ObjectMapper**和**CrudeMapper**消失的问题,但是却引出了一个循环依赖的问题:
    
     *  由于新的**ObjectMapper**是**ObjectMapper**的子类,而默认的**ObjectMapper**一旦发现有其余的**ObjectMapper**的**Bean,** 就不会注册
     *  这样就导致了其余默认的**ObjectMapper**的**Bean**对新的**ObjectMapper**出现了引用.这就导致了循环依赖的问题
 *  **解决方法:**
    
     *  使用泛型作为返回类型,抹除本来的类型签名
     *  这样**config**中就不会存在**ObjectMapper**的**Bean**定义,从而使得**Jackson**默认的**ObjectMapper**可以加载
     *  然后添加 **@DependsOn**注解在**jsonHandler**之后,确保在默认的**ObjectMapper**之后出现
 *  **注意:**
    
     *  在**Java**的**Annotation**配置中 **,Bean**的默认**ID**就是使用了 **@Bean**注解的方法的名字
     *  **@Autowired**注解默认装配是**ByType**
     *  **@Resource**注解默认装配是**ByName**
        
         *  通过抹除类型可以防止**ByType**的装配而引发的循环依赖问题
         *  但是抹除类类型之后就无法使用**ByType**装配
     *  **抹除了类型之后需要使用 @Resource 来注入新的ObjectMapper**

# 总结 #

*  **SpringBoot**和**Bean**相关的注解:

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>参数</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@ConditionalOnBean</td> 
   <td>type - Bean的class对象<br>value - Bean的名称</td> 
   <td>仅当指定的Bean存在时,此注解修饰的内容才会起作用</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnMissingBean</td> 
   <td>type - Bean的class对象<br>value - Bean的名称</td> 
   <td>仅当指定的Bean不存在时,此注解修饰的内容才会起作用</td> 
  </tr> 
  <tr> 
   <td>@ConditionOnClass</td> 
   <td>name - 类名<br>value - 类的class对象</td> 
   <td>仅当class存在时,此注解修饰的内容才会起作用</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnMissingClass</td> 
   <td>value - 类名</td> 
   <td>仅当class不存在时,此注解修饰的内容才会起作用</td> 
  </tr> 
  <tr> 
   <td>@Conditional</td> 
   <td>value - Condition接口的实现类</td> 
   <td>根据指定的类别判断是否让修饰的内容生效</td> 
  </tr> 
  <tr> 
   <td>@DependsOn</td> 
   <td>value(String[] Bean名称)</td> 
   <td>标注当前Bean需要依赖的Bean. 此注解修饰的Bean必须在指定的Bean初始化之后才会起作用</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Primary</td> 
   <td>优先使用此注解修饰的Bean</td> 
  </tr> 
 </tbody> 
</table>