SpringCloud使用Feign實現(xiàn)遠程調用流程詳細介紹

更新時間：2023年02月15日 11:09:51 作者：自牧君

OpenFeign源于Netflix的Feign，是http通信的客戶端。屏蔽了網絡通信的細節(jié)，直接面向接口的方式開發(fā)，讓開發(fā)者感知不到網絡通信細節(jié)。所有遠程調用，都像調用本地方法一樣完成

前言

本次示例代碼的文件結構如下圖所示。

1. 導入依賴坐標

在 order-service 的 pom.xml 文件中導入 Feign 的依賴坐標。

<!-- Feign遠程調用客戶端 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2. 開啟Feign自動裝配

在 order-service 的啟動類上添加注解 @EnableFeignClients ，以開啟 Feign 功能。

@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients
@Slf4j
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
        log.info("訂單微服務啟動成功");
    }
}

3. 聲明遠程調用

Feign 采用了 Spring MVC 的注解的方式發(fā)起遠程調用。只需要把發(fā) HTTP 請求的信息聲明在一個接口中，并添加注解 @FeignClient("微服務名稱") ，F(xiàn)eign 就會自動為我們發(fā)起 HTTP 請求。通常需要聲明的信息如下。

聲明的信息	值
微服務名稱	`userservice`
請求方式	`GET`
請求路徑	`/user/{id}`
請求參數(shù)	`Long id`
返回值類型	`User`

下面的代碼示例演示了訂單微服務 order-service 向用戶微服務 user-service 發(fā)起【根據(jù)用戶 ID 查詢用戶】的遠程調用。

clients/UserClient.java

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

4. 替代RestTemplate

下面代碼示例展示了使用 Feign 之前，使用 RestTemplate 發(fā)起遠程調用。

@Service
public class OrderService {
    @Autowired
    private OrderMapper orderMapper;
    // 自動注入RestTemplate，用于發(fā)起HTTP請求遠程調用
    @Autowired
    private RestTemplate restTemplate;
    public Order queryOrderById(Long orderId) {
        // 1.查詢訂單
        Order order = orderMapper.findById(orderId);
        // 2.使用RestTemplate發(fā)起HTTP請求，查詢訂單所屬用戶信息
        // 2.1 根據(jù)查詢的訂單order中的userId動態(tài)生成HTTP請求的url
        String url = "http://userservice/user/" + order.getUserId();
        // 2.2 發(fā)送HTTP請求，實現(xiàn)遠程調用
        User user = restTemplate.getForObject(url, User.class);
        // 3.把遠程調用獲得的user封裝進order對象中
        order.setUser(user);
        // 4.返回order訂單信息
        return order;
    }
}

使用 Feign 之后，首先把 UserClient 接口自動注入 OrderService.java ，代碼示例如下圖所示。

@Service
public class OrderService {
    @Autowired
    private OrderMapper orderMapper;
    // 自動注入userservice的Feign客戶端，用于發(fā)起HTTP請求遠程調用
    @Autowired
    private UserClient userClient;
    public Order queryOrderById(Long orderId) {
        // 1.查詢訂單
        Order order = orderMapper.findById(orderId);
        // 2.使用Feign客戶端發(fā)起HTTP請求，查詢訂單所屬用戶信息
        User user = userClient.getById(order.getUserId());
        // 3.把遠程調用獲得的user封裝進order對象中
        order.setUser(user);
        // 4.返回order訂單信息
        return order;
    }
}

通過對比，使用 Feign 遠程調用的編程風格非常統(tǒng)一，沒有像 RestTemplate 那樣還需要定義字符串 URL 。