解決Feign呼叫的GET引數傳遞的問題

2022-03-04 16:00:40

需求

在消費方服務通過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;

**結果截圖：**

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。

解決Feign呼叫的GET引數傳遞的問題

目錄

需求

思考

GET方式請求①

GET方式請求②

GET方式請求③

熱門文章