Open?Feign之非SpringCloud方式使用示例

更新時間：2023年07月13日 11:58:53 作者：xiaomiusa

這篇文章主要為大家介紹了Open?Feign之非SpringCloud方式使用示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

前言

網上對于spring-cloud-starter-openfeign的使用有非常多的說明，此處不再贅述。

機緣巧合之下，筆者遇到希望輕量級使用Open Feign的場景，即項目中并未使用SpringCloud框架、注冊中心等服務發(fā)現組件，而只是想簡單的做遠程http請求調用來解耦微-微服務。

OpenFeign是什么

Feign 是netflix提供的開源http client庫，目前已經停止維護。

隨后，Spring Cloud官方提供了Open Feign，對Feign做了如下增強：

支持SpringMVC注解
整合Ribbon、Nacos等

它與Apache HttpClient不同，它可以像調用本地方法一樣進行遠程方法調用；對，它也是一個RPC框架。

原生注解（不推薦）

    @RequestLine("POST /postJson")
    @Headers("Content-Type: application/json")
    OrderDto postJson (OrderDto dto);
    @RequestLine("POST /postForm")
    @Headers("Content-Type: application/x-www-form-urlencoded")
    OrderDto postForm (@Param("id") String id, @Param("name") String name);
    @RequestLine("GET /get?id={id}&name={name}")
    String get(@Param("id") String id, @Param("name") String name);
    @RequestLine("GET /get")
    String getByMap(@QueryMap Map<String, Object> param);
    @RequestLine("GET /getById/{id}")
    String getById(@Param("id") String id);

原生注解@RequestLine有額外的理解成本，我們一般不會使用，上面僅做示例。

注意：

1、參數@Param注解需要與@RequestLine中的{xxx} 對應

2、表單方式需要依賴feign-form

spring注解最佳實踐（推薦）

從10.5.0版本開始提供了feign-spring4，來適配spring注解。

使用spring注解需要將contract契約設置為SpringContract。

1、引入依賴

<dependency>
   <groupId>io.github.openfeign</groupId>
   <artifactId>feign-core</artifactId>
   <version>11.6</version>
</dependency>
<dependency>
   <groupId>io.github.openfeign</groupId>
   <artifactId>feign-spring4</artifactId>
   <version>11.6</version>
</dependency>
<dependency>
   <groupId>io.github.openfeign</groupId>
   <artifactId>feign-jackson</artifactId>
   <version>11.6</version>
</dependency>
<dependency>
   <groupId>io.github.openfeign</groupId>
   <artifactId>feign-httpclient</artifactId>
   <version>11.6</version>
</dependency>
<dependency>
   <groupId>io.github.openfeign.form</groupId>
   <artifactId>feign-form</artifactId>
   <version>3.8.0</version>
</dependency>

2、定義RPC接口

public interface HelloFacade {
    // spring注解用法
    @PostMapping(value = "/postJson", consumes = "application/json")
    OrderDto postJson (@RequestBody OrderDto dto);
    @PostMapping(value = "/postForm", consumes = "application/x-www-form-urlencoded")
    OrderDto postForm (OrderDto dto);
    @GetMapping("/get")
    OrderDto get(@RequestParam("id") Long id, @RequestParam("name") String name);
    @GetMapping("/getByMap")
    OrderDto getByMap(@RequestParam("param") Map<String, Object> param);
    @GetMapping("/getById/{id}")
    OrderDto getById(@PathVariable("id") Long id);
}

3、自定義Json解碼器

public class MyJacksonDecoder extends JacksonDecoder {
    @Override
    public Object decode(Response response, Type type) throws IOException {
        if (response.body() == null) {
            return null;
        }
        if (type == String.class) {
            return StreamUtils.copyToString(response.body().asInputStream(), StandardCharsets.UTF_8);
        }
        return super.decode(response, type);
    }
}

默認的JacksonDecoder直接拿著字符串做json反序列化，而當我們存在接口返回值是String時，就會格式化報錯。

所以我們集成JacksonDecoder，特殊處理一下String類型即可（String類型不需要經過json格式化）

4、配置HttpClient線程池

    public static CloseableHttpClient getHttpClient() throws KeyStoreException,
            NoSuchAlgorithmException, KeyManagementException {
        SSLContextBuilder builder = new SSLContextBuilder();
        builder.loadTrustMaterial(null, new TrustSelfSignedStrategy());
        SSLConnectionSocketFactory sslSf = new SSLConnectionSocketFactory(builder.build());
        // 配置同時支持 HTTP 和 HTTPS
        Registry<ConnectionSocketFactory> socketFactoryRegistry = RegistryBuilder.<ConnectionSocketFactory>create()
                .register("http", PlainConnectionSocketFactory.getSocketFactory())
                .register("https", sslSf).build();
        // 初始化連接管理器
        PoolingHttpClientConnectionManager poolConnManager =
                new PoolingHttpClientConnectionManager(socketFactoryRegistry);
        // 同時最多連接數（不設置默認20）
        poolConnManager.setMaxTotal(20);
        // 設置最大路由（不設置默認2）
        poolConnManager.setDefaultMaxPerRoute(10);
        // 此處解釋下MaxtTotal和DefaultMaxPerRoute的區(qū)別：
        // 1、MaxtTotal是整個池子的大??；
        // 2、DefaultMaxPerRoute是根據連接到的主機對MaxTotal的一個細分；比如：
        // MaxtTotal=400 DefaultMaxPerRoute=200
        // 而只連接到http://www.abc.com時，到這個主機的并發(fā)最多只有200；而不是400；
        // 連接到http://www.bac.com 和 http://www.ccd.com時，到每個主機的并發(fā)最多只有200；即加起來是400（但不能超過400）；
        // 所以起作用的設置是DefaultMaxPerRoute
        // 初始化httpClient
        RequestConfig config = RequestConfig.custom().setConnectTimeout(1000)
                .setConnectionRequestTimeout(2000)
                .setSocketTimeout(10000).build();
        return HttpClients.custom()
                // 設置連接池管理
                .setConnectionManager(poolConnManager)
                .setDefaultRequestConfig(config)
                //  過期連接關閉
                .evictIdleConnections(60, TimeUnit.SECONDS)
                .setConnectionTimeToLive(600, TimeUnit.SECONDS)
                // 設置重試次數
                .setRetryHandler(new DefaultHttpRequestRetryHandler(1, false)).build();
    }

OpenFeign默認Http客戶端是HttpURLConnection（JDK自帶的Http工具），該工具不能配置連接池，生產中使用時性能較差，故我們配置自己的Apache HttpClient連接池。（當然Open Feign也有OkHttp的適配）

5、編寫調用入口

    public static void main(String[] args) throws Exception{
        HelloFacade target = Feign.builder()
                // spring注解
                .contract(new SpringContract())
                .encoder(new FormEncoder(new JacksonEncoder()))
                .decoder(new MyJacksonDecoder())
                .client(new ApacheHttpClient(getHttpClient()))
                .logLevel(Logger.Level.BASIC)
                .target(HelloFacade.class, "http://localhost:8080");
        String result = target.testStr("hello world");
        System.out.println(result);
    }

通過Feign.builder 鏈式初始化，設置Spring注解契約、json編解碼器、http客戶端工具、日志級別、需要動態(tài)代理的接口、以及目標服務的地址。

6、RequestInterceptor攔截器擴展

真實業(yè)務場景下，我們可能需要統(tǒng)一添加header經過鑒權邏輯，或者根據環(huán)境進行轉發(fā)不同的目標地址，而不是寫死。

那么我們就可以實現OpenFeign提供的RequestInterceptor攔截器接口。

@Component
public class TargetUrlRequestInterceptor implements RequestInterceptor {
    @Value("${feign.target.url:http://localhost:7777}")
    private String targetUrl;
    @Override
    public void apply(RequestTemplate template) {
        // 可以添加自定義header
        template.header("customHeader", "123");
        // 可以改變初始化時的目標地址
        template.target(targetUrl);
    }
}