SpringCloud---(6)Feign(声明式服务调用)

Feign是一个声明式、模板化的HTTP客户端，它使得HTTP客户端变得更简单。使用Feign，只需要创建一个接口并用注解方式来配置它，即可完成对服务提供者的接口绑定，简化了在使用Ribbon时自行封装服务调用客户端的开发量。

Feign具有可插拔的注解特性，包括Feign注解和JAX-RS注解，同时也扩展了对Spring MVC的注解支持。Feign支持可插拔的编码器的解码器，默认集成了Ribbon，并和Eureka结合，默认实现了负载均衡的效果。

在pom中增加spring-cloud-starter-feign依赖包

 

1 Feign的基础应用

1.1 pom.xml

注：引入依赖

<?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>



<artifactId>microservice-consumer-movie-feign</artifactId>

<packaging>jar</packaging>



<parent>

    <groupId>com.kevin.cloud</groupId>

    <artifactId>microservice-spring-cloud</artifactId>

    <version>0.0.1-SNAPSHOT</version>

    <relativePa
th/>

</parent>


<properties>

    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

    <java.version>1.8</java.version>

</properties>


<dependencies>

    <dependency>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-web</artifactId>

</dependency>


<dependency>

    <groupId>org.springframework.cloud</groupId>

    <artifactId>spring-cloud-starter-eureka</artifactId>

</dependency>


<dependency>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-actuator</artifactId>

</dependency>


<dependency>

    <groupId>org.springframework.cloud</groupId>

    <artifactId>spring-cloud-starter-feign</artifactId>

</dependency>

</dependencies>


</project>

1.2 application.yml

server:

  port: 7901

spring:

  application:

    name: microservice-consumer-movie

eureka:

  client:

    healthcheck:

      enabled: true

service-url:

      defaultZone: http://kevin:123456@localhost:8761/eureka

instance:

    prefer-ip-address: true

 

1.3 ConsumerMovieFeignApplication.java

注：在springboot主类加入注解，@EnableFeignClients开启Feign功能。

package com.keivn.cloud;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

import org.springframework.cloud.netflix.feign.EnableFeignClients;


/**

 *

 * @title   服务消费者

 * @description

* @author caonanqing

 * @createDate 2018/11/7

 * @version 1.0

 */

@SpringBootApplication

@EnableEurekaClient    //注册到Eureka

@EnableFeignClients    //开启Fegin功能

public class ConsumerMovieFeignApplication {



public static void main(String[] args) {

      SpringApplication.run(ConsumerMovieFeignApplication.class, args);

      System.out.println("服务消费者启动...");

   }

}

1.4 UserFeignClient.java

注：注入接口，@FeignClient("microservice-provider-user") //绑定该接口对应的服务，不能使用GETMapping，需要使用RequestMapping
 

package com.keivn.cloud.feign;

import com.keivn.cloud.entity.User;

import org.springframework.cloud.netflix.feign.FeignClient;

import org.springframework.web.bind.annotation.*;


/**

 *

 * @title

* @description

* @author caonanqing

 * @createDate 2018/11/9

 * @version 1.0

 */

@FeignClient("microservice-provider-user") //绑定该接口对应的服务

public interface UserFeignClient {

// 1.@GetMapping不支持，2.@PathVarible必须要得设置value

@RequestMapping(value = "/simple/{id}", method = RequestMethod.GET)

public User findById(@PathVariable("id") Long id );

// 测试POST请求方式

@RequestMapping(value = "/post-user", method = RequestMethod.POST)

public User postUser(@RequestBody User user);

// 测试GET请求方式

@RequestMapping(value = "/get-user", method = RequestMethod.GET)

public User getUser(User user);

}

1.5 MovieController.java

注：在Controller类调用接口

package com.keivn.cloud.controller;

import com.keivn.cloud.feign.UserFeignClient;

import com.keivn.cloud.entity.User;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.*;

/**

 *

 * @title

* @description

* @author caonanqing

 * @createDate 2018/11/7

 * @version 1.0

 */

@RestController

public class MovieController {

@Autowired

private UserFeignClient userFeignClient;

@GetMapping(value = "/movie/{id}")

public User finById(@PathVariable long id ){

return this.userFeignClient.findById(id);

    }

@GetMapping(value = "/post-user")

public User postUser(User user){

return this.userFeignClient.postUser(user);

    }

@GetMapping(value = "/get-user")

public User getUser(User user){

return this.userFeignClient.getUser(user);

    }

}

1.6 User.java

package com.keivn.cloud.entity;



import java.io.Serializable;

import java.math.BigDecimal;



/**

 *

 * @title

* @description

* @author caonanqing

 * @createDate 2018/11/7

 * @version 1.0

 */

public class User implements Serializable {



private Long id;



private String username;



private String name;



private Short age;



private BigDecimal balance;



public User() {

    }



public User(Long id, String username, String name, Short age, BigDecimal balance) {

this.id = id;

this.username = username;

this.name = name;

this.balance = balance;

    }



public Long getId() {

return id;

    }



public void setId(Long id) {

this.id = id;

    }



public String getUsername() {

return username;

    }



public void setUsername(String username) {

this.username = username;

    }



public String getName() {

return name;

    }



public void setName(String name) {

this.name = name;

    }



public Short getAge() {

return age;

    }



public void setAge(Short age) {

this.age = age;

    }



public BigDecimal getBalance() {

return balance;

    }



public void setBalance(BigDecimal balance) {

this.balance = balance;

    }

}

 

2 Feign覆写Feign的默认配置及日志

Spring Cloud 的Feign支持的一个中心概念是命名客户端。

每个Feign Client是整体的一部分，它们一起工作以按需联系远程服务器，并且该整体具有一个名称，开发人员可以使用@FeignClient将其命名。

SpringCloud根据需要使用FeignClientsConfiguration为每个命名的客户端创建一个新的整体作为ApplicationContext。这包含（其他）Feign.Docoder，Feign.Encoder和Feign.Contract。

 

通过额外的配置来控制Feign Client（覆写默认配置）

pom与上面1.1的一致，不需要改动，user类与上面的也是一致

2.1 application.yml

server:

  port: 7901

spring:

  application:

    name: microservice-consumer-movie

eureka:

  client:

    healthcheck:

      enabled: true

service-url:

      defaultZone: http://kevin:123456@localhost:8761/eureka

instance:

    prefer-ip-address: true

logging:  #启动日志

level:

    com.keivn.cloud.feign.UserFeignClient: debug



# 解决第一次请求报超时异常的方案：

# hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 5000

# 或者：

# hystrix.command.default.execution.timeout.enabled: false

# 或者：

feign.hystrix.enabled: false  # 索性禁用feign的hystrix



# 超时的issue：https://github.com/spring-cloud/spring-cloud-netflix/issues/768

# 超时的解决方案： http://stackoverflow.com/questions/27375557/hystrix-command-fails-with-timed-out-and-no-fallback-available

# hystrix配置： https://github.com/Netflix/Hystrix/wiki/Configuration#execution.isolation.thread.timeoutInMilliseconds

2.2 ConsumerMovieFeignApplication.java

package com.keivn.cloud;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

import org.springframework.cloud.netflix.feign.EnableFeignClients;



/**

 *

 * @title   服务消费者

 * @description

* @author caonanqing

 * @createDate 2018/11/7

 * @version 1.0

 */

@SpringBootApplication

@EnableEurekaClient    //注册到Eureka

@EnableFeignClients    //开启Fegin功能

public class ConsumerMovieFeignApplication {



public static void main(String[] args) {

      SpringApplication.run(ConsumerMovieFeignApplication.class, args);

      System.out.println("服务消费者启动...");

   }

}

2.3 UserFeignClient.java

package com.keivn.cloud.feign;

import com.keivn.cloud.entity.User;

import com.keivn.config.Configuration1;

import feign.Param;

import feign.RequestLine;

import org.springframework.cloud.netflix.feign.FeignClient;



/**

 *

 * @title

* @description

* @author caonanqing

 * @createDate 2018/11/9

 * @version 1.0

 */

@FeignClient(name = "microservice-provider-user", configuration = Configuration1.class) //绑定该接口对应的服务，以及配置

public interface UserFeignClient {



// 覆写Feign默认的配置，使用的Feign本身的注解，而不是SpringMVC

@RequestLine("GET /simple/{id}") //GET请求+空格+请求地址

public User findById(@Param("id") Long id );



}

2.4 UserFeignClient2.java

package com.keivn.cloud.feign;

import com.keivn.config.Configuration2;

import org.springframework.cloud.netflix.feign.FeignClient;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;


/**

 *

 * @title

* @description

* @author caonanqing

 * @createDate 2018/11/14

 * @version 1.0

 */

//xxx只是随意起的名称，实际是Eureka中Application的名称

@FeignClient(name = "xxx", url = "http://localhost:8761/", configuration = Configuration2.class) //绑定该接口对应的服务，以及配置

public interface UserFeignClient2 {

//访问eureka里注册的服务的名称

@RequestMapping(value ="/eureka/apps/{serviceName}")

public String findServiceInfoFromEurekaByServiceName(@PathVariable("serviceName") String serviceName);


}

2.5 Configuration1.java

package com.keivn.config;

import feign.Contract;

import feign.Logger;

import org.springframework.context.annotation.Configuration;

import org.springframework.context.annotation.Bean;



/**

 *

 * @title   通过声明额外的配置来控制Feign Client（覆写默认配置）

 * @description 为了不与Spring Boot的Application的ComponentScan包冲突，将配置类放到cloud包外面

 * @author caonanqing

 * @createDate 2018/11/14

 * @version 1.0

 */

@Configuration

public class Configuration1 {



// 契约，Contract使用的是Feign本身的注解

@Bean

public Contract feignContract(){

return new feign.Contract.Default();

    }



// 启动日志

@Bean

Logger.Level feignLoggerLever(){

return Logger.Level.FULL;

    }



}

2.6 Configuration2.java

package com.keivn.config;

import feign.Contract;

import feign.auth.BasicAuthRequestInterceptor;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;



/**

 *

 * @title

* @description

* @author caonanqing

 * @createDate 2018/11/14

 * @version 1.0

 */

@Configuration

public class Configuration2 {



// 直接访问是没有权限的，需要加上该注解配置服务提供者的账号密码。

@Bean

public BasicAuthRequestInterceptor basicAuthRequestInterceptor(){

return new BasicAuthRequestInterceptor("kevin","123456");

    }



}

2.7 MovieController.java

package com.keivn.cloud.controller;

import com.keivn.cloud.feign.UserFeignClient;

import com.keivn.cloud.entity.User;

import com.keivn.cloud.feign.UserFeignClient2;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.*;



/**

 *

 * @title

* @description

* @author caonanqing

 * @createDate 2018/11/7

 * @version 1.0

 */

@RestController

public class MovieController {



@Autowired

private UserFeignClient userFeignClient;



@Autowired

private UserFeignClient2 userFeignClient2;



@GetMapping(value = "/movie/{id}")

public User finById(@PathVariable long id ){

return this.userFeignClient.findById(id);

    }



@GetMapping("/{serviceName}")

public String findServiceInfoFromEurekaByServiceName(@PathVariable String serviceName){

return this.userFeignClient2.findServiceInfoFromEurekaByServiceName(serviceName);

    }

}