OpenFeign快速上手 与restTemplate简单比较
在使用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类以远程调用微服务提供者的资源,通过访问获得结果。
@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); } }