前言
使用Feign远程调用代替RestTemplate远程调用。
一、Feign的优势
使用RestTemplate发起远程调用:
String url = "http://userservice/user/"+order.getUserId(); User user = restTemplate.getForObject(url, User.class);
虽然在引入注册中心后,使用RestTemplate发起请求可以使用服务名代替主机地址,减少了主机地址修改带来的问题,实现根据服务名去注册中心拉取。但是仍然存在问题:
代码可读性差,编程体验不统一
参数复杂URL难以维护
而Feign是一个声明式的http客户端,可以帮助我们优雅的实现http请求的发送,解决这些问题。
二、Feign使用
初步搭建
下面以orderserver调用userserver服务搭建步骤如下:
(1)引入依赖
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>
(2)添加注解
在服务调用者的启动类添加注解(@EnableFeignClients)开启Feign功能,例如:
@EnableFeignClients @MapperScan("cn.itcast.order.mapper") @SpringBootApplication public class OrderApplication { public static void main(String[] args) { SpringApplication.run(OrderApplication.class, args); } }
(3)客户端编写
import cn.itcast.order.config.DefaultFeignConfiguration; import cn.itcast.order.pojo.User; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; /** * @version 1.0.0 * @Author: dragon_王 * @Date: 2024/3/28 14:12:39 */ @FeignClient("userservice") public interface UserClient { @GetMapping("/user/{id}") User findById(@PathVariable("id") Long id); }
这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
服务名称:userservice
请求方式:GET
请求路径:/user/{id}
请求参数:Long id
返回值类型:User
这样,Feign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。
(4)调用代码
@Service public class OrderService { @Autowired private OrderMapper orderMapper; //注入客户端调用 @Autowired private UserClient userClient; public Order queryOrderById(Long orderId) { Order order = orderMapper.findById(orderId); //用Fegin远程调用 User user = userClient.findById(order.getUserId()); order.setUser(user); return order; } }
5)小结
使用Feign的步骤:
① 引入依赖
② 添加@EnableFeignClients注解
③ 编写FeignClient接口
④ 使用FeignClient中定义的方法代替RestTemplate
自定义配置
Feign可以支持很多的自定义配置,如下表所示:
类型 作用 说明
feign.Logger.Level 修改日志级别 包含四种不同的级别:NONE、BASIC、HEADERS、FULL
feign.codec.Decoder 响应结果的解析器 http远程调用的结果做解析,例如解析json字符串为java对象
feign.codec.Encoder 请求参数编码 将请求参数编码,便于通过http请求发送
feign. Contract 支持的注解格式 默认是SpringMVC的注解
feign. Retryer 失败重试机制 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试
一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。
下面以日志为例来演示如何自定义配置。
配置文件方式
基于配置文件修改feign的日志级别可以针对单个服务:
feign: client: config: userservice: # 针对某个微服务的配置 loggerLevel: FULL # 日志级别
也可以针对所有服务:
feign: client: config: default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置 loggerLevel: FULL # 日志级别
而日志的级别分为四种:
NONE:不记录任何日志信息,这是默认值。
BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
java代码方式
也可以基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:
public class DefaultFeignConfiguration { @Bean public Logger.Level feignLogLevel(){ return Logger.Level.BASIC; // 日志级别为BASIC } }