一、介绍
Spring Cloud提供的微服务都是基于http,那么在请求的时候如果用spring提供的RestTemplate再加一个Ribbon提供的@LoadBalanced注解也是可以比较方便的发起微服务的调用,并且也能做到负载均衡。但是如果服务提供者参数较多也较复杂,那么使用这种方式需要拼接url或者使用Map的形式,但总归是不便于开发的。
Spring Cloud全家桶提供了feign这样的一个组件,feign是Netflix开发的声明式、模板化的HTTP客户端,feign的使用非常简单,创建一个接口,在接口上加入一些注解,这样就完成了代码开发。
Spring Cloud在Netflix的基础上对feign进行了进一步的增强,添加了对Spring MVC注解的支持,并整合了Ribbon和Eureka,从而让feign的使用更加简单了。接下去介绍使用feign的最佳实践。
二、开发
1、新建项目hjduan.spring.cloud.feign pom如下
<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>
<parent>
<groupId>com.hjduan.spring.cloud</groupId>
<artifactId>hjduan.spring.cloud</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<artifactId>hjduan.spring.cloud.feign</artifactId>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-feign</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
2、application.yml配置
server:
port: 8765
eureka:
client:
serviceUrl:
defaultZone: http://admin:admin@localhost:8761/eureka/
instance:
prefer-ip-address: true
instance-id: ${spring.application.name}:${spring.application.instance_id:${server.port}}
spring:
application:
name: hjduan-spring-cloud-feign
3、FeignService配置
package com.hjduan.spring.cloud.feign.service;
import org.springframework.cloud.netflix.feign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import com.hjduan.spring.cloud.feign.hystric.HystricFeignService;
/**
* 1. 在没有错误的情况下执行value对应的服务
* 2. 出现错误执行fallback指定类中对应的函数
* 作者: 段浩杰 2017年7月25日
*/
@FeignClient(value = "HJDUAN-SPRING-CLOUD-CONSUMER", fallback = HystricFeignService.class)
public interface FeignService {
@RequestMapping(value = "/hi/{name}", method = RequestMethod.GET)
String sayHiFromClientOne(@RequestParam(value = "name") String name);
}
4、编写断路器hystric
package com.hjduan.spring.cloud.feign.hystric;
import org.springframework.stereotype.Service;
import com.hjduan.spring.cloud.feign.service.FeignService;
@Service
public class HystricFeignService implements FeignService {
@Override
public String sayHiFromClientOne(String name) {
return "sorry:【断路器起作用了!】";
}
}
5、编写controller
package com.hjduan.spring.cloud.feign.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import com.hjduan.spring.cloud.feign.service.FeignService;
@RestController
public class FeignController {
@Autowired
private FeignService feignService;
@RequestMapping(value = "/hi/{name}", method = RequestMethod.GET)
public String sayHi(@PathVariable String name) {
return feignService.sayHiFromClientOne(name);
}
}
6、编写启动类
package com.hjduan.spring.cloud.feign;
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;
@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
/**
* Feign客户端
* feign采用的是接口加注解
* feign 整合了ribbon
* 作者: 段浩杰 2017年7月25日
*/
public class FeignApplicationConfiguration {
public static void main(String[] args) {
new SpringApplication(FeignApplicationConfiguration.class).run(args);
}
}
7、然后运行hjduan.spring.cloud.eureka,hjduan.spring.cloud.consumer修改hjduan.spring.cloud.consumer端口再次运行一下,运行hjduan.spring.cloud.feign,然后访问http://localhost:8765/hi/123
8、验证断路器是否起作用
关闭hjduan.spring.cloud.consumer这两个服务,在访问会出现,断路器指定的方法。