快捷導(dǎo)航

SpringCloud OpenFeign概述與使用

更新時(shí)間：2023年01月31日 14:01:44 作者：情緒大瓜皮丶

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

OpenFeign概述

OpenFeign 可以聲明式的實(shí)現(xiàn)微服務(wù)之間的調(diào)用，我們只需要向調(diào)用接口一樣，對(duì) FeignClient 直接調(diào)用即可。

若不采用 OpenFeign，不同微服務(wù)之間的遠(yuǎn)程 API 調(diào)用通過Ribbon + RestTemplate實(shí)現(xiàn)；而采用 OpenFeign 后直接采用接口 + 注解的方式即可實(shí)現(xiàn)。

OpenFeign使用

本文仍然使用SpringCloud – Nacos中所創(chuàng)建的 order 訂單微服務(wù)與 payment 支付微服務(wù)為例，在訂單微服務(wù)中調(diào)用支付微服務(wù)的方法。

引入依賴

首先在 order 微服務(wù)中引入 OpenFeign 的依賴

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

編寫服務(wù)調(diào)用Service接口

創(chuàng)建 Service 接口，在接口中定義方法實(shí)現(xiàn)對(duì)其他微服務(wù)的調(diào)用

注意：

@FeignClient括號(hào)里的值為被調(diào)用的微服務(wù)在 nacos 注冊(cè)中心的注冊(cè)服務(wù)名；
定義的方法上的請(qǐng)求及路徑需要與被調(diào)用服務(wù)的相應(yīng)方法匹配；

@FeignClient("nacos-payment-provider")
public interface PaymentService {
    /**
     * 測試調(diào)用Payment
     * @return 調(diào)用結(jié)果
     */
    @GetMapping("/paymentFeign/test")
    String feignTest();
}

編寫被調(diào)用的方法

在兩個(gè)被調(diào)用的 payment 服務(wù)中編寫業(yè)務(wù)處理邏輯，此處為方便，直接返回相應(yīng)的字符串

paymeng8001

@RestController
@RequestMapping("/paymentFeign")
public class PaymentFeignController8001 {
    @GetMapping("/test")
    public String test() {
        return "8001支付模塊test()方法被調(diào)用~";
    }
}

payment8002

@RestController
@RequestMapping("/paymentFeign")
public class PaymentFeignController8002 {
    @GetMapping("/test")
    public String test() {
        return "8002支付模塊test()方法被調(diào)用~";
    }
}

支付模塊修改完成后，直接啟動(dòng)服務(wù)

啟動(dòng)服務(wù)調(diào)用模塊

在 order8005 模塊的啟動(dòng)類上添加注解，標(biāo)明 FeignClient 包的位置

@SpringBootApplication
@EnableFeignClients(basePackages = "com.zqf.service")
public class OrderStart8005 {
    public static void main(String[] args) {
        SpringApplication.run(OrderStart8005.class);
    }
}

啟動(dòng)訂單微服務(wù)