微服务之feign篇

1 http客户端Feign

1.1 Feign介绍

先来看我们以前利用RestTemplate发起远程调用的代码：

User user = restTemplate.getForObject("http://scenic-user/user/"+orderInfo.getUserId(), User.class);

存在下面的问题：

• 代码可读性差，编程体验不统一
• 参数复杂URL难以维护

上面RestTemplate存在的问题可以使用Feign解决，那么什么是Feign？

Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

1.2 Feign入门案例

使用order服务调用user服务

定义和使用Feign客户端的步骤如下：

1:引入依赖包 spring-cloud-starter-openfeign
2:添加注解@EnableFeignClients开启Feign功能
3:消费者端定义远程调用接口，在接口中远程调用的【服务名字】、【方法签名】
4:消费者端注入接口，执行远程调用(接口)

① 引入依赖

在order中引入如下依赖：

<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-openfeignartifactId>
dependency>

② 开启Feign功能

在order的启动类OrderApplication添加@EnableFeignClients注解开启Feign功能，代码如下：

@SpringBootApplication
@EnableFeignClients
public class OrderApplication {

    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }
    //...其他略
}

③ 定义远程调用接口

在order中创建接口UserClient
上图代码如下：在order工程中添加

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

/**
 * order调用user服务(代替了 String url = "http://user/user/" + orderInfo.getUserId();)
 * 1.接口上使用@FeignClient(value="被调用服务名")
 * 2.定义被调用接口中的方法（基于被调用的controller编写）
 *  2.1 requestMapping中的路径必须是全路径(controller类上的+方法上的)
 *  2.2 使用PathVariable注解，必须取别名
 */
@FeignClient(value = "user")
public interface UserClient {

    /**
     * 调用用户微服中controller的方法
     */
    @GetMapping(value = "/user/{id}")
    public User one(@PathVariable(value = "id") Long id);
}

主要是基于SpringMVC的注解来声明远程调用的信息，比如：

• 服务名称：user
• 请求方式：GET
• 请求路径：/user/{username}
• 请求参数：String username
• 返回值类型：User

④ 远程调用

修改order的OrderServiceImpl.one()方法，执行远程调用，代码如下：

@Autowired
private UserClient userClient;

/**
 * 根据ID查询订单信息
 */
@Override
public OrderInfo findById(Long id) {
    //1.查询订单
    OrderInfo orderInfo = orderDao.selectById(id);
    //2.根据订单查询用户信息->需要调用  【item-user】  服务
    User user = userClient.one(orderInfo.getUserId());
    //3.封装user
    orderInfo.setUser(user);
    //4.返回订单信息
    return orderInfo;
}

使用接口去调用方法

2.3 Feign其他功能

Feign运行自定义配置来覆盖默认配置，可以修改的配置如下：

类型	作用	说明
feign.Logger.Level	修改日志级别	包含四种不同的级别：NONE、BASIC、HEADERS、FULL
feign.codec.Decoder	响应结果的解析器	http远程调用的结果做解析，例如解析json字符串为java对象
feign.codec.Encoder	请求参数编码	将请求参数编码，便于通过http请求发送
feign. Contract	支持的注解格式	默认是SpringMVC的注解
feign. Retryer	失败重试机制	请求失败的重试机制，默认是没有，不过会使用Ribbon的重试

NONE:默认的，不显示任何日志
BASIC:仅记录请求方法、URL、响应状态码以及执行时间
HEADERS:除了BASIC中定义的信息以外，还有请求和响应的头信息
FULL:除了HEADERS中定义的信息之外，还有请求和响应的正文及元数据

SpringBoot日志配置;

2.3.1 Feign日志配置

要想让Feign日志生效，得结合着SpringBoot的日志配置一起使用

SpringBoot日志配置

logging:
  pattern:
    # 输出到控制台
    console: '%d{HH:mm:ss} %-5level %msg [%thread] - %logger{15}%n\'
  level:
    root: info # 全局用info
    # 只有在相同包下才输出debug信息
    com:
      it: debug

配置Feign日志有两种方式：

• 配置文件方式

  • 全局生效

    feign:
      client:
        config:
          default: #这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
            loggerLevel: HEADERS #日志级别
    

  • 局部生效

    feign:
      client:
        config:
          user: #指定服务
            loggerLevel: HEADERS #日志级别
    

• 代码方式

  • 注册日志级别

    /**
     * 注册日志级别
     * @return
     */
    @Bean
    public Logger.Level feignLogLevel() {
        return Logger.Level.FULL;
    }
    

  • 全局生效

    #如果是全局配置，则把它放到@EnableFeignClients这个注解中
    @EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
    

  • 局部生效

    #如果是局部配置，则把它放到@FeignClient这个注解中
    @FeignClient(value = "user",configuration = FeignClientConfiguration.class)
    

2.3.2 Feign性能优化

Feign底层的客户端实现：

• URLConnection：默认实现，不支持连接池
• Apache HttpClient ：支持连接池
• OKHttp：支持连接池

因此优化Feign的性能主要包括：

• 使用连接池代替默认的URLConnection
• 日志级别，最好用basic或none

Feign切换Apache HttpClient步骤如下：

1:引入依赖
2:配置连接池

1)引入依赖

在order中引入如下依赖：

<dependency>
    <groupId>io.github.openfeigngroupId>
    <artifactId>feign-httpclientartifactId>
dependency>

2)配置连接池

在order的核心配置文件application.yml中添加如下配置：

feign:
  client:
    config:
      default: #这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: BASIC #日志级别
        user: #指定服务
        loggerLevel: BASIC #日志级别
  httpclient:
    enabled: true #开启feign对HttpClient的支持
    max-connections: 200 #最大的连接数
    max-connections-per-route: 50 #每个路径的最大连接数

2.3.3 Feign最佳实现

方式一（继承）：给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。

• 服务紧耦合
• 父接口参数列表中的映射不会被继承

方式二（抽取）：将FeignClient抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用

Feign最佳实现流程如上图所示：

4:重启测试

1)引入依赖

创建api，然后引入feign的starter依赖 user依赖

<dependencies>
     
     <dependency>
         <groupId>org.springframework.cloudgroupId>
         <artifactId>spring-cloud-starter-openfeignartifactId>
     dependency>

     
     <dependency>
         <groupId>io.github.openfeigngroupId>
         <artifactId>feign-httpclientartifactId>
     dependency>

     <dependency>
         <groupId>com.aotaingroupId>
         <artifactId>aotain-pojoartifactId>
         <version>1.0-SNAPSHOTversion>
     dependency>
dependencies>

2)编写的UserClient

将order中编写的UserClient复制到api项目中

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

/**
 * order调用user服务(代替了 String url = "http://user/user/" + orderInfo.getUserId();)
 * 1.接口上使用@FeignClient(value="被调用服务名")
 * 2.定义被调用接口中的方法（基于被调用的controller编写）
 *  2.1 requestMapping中的路径必须是全路径(controller类上的+方法上的)
 *  2.2 使用PathVariable注解，必须取别名
 */
@FeignClient(value = "user")
public interface UserClient {

    /**
     * 调用用户微服中controller的方法
     */
    @GetMapping(value = "/user/{id}")
    public User one(@PathVariable(value = "id") Long id);
}

3)在order中引入api的依赖

<dependency>
    <groupId>com.aotaingroupId>
    <artifactId>aotain-apiartifactId>
    <version>1.0-SNAPSHOTversion>
dependency>

4. 【注意】当定义的FeignClient不在SpringBootApplication的扫描包范围时，这些FeignClient无法使用。

有两种方式解决：
方式一：指定FeignClient所在包

@EnableFeignClients(basePackages = "com.leannews.user.feign")

方式二：指定FeignClient字节码

@EnableFeignClients(clients = {UserClient.class})

5.3.4. 总结

• Feign的使用步骤

  • 引入依赖
  • 启动类添加@EnableFeignClients注解，如果feignclient接口不在启动类包下，则需要添加扫包(basePackages )
  • 编写FeignClient接口
  • 使用FeignClient中定义的方法代替RestTemplate

• Feign的日志配置:

  • 方式一是配置文件，feign.client.config.xxx.loggerLevel
  • 如果xxx是default则代表全局
  • 如果xxx是服务名称，例如userservice则代表某服务

• 方式二是java代码配置Logger.Level这个Bean

  • 如果在@EnableFeignClients注解声明则代表全局
  • 如果在@FeignClient注解中声明则代表某服务

• Feign的优化

  • 日志级别尽量用basic
  • 使用HttpClient或OKHttp代替URLConnection
    • 引入feign-httpClient依赖
    • 配置文件开启httpClient功能，设置连接池参数

• Feign的最佳实践：

  • 让controller和FeignClient继承同一接口
  • 将FeignClient、POJO、Feign的默认配置都定义到一个项目中，供所有消费者使用

总结

1. 微服务，为什么使用微服务。为了更高的并发。

   • 单体
   • 分布式
   • 微服务 属于分布式

2. 远程调用案例

   • 订单服务
   • 用户服务
   • 怎么调用? 用RestTemplate(??? 发请求的postman)
   • 问题： 服务单点问题（订单只能依赖于用户，localhost:18081/user/1)

3. Eureka 注册中心(房产中介、美团、饿了么), 解决服务单点问题

   • 是个什么 注册中心。 提供者、消费者
   • 有什么作用 解决服务单点问题
   • 使用: 平台。
     • 启动： 依赖、启动类、配置文件
     • 提供者: 注册
     • 消费者: 注册
     • 远程调用: 获取提供者列表、通过负载均衡的方式来调用。 使用localhost:18081改为user，开启负载均衡(restTemplate @LoadBalanced)

4. ribbon 做负载均衡

   • 使用：IRule， 默认使用ZoneAvoidanceRule
   • 配置：
     • 全局 配置类
     • 局部 配置文件 指定服务提供都负载均衡方式
   • 饥饿加载, 配置

5. OpenFeign

   • 是什么？ 代替restTemplate

   • 使用?

     • 导入依赖，启动类开启注解，消费者创建接口(方法：服务提供者controller的方法, 全路径)，使用的注入

     • @FeignClient(name=服务提供者名称)

     • 优化：使用httpclient配置连接池（线程隔离）

     • 日志：BASIC

   最佳远程调用方法

   • 抽取Feign的接口独立为工程。其它服务想调用时，引入依赖
     如：调用远程的自媒体微服务

操作步骤如下：

(1) 添加依赖

(2) 创建feign接口

(3) 实现feign接口（业务实现）

(4) 调用Feign接口实现创建自媒体账号

(1) 添加依赖

        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-starter-openfeignartifactId>
        dependency>

（2）在API的独立工程下建立自媒体调用接口

代码如下

/**
 * @version 1.0
 * @description 自媒体用户信息的远程调用
 * @package com.aotain.wemedia.feign
 *
 * contextId: 在消费者 做动态代理对象存入spring容器中的id|name
 * 默认使用微服的名称
 */
@FeignClient(name = "leadnews-wemedia", contextId = "wmUserFeign")
public interface WmUserFeign {

    /**
     * 通过app用户id查询自媒体帐号信息
     * @param apUserId
     * @return
     */
    @GetMapping("/api/wmUser/getByApUserId/{apUserId}")
    ResultVo<WmUser> getByApUserId(@PathVariable(value = "apUserId") Long apUserId);

    /**
     * 添加自媒体帐号
     * @param wmUser
     * @return
     */
    @PostMapping("/api/wmUser/add")
    ResultVo<WmUser> addWmUser(@RequestBody WmUser wmUser);
}

（3） 在服务提供方：自媒体微服务中实现feign接口

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

/**
 * @version 1.0
 * @description 说明
 * @package com.aotain.wemedia.controller
 */
@RestController
public class ApiController {

    @Autowired
    private WmUserService wmUserService;

    /**
     * 远程调用添加自媒体账号
     * @param wmUser
     * @return
     */
    @PostMapping("/api/wmUser/add")
    public ResultVo<WmUser> add(@RequestBody WmUser wmUser) {
        wmUserService.save(wmUser);
        return ResultVo.ok(wmUser);
    }

    /**
     * 通appUserId查询自媒体账号信息
     * @param appUserId
     * @return
     */
    @GetMapping("/api/wmUser/{appUserId}")
    public ResultVo<WmUser> getByAppUserId(@PathVariable(name = "appUserId") Integer appUserId){
        WmUser wmUser = wmUserService.getByAppUserId(appUserId);
        return ResultVo.ok(wmUser);
    }
}

(4)调用Feign接口实现创建自媒体账号

leadnews-service-user微服中添加使用到的依赖并Feign开启接口扫描：

在消费方提供API依赖

<dependency>
    <groupId>com.aotaingroupId>
    <artifactId>leadnews-wemedia-apiartifactId>
    <version>1.0-SNAPSHOTversion>
dependency>

然后在启动类上打上注解开启远程调用功能
@EnableFeignClients(basePackages = “com.aotain.*.feign”)

总结

远程调用的操作步骤：

1. 创建feign接口

2. 服务提供方创建controller方法

3. 服务提供方service实现

4. 消费者端
   4.1 添加pom依赖
   4.2 开启扫feign包
   4.3 业务层中注入feign接口，调用