正文

springcloud：使用feign实现声明式rest调用

 2022-03-20  496

关键词：

一、简介

前面我们是使用RestTemplate实现rest api调用的，代码如下：

@GetMapping("/user/{id}")
public User findById(@PathVariable Long id) throws Exception {
    return  this.restTemplate.getForObject("http://spring-ribbon-eureka-client2/" + id, User.class);
}

由上代码可知，我们是使用拼接URI的，如果参数过多，就会很麻烦了，解决的方式就是采用Feign。

Feign是Netflix开发的声明式、模板化的HTTP客户端，Feign可帮助我们更便捷、优雅的调用HTTP API。

Spring cloud对Feign进行了增强，是Feign支持了SpringMVC注解，并整合了Ribbon和Eureka。

二、为服务消费者整合Feign

2.1、添加依赖

<dependency>
   <groupId>org.springframework.cloud</groupId>
   <artifactId>spring-cloud-starter-feign</artifactId>
</dependency>

2.2、创建一个Feign接口，并添加@FeignClient注解

package com.example.demo.feign;

import com.example.demo.pojo.User;
import org.springframework.cloud.netflix.feign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

/**
 * 描述
 *
 * @Author: 我爱大金子
 * @Description: 描述
 * @Date: Create in 10:14 2017/7/17
 */
@FeignClient(name = "spring-ribbon-eureka-client2")
public interface UserFeignClient {
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    public User findById(@PathVariable("id") Long id) throws Exception;
}

说明：

1、@FeignClient注解中的spring-ribbon-eureka-client2是一个任意的客户端名称，用于创建Ribbon负载均衡器。

2、由于这实例使用了Eureka，所以Ribbon会把spring-ribbon-eureka-client2解析成Eureka Server服务注册表中的服务。

3、如果不想使用Eureka，可使用service.ribbon.listOfServers属性配置服务器列表。

2.3、在Controller中添加feign

@RestController
public class UserController {
    @Autowired
    private UserFeignClient userFeignClient;

    @GetMapping("/user/{id}")
    public User findById(@PathVariable Long id) throws Exception {
        if (null == id) {
            return null;
        }
        return  this.userFeignClient.findById(id);
    }
}

2.4、修改启动类，为其添加@EnableFeignClients注解

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.feign.EnableFeignClients;

@EnableEurekaClient
@EnableFeignClients
@SpringBootApplication
public class SpringFeignConsumerApplication {

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

三、自定义Feign配置

在Spring Cloud中，Feign的默认配置类是FeignClientsConfiguration，该类定义了Feign默认使用的编码器、解码器、所使用的契约等。

Spring Cloud允许通过注解@FeignClient的configura属性自定义Feign的配置，自定义配置的优先级比FeignClientsConfiguration要高。

另外，有的配置尽管没有提供默认值，但是spirng也会扫描其中列出的类型（也就是说，这部分配置也可以自定义）

例：自定义Feign的配置，让它使用Feign自带的注解进行工作。

注意：代码是基于上面工程的基础上

3.1、创建Feign的配置类

package com.example.demo.config;

import com.example.demo.ExcludeFromComponentScan;
import feign.Contract;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Feign的配置类
 * 注意：此类不该在主应用程序上下文的@ComponetScan中
 * @Author: 我爱大金子
 * @Description: Feign的配置类
 * @Date: Create in 15:57 2017/7/17
 */
@Configuration
@ExcludeFromComponentScan
public class FeignConfiguration {
    /**
     * 将契约改为feign原生的默认契约。这样就可以使用feign自带的注解了
     * @Author: 我爱大金子
     * @Description: 将契约改为feign原生的默认契约。这样就可以使用feign自带的注解了
     * @Date: 16:02 2017/7/17
     * @return 默认的feign契约
     */
    @Bean
    public Contract feignContract() {
        return new Contract.Default();
    }
}

package com.example.demo;

public @interface ExcludeFromComponentScan {

}

3.2、修改Feign接口

package com.example.demo.feign;

import com.example.demo.config.FeignConfiguration;
import com.example.demo.pojo.User;
import feign.Param;
import feign.RequestLine;
import org.springframework.cloud.netflix.feign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

/**
 * 描述
 *
 * @Author: 我爱大金子
 * @Description: 描述
 * @Date: Create in 10:14 2017/7/17
 */
@FeignClient(name = "spring-ribbon-eureka-client2", configuration = FeignConfiguration.class)
public interface UserFeignClient {

    /**
     * 使用feign自带的注解@RequestLine
     * @Author: 我爱大金子
     * @Description: 使用feign自带的注解@RequestLine
     * @Date: 17:42 2017/7/17
     * @param id 用户id
     * @return 用户信息
     * @throws Exception
     */
    @RequestLine("GET /{id}")
    public User findById(@Param("id") Long id) throws Exception;
}

OK了

3.3、测试

访问：http://localhost:8086/user/1

类似的，还可以自定义Feign的编码器、解码器、日志打印，甚至为Feign添加拦截器。

例如，一些接口需要进行基于Http Basic的认证后才能调用，配置类可以这样写：

@Configuration
@ExcludeFromComponentScan
public class FeignConfiguration {
    @Bean
    public BasicAuthRuestInterceptor basicAuthRuestInterceptor() {
        return new BasicAuthRuestInterceptor("user","password");
    }
}

未完，待续...

本文出自 “我爱大金子” 博客，请务必保留此出处http://1754966750.blog.51cto.com/7455444/1948303

springcloud声明式服务调用：feign

Feign介绍Feign是一个声明式的REST客户端，它用了基于接口的注解方式，可以很方便地实现客户端配置。Feign最初由Netflix公司提供，但最初不支持SpringMVC注解，后由SpringCloud对其封装，才支持了SpringMVC注解，让使用者更易于接受查看详情

springcloud（10）：使用feign实现声明式rest调用-构造多参数请求

请求多参数的URL假设请求的URL包含多个参数，如:http://localhost:8086/user1?id=1&username=nihao 1.1、Feign接口@FeignClient(name = "spring-ribbon-eureka-client2")public interface UserFeignClient&nb 查看详情

springcloud——feign声明式服务调用(代码片段)

什么是FeignFeign是SpringCloudNetflix组件中的一个轻量级RESTFUL和HTTP服务客户端，实现了负载均衡和Rest调用的开源框架，封装了Ribbon和RestTemplate，实现了webService的面向接口编程，进一步降低了项目的耦合度。是一种声... 查看详情

springcloud第七篇|声明式服务调用feign

本文是SpringCloud专栏的第七篇文章，了解前六篇文章内容有助于更好的理解本文：SpringCloud第一篇|SpringCloud前言及其常用组件介绍概览SpringCloud第二篇|使用并认识Eureka注册中心SpringCloud第三篇|搭建高可用Eureka注册中心SpringCloud第四... 查看详情

springcloud入门教程：用声明式rest客户端feign调用远端http服务

首先简单解释一下什么是声明式实现？要做一件事，需要知道三个要素，where,what,how。即在哪里（where）用什么办法（how）做什么（what）。什么时候做（when）我们纳入how的范畴。1）编程式实现：每一个要素（where，what，how）都... 查看详情

springcloud——feign声明式服务调用(代码片段)

springcloud（10）——声明式的rest客户端feign(代码片段)

声明式的Rest客户端Feign是一个声明式的Rest客户端，它可以跟SpringMVC的相关注解一起使用，也可以使用SpringWeb的HttpMessageConverter进行请求或响应内容的编解码。其底层使用的Ribbon和Eureka，从而拥有客户端负载均衡的功能。使用它需... 查看详情

springcloud----服务消费与负载均衡（feign）

　　feign是一个声明式的伪客户端，只需要创建一个接口并且注解，它具有可插拔的特性。feign集合了Ribbon，再与Eurake结合实现服务的注册发现与负载均衡。结合Hystrix,具有熔断功能。　　1.使用步骤首先引入feign，eureka,hystrix的jar... 查看详情

springcloud无废话入门03：feign声明式服务调用

1.Feign概述在上一篇的HelloService这个类中，我们有这样一行代码： returnrestTemplate.getForObject("http://hello-service/hello",String.class); 查看详情

使用feign实现声明式rest调用(代码片段)

使用Feign实现声明式REST调用之前示例中是使用RestTemplate实现RESTAPI调用的，代码大致如下： publicUserfindById(@PathVariableLongid)returnthis.restTemplate.getForObject("http://microservice-provider-user/"&# 查看详情

feign(代码片段)

...格(RestTemplate)，这种调用方式违背了程序员的思维。后来springcloud提供了另外一种符合程序员思维的调用方式：声明式服务调用(Feign)1.feign虽然springcloud把他定义为声明式服务调用，但他仍然是一个负载均衡(换句话说，也可以实现... 查看详情

springcloud系列四feign远程调用服务

一：Feign简介Feign是一种声明式、模板化的HTTP客户端，在SpringCloud中使用Feign，可以做到使用HTTP请求远程服务时能与调用本地方法一样的编码体验，开发者完全感知不到这是远程方法，更感知不到这是个HTTP请求。Feign的灵感来源... 查看详情

springcloud学习--feign

...eign注解和JAX-RS注解、Feign还支持可插拔编码器和解码器、SpringCloud增加了对SpringMVC注释的支持，并HttpMessageConverters在SpringWeb中使用了默认使用的相同方式。SpringCloud集成了Ribb 查看详情

springcloud(hoxton.sr3)基础篇：第六章feign声明式服务调用

一、Feign简介　　在前面的文章中可以发现当我们通过RestTemplate调用其它服务的API时，所需要的参数须在请求的URL中进行拼接，如果参数少的话或许我们还可以忍受，一旦有多个参数的话，这时拼接请求字符串就会效率低下　　... 查看详情

springcloud：服务调用-声明式客户端访问

环境springcloudEdgware.SR6jdk7sts4.6.0mysql5.7背景通过声明式客户端openfeign进行支付微服务的访问。搭建步骤只需要修改支付服务调用层，增加依赖就可以了。支付服务调用层只需要定义接口，不需要进行实现。packagejiangbo.springcloud.dao;im... 查看详情

springcloud之feign客户端

...eign注释和JAX-RS注释。Feign还支持可插拔编码器和解码器。SpringCloud增加了对SpringMVC注释的支持，并使用SpringWeb中默认使用的HttpMessageConverters。SpringCloud集成Ribbon和查看详情

springcloud-feign

...JAX-RS标准的注解.Feign也支持可拔插式的编码器和解码器.SpringCloud对Feign进行了封装,使其支查看详情