从零开始学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需要放在外面。