Spring Cloud OpenFeign模版化使用者端搭建過程

2022-06-24 18:01:52

OpenFeign是什麼？

OpenFeign是一個顯示宣告式的WebService使用者端。使用OpenFeign能讓編寫Web Service使用者端更加簡單。使用時只需定義服務介面，然後在上面新增註解。OpenFeign也支援可拔插式的編碼和解碼器。spring cloud對feign進行了封裝，使其支援MVC註解和HttpMessageConverts。和eureka（服務註冊中心）和ribbon組合可以實現負載均衡。在Spring Cloud中使用OpenFeign，可以做到使用HTTP請求存取遠端服務，就像呼叫本地方法一樣的，開發者完全感知不到這是在呼叫遠端方法，更感知不到在存取HTTP請求，非常的方便。

OpenFeign能幹啥？

OpenFeign的設計宗旨式簡化Java Http使用者端的開發。Feign在restTemplate的基礎上做了進一步的封裝，由其來幫助我們定義和實現依賴服務介面的定義。在OpenFeign的協助下，我們只需建立一個介面並使用註解的方式進行設定（類似於Dao介面上面的Mapper註解）即可完成對服務提供方的介面繫結，大大簡化了Spring cloud Ribbon的開發，自動封裝服務呼叫使用者端的開發量。
OpenFeign整合了Ribbon,利用ribbon維護了服務列表，並且通過ribbon實現了使用者端的負載均衡。與ribbon不同的是，通過OpenFeign只需要定義服務繫結介面且以申明式的方法，優雅而簡單的實現了服務呼叫。

OpenFeign使用

使用OpenFeign之前，我們首先將之前的工程還原，為了操作簡單，我們只採用單節點的eureka。

API服務模組搭建

由於我們使用openfeign之後，需要暴露相關介面給外部服務，所以我們需要寫一個api服務。

我這裡為了方便所以直接在外部建立了一個ms-service-api服務，實際開發過程中我們基本都是將其寫在對應的模組中。

整體模組建立完成後，我們便可以定義相關介面供外部呼叫了，每個服務一一對應即可。

這裡只演示一個goods-service-api專案的搭建，專案程式碼在文末會給出。

引入依賴

引入 open feign的相關依賴。

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

建立介面

這裡對應的是goods-service專案中的GoodsService類，這裡定義了其中的方法。

public interface IGoodsService {
    @GetMapping("/goods")
    String getGoodsById();
}

這個時候還需要將goods-service專案的類繼承該介面：

首先需要將我們建立的api服務依賴新增到專案中：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>goods-service-api</artifactId>
</dependency>

然後開始修改：

@Slf4j
@RestController
public class GoodsService implements IGoodsService  {

    @Value("${server.port}")
    private String port;

    /**
     * 根據ID查詢商品資訊
     *
     * @return
     */
    @GetMapping("/goods")
    public String getGoodsById() {
        log.info("收到請求，埠為：{}", port);
        return "返回商品資訊";
    }
}

這裡為了區分職責，類似我們寫mapper和service這種，又額外寫了一個對外暴露的介面。

FeignClient中的name不能隨意寫，它對應各個服務在eureka中註冊的名字。如果不寫該介面的話，可以將該註解加在IGoodsService上。

@FeignClient(name = "goods-service")
public interface IGoodsServiceFeignClient extends IGoodsService {
}

以上便是一個api服務的搭建過程。

外部呼叫

當我們的API服務呼叫完成之後，如何在聚合服務中呼叫呢？

首先我們需要在聚合服務中引入openfeign以及各api服務的依賴：

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

        <dependency>
            <groupId>com.example</groupId>
            <artifactId>goods-service-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>marking-service-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>order-service-api</artifactId>
        </dependency>

引入相關依賴後，我們就可以不需要之前的程式碼了，全面採用面向介面的形式來開發。

@RestController
@RequestMapping("/order")
@Slf4j
public class OrderController {

    // 代理物件
    @Autowired
    private IGoodsService goodsService;

    @Autowired
    private IPromotionService promotionService;

    @Autowired
    private IOrderService orderService;

    @GetMapping
    public String order() {
        log.info("begin do order");
//        使用openfiegn
        String goods = goodsService.getGoodsById();
        String promotion = promotionService.getPromotionById();
        String result = orderService.createOrder(goods, promotion);
        return result;
    }
}

這個時候還沒有完全結束，我們還需要在啟動類上設定掃碼相關的feign類。

@EnableFeignClients(basePackages = "com.example.feignclient")
@SpringBootApplication
public class MallProtalApplication {

    public static void main(String[] args) {
        SpringApplication.run(MallProtalApplication.class, args);
    }
}

以上便是我們整合openfeign的全部步驟。

專案程式碼

cloud-demo

OpenFeign相關特性

Gzip壓縮
Looger
底層通訊框架：（sun.net.www.protocol.http.HttpURLConnection）
也可以自定義替換為OKHttp

Logger 紀錄檔使用

使用OpenFeign的紀錄檔功能，我們需要進行如下幾個操作：

建立設定類

@Configuration
public class FeignClientLogConfiguration {

    /**
     * NONE
     * BASIC
     * HEAD
     * FULL
     * @return
     */
    @Bean
    Logger.Level feignLogger(){
        return Logger.Level.FULL;
    }
}

指定設定類

@FeignClient(name = "goods-service",configuration = FeignClientLogConfiguration.class)
public interface IGoodsServiceFeignClient extends IGoodsService {

}

最後還需要在聚合服務出新增相關紀錄檔設定

feignclient所在的路徑

# openfeign 紀錄檔
logging.level.[com.example.feignclient]=DEBUG

使用OKHttp通訊

引入依賴

<!--        ophttp-->
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-okhttp</artifactId>
        </dependency>

修改設定

# openfeign替換底層通訊框架
feign.httpclient.enabled=false
feign.okhttp.enabled=true

到此這篇關於Spring Cloud OpenFeign模版化使用者端的文章就介紹到這了,更多相關Spring Cloud OpenFeign使用者端內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

Spring Cloud OpenFeign模版化使用者端搭建過程

目錄

OpenFeign是什麼？

OpenFeign能幹啥？

OpenFeign使用

API服務模組搭建

引入依賴

建立介面

外部呼叫

專案程式碼

OpenFeign相關特性

Logger 紀錄檔使用

使用OKHttp通訊

熱門文章