服务器之家：专注于服务器技术及软件下载分享
分类导航

PHP教程|ASP.NET教程|JAVA教程|ASP教程|编程技术|正则表达式|C/C++|IOS|C#|Swift|Android|JavaScript|易语言|

服务器之家 - 编程语言 - JAVA教程 - Spring Cloud Feign实例讲解学习

Spring Cloud Feign实例讲解学习

2021-04-07 13:13牛麦康纳 JAVA教程

这篇文章主要介绍了Spring Cloud Feign实例讲解学习，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

前面博文搭建了一个Eureka+Ribbon+Hystrix的框架，虽然可以基本满足服务之间的调用，但是代码看起来实在丑陋，每次客户端都要写一个restTemplate，为了让调用更美观，可读性更强，现在我们开始学习使用Feign。

Feign包含了Ribbon和Hystrix，这个在实战中才慢慢体会到它的意义，所谓的包含并不是Feign的jar包包含有Ribbon和Hystrix的jar包这种物理上的包含，而是Feign的功能包含了其他两者的功能这种逻辑上的包含。简言之：Feign能干Ribbon和Hystrix的事情，但是要用Ribbon和Hystrix自带的注解必须要引入相应的jar包才可以。

案例一：

Eureka注册中心：https://github.com/yejingtao/forblog/tree/master/demo-eureka-register

服务提供方：https://github.com/yejingtao/forblog/tree/master/demo-feign-freeservice

服务调用方：https://github.com/yejingtao/forblog/tree/master/demo-feign-freeconsumer

服务提供方就是个简单的EurekaClient端+web应用，提供以下方法

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
@RestController
@RequestMapping("/feign-service")
public class HelloServiceContorller {
  private Logger logger = LoggerFactory.getLogger(this.getClass());   
  private void sleep(String methodName) {
    int sleepMinTime = new Random().nextInt(3000);
    logger.info("helloService "+methodName+" sleepMinTime: "+sleepMinTime);
    try {
      Thread.sleep(sleepMinTime);
    } catch (InterruptedException e) {
      e.printStackTrace();
    }
  }
   
  @RequestMapping(value="/serviceGet",method=RequestMethod.GET)
  public String helloService(@RequestParam String name) {
    sleep("get");
    return "HelloServiceImpl name :"+name;
  }
   
  @RequestMapping(value="/serviceHead", method=RequestMethod.HEAD)
  public String helloService(@RequestHeader String name,
      @RequestHeader String password) {
    sleep("header");
    return "helloServiceHead name :"+name +" password:"+password;
  }
   
  @RequestMapping(value="/servicePost", method=RequestMethod.POST)
  public String helloService(@RequestBody UserDemo userDemo) {
    sleep("post");
    return userDemo.toString();
  }
}

需要注意的以下注解不可以省略。

@RequestParam：Annotation which indicates that amethod parameter should be bound to a web request parameter

@RequestBody：Annotation indicating a methodparameter should be bound to the body of the web request.

@RequestHeader：Annotation which indicates that amethod parameter should be bound to a web request header.

如果缺少了以上注解，服务运行起来以后虽然不会报错，但是获取不到入参。

服务调用方项目：

?
1
2
3
4
<dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-feign</artifactId>
    </dependency>

这里只依赖了Feign，没有依赖Ribbon和Hystrix。

application.yml：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
server:
 port: 9051
 
spring:
 application:
  name: demo-feign-freeconsumer
   
eureka:
 client:
  serviceUrl:
   defaultZone: http://peer1:1111/eureka/,http://peer2:1112/eureka/
feign:
 hystrix:
  enabled: true
 
#Ribbon 超时时间设置
#ribbon:
# ConnectTimeout: 500
# ReadTimeout: 3000

hystrix这个配置坑了我好久我用的Spring Cloud是Dalston版本SR1，比网上其他材料的版本要新，因为在新版本中Feign对Hystrix的支持默认是关闭的，所以要通过配置手动打开feign.hystrix.enabled=true，这样服务降级等功能才有效果。

Application启动程序

?
1
2
3
4
5
6
7
8
@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
public class DemoFeignApplication {   
  public static void main(String[] args) {
    SpringApplication.run(DemoFeignApplication.class, args);
  }
}

注意这里还有个坑，我这里用的是@SpringBootApplication+@EnableEurekaClient，而不是用的@SpringCloudApplication，因为后者包含了@EnableCircuitBreaker，而@EnableCircuitBreaker又是属于Hystrix包里的内容，我的pom里并没有引入Hystrix。所以这一点Spring Cloud做的还是有不足的地方，直接用@SpringCloudApplication编译不会报错，但是启动不了。当然这里的主角还是@EnableFeignClients这个注解。

核心客户端代码

?
1
2
3
4
5
6
7
8
9
10
11
12
13
@FeignClient(name="demo-feign-freeservice",fallback=DemoFeignFallback.class)
public interface DemoFeignService{
    
  @RequestMapping(value="/feign-service/serviceGet",method=RequestMethod.GET)
  String helloService(@RequestParam("name") String name);
   
  @RequestMapping(value="/feign-service/serviceHead", method=RequestMethod.HEAD)
  String helloService(@RequestHeader("name") String name,
      @RequestHeader("password") String password);
   
  @RequestMapping(value="/feign-service/servicePost", method=RequestMethod.POST)
  String helloService(@RequestBody UserDemo userDemo); 
}

@FeignClient注解定义了该接口是一个Feign客户端，name指定了注册到Eureka上的服务名，fallback是服务降级后的接口实现类。

@RequestMapping里指定了请求的相对url和http请求方式，与服务端一一对应。入参里的@RequestParam、

@RequestBody、@RequestHeader注解比起服务端多了value属性，这里不能省略，需要显式的告知Feign客户端参数要如何对应。

降级服务代码：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Component
public class DemoFeignFallback implements DemoFeignService{
  @Override
  public String helloService(String name) {
    return "get error";
  }
 
  @Override
  public String helloService(String name,String password) {
    return "head error";
  }
   
  @Override
  public String helloService(UserDemo userDemo) {
    return "post error";
  }
}

发现这里的入参里我故意去掉了@RequestParam、@RequestBody、@RequestHeader注解，因为这几个注解本质上的意义就在于Feign在做微服务调用的时候对http传递参数用的，但服务降级根本不会做http请求了，所以此处可以省略。

Controller代码：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@RestController
public class DemoFeignController {   
  @Autowired
  private DemoFeignService demoFeignService;   
  @RequestMapping(value="/test", method=RequestMethod.GET)
  public String demoServiceTest() {
    StringBuffer sb = new StringBuffer();
    sb.append(demoFeignService.helloService("yuanyuan"));
    sb.append("\n");
    sb.append(demoFeignService.helloService("yjt","xixihaha"));
    sb.append("\n");
    sb.append(demoFeignService.helloService(new UserDemo("yejingtao","123456")));
    return sb.toString();     
  }
}

我们来看效果：

Spring Cloud Feign实例讲解学习

Spring Cloud Feign实例讲解学习

我们服务都没超时，3个方法全部正常，但是head请求没有拿到返回值，这个是因为head方式http请求的特性决定的，head不返回response的body体，一般用来做连通性测试来用。

再看一组：

运气不好head和post请求方法处理时间超过了2000ms，服务降级，实现被fallback处理类取代。

Spring Cloud Feign实例讲解学习

Spring Cloud Feign实例讲解学习

在案例一中我们总有种感觉，服务提供方和服务调用方存在重复的代码，是否可以进行优化？请看案例二。

案例二：

Eureka注册中心：https://github.com/yejingtao/forblog/tree/master/demo-eureka-register

接口API：https://github.com/yejingtao/forblog/tree/master/demo-feign-serviceapi

服务提供方：https://github.com/yejingtao/forblog/tree/master/demo-feign-serviceimpl

服务调用方：https://github.com/yejingtao/forblog/tree/master/demo-feign-apiconsumer

案例二最大的变动是将服务能力单独写到一个API的project中，调用方和提供方pom都依赖这个API。

API：

?
1
2
3
4
5
6
7
8
9
10
11
public interface HelloService {   
  @RequestMapping(value="/feign-service/serviceGet",method=RequestMethod.GET)
  String helloService(@RequestParam("name") String name);
   
  @RequestMapping(value="/feign-service/serviceHead", method=RequestMethod.HEAD)
  String helloService(@RequestHeader("name") String name,
      @RequestHeader("password") String password);
   
  @RequestMapping(value="/feign-service/servicePost", method=RequestMethod.POST)
  String helloService(@RequestBody UserDemo userDemo);   
}

服务提供方：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@RestController
public class HelloServiceContorller implements HelloService{   
  private Logger logger = LoggerFactory.getLogger(this.getClass());   
  private void sleep(String methodName) {
    int sleepMinTime = new Random().nextInt(3000);
    logger.info("helloService "+methodName+" sleepMinTime: "+sleepMinTime);
    try {
      Thread.sleep(sleepMinTime);
    } catch (InterruptedException e) {
      e.printStackTrace();
    }
  }
   
  @Override
  public String helloService(@RequestParam("name") String name) {
    sleep("get");
    return "HelloServiceImpl name :"+name;
  }
   
  @Override
  public String helloService(@RequestHeader("name") String name,
      @RequestHeader("password") String password) {
    sleep("header");
    return "helloServiceHead name :"+name +" password:"+password;
  }
   
  @Override
  public String helloService(@RequestBody UserDemo userDemo) {
    sleep("post");
    return userDemo.toString();
  }      
}

服务调用方：

?
1
2
3
@FeignClient(name="demo-feign-serviceimpl", fallback=FeignServiceFallback.class)
public interface FeignService extends HelloService{ 
}

其它代码基本不变，效果也一样。

两种风格各有优缺点：freestyle的更自由，服务端新增方法不会影响客户端代码，缺点是服务能力不同步服务能力的变动会引起异常；API格式服务端客户端服务能力同步，但是接口的变动需要修改两边的代码，需要构建的时候就要考虑清楚。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持服务器之家。

原文链接：http://blog.csdn.net/yejingtao703/article/details/77748190

  • Feign
  • Cloud
  • spring

    • 延伸 · 阅读

    精彩推荐
    最近更新
    编辑推荐
    阅读排行
    热门标签
    501 　 406 　 2000 　 1433 　 415 　 401 　 空心菱形 　 选择排序法 　 随机抽取 　 内存卡 　 下载器 　 十六进制字符 　 响应 　 静态工厂 　 构造函数 　 swt 　 Overview 　 对象池模式 　 子线程 　 短信猫 　 htmlparser 　 支票 　 金额大写转换 　 猴子选王 　 AspectJ 　 面向切面编程 　 方法名 　 网址信息 　 动态代理模式 　 线程安全 　
    © 2019-2021 服务器之家(www.zzvips.com) 版权所有关于我们联系我们版权申明网站地图