1. 引言
代码已上传至Github,有兴趣的同学可以下载来看看:https://github.com/ylw-github/SpringCloud-Feign-Demo
Feign客户端是一个web声明式HTTP远程调用工具,提供了接口和注解方式进行调用。简单的说就是A工程如果知道B工程的接口,不需要知道它的具体实现就可以调用了,类似controller调用service。Spring Cloud集成了Ribbon和Eureka,可在使用Feign时提供负载均衡的http客户端。
2. 环境搭建
需求:订单工程需要调用会员工程的接口,但是订单工程不能知道会员工程的真实ip地址。
1. 新建Eureka注册中心项目、订单项目、会员项目
2.订单项目和会员工程都需要添加Feign依赖
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>
3.订单项目和会员工程项目启动加上@EnableFeignClients
订单项目:------------------------------------------------------ @SpringBootApplication @EnableEurekaClient @EnableFeignClients @EnableHystrix public class AppOrder { public static void main(String[] args) { SpringApplication.run(AppOrder.class, args); } } 会员项目:------------------------------------------------------ @SpringBootApplication @EnableEurekaClient @EnableFeignClients public class AppMember { public static void main(String[] args) { SpringApplication.run(AppMember.class, args); } }
4.会员工程定义接口
定义接口:--------------------------------------------------------- public interface IMemberService { // 实体类是存放接口项目还是 存放在实现项目 实体类存放在接口项目里面 // 实体类和定义接口信息存放在接口项目 // 代码实现存放在接口实现类里面 @RequestMapping("/getMem") public UserEntity getMem(@RequestParam("name") String name); } 接口实现:--------------------------------------------------------- @RestController public class MemberServiceImpl extends BaseApiService implements IMemberService { @Value("${server.port}") private String serverPort; @Override public UserEntity getMem(String name) { UserEntity userEntity = new UserEntity(); userEntity.setName(name + "serverPort:" + serverPort); userEntity.setAge(20); return userEntity; } }
5.订单工程定义Feign客户端接口
public interface IMemberService { // 实体类是存放接口项目还是 存放在实现项目 实体类存放在接口项目里面 // 实体类和定义接口信息存放在接口项目 // 代码实现存放在接口实现类里面 @RequestMapping("/getMem") public UserEntity getMem(@RequestParam("name") String name); } @FeignClient(name = "app-service-member") public interface MemberServiceFeigin extends IMemberService { // 服务降级 熔断 // 实体类是存放接口项目还是 存放在实现项目 实体类存放在接口项目里面 // 实体类和定义接口信息存放在接口项目 // 代码实现存放在接口实现类里面 }
6.订单工程调用会员工程接口
定义接口:--------------------------------------------------------- public interface IOrderService { @RequestMapping("/getOrderMember") public ResponseBase getOrderMember(String name); } 接口实现:--------------------------------------------------------- @RestController public class OrderServiceImpl extends BaseApiService implements IOrderService { // 订单服务继承会员服务接口,用来实现feign客户端 减少重复接口代码 @Autowired private MemberServiceFeigin memberServiceFeigin; @RequestMapping("/getOrderMember") public ResponseBase getOrderMember(String name) { System.out.println("name:" + name); UserEntity user = memberServiceFeigin.getMem(name); if (user == null) { return setResultError("没有查询到用户信息"); } return setResultSuccess(user); } }
7.启动Eureka注册中心、会员工程、订单工程
8.浏览器访问:http://localhost:8020/getOrderMember?name=ylw
成功!!!
3. feign继承特性
在使用声明式feign客户端工具的时候,因为书写的方式代码可能会产生重复,可以使用feign客户端集成方式减少代码。
订单项目项目结构:
parent maven依赖:
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.1.RELEASE</version> </parent> <!-- 管理依赖 --> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Finchley.M7</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <!-- SpringBoot整合Web组件 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- SpringBoot整合eureka客户端 --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency> <!-- SpringBoot整合fegnin客户端 --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> <!-- hystrix断路器 --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-hystrix</artifactId> </dependency> </dependencies> <!-- 注意: 这里必须要添加, 否者各种依赖有问题 --> <repositories> <repository> <id>spring-milestones</id> <name>Spring Milestones</name> <url>https://repo.spring.io/libs-milestone</url> <snapshots> <enabled>false</enabled> </snapshots> </repository> </repositories>
application.yml:
###服务启动端口号 server: port: 8020 tomcat: max-threads: 10 ###服务名称(服务注册到eureka名称) spring: application: name: app-service-order ###服务注册到eureka地址 eureka: client: service-url: defaultZone: http://localhost:8100/eureka ###因为该应用为注册中心,不会注册自己 register-with-eureka: true ###是否需要从eureka上获取注册信息 fetch-registry: true
4. Ribbon配置
SpringCloud Feign客户端Http调用工具,默认已经整合了Ribbon负载均衡客户端。
配置Feign客户端超时时间:
###设置feign客户端超时时间 ribbon: ###指的是建立连接所用的时间,适用于网络状况正常的情况下,两端连接所用的时间。 ReadTimeout: 5000 ###指的是建立连接后从服务器读取到可用资源所用的时间。 ConnectTimeout: 5000
测试:
1.拷贝会员工程,命名为Member-Service-Copy,并导入
2.修改端口号为:8011
###服务启动端口号 server: port: 8011 tomcat: max-threads: 10 ###服务名称(服务注册到eureka名称) spring: application: name: app-service-member ###服务注册到eureka地址 eureka: client: service-url: defaultZone: http://localhost:8100/eureka
3.修改Service类返回的内容:
@RestController public class MemberServiceImpl extends BaseApiService implements IMemberService { @Value("${server.port}") private String serverPort; @Override public UserEntity getMem(String name) { UserEntity userEntity = new UserEntity(); userEntity.setName("copy -------------> "+name + "serverPort:" + serverPort); userEntity.setAge(20); return userEntity; } }
4.启动Eureka注册工程、会员工程(两个)、订单工程:
5.浏览器访问:http://localhost:8020/getOrderMember?name=ylw
再次请求,可以看出两个订单工程被轮询访问了:
5. 总结
代码已上传至Github,有兴趣的同学可以下载来看看:https://github.com/ylw-github/SpringCloud-Feign-Demo