Feign是一个开源的声明式HTTP客户端,它可以简化HTTP API的调用过程。Feign的设计目标是使得使用者可以像调用本地方法一样调用远程服务,使得编写和维护HTTP客户端变得更加简单。类似controller调用service。SpringCloud集成了Ribbon和Eureka,可以使用Feigin提供负载均衡的http客户端
使用Feign时,需要先定义一个接口,该接口中定义了需要远程调用的方法、URL、请求方法、请求头等信息。然后通过使用Feign注解来配置接口的具体实现,包括URL模板、请求方法、请求参数等。通过这种方式,Feign会自动处理接口方法的参数和返回值,并将其转化为HTTP请求发送到远程服务。
Feign,主要是社区版,大家都习惯面向接口编程。这个是很多开发人员的规范。调用微服务访问两种方法
Feign能干什么?
Feign默认集成了Ribbon
1.创建springcloud-consumer-fdept-feign模块 : 拷贝springcloud-consumer-dept-80模块下的pom.xml,resource,以及java代码到springcloud-consumer-feign模块,并添加feign依赖
org.springframework.cloud spring-cloud-starter-feign 1.4.6.RELEASE
springcloud-api模块和Feign模块都添加此依赖
2.修改springcloud-api模块
package com.kdz.springcloud.service; import com.kdz.springcloud.pojo.Dept; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import java.util.List; // @FeignClient:微服务客户端注解,value:指定微服务的名字,这样就可以使Feign客户端直接找到对应的微服务,就可以直接远程通信调用 @FeignClient(value = "SPRINGCLOUD-PROVIDER-DEPT") public interface DeptClientService { @GetMapping("/dept/get/{id}") public Dept queryById(@PathVariable("id") Long id); @GetMapping("/dept/list") public ListqueryAll(); @GetMapping("/dept/add") public Dept addDept(Dept dept); }
3.修改DeptConsumerController.java:使用接口的形式
package com.kdz.springcloud.controller; import com.kdz.springcloud.pojo.Dept; import com.kdz.springcloud.service.DeptClientService; 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.RestController; import java.util.List; @RestController public class DeptConsumerController { @Autowired private DeptClientService deptClientService =null; /** * 消费方添加部门信息 * @param dept * @return */ @RequestMapping("/consumer/dept/add") public Dept add(Dept dept) { return deptClientService.addDept(dept); } /** * 消费方根据id查询部门信息 * @param id * @return */ @RequestMapping("/consumer/dept/get/{id}") public Dept get(@PathVariable("id") Long id) { return deptClientService.queryById(id); } /** * 消费方查询部门信息列表 * @return */ @RequestMapping("/consumer/dept/list") public Listlist() { return deptClientService.queryAll(); } }
之前的DeptConsumerController.java:使用http-Resttemplate
@RestController public class DeptConsumerController { /** * 理解:消费者,不应该有service层~ * RestTemplate .... 供我们直接调用就可以了! 注册到Spring中 * (地址:url, 实体:Map ,ClassresponseType) * * 提供多种便捷访问远程http服务的方法,简单的Restful服务模板~ */ @Autowired private RestTemplate restTemplate; /** * 服务提供方地址前缀 *
* Ribbon:我们这里的地址,应该是一个变量,通过服务名来访问 */ // private static final String REST_URL_PREFIX = "http://localhost:8001"; private static final String REST_URL_PREFIX = "http://SPRINGCLOUD-PROVIDER-DEPT"; /** * 消费方添加部门信息 * @param dept * @return */ @RequestMapping("/consumer/dept/add") public boolean add(Dept dept) { // postForObject(服务提供方地址(接口),参数实体,返回类型.class) return restTemplate.postForObject(REST_URL_PREFIX + "/dept/add", dept, Boolean.class); } /** * 消费方根据id查询部门信息 * @param id * @return */ @RequestMapping("/consumer/dept/get/{id}") public Dept get(@PathVariable("id") Long id) { // getForObject(服务提供方地址(接口),返回类型.class) return restTemplate.getForObject(REST_URL_PREFIX + "/dept/get/" + id, Dept.class); } /** * 消费方查询部门信息列表 * @return */ @RequestMapping("/consumer/dept/list") public List
list() { return restTemplate.getForObject(REST_URL_PREFIX + "/dept/list", List.class); } }
4.启动类配置Feign,扫描到之前的注解配置
EnableFeignClients直接扫到springcloud-api的com.kdz.springcloud下的注解绑定的接口
理解:本质上,Feign集成了Ribben,通过Ribben实现负载均衡,通过Feign实现远程进程调用,和使用@reference注解的方式类似,另一种方式是使用http-Restful实现远程通信调用
Feign和Ribbon二者对比,前者显现出面向接口编程特点,代码看起来更清爽,而且Feign调用方式更符合我们之前在做SSM或者SprngBoot项目时,Controller层调用Service层的编程习惯!
@SpringBootApplication @EnableEurekaClient // feign客户端注解,并指定要扫描的包以及配置接口DeptClientService @EnableFeignClients(basePackages = {"com.haust.springcloud"}) // 切记不要加这个注解,不然会出现404访问不到 //@ComponentScan("com.haust.springcloud") public class FeignDeptConsumer_80 { public static void main(String[] args) { SpringApplication.run(FeignDeptConsumer_80.class, args); } }
4.测试效果:
启动7001、8001、8002、feign
根据个人习惯而定,如果喜欢REST风格使用Ribbon;如果喜欢社区版的面向接口风格使用Feign.
Feign 本质上也是实现了 Ribbon,只不过后者是在调用方式上,为了满足一些开发者习惯的接口调用习惯!
下面我们关闭springcloud-consumer-dept-80 这个服务消费方,换用springcloud-consumer-dept-feign(端口还是80) 来代替:(依然可以正常访问,就是调用方式相比于Ribbon变化了)
在使用Feign时,有一些注意事项需要注意:
使用Feign时需要先引入相关的依赖,如Spring Cloud Feign。
Feign的配置过程较为复杂,需要设置一些参数,如连接超时时间、请求重试策略等。
在定义接口时,需要注意正确的URL模板和请求方法,调用的时候也要注意与配置的接口信息一致。
Feign默认使用的是SpringEncoder和SpringDecoder,会对请求和响应进行编码和解码,需要根据具体情况进行调整。
对于需要进行身份认证的接口,需要配置相应的认证信息。
SpringCloud-Feign:负载均衡(基于服务端) 到此完结,笔者归纳、创作不易,大佬们给个3连再起飞吧