Feign 是Spring Cloud Netflix元件中的一個輕量級Restful的 HTTP 服務用戶端,實作了負載均衡和 Rest 調用的開源架構,封裝了Ribbon和RestTemplate, 實作了WebService的面向接口程式設計,進一步降低了項目的耦合度。
先來看我們以前利用RestTemplate發起遠端調用的代碼:
String url = "http://user-service:8081/user/"+order.getUserId();
User user = restTemplate.getForObject(url, User.class);
以上的代碼存在參數複雜、URL難以維護等問題,如當我有一台服務位址換了,那麼這時候就需要雲同步修改url,那要是多台要修改的情況下那就得改很多台,當我們服務多的時候這是個很麻煩的事情。
1.Feign替代RestTemplate
Fegin的使用步驟如下:
1)引入依賴
我們在order-service服務的pom檔案中引入feign的依賴:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2)添加注解
在order-service的啟動類添加注解開啟Feign的功能:
3)編寫Feign的用戶端
在order-service中建立一個接口,内容如下:
package cn.itcast.order.service.feign;
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;
@FeignClient("user-service")
public interface UserFeignClient {
@GetMapping("/user/{id}")
User queryById(@PathVariable("id") Long id);
}
這個用戶端主要是基于SpringMVC的注解來聲明遠端調用的資訊,比如:
- 服務名稱:user-service
- 請求方式:GET
- 請求路徑:/user/{id}
- 請求參數:Long id
- 傳回值類型:User
這樣,Feign就可以幫助我們發送http請求,無需自己使用RestTemplate來發送了。底層會通過服務名稱:user-service去映射到具體的user服務對應的url位址。
4)測試
修改order-service中的OrderService類中的queryOrderById方法,使用Feign用戶端代替RestTemplate:
@Service
public class OrderService {
@Autowired
private OrderMapper orderMapper;
@Autowired
private RestTemplate restTemplate;
@Autowired
UserFeignClient feignClient;
public Order queryOrderById(Long orderId) {
// 1.查詢訂單
Order order = orderMapper.findById(orderId);
User user = feignClient.queryById(orderId);
order.setUser(user);
// 4.傳回
return order;
}
}
測試調用:
2.自定義配置
Feign可以支援很多的自定義配置,如下表所示:
類型
作用
說明
feign.Logger.Level
修改日志級别
包含四種不同的級别:NONE、BASIC、HEADERS、FULL
feign.codec.Decoder
響應結果的解析器
http遠端調用的結果做解析,例如解析json字元串為java對象
feign.codec.Encoder
請求參數編碼
将請求參數編碼,便于通過http請求發送
feign. Contract
支援的注解格式
預設是SpringMVC的注解
feign. Retryer
失敗重試機制
請求失敗的重試機制,預設是沒有,不過會使用Ribbon的重試
一般情況下,預設值就能滿足我們使用,如果要自定義時,隻需要建立自定義的@Bean覆寫預設Bean即可。
下面以日志為例來示範如何自定義配置。
2.1.配置檔案方式
基于配置檔案修改feign的日志級别可以針對單個服務:(注意:有時yml配置檔案中有中文注釋會報錯)
feign:
client:
config:
user-service: # 針對某個微服務的配置
loggerLevel: FULL # 日志級别
也可以針對所有服務:
feign:
client:
config:
default: # 這裡用default就是全局配置,如果是寫服務名稱,則是針對某個微服務的配置
loggerLevel: FULL # 日志級别
而日志的級别分為四種:
- NONE:不記錄任何日志資訊,這是預設值。
- BASIC:僅記錄請求的方法,URL以及響應狀态碼和執行時間
- HEADERS:在BASIC的基礎上,額外記錄了請求和響應的頭資訊
- FULL:記錄所有請求和響應的明細,包括頭資訊、請求體、中繼資料。
2.2.Java代碼方式
也可以基于Java代碼來修改日志級别,先聲明一個類,然後聲明一個Logger.Level的對象:
public class DefaultFeignConfiguration {
@Bean
public Logger.Level feignLogLevel(){
return Logger.Level.BASIC; // 日志級别為BASIC
}
}
如果要全局生效,将其放到啟動類的@EnableFeignClients這個注解中:
package cn.itcast.order;
import cn.itcast.order.config.DefaultFeignConfiguration;
import com.netflix.loadbalancer.IRule;
import com.netflix.loadbalancer.RandomRule;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
// 配置類的方式開啟全局日志記錄
//@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class) // 開啟feign用戶端的支援
@EnableFeignClients // 開啟feign用戶端的支援
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
//......
}
如果是局部生效,則把它放到對應的@FeignClient這個注解中:
package cn.itcast.order.feign;
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;
// 指定服務日志配置
//@FeignClient(value = "userservice",configuration = DefaultFeignConfiguration.class)
@FeignClient(value = "userservice")
public interface UserFeignClient {
@GetMapping("/user/{id}")
User queryById(@PathVariable("id") Long id);
}
2.3.Feign使用優化
Feign底層發起http請求,依賴于其它的架構。其底層用戶端實作包括:
•URLConnection:預設實作,不支援連接配接池
•Apache HttpClient :支援連接配接池
•OKHttp:支援連接配接池
是以提高Feign的性能主要手段就是使用連接配接池代替預設的URLConnection。
這裡我們用Apache的HttpClient來示範。
1)引入依賴
在order-service的pom檔案中引入Apache的HttpClient依賴:
<!--httpClient的依賴 -->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
2)配置連接配接池
在order-service的application.yml中添加配置:
feign:
client:
config:
default: # default全局的配置
loggerLevel: BASIC # 日志級别,BASIC就是基本的請求和響應資訊
httpclient:
enabled: true # 開啟feign對HttpClient的支援
max-connections: 200 # 最大的連接配接數
max-connections-per-route: 50 # 每個路徑的最大連接配接數
max-connections解釋:比如有以下情況,有一個服務A同時有可能會通路B服務和C服務,這時候配置的最大連接配接數指的就是A在通路B和C時,總的連接配接數不超過200。
max-connections-per-route解釋:指的是A服務通路B服務時的路徑最大連接配接資料為50,也就是200個連接配接,A服務到B服務的通路最多隻會有50個連接配接,當超出50個連接配接時,其他連接配接就會路由到B服務之外的服務中。
接下來,在FeignClientFactoryBean中的loadBalance方法中打斷點:
Debug方式啟動order-service服務,可以看到這裡的client,底層就是Apache HttpClient:
改成http連接配接池後,從示範項目背景的請求日志中可以發現會從原來的幾十ms變成個位數ms,有興趣的小夥伴可以自己測試一下。
2.4.最佳實踐-抽取feign-api接口
目前存在一個問題,我們目前示範的是隻有一個order-service調用user-service,那如果當有多個服務要去調userservice的時候呢,那是否需要在每個service裡都去寫一份遠端調用user-service的代碼?完成沒必要是不是?是以,把這部分代碼直接抽成一個module打成jar包,在需要調用的地方引入即可。
将Feign的Client抽取為獨立子產品,并且把接口有關的POJO、預設的Feign配置都放到這個子產品中,提供給所有消費者使用。
即将UserClient、User、Feign的預設配置都抽取到一個feign-api包中,所有微服務引用該依賴包,即可直接使用。
1)抽取
首先建立一個module,命名為feign-api:
項目結構:
在feign-api中然後引入feign的starter依賴
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
然後,order-service中編寫的UserClient、User、DefaultFeignConfiguration都複制到feign-api項目中
2)在order-service中使用feign-api
首先,删除order-service中的UserClient、User、DefaultFeignConfiguration等類或接口。
在order-service的pom檔案中中引入feign-api的依賴:
<dependency>
<groupId>cn.itcast.demo</groupId>
<artifactId>feign-api</artifactId>
<version>1.0</version>
</dependency>
修改order-service中的所有與上述三個元件有關的導包部分,改成導入feign-api中的包
掃描包問題
最後,包的掃描要指定一下,不然啟動會報錯找不到userfeignclient
方式一:
指定Feign應該掃描的包:
@EnableFeignClients(basePackages = "cn.itcast.feign.clients")
方式二:
指定需要加載的Client接口:
@EnableFeignClients(clients = {UserClient.class})
Feign實作原理
Feign的底層源碼實作主要包括以下幾個部分:
1. 接口定義
Feign的接口定義類似于Java的接口定義,但是它使用了注解來描述HTTP請求的參數和傳回值。例如,@RequestMapping注解用于指定HTTP請求的URL和請求方法,@RequestParam注解用于指定HTTP請求的參數,@RequestBody注解用于指定HTTP請求的請求體,@PathVariable注解用于指定HTTP請求的路徑參數等。
2. 動态代理
Feign使用了Java的動态代理技術來生成HTTP請求的實作類。當應用程式調用Feign接口的方法時,Feign會動态生成一個HTTP請求的實作類,并将請求參數傳遞給該實作類。該實作類會将請求參數轉換為HTTP請求,并發送給遠端服務。當遠端服務傳回響應時,該實作類會将響應轉換為Java對象,并傳回給應用程式。
3. 編碼器和解碼器
Feign使用了編碼器和解碼器來将Java對象轉換為HTTP請求和響應。編碼器将Java對象轉換為HTTP請求的請求體,解碼器将HTTP響應的響應體轉換為Java對象。Feign支援多種編碼器和解碼器,例如JSON編碼器和解碼器、XML編碼器和解碼器等。
4. 負載均衡
Feign可以與負載均衡器無縫內建,以實作服務的負載均衡。當應用程式調用Feign接口的方法時,Feign會将請求發送給負載均衡器,負載均衡器會選擇一個可用的服務執行個體,并将請求轉發給該執行個體。如果該執行個體不可用,則負載均衡器會選擇另一個可用的服務執行個體,并将請求轉發給該執行個體。
5. 斷路器
Feign可以與斷路器無縫內建,以實作服務的容錯。當應用程式調用Feign接口的方法時,Feign會将請求發送給斷路器,斷路器會檢查服務執行個體的可用性。如果服務執行個體不可用,則斷路器會傳回一個預設的響應,以避免應用程式出現異常。如果服務執行個體可用,則斷路器會将請求轉發給該執行個體,并傳回執行個體的響應。