解决Feign调用的GET参数传递的问题

目录
  • 需求
  • 思考
    • GET方式请求①
    • GET方式请求②
    • GET方式请求③

需求

​ 在消费方服务通过GET方式,访问服务提供方的接口,需要传递多参数,拆分成多个参数的方式访问,不太适合用在该场景,需要改造成合适的方式调用服务方的接口

思考

拆分成多个参数时,若GET请求的参数超过3个及以上时,便不适用该种方式请求服务,因为这样传递参数过于臃肿,可读性也比较差;

若改造成POST请求的方式,虽然解决参数过多的问题,但是也带来了其他的开销,参数被放到了body里面,然后请求到服务方提供的接口,服务方的接口也改造成了POST方式,改变了原来的GET方式调用的初衷,不太友好;

​ 可以在消费方调用Feign接口时,参数封装到body中,在组装Feign接口请求时,将body里面的参数取出来,转换为GET方式请求的参数,请求body的参数,然后发起请求,实现了GET方式访问服务方提供的接口;

以下是这三种调用方式的具体实现,可以根据适合自己的业务场景去使用,选择不同的方式请求调用:

GET方式请求①

请求DTO对象:

package com.springcloud.pojo; 
import java.util.Date;  
public class Requets01DTO { 
    private Date startTime; 
    private Date endTime; 
    private String message;
 
    @Override
    public String toString() {
        return "Requets01DTO{" +
                "startTime=" + startTime +
                ", endTime=" + endTime +
                ", message='" + message + '\'' +
                '}';
    }
 
    public Date getStartTime() {
        return startTime;
    }
 
    public void setStartTime(Date startTime) {
        this.startTime = startTime;
    }
 
    public Date getEndTime() {
        return endTime;
    }
 
    public void setEndTime(Date endTime) {
        this.endTime = endTime;
    }
 
    public String getMessage() {
        return message;
    }
 
    public void setMessage(String message) {
        this.message = message;
    }
}

消费方的请求:

    @Autowired
    GetClient01 getClient01;
 
    @GetMapping("/request/get/01")
    public String requestGetOne(Requets01DTO requets01DTO) {
        return getClient01.queryDataByGetRequest(requets01DTO.getStartTime(), requets01DTO.getEndTime(), requets01DTO.getMessage());
    }

Feign接口:

package com.springcloud.service; 
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam; 
import java.util.Date;
 
@FeignClient(value = "provider-8762", contextId = "GetClient01")
public interface GetClient01 {
 
    /**
     * GET方式请求①
     *
     * @param startTime
     * @param endTime
     * @param message
     * @return
     */
    @GetMapping("/get/01")
    String queryDataByGetRequest(@RequestParam("startTime") Date startTime, @RequestParam("endTime") Date endTime,
                                 @RequestParam("message") String message);
}

服务提供方:

@RestController
public class RequestProviderController {
 
    @GetMapping("/get/01")
    public String queryDataByGetRequest(@RequestParam("startTime") Date startTime, @RequestParam("endTime") Date endTime,
                                        @RequestParam("message") String message) {
        Requets01DTO requets01DTO = new Requets01DTO();
        requets01DTO.setStartTime(startTime);
        requets01DTO.setEndTime(endTime);
        requets01DTO.setMessage(message);
        return requets01DTO.toString();
    }
}

请求结果截图:

GET方式请求②

Feign调用的请求改为POST方式

消费方的请求:

    @Autowired
    GetClient02 getClient02;
 
    @GetMapping("/request/get/02")
    public String requestGetTwo(Requets01DTO requets01DTO) {
        return getClient02.queryDataByGetRequest(requets01DTO);
    }

Feign接口:

package com.springcloud.service; 
import com.springcloud.pojo.Requets01DTO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PostMapping;
 
@FeignClient(value = "provider-8762", contextId = "GetClient02")
public interface GetClient02 { 
 
    /**
     * GET方式请求②(Feign调用的请求改为POST方式)
     *
     * @param requets01DTO
     * @return
     */
    @PostMapping("/post/02")
    String queryDataByGetRequest(Requets01DTO requets01DTO);
}

服务提供方:

    @PostMapping("/post/02")
    public String queryDataByGetRequest(@RequestBody Requets01DTO requets01DTO) {
        return requets01DTO.toString();
    }

请求结果截图:

GET方式请求③

组装Feign接口请求时,将body里面的参数取出来,转换为GET方式请求的参数

添加Feign请求的配置类:

package com.springcloud.config; 
import com.alibaba.fastjson.JSON;
import feign.Request;
import feign.RequestInterceptor;
import feign.RequestTemplate;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpMethod;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
 
import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Field;
import java.util.*;
 
@Configuration
public class FeignConfiguration implements RequestInterceptor {
 
    @Override
    public void apply(RequestTemplate requestTemplate) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
 
        //填充get中的body数据转化成query数据
        if (requestTemplate.method().equals(HttpMethod.GET.name()) && Objects.nonNull(requestTemplate.body())) {
            String json = requestTemplate.requestBody().asString();
            Map<String, Object> map = JSON.parseObject(json);
            Set<String> set = map.keySet();
            Iterator<String> it = set.iterator();
            while (it.hasNext()) {
                String key = it.next();
                Object values = map.get(key);
                if (Objects.nonNull(values)) {
                    // 将body的参数写入queries
                    requestTemplate.query(key, values.toString());
                }
            }
 
            try{
                Class requestClass = requestTemplate.getClass();
                Field field = requestClass.getDeclaredField("body");
                field.setAccessible(true);
                //修改body为空。
                field.set(requestTemplate, Request.Body.empty());
            } catch (Exception ex) {
                System.out.println(ex.fillInStackTrace());
            } 
        }
 
        Enumeration<String> headerNames = request.getHeaderNames();
        if (headerNames != null) {
            while (headerNames.hasMoreElements()) {
                String name = headerNames.nextElement();
                String values = request.getHeader(name);
                // 跳过 content-length
                if (name.equals("content-length")){
                    continue;
                }
                requestTemplate.header(name, values);
            }
        } else {
            System.out.println(String.format("feign interceptor error header:%s", requestTemplate));
        }
    }
}

添加fastJson的maven依赖:

<!-- JSON 解析器和生成器 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.74</version>
        </dependency>

消费方的请求:

    @Autowired
    GetClient03 getClient03;
 
    @GetMapping("/request/get/03")
    public String requestGetThree(Requets01DTO requets01DTO) {
        return getClient03.queryDataByGetRequest(requets01DTO);
    }

Feign接口:

package com.springcloud.service; 
import com.springcloud.config.FeignConfiguration;
import com.springcloud.pojo.Requets01DTO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
 
@FeignClient(value = "provider-8762", contextId = "GetClient03", configuration = FeignConfiguration.class)
public interface GetClient03 {
 
    /**
     * GET方式请求③(组装Feign接口请求时,将body里面的参数取出来,转换为GET方式请求的参数)
     *
     * @param requets01DTO
     * @return
     */
    @GetMapping("/get/03")
    String queryDataByGetRequest(Requets01DTO requets01DTO);
}

服务提供方:

    @GetMapping("/get/03")
    public String queryDataByGetRequest03(Requets01DTO requets01DTO) {
        return requets01DTO.toString();
    }

请求结果截图:

Feign调用传递的GET参数日期,要指定jsonFormat注解,body转GET参数时,日期参数会变为字符串,需要指定日期格式

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date startTime;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date endTime;

**结果截图:**

以上为个人经验,希望能给大家一个参考,也希望大家多多支持我们。

(0)

相关推荐

  • Spring cloud restTemplate 传递复杂参数的方式(多个对象)

    使用微服务的时候往往服务之间调用比较麻烦,spring cloud提供了Feign接口调用,RestTemplate调用的方式 这里我探讨下RestTemplate调用的方式: 服务A:接收三个对象参数  这三个参数的是通过数据库查询出来的 服务B:要调用服务A 服务B提供了查询三个参数的方法,后面要使用三个参数 对于服务A,处理的方式有两中 1. 服务B提供一个Feign接口将查询三个参数的方法公开,服务A直接引用Feign来查询参数,服务B只需要将三个查询关键字传递过去即可 服务A acti

  • 解决SpringCloud Feign传对象参数调用失败的问题

    SpringCloud Feign传对象参数调用失败 不支持GET请求方式 使用Apache HttpClient替换Feign原生httpclient @RequestBody接收json参数 bootstrap-local.yml feign: httpclient: enabled: true pom.xml <!-- 使用Apache HttpClient替换Feign原生httpclient --> <dependency> <groupId>com.netf

  • feign实现传递参数的三种方式小结

    需要注意的一点是,feign好像是无法传递list集合类型的,但是你可以通过传递对象类型,然后在接收方再次将对象装在集合中达到集合传递的效果 传递方式一:传递的都是基本数据类型 restful风格参数,用@PathVariable写着走就行了 传递方式二:传递数组类型的参数 不使用restful风格,直接用@RequestParam声明参数之间的对应关系. 传递方式三:传递带有对象的参数 1.使用restful风格的参数要用@Pathvarible声明参数对应关系,@Pathvariable用于

  • 解决Feign调用的GET参数传递的问题

    目录 需求 思考 GET方式请求① GET方式请求② GET方式请求③ 需求 ​ 在消费方服务通过GET方式,访问服务提供方的接口,需要传递多参数,拆分成多个参数的方式访问,不太适合用在该场景,需要改造成合适的方式调用服务方的接口 思考 拆分成多个参数时,若GET请求的参数超过3个及以上时,便不适用该种方式请求服务,因为这样传递参数过于臃肿,可读性也比较差: 若改造成POST请求的方式,虽然解决参数过多的问题,但是也带来了其他的开销,参数被放到了body里面,然后请求到服务方提供的接口,服务方的

  • 解决feign调用接口不稳定的问题

    我就废话不多说了,大家还是直接看代码吧~ Caused by: java.net.SocketException: Software caused connection abort: recv failed at java.net.SocketInputStream.socketRead0(Native Method) at java.net.SocketInputStream.socketRead(SocketInputStream.java:116) at java.net.SocketIn

  • 使用feign调用接口时调不到get方法的问题及解决

    目录 feign调用接口调不到get方法 feign调用拿不到数据 feign调用接口调不到get方法 记录今天在使用springcloud的feign调用接口时踩的坑. 调用的方法是get方法时调用不到接口的问题 1.feign调用时默认的请求方式是post请求,所以如果是要调用的请求为get请求,并且有参数传递时的解决方法: (1)在调用的接口上需要给参数添加@RequestParam注解 @RequestMapping(value = "/cust-archives", meth

  • Feign调用接口解决处理内部异常的问题

    问题描述: 当使用feign调用接口,出现400-500-的接口问题时.会出错feign:FeignException.(因为是错误,只能用catch Throwable,不可使用catch Exception捕获异常)导致程序无法继续运行. 问题原因: 由于feign默认的错误处理类是FunFeignFallback会throw new AfsBaseExceptio导致外部无法捕获异常. package com.ruicar.afs.cloud.common.core.feign; impo

  • 解决微服务feign调用添加token的问题

    微服务feign调用添加token 1.一般情况是这么配置的 具体的怎么调用就不说了 如下配置,就可以在请求头中添加需要的请求头信息. package localdate; import feign.RequestInterceptor; import feign.RequestTemplate; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Autowired; imp

  • springcloud本地调试feign调用出现的诡异404问题及解决

    目录 本地调试feign调用出现的诡异404问题 问题产生 技术框架 核心代码 诡异的404 心态 springcloud在本地调试的踩坑记录 1.在本地调试的时候 2.修改配置文件中关于eureka的配置 3.还是关于eureka的配置 本地调试feign调用出现的诡异404问题 问题产生 最近在给公司准备做分布式事务框架seata的调研,准备搭建一套demo,根据阿里云官网的案例,我准备搭建一套微服务架子,分别含有business.order.storage三个微服务组成,其中第一个微服务实

  • 关于feign调用的参数传递问题(@RequestBody和@RequestParam)

    目录 feign调用的参数传递问题 错误写法 正确写法 body的正确形式 feign传参总结 返回实体对象服务提供者 restful传参服务提供者 传实体对象服务提供者 feign调用的参数传递问题 SpringCloud Feign报错: java.lang.IllegalStateException: Method has too many Body parameters 上边的报错提示为body太多了,feign调用的方法里只能有一个body但是requestparam可以多个 错误写法

  • Feign调用服务各种坑的处理方案

    1.编写被调用服务 @RefreshScope @RestController public class XXXController extends BaseController implements IndicatorsFeignApi{ @Resource private XXXService xxx; @Override public Wrapper<CommonVo> getXXXX(@RequestBody CommonDto commonDto) { try { CommonVo

  • 详解feign调用session丢失解决方案

    最近在做项目的时候发现,微服务使用feign相互之间调用时,存在session丢失的问题.例如,使用Feign调用某个远程API,这个远程API需要传递一个鉴权信息,我们可以把cookie里面的session信息放到Header里面,这个Header是动态的,跟你的HttpRequest相关,我们选择编写一个拦截器来实现Header的传递,也就是需要实现RequestInterceptor接口,具体代码如下: @Configuration @EnableFeignClients(basePack

  • feign调用返回object类型转换方式

    feign调用返回object类型转换 引入依赖 <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.8</version> </dependency> /** * @Description: 将数据转换到相应的容器 * @param b

随机推荐