OpenFeign快速上手与restTemplate简单比较

最新推荐文章于 2025-06-16 10:16:58 发布

~天下亦有不散之筵席~

最新推荐文章于 2025-06-16 10:16:58 发布

阅读量2.5k

点赞数 1

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/weixin_48646819/article/details/121203446

本文介绍了Spring Cloud OpenFeign的基本概念和使用方法，它提供了一种声明式的Web服务客户端方式，使得调用远程服务如同本地方法调用一样简单。通过实例展示了如何在微服务消费者端配置和使用OpenFeign，并与传统的restTemplate进行比较，强调了OpenFeign在接口管理和代码简洁性上的优势。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

OpenFeign

在使用restTemplate访问远程接口的时候，我们难以将接口管理起来，当接口变动的时候我们可能会修改多处。Spring Cloud 提供OpenFeign来解决这个问题。

(一) OpenFeign简介

OpenFeign是一种声明式、模板化的HTTP客户端。在Spring Cloud中使用OpenFeign，可以做到使用HTTP请求访问远程服务，就像调用本地方法一样的。
需要引入依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<!-- 新版openfeign以不在集成Ribbon，需添加loadbalancer进行负载均衡 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-loadbalancer</artifactId>
    <version>3.0.1</version>
</dependency>

下面是一个例子：

（二）微服务消费者（端口`8080`）：

1.在主程序里添加注解@EnableFeignClients开启Feign客户端：

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class ConsumerApplication {

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

}

2.添加注解@FeignClient，name为微服务名称，@RequestMapping访问路径与以下微服务提供者的访问路径建议一致，编写接口将远程调用同一个微服务的API集中，这样集中化管理API，就可以很方便管理。

@Component
@FeignClient(name = "spring-cloud-pro")
public interface ConsumerrService {
    @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
    String echo(@PathVariable(value = "string") String string);
}

3.编写controller类以远程调用微服务提供者的资源，通过访问http://localhost:8080/echo/2018获得结果。

@RestController
public class TestController {

    @Autowired
    private ConsumerService consumerService;

    @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
    public String echo(@PathVariable String str) {
        return consumerService.echo(str);
    }
}

（三）微服务提供者（端口`8081`）

微服务提供者提供的资源

@RestController
class EchoController {
    @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
    public String echo(@PathVariable(value = "string") String string) {
        return "Hello Nacos Discovery " + string;
    }
}

（四）与restTemplate比较:

使用restTemplate需要注入RestTemplate。

@Configuration
public class RestTConfig {
    @LoadBalanced
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

以下的spring-cloud-order为微服务名称，通过restTemplate去调用微服务，同一个服务提供者的名称可能分布在不同的controller里，或者一个controller里有几个不同的微服务提供者，这会较难去管理。

@RestController
public class TestController {
    @Autowired
    private  RestTemplate restTemplate;

    @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
    public String echo(@PathVariable String str) {
        return restTemplate.getForObject("http://spring-cloud-order/echo/" + str, String.class);
    }
}