從零開始搭建spring-cloud(3) ----feign

Feign簡介

Feign是Netflix開發的聲明式、模塊化的HTTP客戶端,其靈感來自Retrofit、JAXRS-2.0以及WebSocket。Feign可幫組咱們更加便捷、優雅的調用HTTP API。java

在Spring Cloud中,使用Feign很是簡單——建立一個接口,並在接口上添加一些註解,代碼就完成了。Feign支持多種註解,例如Feign自帶的註解或者JAX-RS註解等。web

Spring Cloud對feign進行了加強,並整合了Ribbon和Eureka,從而讓Feign的使用更加便捷。spring

Feign是一個聲明式的僞Http客戶端,它使得寫Http客戶端變得更簡單。使用Feign,只須要建立一個接口並註解。它具備可插拔的註解特性,可以使用Feign 註解和JAX-RS註解。Feign支持可插拔的編碼器和解碼器。Feign默認集成了Ribbon,並和Eureka結合,默認實現了負載均衡的效果。apache

簡而言之:瀏覽器

  • Feign 採用的是基於接口的註解
  • Feign 整合了ribbon

準備工做

繼續以前的工做,啓動Eureka server,端口爲8080,啓動spring-cloud-eureka-provider-A-一、啓動spring-cloud-eureka-provider-A-2,端口分別爲808一、8082mybatis

建立一個feign服務

新建一個spring-boot工程,取名爲spring-cloud-feign,在它的pom文件引入Feign的起步依賴spring-cloud-starter-feign、Eureka的起步依賴spring-cloud-starter-eureka、Web的起步依賴spring-boot-starter-web,代碼以下:app

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.vincent</groupId>
    <artifactId>spring-cloud-feign</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.1.4.RELEASE</version>
                <scope>import</scope>
                <type>pom</type>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

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

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

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

    </dependencies>

</project>

在工程的配置文件application.properties文件,指定程序名爲service-feign,端口號爲8083,服務註冊地址爲http://127.0.0.1:8080/eureka/,代碼以下:負載均衡

# 註冊中心的註冊地址
eureka.client.service-url.defaultZone=http://127.0.0.1:8080/eureka/

# 服務名稱--調用的時候根據名稱來調用該服務的方法
spring.application.name=service-feign
server.port=8083

在程序的啓動類App ,加上@EnableFeignClients註解開啓Feign的功能:maven

package com.vincent;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.openfeign.EnableFeignClients;

/**
 * Created by vincent on 2019-6-18 21:56
 */
@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

定義一個feign接口,經過@ FeignClient(「服務名」),來指定調用哪一個服務。好比在代碼中調用了service-provider-A服務的「/user/{name}」接口,代碼以下:ide

@FeignClient("service-provider-A")
public interface FeignService {
    @GetMapping("/user/{name}")
    Map<String,Object> getUser(@PathVariable("name") String userName);
}

在Web層的controller層,對外暴露一個"/user/{name}"的API接口,經過上面定義的Feign客戶端FeighService 來消費服務。代碼以下:

public class UserController {
    @Autowired
    FeignService feignService;

    @GetMapping("/user/{userName}")
    public Map<String, Object> getUser(@PathVariable("userName") String userName){
        Map<String, Object> user = feignService.getUser(userName);
        System.out.println(user);
        return user;
    }
}

啓動程序,屢次訪問http://localhost:8083/user/vincent,瀏覽器交替顯示:

{"from":"provider-A-2","id":"vincent"}
{"from":"provider-A-1","id":"vincent"}

Ribbon與Feign的區別

Ribbon
是一個基於 HTTP 和 TCP 客戶端 的負載均衡的工具。
它能夠 在客戶端 配置 RibbonServerList(服務端列表),使用 HttpClient 或 RestTemplate 模擬http請求,步驟至關繁瑣。

Feign
Feign 是在 Ribbon的基礎上進行了一次改進,是一個使用起來更加方便的 HTTP 客戶端。

採用接口的方式, 只須要建立一個接口,而後在上面添加註解便可 ,將須要調用的其餘服務的方法定義成抽象方法便可, 不須要本身構建http請求。

而後就像是調用自身工程的方法調用,而感受不到是調用遠程方法,使得編寫 客戶端變得很是容易。

相似於 mybatis 的 @Mapper註解 。

spring-cloud-starter-openfeign 裏面已經包含了 spring-cloud-starter-ribbon(Feign 中也使用了 Ribbon)

相關文章
相關標籤/搜索