FeignRPC源码分析

发表于 2025/10/14

作者羊羽

10 分钟阅读

FeignRPC源码分析

1. 简介

Feign 是一个声明式的 HTTP 客户端库，由 Netflix 开发，现属于 OpenFeign 项目。它简化了 HTTP API 客户端的编写，让你可以用简单的接口和注解来定义 REST 服务调用。

1. 核心特点

声明式风格：通过 Java 接口和注解定义 HTTP 请求
简化开发：自动处理 HTTP 请求/响应序列化
集成友好：与 Ribbon、Hystrix、Eureka 等 Netflix 组件无缝集成
可扩展：支持自定义编码器、解码器、拦截器等

2. 声明式风格

  
// 使用HttpClient等工具手动构建请求
public List<User> getUsers() {
    try {
        // 1. 创建HTTP客户端
        CloseableHttpClient client = HttpClients.createDefault();
        // 2. 构建请求
        HttpGet request = new HttpGet("http://api.example.com/users");
        request.addHeader("Accept", "application/json");
        // 3. 执行请求
        HttpResponse response = client.execute(request);
        // 4. 处理响应
        String json = EntityUtils.toString(response.getEntity());
        // 5. 手动反序列化
        ObjectMapper mapper = new ObjectMapper();
        return mapper.readValue(json, new TypeReference<List<User>>(){});
    } catch (Exception e) {
        throw new RuntimeException("API调用失败", e);
    }
}
// 只需定义接口，Feign自动实现
public interface UserApi {

    @RequestLine("GET /users")
    @Headers("Accept: application/json")
    List<User> getUsers();
}

// 使用方式
public class Client {

    public static void main(String[] args) {
        UserApi api = Feign.builder()
                          .decoder(new JacksonDecoder())
                          .target(UserApi.class, "http://api.example.com");
                          
        List<User> users = api.getUsers(); // 一行调用
    }
}

基于 interface + annotation 实现了 DSL，只需要描述接口信息，其他的样板代码如创建httpclient、payload编解码、

只需要描述调用的接口，具体的调用细节全部屏蔽。

2. 核心API

1. Feign

1,【构造Feign】feign.Feign.Builder

  
 // 创建完整配置的Feign实例
    public static Feign createFeignInstance() {
        ObjectMapper objectMapper = new ObjectMapper()
            .registerModule(new JavaTimeModule())
            .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);

        return Feign.builder()
            .client(new ApacheHttpClient())
            .encoder(new JacksonEncoder(objectMapper))
            .decoder(new JacksonDecoder(objectMapper))
            .errorDecoder(new CustomErrorDecoder())
            .options(new Request.Options(1000, 5000))
            .retryer(new Retryer.Default())
            .logger(new Slf4jLogger())
            .logLevel(Logger.Level.BASIC)
            .requestInterceptor(new AuthInterceptor())
            .queryMapEncoder(new BeanQueryMapEncoder())
            .contract(new SpringMvcContract())
            .build();
    }

feign.Feign.Builder是可复用的工厂，收集了大量定制化配置和自定义拓展，用于后续指定Interface动态代理生成目标对象。

.client(new ApacheHttpClient())
1. 作用：指定底层HTTP客户端实现
2. 说明：使用Apache HttpClient作为HTTP传输层，替代默认的JDK HttpURLConnection
.encoder(new JacksonEncoder(objectMapper))
1. 作用：请求体编码器
2. 说明：使用Jackson将Java对象序列化为JSON格式的请求体
3. 定制：传入自定义配置的ObjectMapper（支持Java8时间类型，忽略未知属性）
.decoder(new JacksonDecoder(objectMapper))
1. 作用：响应体解码器
2. 说明：使用Jackson将JSON响应体反序列化为Java对象
3. 定制：使用与编码器相同的ObjectMapper配置保证一致性
.errorDecoder(new CustomErrorDecoder())
1. 作用：错误响应处理器
2. 说明：自定义非2xx响应的处理逻辑，可转换为特定异常类型
.options(new Request.Options(1000, 5000))
1. 作用：请求超时配置
2. 参数：连接超时1秒，读取超时5秒
.retryer(new Retryer.Default())
1. 作用：重试策略
2. 说明：使用默认的重试机制（间隔时间指数增长，最多重试5次）
.logger(new Slf4jLogger())
1. 作用：日志记录器
2. 说明：使用SLF4J记录请求日志
.logLevel(Logger.Level.BASIC)
1. 作用：日志级别
2. 说明：记录请求方法、URL和响应状态等基本信息
.requestInterceptor(new AuthInterceptor())
1. 作用：请求拦截器
2. 说明：可添加认证头等全局请求参数（如JWT token）
.queryMapEncoder(new BeanQueryMapEncoder())
1. 作用：查询参数编码器
2. 说明：将Java对象转换为URL查询参数
.contract(new SpringMvcContract())
1. 作用：接口方法解析契约
2. 说明：支持Spring MVC注解（如@RequestMapping），使Feign接口与Controller定义方式一致

2.【构造Stub】feign.Feign

  
    // 创建目标客户端
    public static <T> T createClient(Class<T> apiType, String baseUrl) {
        return createFeignInstance().newInstance(
            new Target.HardCodedTarget<>(apiType, baseUrl)
        );
    }

3. 应用层使用

  
public interface MyApi {
    // 1. 基本GET请求
    @RequestLine("GET /users/{id}")
    User getUserById(@Param("id") Long userId);
}

// 用户实体类
class User {
    private Long id;
    private String name;
    private String email;
    // getters/setters 省略
}
// 使用示例
public class Main {
    public static void main(String[] args) {
        MyApi api = FeignClientFactory.createClient(
            MyApi.class, 
            "http://api.example.com"
        );
        
        api.getData(); // 调用接口方法
    }
}