概述上一篇用RestTemplateLoadBalanced打通了 order-service 到 user-service 的远程调用能用但写法笨重。本文用 Feign 把远程调用改造成调本地方法的体验四步完成改造并顺手把底层原理和常见的启动坑讲清楚。纲要RestTemplate 的问题URL 硬编码、字符串拼接易错复杂参数难以维护编程体验不统一写的是 HTTP 请求不是业务方法Feign 是什么声明式 HTTP 客户端类比声明式事务一个 HTTP 请求的五要素服务名称、请求方式、请求路径、请求参数、返回值类型四步改造 order-service引入spring-cloud-starter-openfeign依赖启动类加EnableFeignClients编写UserClient接口FeignClient SpringMVC 注解OrderService注入接口直接调用改造前后对比RestTemplate 写法 vs Feign 写法底层原理动态代理 集成 Ribbon 负载均衡实战避坑注解扫描不到、参数注解缺失、服务名大小写、返回类型不一致RestTemplate 到底差在哪先看改造前的代码这是 order-service 里查询订单时远程查询用户的逻辑// 2.利用RestTemplate发起http请求查询用户// 2.1.url路径服务名写死在字符串里参数靠手工拼接Stringurlhttp://userservice/user/order.getUserId();// 2.2.发送http请求实现远程调用UseruserrestTemplate.getForObject(url,User.class);这段代码已经是基于 Ribbon 做过优化的版本了——URL 里写的是服务名userservice而不是 IP 端口负载均衡已经生效。但它依然有三个硬伤问题具体表现后果可读性差一段代码里混着 URL、请求方式、参数拼接、返回类型转换没接触过远程调用的人第一眼看不懂参数拼接易错路径参数靠手工拼接参数一多就乱拼错路径只会在运行时报 404编程体验不统一业务代码里到处写的是怎么发请求而不是要做什么正常写业务都是调方法这里突然冒出一个 URL 字符串参数复杂时问题会被放大。回想一下在浏览器里访问 Nacos 控制台、或者用百度搜索时地址栏里那一长串参数——七八个参数拼在 Java 字符串里维护将来参数一变改代码就是灾难。Feign把发请求的五个信息声明出来Feign 是一个声明式的 HTTP 客户端。声明式这个概念在 Spring 声明式事务里已经见过早期手动开事务、提交事务、回滚后来只需要告诉 Spring 规则剩下的事框架做。Feign 同理——你把发 HTTP 请求所需要的信息声明出来请求本身由 Feign 帮你发。发一个 HTTP 请求恰好需要五个信息服务名称发给谁请求方式GET / POST请求路径请求参数返回值类型Feign 的做法是定义一个接口把这五个信息全部用注解声明在接口上运行时由 Feign 生成实现并发请求。声明完之后业务代码里只剩下调接口的方法这一件事。四步改造 order-service改造只动 order-service 这个消费方user-service 作为提供方一行不改。改造后的 order-service 结构order-service ├── pom.xml # 第一步在这里加 feign 依赖 └── src/main/java/cn/itcast/order ├── OrderApplication.java # 第二步加 EnableFeignClients ├── client │ └── UserClient.java # 第三步Feign 客户端接口 ├── controller │ └── OrderController.java ├── mapper │ └── OrderMapper.java ├── pojo │ └── Order.java └── service └── OrderService.java # 第四步注入 UserClient 调用引入依赖在 order-service 的 pom.xml 中添加 openfeign 起步依赖。artifactId 是spring-cloud-starter-openfeign注意别写成老版本的spring-cloud-starter-feigndependencygroupIdorg.springframework.cloud/groupIdartifactIdspring-cloud-starter-openfeign/artifactId/dependencystarter 意味着自动装配Feign 运行所需的各种组件由 Spring Boot 帮我们配好。启动类加 EnableFeignClientsEnableFeignClients是 Feign 功能的总开关不加它接口声明得再规范也不会生效。这一步改的就是启动类这一个注解packagecn.itcast.order;importorg.mybatis.spring.annotation.MapperScan;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.cloud.client.loadbalancer.LoadBalanced;importorg.springframework.cloud.openfeign.EnableFeignClients;importorg.springframework.context.annotation.Bean;importorg.springframework.web.client.RestTemplate;MapperScan(cn.itcast.order.mapper)SpringBootApplicationEnableFeignClients// 开启Feign功能默认扫描启动类所在包及其子包中的FeignClient接口publicclassOrderApplication{publicstaticvoidmain(String[]args){SpringApplication.run(OrderApplication.class,args);}/** * 创建RestTemplate并注入Spring容器 * 改用Feign后这个Bean可以删掉这里暂时保留用于对比 */BeanLoadBalancedpublicRestTemplaterestTemplate(){returnnewRestTemplate();}}EnableFeignClients默认扫描启动类所在包及子包。UserClient放在cn.itcast.order.client在扫描范围内什么都不用配。如果客户端接口放在别的包就要显式指定basePackages或clients属性——这是后面避坑清单里的第一名。编写 UserClient 接口新建一个接口封装所有对 userservice 服务的远程调用packagecn.itcast.order.client;importcn.itcast.order.pojo.User;importorg.springframework.cloud.openfeign.FeignClient;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.PathVariable;FeignClient(userservice)publicinterfaceUserClient{GetMapping(/user/{id})UserfindById(PathVariable(id)Longid);}仔细看这个接口全是 SpringMVC 的注解没有任何新东西——这正是 Feign 降低学习成本的设计它默认采用 SpringMVC 的注解来声明调用信息。五个要素对应关系如下声明位置代码对应要素类上FeignClient(userservice)userservice服务名称注册中心里的服务名不是 IP 地址方法上GetMapping(/user/{id})GetMapping请求方式 GET同上/user/{id}请求路径{id}是路径占位符方法参数PathVariable(id) Long idLong id请求参数方法返回值User返回值类型写这个接口时对着提供方的UserController抄即可两边的方法签名和注解必须保持一致。user-service 里的接口长这样packagecn.itcast.user.web;importcn.itcast.user.pojo.User;importcn.itcast.user.service.UserService;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.PathVariable;importorg.springframework.web.bind.annotation.RequestMapping;importorg.springframework.web.bind.annotation.RestController;RestControllerRequestMapping(/user)publicclassUserController{AutowiredprivateUserServiceuserService;/** * 路径 /user/110 * * param id 用户id * return 用户 */GetMapping(/{id})publicUserqueryById(PathVariable(id)Longid){returnuserService.queryById(id);}}类上的RequestMapping(/user)加方法上的GetMapping(/{id})合并起来就是/user/{id}——这正是UserClient里声明的路径。有一个关键认知FeignClient的 value 是服务名对应 nacos/eureka 注册中心里注册的服务名。Feign 拿到服务名后自己去注册中心拉实例列表你永远不需要在代码里写 IP 和端口。OrderService 注入 UserClient 调用最后一步把原来 RestTemplate 的代码整段删掉注入UserClient直接调方法packagecn.itcast.order.service;importcn.itcast.order.client.UserClient;importcn.itcast.order.mapper.OrderMapper;importcn.itcast.order.pojo.Order;importcn.itcast.order.pojo.User;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.stereotype.Service;ServicepublicclassOrderService{AutowiredprivateOrderMapperorderMapper;AutowiredprivateUserClientuserClient;publicOrderqueryOrderById(LongorderId){// 1.查询订单OrderorderorderMapper.findById(orderId);// 2.用Feign远程调用查用户UseruseruserClient.findById(order.getUserId());// 3.封装user到Orderorder.setUser(user);// 4.返回returnorder;}}启动 order-service浏览器访问http://localhost:8080/order/101并多刷新几次每次都返回完整订单数据。观察 user-service 的 8081、8082 两个实例的日志会发现两个实例都被访问到了——Feign 不仅完成了远程调用负载均衡也在生效。改造前后对比同一个查用户动作两种写法放在一起看改造前RestTemplateStringurlhttp://userservice/user/order.getUserId();UseruserrestTemplate.getForObject(url,User.class);改造后FeignUseruseruserClient.findById(order.getUserId());维度RestTemplateFeign调用风格拼 URL 字符串发请求调接口方法URL 维护硬编码在业务代码里声明在客户端接口上集中管理参数处理手工字符串拼接多个参数极易出错方法参数 注解几个参数写几个形参负载均衡需要LoadBalanced手动开启内部集成 Ribbon自动生效可读性不看注释不知道在干什么不说明都以为是本地方法调用复杂 URL参数七八个时基本没法维护方法列表里加形参即可将来遇到参数非常多的接口Feign 的应对方式很朴素方法列表里多加几个参数每个参数配好RequestParam或PathVariable维护成本恒定。Feign 底层是怎么工作的你写的只是一个接口没有实现类那调用方法时发生了什么答案是动态代理Feign 在启动时为每个FeignClient接口生成代理对象注入容器调用方法时代理对象把注解里声明的信息组装成一个 HTTP 请求发出去。user-service注册中心(Nacos)Ribbon负载均衡UserClient(动态代理对象)OrderServiceuser-service注册中心(Nacos)Ribbon负载均衡UserClient(动态代理对象)OrderServicefindById(101L) 看似调用本地方法解析FeignClient/GetMapping注解组装请求: GET /user/101请求目标: 服务名 userservice拉取 userservice 实例列表[8081, 8082]按负载均衡策略选出一个实例HTTP GET http://192.168.x.x:8082/user/101返回 JSON响应体反序列化为 User 对象整个过程可以概括成一条链路OrderService 调方法UserClient 动态代理解析注解生成 HTTP 请求按服务名从注册中心拉取实例Ribbon 负载均衡选实例发起 HTTP 调用 user-service所以 Feign 并不是什么黑魔法它的本质就是RestTemplate/OkHttp 这类 HTTP 客户端 负载均衡的一层封装只是把这层封装藏到了动态代理背后。打开 Feign 的核心依赖树能看到feign-core其内部已经带上了 Ribbon负载均衡不用你操心。实战避坑这几个坑在真实项目里出现频率极高改造时提前避开启动类忘加EnableFeignClients最常见的启动坑。现象是注入UserClient时报Field userClient required a bean找不到 Feign 客户端的 Bean。检查启动类注解即可。客户端接口不在扫描范围内EnableFeignClients默认只扫启动类所在包及子包。如果UserClient放在cn.itcast.feign.clients这类外部包里必须在注解上显式指定两种写法二选一// 写法一指定扫描包EnableFeignClients(basePackagescn.itcast.feign.clients)// 写法二直接指定接口类EnableFeignClients(clients{UserClient.class})方法参数漏写注解Feign 方法有多个参数时RequestParam(xxx)、PathVariable(xxx)一个都不能省且要写明参数名。漏写后 Feign 无法确定参数该放 query、path 还是 body多参数场景会冲突甚至直接把参数塞进请求体导致提供方收不到。服务名大小写与拼写FeignClient(userService)与注册中心里的userservice对不上启动不报错一调用就报No instances available。服务名以注册中心列表里显示的为准。返回类型与提供方不一致提供方返回User客户端方法却声明成Order反序列化字段全为 null 或者直接抛解析异常。排查时先对齐两边的方法签名。API 速览注解 / 组件位置作用EnableFeignClients启动类开启 Feign 功能扫描FeignClient接口basePackages/clients指定扫描范围FeignClient(服务名)接口上声明这是 Feign 客户端value 填注册中心里的服务名GetMapping/PostMapping接口方法上声明请求方式与请求路径与 SpringMVC 注解通用PathVariable(x)方法参数路径占位符参数必须写参数名RequestParam(x)方法参数query 参数必须写参数名LoadBalancedRestTemplate 的 BeanRestTemplate 方案下开启负载均衡Feign 内部已集成无需再配官方文档Spring Cloud OpenFeign 官方文档Spring Cloud Netflix Ribbon总结RestTemplate 的三个问题URL 硬编码拼接、复杂参数难维护、编程体验不统一。Feign 是声明式 HTTP 客户端把服务名称、请求方式、请求路径、请求参数、返回值类型五个信息用注解声明在接口上请求由框架发送。改造四步引依赖spring-cloud-starter-openfeign→ 启动类加EnableFeignClients→ 编写UserClient接口 → 业务代码注入接口调方法。客户端接口全部使用 SpringMVC 注解照着提供方的 Controller 抄即可FeignClient的 value 是服务名不是地址。底层没有黑魔法动态代理生成实现内部集成 Ribbon 自动负载均衡本质是 HTTP 客户端 负载均衡的封装。排查口诀启动报找不到 Bean 查EnableFeignClients调用报找不到实例查服务名拼写参数收不到查RequestParam/PathVariable是否写全。