溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
這篇文章主要介紹“Feign怎么解決服務之間傳遞文件、傳遞list，map、對象等情況”，在日常操作中，相信很多人在Feign怎么解決服務之間傳遞文件、傳遞list，map、對象等情況問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”Feign怎么解決服務之間傳遞文件、傳遞list，map、對象等情況”的疑惑有所幫助！接下來，請跟著小編一起來學習吧！
先說下背景，前段時間有一個需求，需要將服務A生成的一個文件傳遞到服務B，交予服務B去做處理，最開始的時候使用的spring-cloud-starter-openfeign，發現這一塊是不支持的，然后引入了io.github.openfeign.form ,解決，但過一段時間又有新需求，在傳遞文件的同時，還傳遞對象和一些其他參數，這個時候發現feign就有些不行了。這個時候引入了feign-httpclient，暫時解決。用了一段時間，發現大文件的時候又出現了數據丟失等等問題。還有其他各種坑就不說了，都是用升級版本，引入其他的jar來解決的，但這個大文件數據丟失的問題一直不行。
之前使用的maven重要坐標
<!--feign支持文件上傳-->
<dependency>
<groupId>io.github.openfeign.form</groupId>
<artifactId>feign-form</artifactId>
<version>${feign-form-version}</version>
</dependency>
<dependency>
<groupId>io.github.openfeign.form</groupId>
<artifactId>feign-form-spring</artifactId>
<version>${feign-form-version}</version>
</dependency>
<!--解決feign的傳遞數據丟失的問題，而且版本也要注意，中文有亂碼問題-->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
<version>${feign-httpclient}</version>
</dependency>決定解決這個，首先說下使用的版本，這點很重要、很重要、很重要！
使用的版本：
springboot 2.0.3.RELEASE
springcloud Finchley.RELEASE
替換為下面的maven。上面的那些maven地址沒必要了。
<!--版本管理-->
<properties>
<spring-mock-version>2.0.8</spring-mock-version>
<!--netflix.feign 核心，使用openfeign有問題-->
<netflix.feign-version>8.17.0</netflix.feign-version>
</properties>
<!--遠程服務調用，springboot2.0版本以上，需要導入下面的包才能使用 @EnableFeignClients 注解-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<!--feign服務直接調用，支持文件、基礎數據類型、對象，list等-->
<dependency>
<groupId>com.netflix.feign</groupId>
<artifactId>feign-core</artifactId>
<version>${netflix.feign-version}</version>
</dependency>
<dependency>
<groupId>com.netflix.feign</groupId>
<artifactId>feign-jackson</artifactId>
<version>${netflix.feign-version}</version>
</dependency>
<dependency>
<groupId>com.netflix.feign</groupId>
<artifactId>feign-slf4j</artifactId>
<version>${netflix.feign-version}</version>
</dependency>
<!--file轉MultipartFile-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-mock</artifactId>
<version>${spring-mock-version}</version>
</dependency>注意，我已經測試過 openfeign、feign-httpclient，如果使用這些版本的并不能解決文件傳遞的問題，雖然可以接收文件，但是文件是殘缺的，一定要替換成上面的maven才行。
核心思路就是：對編碼器重寫，Encoder的原理就是將每個參數json序列化，設置requestHeader為Multipart/form-data,采用表單請求去請求生成者提供的接口。這個方法能夠同時發送多個實體文件，以及MultipartFile[]的數組.
首先對編碼器重寫，
import feign.RequestTemplate;
import feign.codec.EncodeException;
import feign.codec.Encoder;
import org.springframework.core.io.InputStreamResource;
import org.springframework.core.io.Resource;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.multipart.MultipartFile;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.reflect.Type;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
/**
* @author ：LX
* 創建時間： 2020/10/14. 15:06
* 地點：廣州
* 目的: 自定義表單編碼器。feign 實現多pojo傳輸與MultipartFile上傳 編碼器，需配合開啟feign自帶注解使用
* 用于支持多對象和文件的上傳
*
* Encoder的原理就是將每個參數json序列化，設置requestHeader為Multipart/form-data,采用表單請求去請求生成者提供的接口。
* 這個方法能夠同時發送多個實體文件，以及MultipartFile[]的數組.
*
* 參考資料：
* https://github.com/pcan/feign-client-test
* 備注說明：
*/
public class FeignSpringFormEncoder implements Encoder{
private final List<HttpMessageConverter<?>> converters = new RestTemplate().getMessageConverters();
public static final Charset UTF_8 = Charset.forName("UTF-8");
public FeignSpringFormEncoder() {}
/**
* 實現一個 HttpOutputMessage
*/
private class HttpOutputMessageImpl implements HttpOutputMessage{
/**
* 輸出流，請求體
*/
private final OutputStream body;
/**
* 請求頭
*/
private final HttpHeaders headers;
public HttpOutputMessageImpl(OutputStream body, HttpHeaders headers) {
this.body = body;
this.headers = headers;
}
@Override
public OutputStream getBody() throws IOException {
return body;
}
@Override
public HttpHeaders getHeaders() {
return headers;
}
}
/**
* 判斷是否表單請求
* @param type
* @return
*/
static boolean isFormRequest(Type type){
return MAP_STRING_WILDCARD.equals(type);
}
/**
* 內部靜態類,保存 MultipartFile 數據
*/
static class MultipartFileResource extends InputStreamResource {
/**
* 文件名
*/
private final String filename;
/**
* 文件大小
*/
private final long size;
/**
* 構造方法
* @param inputStream
* @param filename
* @param size
*/
public MultipartFileResource(InputStream inputStream, String filename, long size) {
super(inputStream);
this.filename = filename;
this.size = size;
}
@Override
public String getFilename() {
return this.filename;
}
@Override
public InputStream getInputStream() throws IOException, IllegalStateException {
return super.getInputStream();
}
@Override
public long contentLength() throws IOException {
return size;
}
}
/**
* 重寫編碼器
* @param object
* @param bodyType
* @param template
* @throws EncodeException
*/
@Override
public void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException {
if (isFormRequest(bodyType)){
final HttpHeaders multipartHeaders = new HttpHeaders();
multipartHeaders.setContentType(MediaType.MULTIPART_FORM_DATA);
encodeMultipartFormRequest((Map<Object, ?>) object, multipartHeaders, template);
} else {
final HttpHeaders jsonHeaders = new HttpHeaders();
jsonHeaders.setContentType(MediaType.APPLICATION_JSON);
encodeRequest(object, jsonHeaders, template);
}
}
/**
* 對有文件、表單的進行編碼
* @param formMap
* @param multipartHeaders
* @param template
*/
private void encodeMultipartFormRequest(Map<Object, ?> formMap, HttpHeaders multipartHeaders, RequestTemplate template){
if (formMap == null){
throw new EncodeException("無法對格式為null的請求進行編碼。");
}
LinkedMultiValueMap<Object, Object> map = new LinkedMultiValueMap<>();
//對每個參數進行檢查校驗
for (Entry<Object, ?> entry : formMap.entrySet()){
Object value = entry.getValue();
//不同的數據類型進行不同的編碼邏輯處理
if (isMultipartFile(value)){
//單個文件
map.add(entry.getKey(), encodeMultipartFile((MultipartFile)value));
} else if (isMultipartFileArray(value)){
//多個文件
encodeMultipartFiles(map, (String) entry.getKey(), Arrays.asList((MultipartFile[]) value));
} else {
//普通請求數據
map.add(entry.getKey(), encodeJsonObject(value));
}
}
encodeRequest(map, multipartHeaders, template);
}
/**
* 對請求進行編碼
* @param value
* @param requestHeaders
* @param template
*/
private void encodeRequest(Object value, HttpHeaders requestHeaders, RequestTemplate template){
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
HttpOutputMessage dummyRequest = new HttpOutputMessageImpl(outputStream, requestHeaders);
try {
Class<?> requestType = value.getClass();
MediaType requestContentType = requestHeaders.getContentType();
for (HttpMessageConverter<?> messageConverter : converters){
if (messageConverter.canWrite(requestType, requestContentType)){
((HttpMessageConverter<Object>) messageConverter).write(value, requestContentType, dummyRequest);
break;
}
}
} catch (IOException e) {
throw new EncodeException("無法對請求進行編碼:", e);
}
HttpHeaders headers = dummyRequest.getHeaders();
if (headers != null){
for (Entry<String, List<String>> entry : headers.entrySet()){
template.header(entry.getKey(), entry.getValue());
}
}
/*
請使用模板輸出流。。。如果文件太大，這將導致問題，因為整個請求都將在內存中。
*/
template.body(outputStream.toByteArray(), UTF_8);
}
/**
* 編碼為json對象
* @param obj
* @return
*/
private HttpEntity<?> encodeJsonObject(Object obj){
HttpHeaders jsonPartHeaders = new HttpHeaders();
jsonPartHeaders.setContentType(MediaType.APPLICATION_JSON);
return new HttpEntity<>(obj, jsonPartHeaders);
}
/**
* 編碼MultipartFile文件，將其轉換為HttpEntity，同時設置 Content-type 為 application/octet-stream
* @param map 當前請求 map.
* @param name 數組字段的名稱
* @param fileList 要處理的文件
*/
private void encodeMultipartFiles(LinkedMultiValueMap<Object, Object> map, String name, List<? extends MultipartFile> fileList){
HttpHeaders filePartHeaders = new HttpHeaders();
//設置 Content-type
filePartHeaders.setContentType(MediaType.APPLICATION_OCTET_STREAM);
try {
for (MultipartFile file : fileList){
Resource multipartFileResource = new MultipartFileResource(file.getInputStream(), file.getOriginalFilename(), file.getSize());
map.add(name, new HttpEntity<>(multipartFileResource, filePartHeaders));
}
} catch (IOException e) {
throw new EncodeException("無法對請求進行編碼:", e);
}
}
/**
* 編碼MultipartFile文件，將其轉換為HttpEntity，同時設置 Content-type 為 application/octet-stream
* @param file 要編碼的文件
* @return
*/
private HttpEntity<?> encodeMultipartFile(MultipartFile file){
HttpHeaders filePartHeaders = new HttpHeaders();
//設置 Content-type
filePartHeaders.setContentType(MediaType.APPLICATION_OCTET_STREAM);
try {
Resource multipartFileResource = new MultipartFileResource(file.getInputStream(), file.getOriginalFilename(), file.getSize());
return new HttpEntity<>(multipartFileResource, filePartHeaders);
} catch (IOException e) {
throw new EncodeException("無法對請求進行編碼:", e);
}
}
/**
* 判斷是否多個 MultipartFile
* @param object
* @return
*/
private boolean isMultipartFileArray(Object object){
return object != null && object.getClass().isArray() && MultipartFile.class.isAssignableFrom(object.getClass().getComponentType());
}
/**
* 判斷是否MultipartFile文件
* @param object 要判斷的對象
* @return
*/
private boolean isMultipartFile(Object object){
return object instanceof MultipartFile;
}
}將該編碼器注冊為bean
import feign.Contract;
import feign.codec.Encoder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* 上傳文件所用配置
* @author admin
*/
@Configuration
public class MultipartSupportConfig {
/**
* 啟用feigin自定義注解支持，如 @RequestLine 和 @Param
* @return
*/
@Bean
public Contract feignContract(){
return new Contract.Default();
}
/**
* feign 實現多pojo傳輸與MultipartFile上傳 編碼器，需配合開啟feign自帶注解使用
* @return
*/
@Bean
public Encoder feignSpringFormEncoder(){
//注入自定義編碼器
return new FeignSpringFormEncoder();
}
}這個時候就基本告一段落，
所有的請求按照這個標準來寫
/** * 示例代碼：請求方式和路徑之間須有一個空格。 表單提交的話請求方式只能是post * 支持如下的所有請求方式。 * 請求參數需要 @Param 修飾 * 在接收端，采用@RequestPart注解接收每一個參數。所有接收都用 @RequestPart(value = "advertiser", required = false) * @return */ @RequestLine(value = "POST /data/test01") ResultJson test01(@Param(value = "name") String name, @Param(value = "nametwo") String nametwo, @Param(value = "file") MultipartFile file, @Param(value = "advertiserMap") Map<String, User> advertiserMap, @Param(value = "materials") List<User> materials, @Param(value = "user") User user, @Param(value = "files") MultipartFile[] files);
要使用 Feign 自帶的注解，@RequesLine 和 @Param 來做請求參數的注入，
我測試的時候，使用 如下這些參數，都可以完成傳遞、
/**
* 示例代碼：feign請求測試
* @return
*/
public String test01(){
try {
String name = "中文";
String nametwo = "two";
MultipartFile file = fileToMultipartFile(new File("E:\\臨時\\1.xlsx"));
MultipartFile file2 = fileToMultipartFile(new File("E:\\臨時\\2.xlsx"));
Map<String, User> advertiserMap = new HashMap<>();
User user = new User();
user.setXm("張三");
User user1 = new User();
user1.setXm("張四");
advertiserMap.put("zw", user);
advertiserMap.put("中", user1);
List<User> list = new ArrayList<>();
list.add(user);
list.add(user1);
MultipartFile[] files = new MultipartFile[2];
files[0] = file;
files[1] = file2;
ResultJson resultJson = resourceAdminFeignImp.test01(name, nametwo, file, advertiserMap, list, user, files);
if (ResultEnum.SUCCESS.getStatus().equals(resultJson.getStatus())){
log.info("測試結果：{}", resultJson.getData());
return (String) resultJson.getData();
} else {
log.error("測試失敗，失敗原因，{}", resultJson.getMsg());
return null;
}
} catch (Exception e) {
e.printStackTrace();
log.error("服務不可用或服務調用失敗，上傳數據失敗");
return null;
}
}接收端同樣要注意，要使用@RequestPart 來接收參數。
/**
* 演示用demo，用來測試這些類型是不是都可以接收
* @param name 普通參數
* @param file 普通文件
* @param advertiserMap 普通map對象
* @param materials 普通list對象
* @param user 對象
* @param files 多文件
* @return
*/
@ResponseBody
@PostMapping("/test01")
public ResultJson test01(@RequestPart(value = "name", required = false) String name,
@RequestPart(value = "nametwo", required = false) String nametwo,
@RequestPart(value = "file", required = false) MultipartFile file,
@RequestPart(value = "advertiserMap", required = false) Map<String, User> advertiserMap,
@RequestPart(value = "materials", required = false) List<User> materials,
@RequestPart(value = "user", required = false) User user,
@RequestPart(value = "files", required = false) MultipartFile[] files){
log.info("name:{}", name);
log.info("nametwo:{}", nametwo);
log.info("文件名:{},文件大小:{},文件名：{}", file.getOriginalFilename(), file.getSize(), file.getName());
log.info("map對象大小：{}", advertiserMap.size());
log.info("list對象大小:{}", materials.size());
log.info("用戶:{}", user.toString());
log.info("文件名:{},文件大小:{},文件名：{}", files[0].getOriginalFilename(), files[0].getSize(), files[0].getName());
return new ResultJson("查詢成功", null);
}注意，基礎的數據類型，String 之類的可以不用寫注解也可以接收。
到此，關于“Feign怎么解決服務之間傳遞文件、傳遞list，map、對象等情況”的學習就結束了，希望能夠解決大家的疑惑。理論與實踐的搭配能更好的幫助大家學習，快去試試吧！若想繼續學習更多相關知識，請繼續關注億速云網站，小編會繼續努力為大家帶來更多實用的文章！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
