Feign远程调用

1.Feign简介

• Feign是Spring Cloud提供的一个声明式的伪Http客户端， 它使得调用远程服务就像调用本地服务一样简单， 只需要创建一个接口并添加一个注解即可。

2.Feign的使用

1. 引入依赖，在order-service服务的pom文件中引入feign的依赖

        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-starter-openfeignartifactId>
        dependency>
1
2
3
4
5

2. 添加注解，在order-service的启动类添加注解开启Feign的功能

@MapperScan("cn.zyj.order.mapper")
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {

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

    /**
     * 创建 RestTemplate 并注入 Spring 容器
     * @return
     */
    @Bean
    @LoadBalanced
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

3. 编写Feign的客户端，在order-service中新建一个接口

@FeignClient("user-service")
public interface UserClient {

    @GetMapping("/user/{id}")
    User findById(@PathVariable Long id);

}
/**
 * 服务名称：userservice
 * 请求方式：GET
 * 请求路径：/user/{id}
 * 请求参数：Long id
 * 返回值类型：User
**/
1
2
3
4
5
6
7
8
9
10
11
12
13
14

4. 调用

@Service
public class OrderService {
    @Autowired
    private OrderMapper orderMapper;
    @Autowired
    private UserClient userClient;

    public Order queryOrderById(Long orderId) {
        // 1.查询订单
        Order order = orderMapper.findById(orderId);
        
       //2.用feign远程调用
        User user = userClient.findById(order.getUserId());
        
        //3. 封装 user 到 Order
        order.setUser(user);
        // 4.返回
        return order;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

3.自定义配置

1. 配置方式一：配置文件方式

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

日志的级别分为四种：

• NONE：不记录任何日志信息，这是默认值。
• BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
• HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
• FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

2. 配置方式二：Java代码方式

• 局部生效

​ 声明一个类，然后声明一个Logger.Level的对象：

public class DefaultFeignConfiguration {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}
1
2
3
4
5
6

​ 修改@FeignClient注解

@FeignClient(value = "user-service", configuration = DefaultFeignConfiguration .class) 
1

• 全局生效

​ 修改启动类的@EnableFeignClients注解

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class) 
1

4.Feign使用优化

• Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：

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

• 提高Feign的性能主要手段就是使用连接池代替默认的URLConnection，日志级别尽量用basic

• 使用方法

1. 引入依赖，在order-service的pom文件中引入Apache的HttpClient依赖

 
        <dependency>
            <groupId>io.github.openfeigngroupId>
            <artifactId>feign-httpclientartifactId>
        dependency>
1
2
3
4
5

2. 配置连接池，在order-service的application.yml中添加配置

feign:
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数
1
2
3
4
5

5.Feign最佳使用方式

• 抽取方式

1. 抽取，创建一个module，命名为feign-api

2. 在feign-api中引入feign的starter依赖

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-starter-openfeignartifactId>
        dependency>
    dependencies>
1
2
3
4
5
6

3. order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

• UserClient

@FeignClient("user-service")
public interface UserClient {

    @GetMapping("/user/{id}")
    User findById(@PathVariable Long id);

}
1
2
3
4
5
6
7

• User

@Data
public class User {
    private Long id;
    private String username;
    private String address;
}
1
2
3
4
5
6

• DefaultFeignConfiguration

public class DefaultFeignConfiguration {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}
1
2
3
4
5
6

4. 在order-service中使用feign-api，在order-service的pom文件中中引入feign-api的依赖并修改有关导包代码

        <dependency>
            <groupId>cn.zyj.demo</groupId>
            <artifactId>feign-api</artifactId>
            <version>1.0</version>
        </dependency>
1
2
3
4
5

5. 解决扫描包问题

• 指定Feign应该扫描的包

@EnableFeignClients(basePackages = "cn.zyj.feign.clients")
1

• 指定需要加载的Client接口

@EnableFeignClients(clients = {UserClient.class})
1