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应用，提供以下方法
@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.
如果缺少了以上注解，服务运行起来以后虽然不会报错，但是获取不到入参。
服务调用方项目：
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-feign</artifactId>
</dependency>
这里只依赖了Feign，没有依赖Ribbon和Hystrix。
application.yml：
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启动程序
@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这个注解。
核心客户端代码
@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客户端参数要如何对应。
降级服务代码：
@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代码：
@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();
}
}
我们来看效果：
我们服务都没超时，3个方法全部正常，但是head请求没有拿到返回值，这个是因为head方式http请求的特性决定的，head不返回response的body体，一般用来做连通性测试来用。
再看一组：
运气不好head和post请求方法处理时间超过了2000ms，服务降级，实现被fallback处理类取代。
在案例一中我们总有种感觉，服务提供方和服务调用方存在重复的代码，是否可以进行优化？请看案例二。
案例二：
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：
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);
}
服务提供方：
@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();
}
}
服务调用方：
@FeignClient(name="demo-feign-serviceimpl", fallback=FeignServiceFallback.class)
public interface FeignService extends HelloService{
}
其它代码基本不变，效果也一样。
两种风格各有优缺点：freestyle的更自由，服务端新增方法不会影响客户端代码，缺点是服务能力不同步服务能力的变动会引起异常；API格式服务端客户端服务能力同步，但是接口的变动需要修改两边的代码，需要构建的时候就要考虑清楚。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
- Spring Cloud Feign简单使用详解
- 使用Spring Cloud Feign作为HTTP客户端调用远程HTTP服务的方法(推荐)
- 详解spring cloud Feign使用中遇到的问题总结
- spring cloud feign不支持@RequestBody+ RequestMethod.GET报错的解决方法
- 详解springcloud Feign的Hystrix支持
- SpringCloud之Feign示例详解
- 使用Spring Cloud Feign上传文件的示例
- spring cloud 之 Feign 使用HTTP请求远程服务的实现方法
- Spring Cloud中关于Feign的常见问题总结
- 解决Spring Cloud中Feign/Ribbon第一次请求失败的方法
相关文章
这篇文章主要介绍了Java ArrayList.add 的实现方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2018-11-11
本文通过实例代码给大家介绍了java io流文件编码的方法，非常不错，具有参考借鉴价值，需要的朋友参考下吧2017-05-05
解决Spring Boot 在localhost域奇怪的404问题(Mac book pro)
这篇文章主要介绍了解决Spring Boot 在localhost域奇怪的404问题(Mac book pro),需要的朋友可以参考下2017-09-09
这篇文章主要介绍了JUC之CountdownLatch使用详解,CountdownLatch 用来进行线程同步协作,等待所有线程完成倒计时,2023-12-12
其中构造参数用来初始化等待计数值,await() 用来等待计数归零,countDown() 用来让计数减一,需要的朋友可以参考下
IDEA JavaWeb项目启动运行后出现404错误的解决方法
这篇文章主要介绍了IDEA JavaWeb项目启动运行后出现404错误的解决方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2019-12-12
本篇文章主要介绍了Hibernate对数据库删除、查找、更新操作实例代码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-05-05
SpringBoot + 微信公众号JSAPI支付功能的实现
这篇文章主要介绍了SpringBoot + 微信公众号JSAPI支付功能的实现,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-03-03
这篇文章主要介绍了在Mybatis @Select注解中实现拼写动态sql，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2020-11-11
这篇文章主要介绍了Java集合List的使用详细解析,List集合类中元素有序、且可重复,集合中的每个元素都有其对应的顺序索引,鉴于Java中数组用来存储数据的局限性,我们通常使用java.util.List替代数组,需要的朋友可以参考下2023-11-11
Mybatis-Plus 是 MyBatis 的一个增强工具，专门针对于传统MyBatis开发中sql需要手动进行映射配置繁琐缺点的一款框架技术。本文将为大家详细讲讲Mybatis-plus的介绍与使用，感兴趣的可以了解一下2022-07-07
最新评论