前言

使用Feign遠(yuǎn)程調(diào)用代替RestTemplate遠(yuǎn)程調(diào)用。

一、Feign的優(yōu)勢

使用RestTemplate發(fā)起遠(yuǎn)程調(diào)用：

String url = "http://userservice/user/"+order.getUserId();
User user = restTemplate.getForObject(url, User.class);

雖然在引入注冊中心后，使用RestTemplate發(fā)起請求可以使用服務(wù)名代替主機(jī)地址，減少了主機(jī)地址修改帶來的問題，實(shí)現(xiàn)根據(jù)服務(wù)名去注冊中心拉取。但是仍然存在問題：

• 代碼可讀性差，編程體驗(yàn)不統(tǒng)一
• 參數(shù)復(fù)雜URL難以維護(hù)

而Feign是一個聲明式的http客戶端，可以幫助我們優(yōu)雅的實(shí)現(xiàn)http請求的發(fā)送，解決這些問題。

二、Feign使用

初步搭建

下面以orderserver調(diào)用userserver服務(wù)搭建步驟如下：

（1）引入依賴

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

（2）添加注解
在服務(wù)調(diào)用者的啟動類添加注解（@EnableFeignClients）開啟Feign功能，例如：

@EnableFeignClients
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }
}

（3）客戶端編寫

import cn.itcast.order.config.DefaultFeignConfiguration;
import cn.itcast.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
/**
 * @version 1.0.0
 * @Author: dragon_王
 * @Date: 2024/3/28 14:12:39
 */
@FeignClient("userservice")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

這個客戶端主要是基于SpringMVC的注解來聲明遠(yuǎn)程調(diào)用的信息，比如：

• 服務(wù)名稱：userservice
• 請求方式：GET
• 請求路徑：/user/{id}
• 請求參數(shù)：Long id
• 返回值類型：User

這樣，F(xiàn)eign就可以幫助我們發(fā)送http請求，無需自己使用RestTemplate來發(fā)送了。

（4）調(diào)用代碼

@Service
public class OrderService {
    @Autowired
    private OrderMapper orderMapper;
    //注入客戶端調(diào)用
    @Autowired
    private UserClient userClient;
    public Order queryOrderById(Long orderId) {
        Order order = orderMapper.findById(orderId);
        //用Fegin遠(yuǎn)程調(diào)用
        User user = userClient.findById(order.getUserId());
        order.setUser(user);
        return order;
    }
}

（5）小結(jié)
使用Feign的步驟：

① 引入依賴

② 添加@EnableFeignClients注解

③ 編寫FeignClient接口

④ 使用FeignClient中定義的方法代替RestTemplate

自定義配置

Feign可以支持很多的自定義配置，如下表所示：

一般情況下，默認(rèn)值就能滿足我們使用，如果要自定義時，只需要創(chuàng)建自定義的@Bean覆蓋默認(rèn)Bean即可。

下面以日志為例來演示如何自定義配置。

配置文件方式

基于配置文件修改feign的日志級別可以針對單個服務(wù)：

feign:  
  client:
    config: 
      userservice: # 針對某個微服務(wù)的配置
        loggerLevel: FULL #  日志級別 

也可以針對所有服務(wù)：

feign:  
  client:
    config: 
      default: # 這里用default就是全局配置，如果是寫服務(wù)名稱，則是針對某個微服務(wù)的配置
        loggerLevel: FULL #  日志級別 

而日志的級別分為四種：

• NONE：不記錄任何日志信息，這是默認(rèn)值。
• BASIC：僅記錄請求的方法，URL以及響應(yīng)狀態(tài)碼和執(zhí)行時間
• HEADERS：在BASIC的基礎(chǔ)上，額外記錄了請求和響應(yīng)的頭信息
• FULL：記錄所有請求和響應(yīng)的明細(xì)，包括頭信息、請求體、元數(shù)據(jù)。

java代碼方式

也可以基于Java代碼來修改日志級別，先聲明一個類，然后聲明一個Logger.Level的對象：

public class DefaultFeignConfiguration  {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志級別為BASIC
    }
}

如果要全局生效，將其放到啟動類的@EnableFeignClients這個注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class) 

如果是局部生效，則把它放到對應(yīng)的@FeignClient這個注解中：

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class) 

Feign優(yōu)化使用

Feign底層發(fā)起http請求，依賴于其它的框架。其底層客戶端實(shí)現(xiàn)包括：

• URLConnection：默認(rèn)實(shí)現(xiàn)，不支持連接池
• Apache HttpClient ：支持連接池
• OKHttp：支持連接池

因此提高Feign的性能主要手段就是使用連接池代替默認(rèn)的URLConnection。

這里我們用Apache的HttpClient來演示。

1）引入依賴

在服務(wù)調(diào)用方的pom文件中引入Apache的HttpClient依賴：

<!--httpClient的依賴 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

2）配置連接池

在服務(wù)調(diào)用方的application.yml中添加配置：

feign:
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志級別，BASIC就是基本的請求和響應(yīng)信息
  httpclient:
    enabled: true # 開啟feign對HttpClient的支持
    max-connections: 200 # 最大的連接數(shù)
    max-connections-per-route: 50 # 每個路徑的最大連接數(shù)

3）小結(jié)
Feign的優(yōu)化：

• 日志級別盡量用basic
• 使用HttpClient或OKHttp代替URLConnection
  • 引入feign-httpClient依賴
  • 配置文件開啟httpClient功能，設(shè)置連接池參數(shù)

三、Feign最佳實(shí)踐

可以發(fā)現(xiàn)，F(xiàn)eign的客戶端與服務(wù)提供者的controller代碼非常相似，
feign客戶端：

@FeignClient("userservice")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

UserController：

@RestController
public class UserController {
@GetMapping("/user/{id}")
    public User queryById(@PathVariable("id") Long id) {
        return userService.queryById(id);
    }

有沒有一種辦法簡化這種重復(fù)的代碼編寫呢？

繼承方式

一樣的代碼可以通過繼承來共享：

1）定義一個API接口，利用定義方法，并基于SpringMVC注解做聲明。

2）Feign客戶端和Controller都集成改接口

優(yōu)點(diǎn)：

• 簡單
• 實(shí)現(xiàn)了代碼共享

缺點(diǎn)：

• 服務(wù)提供方、服務(wù)消費(fèi)方緊耦合
• 參數(shù)列表中的注解映射并不會繼承，因此Controller中必須再次聲明方法、參數(shù)列表、注解

抽取方式

將Feign的Client抽取為獨(dú)立模塊，并且把接口有關(guān)的POJO、默認(rèn)的Feign配置都放到這個模塊中，提供給所有消費(fèi)者使用。
例如，將UserClient、User、Feign的默認(rèn)配置都抽取到一個feign-api包中，所有微服務(wù)引用該依賴包，即可直接使用。

1）抽取
首先創(chuàng)建一個module，命名為feign-api：

項(xiàng)目結(jié)構(gòu)：

在feign-api中然后引入feign的starter依賴：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

然后，order-service（服務(wù)調(diào)用者）中編寫的UserClient（Feign客戶端）、User、DefaultFeignConfiguration（java代碼實(shí)現(xiàn)的日志配置，上面講訴過）都復(fù)制到feign-api項(xiàng)目中

2）在order-service（服務(wù)調(diào)用方）中使用feign-api
首先，刪除原先order-service中的UserClient、User、DefaultFeignConfiguration等類或接口。

在order-service的pom文件中中引入feign-api的依賴（剛才創(chuàng)建的feign-api）：
這段代碼就是在feign-api模塊的pom文件里

<dependency>
    <groupId>cn.itcast.demo</groupId>
    <artifactId>feign-api</artifactId>
    <version>1.0</version>
</dependency>

修改order-service中的所有與上述三個組件有關(guān)的導(dǎo)包部分，改成導(dǎo)入feign-api中的包。

其實(shí)就是將原先服務(wù)調(diào)用者里有關(guān)的feign配置已經(jīng)被提出來作為單獨(dú)的模塊，所以以前的客戶端，對象，配置類什么的都要導(dǎo)入提出來的模塊中的，要不然找不到啊。

尤其是現(xiàn)在掃描包肯定是要變的，現(xiàn)在服務(wù)調(diào)用方?jīng)]有這些類和接口了，都被提出去了，肯定掃描不到。

4）解決掃描包問題
方式一：

指定Feign應(yīng)該掃描的包：

@EnableFeignClients(basePackages = "cn.itcast.feign.clients")

方式二：

指定需要加載的Client接口：

@EnableFeignClients(clients = {UserClient.class})

總結(jié)

以上就是Feign的講解。

到此這篇關(guān)于SpringCloud中的Feign遠(yuǎn)程調(diào)用最佳實(shí)踐方案的文章就介紹到這了,更多相關(guān)SpringCloud Feign遠(yuǎn)程調(diào)用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論