Spring Cloud Feign之全局异常处理

本是古典何须时尚 2023-10-01 15:37 49阅读 0赞

#### 目录 ####

*  Spring Cloud Feign之全局异常处理
 *   *  方式一
     *  方式二
     *  源码分析

## Spring Cloud Feign之全局异常处理 ##

### 方式一 ###

在`@FeignClient`中指定`configuration`属性，可以在这个`configuration`中构造一个`ErrorDecoder`，但这只能对一个`@FeignClient`生效，如果不想为每一个`@FeignClient`都手工去指定一个`ErrorDecoder`，则推荐使用方式二

### 方式二 ###

`spring-cloud-openfeign-core-${version}.jar`在这个`jar`中提供一个`FeignErrorDecoderFactory`接口，我们只需要实现这个接口，并注入到`Spring`容器中即可，我们来看一看`FeignErrorDecoderFactory`接口的定义

/**
     * Allows an application to use a custom Feign {@link feign.codec.ErrorDecoder}.
     *
     * @author Michael Cramer
     */
    public interface FeignErrorDecoderFactory {
        
    
    	/**
    	 * Factory method to provide a {@link feign.codec.ErrorDecoder} for a given
    	 * {@link Class}.
    	 * @param type the {@link Class} for which a {@link feign.codec.ErrorDecoder} instance
    	 * is to be created
    	 * @return a {@link feign.codec.ErrorDecoder} instance
    	 */
    	ErrorDecoder create(Class<?> type);
    }

这个接口只需要实现一个`create`方法，构建一个`ErrorDecoder`即可。

### 源码分析 ###

在`FeignClientFactoryBean`这个类中，有如下方法

public class FeignClientFactoryBean implements FactoryBean<Object>, InitializingBean,
            ApplicationContextAware, BeanFactoryAware {
        
    
        protected void configureUsingConfiguration(FeignContext context, Feign.Builder builder) {
        
            //        ...
            ErrorDecoder errorDecoder = getInheritedAwareOptional(context,
                    ErrorDecoder.class);
            if (errorDecoder != null) {
        
                builder.errorDecoder(errorDecoder);
            }
            else {
        
                FeignErrorDecoderFactory errorDecoderFactory = getOptional(context,
                        FeignErrorDecoderFactory.class);
                if (errorDecoderFactory != null) {
        
                    ErrorDecoder factoryErrorDecoder = errorDecoderFactory.create(type);
                    builder.errorDecoder(factoryErrorDecoder);
                }
            }
            //        ...
        }
    }

当没有找到`ErrorDecoder`时，就会去找`FeignErrorDecoderFactory`创建，而我们实现了自定义`FeignErrorDecoderFactory`，就会调用`create`方法构造我们自己定义的`ErrorDecoder`。从源码可以看出，这种方式不需要我们手工去一个个设置`@FeignClient`，是在构造`FeignClient`时就已经创建好`ErrorDecoder`，此乃真正意义上实现了全局的异常处理。