1.feign替代resttemplate
fegin的使用步骤如下:
1)引入依赖
我们在order-service服务的pom文件中引入feign的依赖:
<dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-starter-openfeign</artifactid> </dependency>
2)添加注解
在order-service的启动类添加注解开启feign的功能:
package cn.itcast.order; import com.netflix.loadbalancer.irule; import com.netflix.loadbalancer.randomrule; import org.mybatis.spring.annotation.mapperscan; import org.springframework.boot.springapplication; import org.springframework.boot.autoconfigure.springbootapplication; import org.springframework.cloud.client.loadbalancer.loadbalanced; import org.springframework.cloud.openfeign.enablefeignclients; import org.springframework.context.annotation.bean; import org.springframework.web.client.resttemplate; @mapperscan("cn.itcast.order.mapper") @springbootapplication @enablefeignclients public class orderapplication { public static void main(string[] args) { springapplication.run(orderapplication.class, args); } /* * 创建resttemplate并注入spring容器 * */ @bean @loadbalanced public resttemplate resttemplate() { return new resttemplate(); }
3)编写feign的客户端
在order-service中新建一个接口,内容如下:
package cn.itcast.order.client; 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; @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)测试
修改order-service中的orderservice类中的queryorderbyid方法,使用feign客户端代替resttemplate:
@autowired private userclient userclient; public order queryorderbyid(long orderid) { // 1.查询订单 order order = ordermapper.findbyid(orderid); // 2.查询用户 user user = userclient.findbyid(order.getuserid()); // 3.封装user信息 order.setuser(user); // 4.返回 return order; }
5)总结
使用feign的步骤:
① 引入依赖
② 添加@enablefeignclients注解
③ 编写feignclient接口
④ 使用feignclient中定义的方法代替resttemplate
2.自定义配置
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即可。
下面以日志为例来演示如何自定义配置。
2.1.配置文件方式
基于配置文件修改feign的日志级别可以针对单个服务:
feign: client: config: userservice: # 针对某个微服务的配置 loggerlevel: full # 日志级别
也可以针对所有服务:
feign: client: config: default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置 loggerlevel: full # 日志级别
而日志的级别分为四种:
- none:不记录任何日志信息,这是默认值。
- basic:仅记录请求的方法,url以及响应状态码和执行时间
- headers:在basic的基础上,额外记录了请求和响应的头信息
- full:记录所有请求和响应的明细,包括头信息、请求体、元数据。
2.2.java代码方式
也可以基于java代码来修改日志级别,先声明一个类,然后声明一个logger.level的对象:
public class defaultfeignconfiguration { @bean public logger.level feignloglevel(){ return logger.level.basic; // 日志级别为basic } }
如果要全局生效,将其放到启动类的@enablefeignclients这个注解中:
@enablefeignclients(defaultconfiguration = defaultfeignconfiguration .class)
如果是局部生效,则把它放到对应的@feignclient这个注解中:
@feignclient(value = "userservice", configuration = defaultfeignconfiguration .class)
3.feign使用优化
feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:
- urlconnection:默认实现,不支持连接池
- apache httpclient :支持连接池
- okhttp:支持连接池
因此提高feign的性能主要手段就是使用连接池代替默认的urlconnection。
这里我们用apache的httpclient来演示。
1)引入依赖
在order-service的pom文件中引入apache的httpclient依赖:
<!--httpclient的依赖 --> <dependency> <groupid>io.github.openfeign</groupid> <artifactid>feign-httpclient</artifactid> </dependency>
2)配置连接池
在order-service的application.yml中添加配置:
feign: client: config: default: # default全局的配置 loggerlevel: basic # 日志级别,basic就是基本的请求和响应信息 httpclient: enabled: true # 开启feign对httpclient的支持 max-connections: 200 # 最大的连接数 max-connections-per-route: 50 # 每个路径的最大连接数
接下来,在feignclientfactorybean中的loadbalance方法中打断点:
总结,feign的优化:
1.日志级别尽量用basic
2.使用httpclient或okhttp代替urlconnection
① 引入feign-httpclient依赖
② 配置文件开启httpclient功能,设置连接池参数
4.最佳实践
4.1.继承方式
一样的代码可以通过继承来共享:
1)定义一个api接口,利用定义方法,并基于springmvc注解做声明。
2)feign客户端和controller都集成改接口
优点:
- 简单
- 实现了代码共享
缺点:
- 服务提供方、服务消费方紧耦合
- 参数列表中的注解映射并不会继承,因此controller中必须再次声明方法、参数列表、注解
4.2.抽取方式
将feign的client抽取为独立模块,并且把接口有关的pojo、默认的feign配置都放到这个模块中,提供给所有消费者使用。
例如,将userclient、user、feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。
4.3.实现基于抽取的最佳实践
1)抽取
首先创建一个module,命名为feign-api:
在feign-api中然后引入feign的starter依赖
<dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-starter-openfeign</artifactid> </dependency>
然后,order-service中编写的userclient、user、defaultfeignconfiguration都复制到feign-api项目中
2)在order-service中使用feign-api
首先,删除order-service中的userclient、user、defaultfeignconfiguration等类或接口。
在order-service的pom文件中中引入feign-api的依赖:
<dependency> <groupid>cn.itcast.demo</groupid> <artifactid>feign-api</artifactid> <version>1.0</version> </dependency>
修改order-service中的所有与上述三个组件有关的导包部分,改成导入feign-api中的包
3)重启测试
重启后,发现服务报错了:
这是因为userclient现在在cn.itcast.feign.clients包下,
而order-service的@enablefeignclients注解是在cn.itcast.order包下,不在同一个包,无法扫描到userclient。
4)解决扫描包问题
方式一:
指定feign应该扫描的包:
@enablefeignclients(basepackages = "cn.itcast.feign.clients")
方式二:
指定需要加载的client接口:
@enablefeignclients(clients = {userclient.class})
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持代码网。
发表评论