2. 程式人生 > >SpringCloud系列-利用Feign實現宣告式服務呼叫

SpringCloud系列-利用Feign實現宣告式服務呼叫

阿新 • • 發佈：2019-10-15

上一篇文章《手把手帶你利用Ribbon實現客戶端的負載均衡》介紹了消費者通過Ribbon呼叫服務實現負載均衡的過程，裡面所需要的引數需要在請求的URL中進行拼接，但是引數太多會導致拼接字串的效率低下，本文將介紹一種更好的方案，利用Feign實現宣告式服務呼叫。

本文目錄

一、Feign簡介二、搭建註冊中心三、服務提供者四、Feign服務消費者五、服務呼叫實戰

一、Feign簡介

Feign是一個宣告式的Web Service客戶端，它的目的就是讓Web Service呼叫更加簡單。

Feign提供了HTTP請求的模板，通過編寫簡單的介面和插入註解，就可以定義好HTTP請求的引數、格式、地址等資訊，而Feign則會完全代理HTTP請求，我們只需要像呼叫方法一樣呼叫它就可以完成服務請求及相關處理。

總起來說，Feign具有如下特性：

  • 可插拔的註解支援，包括Feign註解和JAX-RS註解;
  • 支援可插拔的HTTP編碼器和解碼器;
  • 支援Hystrix和它的Fallback;
  • 支援Ribbon的負載均衡;
  • 支援HTTP請求和響應的壓縮。

二、搭建註冊中心

首先新建一個SpringBoot專案，命名spring-cloud-eureka，然後按照下面步驟編寫程式碼即可。

  1. pom.xml程式碼

新增eureka-server的依賴，程式碼如下：

    <dependencies>
        <dependency>
 
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
 

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.RELEASE</version><!-- eureka版本 -->
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
  1. 啟動類程式碼

啟動類添加註解@EnableEurekaServer即可，程式碼如下：

@EnableEurekaServer
@SpringBootApplication
public class SpringCloudEurekaApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringCloudEurekaApplication.class, args);
    }
}
  1. 配置檔案

使用yml的配置檔案，application.yml配置如下：

server:
  port: 9001 #服務埠
eureka:
  instance:
    hostname: localhost
  client:
    register-with-eureka: false #是否將eureka自身作為應用註冊到eureka註冊中心
    fetch-registry: false #為true時，可以啟動，但報異常：Cannot execute request on any known server
    serviceUrl:
      defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/

配置項說明：

1. server.port=9001表示設定該服務註冊中心的埠號 

2. eureka.instance.hostname=localhost表示設定該服務註冊中心的hostname 

3. eureka.client.register-with-eureka=false,由於我們目前建立的應用是一個服務註冊中心，而不是普通的應用。預設情況下，這個應用會向註冊中心（也是它自己）註冊它自己，設定為false表示禁止這種預設行為 

4. eureka.client.fetch-registry=false,表示不去檢索其他的服務，因為服務註冊中心本身的職責就是維護服務例項，它也不需要去檢索其他服務
  1. 執行截圖

開啟瀏覽器訪問http://localhost:9001/，可以看到註冊中心以及啟動，執行截圖如下：


註冊中心執行截圖

三、服務提供者

服務註冊中心有了之後，我們可以向這個服務註冊中心註冊一個服務提供者，新建一個SpringBoot專案，命名spring-cloud-user-service，提供使用者查詢服務，然後按照下面步驟編寫程式碼即可。

  1. pom.xml程式碼

新增eureka-client的依賴，程式碼如下：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>

    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.60</version>
    </dependency>

    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Finchley.RELEASE</version><!-- eureka版本 -->
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
  1. 啟動類程式碼

啟動類添加註解@EnableEurekaClient即可，程式碼如下：

@EnableEurekaClient
@SpringBootApplication
public class UserServiceDemoApplication {

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

新增一個提供使用者服務的UserController，程式碼如下：

/**
 * 使用者服務
 */
@Slf4j
@RestController
@RequestMapping("/provider")
public class UserController {

    static Map<Integer, User> userMap = new HashMap<>();

    static {
        //模擬資料庫
        User user1 = new User(1, "張三", "123456");
        userMap.put(1, user1);
        User user2 = new User(2, "李四", "123123");
        userMap.put(2, user2);
    }

    /**
     * 根據id 查詢
     */
    @RequestMapping("/getUser")
    public String getUser(Integer id) {
        log.info("呼叫getUser介面,id={}",id);
        User user = userMap.get(id);
        return JSON.toJSONString(user);
    }
  1. 配置檔案

使用yml的配置檔案，application.yml配置如下：

server:
  port: 8100 #服務埠
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:9001/eureka/
spring:
  application:
    name: user-service

四、Feign服務消費者

首先新建一個SpringBoot專案，命名spring-cloud-consumer-fegin，然後按照下面步驟編寫程式碼即可。

  1. pom.xml程式碼

新增eureka-client的依賴，程式碼如下：

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

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>


    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.RELEASE</version><!-- eureka版本 -->
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
  1. 啟動類程式碼

新增@EnableFeignClients註解，就代表啟啟用feign客戶端。

啟動類添加註解@EnableEurekaClient，也註冊到註冊中心，程式碼如下：

@EnableEurekaClient
@EnableFeignClients
@SpringBootApplication
public class SpringCloudConsumerFeginApplication {

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

}
  1. 使用註解@FeignClient 定義feign客戶端

下面將定義了一個feign客戶端，將遠端服務http://user-service//provider/getUser對映為一個本地Java方法呼叫。

IFeginService介面程式碼如下：

//表示"user-service"的服務 提供
@FeignClient(value = "user-service")
public interface IFeginService {

    @RequestMapping(value = "/provider/getUser")
    public String getUser(@RequestParam("id") Integer id);
}

註解說明：

@FeignClient

屬性名預設值作用
value 空字串 呼叫服務名稱，和name屬性相同
name 空字串 呼叫服務名稱，和value屬性相同
url 空字串 全路徑地址或hostname，http或https可選
path 空字串 自動給所有方法的requestMapping前加上字首，類似與controller類上的requestMapping
  1. 新增一個Controller

新增一個Controller，使用註解@Autowired使用上面所定義feign的客戶端，用於呼叫服務提供者。

@RestController
@RequestMapping("/consumer")
public class FeginController {

    @Autowired
    private IFeginService feginService;

    @GetMapping("/getUser")
    public String getUser(Integer id) {
        return feginService.getUser(id);
    }
}
  1. 配置檔案

使用yml的配置檔案，application.yml配置如下：

server:
  port: 8083 #服務埠
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:9001/eureka/
spring:
  application:
    name: fegin-consumer

五、服務呼叫實戰

  1. 啟動服務中心並註冊服務

程式碼編寫之後，按順序啟動spring-cloud-eureka、spring-cloud-user-service和spring-cloud-consumer-fegin，先訪問註冊中心http://localhost:9001/，出現下圖說明註冊中心和兩個服務已經註冊成功。


註冊中心執行截圖

啟動spring-cloud-user-service時候啟動兩個服務8100，啟動命令如下：

java -jar spring-cloud-user-service-0.0.1-SNAPSHOT.jar --server.port=8100
  1. 服務呼叫

開啟瀏覽器訪問http://localhost:8083/consumer/getUser?id=1，訪問成功後截圖如下：


請求成功截圖

 

到此SpringCloud整合Feign呼叫服務的過程已經全部實現，有問題歡迎留言溝通哦！

完整原始碼地址： https://github.com/suisui2019/springboot-study

推薦閱讀

1.手把手帶你利用Ribbon實現客戶端的負載均》
2.SpringCloud搭建註冊中心與服務註冊
3.SpringCloud實現服務間呼叫（RestTemplate方式）
4.別在 Java 程式碼裡亂打日誌了，這才是正確的打日誌姿勢！
5.編碼神器Lombok，學會後開發效率至少提高一倍！

限時領取免費Java相關資料，涵蓋了Java、Redis、MongoDB、MySQL、Zookeeper、Spring Cloud、Dubbo/Kafka、Hadoop、Hbase、Flink等高併發分散式、大資料、機器學習等技術。
關注下方公眾號即可免費領取：

Java碎碎念公眾號

 

相關推薦

SpringCloud系列-利用Feign實現宣告式服務呼叫

上一篇文章《手把手帶你利用Ribbon實現客戶端的負載均衡》介紹了消費者通過Ribbon呼叫服務實現負載均衡的過程，裡面所需要的引數需要在請求的URL中進行拼接，但是引數太多會導致拼接字串的效率低下，本文將介紹一種更好的方案，利用Feign實現宣告式服務呼叫。 本文目錄 一、Feign簡介二、

spring cloud 入門系列五：使用Feign 實現宣告式服務呼叫

一、Spring Cloud Feign概念引入通過前面的隨筆，我們瞭解如何通過Spring Cloud ribbon進行負責均衡，如何通過Spring Cloud Hystrix進行服務斷路保護，兩者作為基礎工具類框架應用在各種基礎設施類微服務和業務類微服務中，並且成對存在，那麼有沒有更高層的封裝，將兩者的

SpringCloud學習筆記(3)：使用Feign實現宣告式服務呼叫

簡介 Feign是一個宣告式的Web Service客戶端，它簡化了Web服務客戶端的編寫操作，相對於Ribbon+RestTemplate的方式，開發者只需通過簡單的介面和註解來呼叫HTTP API。它支援Spring MVC註解和JAX-RS註解，還支援可插拔式的編碼器和解碼器。整合了Eureka，Rib

zuul動態路由整合hystrix實現熔斷保護並整合feign實現宣告式服務呼叫

上一篇中。將userService提供服務的返回時間延遲4000ms。導致feign在呼叫時候出發熔斷。直接返回fallback回撥。 這一篇中加入zuul實現動態路由功能。並加入ZuulFilter的前置過濾功能。zuul整合hystrix預設在早期版本是開啟的。但在後期 版本就關閉了自動

SpringCloud 原始碼系列（6）—— 宣告式服務呼叫 Feign

SpringCloud 原始碼系列（1）—— 註冊中心 Eureka（上） SpringCloud 原始碼系列（2）—— 註冊中心 Eureka（中） SpringCloud 原始碼系列（3）—— 註冊中心 Eureka（下） Sp

springcloud之Feign實現宣告式REST呼叫

Feign是Netflix開發的宣告式、模板化的HTTP客戶端，可幫助我們更加便捷、優雅的呼叫HTTP api。spring cloud對Feign進行了增強，使Feign支援了Spring MVC註解，並整合了Ribbon和Eureka，從而讓Feign的使用更加方便：只需要建立一個介面，並在介面上新增一些

Fegin整合Hystrix實現宣告式服務呼叫及服務熔斷降級

1:fegin集成了Hystrix。所以只需要引入feigin的依賴： <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud

六、Feign實現宣告式REST呼叫

    遺留問題：前文中使用RestTemplate實現REST API呼叫時，會有拼接引數問題，如果引數過多會顯得非常的不優雅，如下： ribbonRestTemplate.getForObject("http://microservice-provider-use

springcloud系列—Feign—第4章-1: 宣告式服務呼叫 Feign

資料參考：《Spring Cloud 微服務實戰》 目錄 Spring Cloud Feign入門 第一步：建立普通Spring Boot工程 第二步：新增依賴 第三步：添加註解 第四步：宣告服務 第五步：Controller中呼叫服務 第六步：屬性配置 測試

SpringCloud宣告式服務呼叫Feign

1.建立一個SpringBoot工程，這裡命名為feign-consumer，然後在pom檔案中新增依賴： <dependencies>     .....     <dependency>      

SpringCloud學習 - Feign宣告式服務呼叫客戶端//介面方式

Feign宣告式服務呼叫客戶端//介面方式 書籤： 1、小小例子 2、Get多個請求引數處理   小小例子 新建專案：eureka-consumer-feign pom核心配置： <dependency&

springcloud-feign元件實現宣告式的呼叫

11.使用feign實現宣告式的呼叫 使用RestTemplate+ribbon已經可以完成對服務端負載均衡的呼叫，為什麼還要使用feign？ @RequestMapping("/hi") public String hi(String name) { String rest

Spring Cloud Feign(宣告式服務呼叫)（1）

Spring Cloud Feign它基於Netflix Feign實現，整合了Spring Cloud Ribbon與Spring Cloud Hystrix,除了提供這兩者的強大功能，它還提供了一種宣告式的Web服務客戶端定義方式。 1.下面首先建立一個Spring Boot基礎工程取名

Spring Cloud Feign(宣告式服務呼叫)（2）

繼承特性 1.首先新建個工程，名為hello-service-api。因為要用到Spring MVC的註解所以要要加鎖spring-boot-web的依賴，具體如下： <?xml version="1.0" encoding="UTF-8"?> <project xml

Spring Cloud 微服務實戰 第六章 宣告式服務呼叫：Spring Cloud Feign

    本章介紹的是Spring Cloud Feign ，它是基於Netfix Feign 實現 ，整合了Spring Cloud Ribbon 與 Spring Cloud Hystrix, 除了提供這兩者的強大功能之外，還提供了一種宣告式的web服務客戶端定義方式。

宣告式服務呼叫Feign

Feign介紹 Feign是Netflix公司開源的輕量級rest客戶端，使用Feign可以非常方便的實現Http 客戶端。Spring Cloud引入.Feign並且集成了Ribbon實現客戶端負載均衡呼叫。   Feign 整合測試 1、在客戶端新增依賴,所需依賴如下

Spring Cloud中宣告式服務呼叫Feign (11)

轉自 https://blog.csdn.net/u012702547/article/details/77823434 這個系列我感覺真的太好了，可以一步一步的瞭解spring cloud 的搭建以及更深層次的東西，對想學這門技術的朋友真的入門特別的快，感謝這位大哥的分享，我也會持續的

第六章 宣告式服務呼叫： Spring Cloud Feign

　　我們在使用 Spring Cloud Ribbon 時， 通常都會利用它對 RestTemplate 的請求攔截來實現對依賴服務的介面呼叫， 而 RestTemplate 已經實現了對 HTTP 請求的封裝處理， 形成了一套模板化的呼叫方法。在之前的例子中，我們只是簡單介紹了 RestTemplate 呼

Spring Cloud 宣告式服務呼叫 Feign

一、簡介  在上一篇中，我們介紹註冊中心Eureka,但是沒有服務註冊和服務呼叫，服務註冊和服務呼叫本來應該在上一章就應該給出例子的，但是我覺得還是和Feign一起講比較好，因為在實際專案中，都是使用宣告式呼叫服務。而不會在客服端和服務端儲存2份相同的model和api定義。Feign在RestTemplat

06.Spring Cloud學習筆記之宣告式服務呼叫元件Feign

前言 Spring Cloud Feign基於Netflix Feign實現，整合了Spring Cloud Ribbon與Spring Cloud Hystrix，除了提供這兩者的強大功能外，還提供了一種宣告式的Web服務客戶端定義方式，我們可以做到使用HT