從零開始學spring cloud(七) -------- Spring Cloud OpenFegin

 

一、OpenFegin 介紹

Feign是一個聲明性的Web服務客戶端。 它使編寫Web服務客戶端變得更容易。 要使用Feign，請創建一個界面並對其進行注釋。 它具有可插入的注釋支持，包括Feign注釋和JAX-RS注釋。 Feign還支持可插拔編碼器和解碼器。 Spring Cloud增加了對Spring MVC注釋的支持，並使用了Spring Web中默認使用的相同HttpMessageConverters。 Spring Cloud集成了Ribbon和Eureka，在使用Feign時提供負載均衡的http客戶端。

 

 二、將OpenFegin應用到項目中

添加依賴到項目中：

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

 

新建一個FeignClient類

package com.zwjk.cloud.fegin;

import com.zwjk.cloud.entity.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;

/**
 * @author : Jixiaohu
 * @Date : 2019-04-12.
 * @Time : 16:50.
 * @Description :
 */
@FeignClient("microservice-provider-user")
public interface UserFeignClient {
    //@PathVariable得設置value
    @GetMapping("/simple/{id}")
    User findById(@PathVariable("id") Long id); //@PathVariable得設置value

    @PostMapping("/user")
    User postUser(@RequestBody User user);

    // 該請求不會成功，只要參數是復雜對象，即使指定了是GET方法，feign依然會以POST方法進行發送請求。
    @GetMapping("/get-user")
    User getUser(User user);
}

 

在movie的controller中。使用feign調用user微服務提供的接口

package com.zwjk.cloud.controller;

import com.zwjk.cloud.entity.User;
import com.zwjk.cloud.fegin.UserFeignClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

/**
 * @author : Jixiaohu
 * @Date : 2019-04-11.
 * @Time : 9:38.
 * @Description :
 */
@RestController
public class MovieController {

    @Autowired
    private UserFeignClient userFeignClient;

    @GetMapping("/movie/{id}")
    public User findById(@PathVariable Long id) {
        return this.userFeignClient.findById(id);
    }

    @GetMapping("/test")
    public User testPost(User user) {
        return this.userFeignClient.postUser(user);
    }

    @GetMapping("/test-get")
    public User testGet(User user) {
        return this.userFeignClient.getUser(user);
    }


}

 

 

package com.zwjk.cloud.controller;

import com.zwjk.cloud.entity.User;
import com.zwjk.cloud.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

/**
 * @author : Jixiaohu
 * @Date : 2019-04-11.
 * @Time : 9:08.
 * @Description :
 */
@RestController
public class UserController {

    @Autowired
    private UserRepository userRepository;

    @GetMapping("/simple/{id}")
    public User findById(@PathVariable Long id) {
        return this.userRepository.getUserById(id);
    }

    @PostMapping("/user")
    public User postUser(@RequestBody User user) {
        return user;
    }

    // 該請求不會成功
    @GetMapping("/get-user")
    public User getUser(User user) {
        return user;
    }
}

 

訪問地址：http://localhost:8010/movie/1

查看結果返回：

 

這邊需要注意的是，在feignClient中，注釋表明的說明。

這里，就簡單實現了使用feignClient調用服務接口。

 

下面看一下，如何復寫默認的FeignClientsConfihuration

https://cloud.spring.io/spring-cloud-static/spring-cloud-openfeign/2.1.0.RELEASE/single/spring-cloud-openfeign.html#spring-cloud-feign-overriding-defaults

官方文檔中，有這樣的說明

Spring Cloud的Feign支持的核心概念是指定客戶端的概念。 每個feign客戶端都是一組組件的一部分，這些組件一起工作以按需聯系遠程服務器，並且該集合具有一個名稱，您可以使用@FeignClient注釋將其作為應用程序開發人員提供。 Spring Cloud使用FeignClientsConfiguration按需為每個命名客戶端創建一個新的集合作為ApplicationContext。 這包含（除其他外）feign.Decoder，feign.Encoder和feign.Contract。 可以使用@FeignClient批注的contextId屬性覆蓋該集合的名稱。

Spring Cloud允許您通過使用@FeignClient聲明其他配置（在FeignClientsConfiguration之上）來完全控制假裝客戶端。 例：

@FeignClient(name = "stores", configuration = FooConfiguration.class)
public interface StoreClient {
    //..
}

 

這邊有個警告，跟ribbon的自定義配置一樣，自定義的配置，需要放在掃描包的外部，查看一下怎么寫，https://github.com/OpenFeign/feign

下面看一下代碼：

package com.zwjk.cloud.fegin;

import com.zwjk.cloud.entity.User;
import com.zwjk.config.UserConfiguration;
import feign.Param;
import feign.RequestLine;
import org.springframework.cloud.openfeign.FeignClient;

/**
 * @author : Jixiaohu
 * @Date : 2019-04-12.
 * @Time : 16:50.
 * @Description :
 */
@FeignClient(name = "microservice-provider-user", configuration = UserConfiguration.class)
public interface UserFeignClient {
    //@PathVariable得設置value
    @RequestLine("GET /simple/{id}")
    User findById(@Param("id") Long id); //@PathVariable得設置value

}

 

 

package com.zwjk.config;

import feign.Contract;
import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author : Jixiaohu
 * @Date : 2019-04-13.
 * @Time : 10:20.
 * @Description :
 */
@Configuration
public class UserConfiguration {

    @Bean
    public Contract feignContract() {
        return new feign.Contract.Default();
    }

    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

 

 其他的不需要修改，下面看一下目錄結構：

UserConfiguretion需要放在外面。