前言

本次示例代码的文件结构如下图所示。

1. 导入依赖坐标

在 order-service 的 pom.xml 文件中导入 Feign 的依赖坐标。

<!-- Feign远程调用客户端 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2. 开启Feign自动装配

在 order-service 的启动类上添加注解 @EnableFeignClients ，以开启 Feign 功能。

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

    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
        log.info("订单微服务启动成功");
    }

}

3. 声明远程调用

Feign 采用了 Spring MVC 的注解的方式发起远程调用。只需要把发 HTTP 请求的信息声明在一个接口中，并添加注解 @FeignClient("微服务名称") ，Feign 就会自动为我们发起 HTTP 请求。通常需要声明的信息如下。

声明的信息值
微服务名称 userservice
请求方式 GET
请求路径 /user/{id}
请求参数 Long id
返回值类型 User
下面的代码示例演示了订单微服务 order-service 向用户微服务 user-service 发起【根据用户 ID 查询用户】的远程调用。

声明的信息	值
微服务名称	`userservice`
请求方式	`GET`
请求路径	`/user/{id}`
请求参数	`Long id`
返回值类型	`User`

clients/UserClient.java

@FeignClient("userservice")
public interface UserClient {

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

}

4. 替代RestTemplate

下面代码示例展示了使用 Feign 之前，使用 RestTemplate 发起远程调用。

@Service
public class OrderService {

    @Autowired
    private OrderMapper orderMapper;
    // 自动注入RestTemplate，用于发起HTTP请求远程调用
    @Autowired
    private RestTemplate restTemplate;

    public Order queryOrderById(Long orderId) {
        // 1.查询订单
        Order order = orderMapper.findById(orderId);
        // 2.使用RestTemplate发起HTTP请求，查询订单所属用户信息
        // 2.1 根据查询的订单order中的userId动态生成HTTP请求的url
        String url = "http://userservice/user/" + order.getUserId();
        // 2.2 发送HTTP请求，实现远程调用
        User user = restTemplate.getForObject(url, User.class);
        // 3.把远程调用获得的user封装进order对象中
        order.setUser(user);
        // 4.返回order订单信息
        return order;
    }
    
}

使用 Feign 之后，首先把 UserClient 接口自动注入 OrderService.java ，代码示例如下图所示。

@Service
public class OrderService {

    @Autowired
    private OrderMapper orderMapper;
    // 自动注入userservice的Feign客户端，用于发起HTTP请求远程调用
    @Autowired
    private UserClient userClient;

    public Order queryOrderById(Long orderId) {
        // 1.查询订单
        Order order = orderMapper.findById(orderId);
        // 2.使用Feign客户端发起HTTP请求，查询订单所属用户信息
        User user = userClient.getById(order.getUserId());
        // 3.把远程调用获得的user封装进order对象中
        order.setUser(user);
        // 4.返回order订单信息
        return order;
    }
}