Feign怎么解決服務(wù)之間傳遞文件、傳遞list,map、對(duì)象等情況

這篇文章主要介紹“Feign怎么解決服務(wù)之間傳遞文件、傳遞list,map、對(duì)象等情況”,在日常操作中,相信很多人在Feign怎么解決服務(wù)之間傳遞文件、傳遞list,map、對(duì)象等情況問(wèn)題上存在疑惑,小編查閱了各式資料,整理出簡(jiǎn)單好用的操作方法,希望對(duì)大家解答”Feign怎么解決服務(wù)之間傳遞文件、傳遞list,map、對(duì)象等情況”的疑惑有所幫助!接下來(lái),請(qǐng)跟著小編一起來(lái)學(xué)習(xí)吧!

10年的肥城網(wǎng)站建設(shè)經(jīng)驗(yàn),針對(duì)設(shè)計(jì)、前端、開發(fā)、售后、文案、推廣等六對(duì)一服務(wù),響應(yīng)快,48小時(shí)及時(shí)工作處理。網(wǎng)絡(luò)營(yíng)銷推廣的優(yōu)勢(shì)是能夠根據(jù)用戶設(shè)備顯示端的尺寸不同,自動(dòng)調(diào)整肥城建站的顯示方式,使網(wǎng)站能夠適用不同顯示終端,在瀏覽器中調(diào)整網(wǎng)站的寬度,無(wú)論在任何一種瀏覽器上瀏覽網(wǎng)站,都能展現(xiàn)優(yōu)雅布局與設(shè)計(jì),從而大程度地提升瀏覽體驗(yàn)。創(chuàng)新互聯(lián)從事“肥城網(wǎng)站設(shè)計(jì)”,“肥城網(wǎng)站推廣”以來(lái),每個(gè)客戶項(xiàng)目都認(rèn)真落實(shí)執(zhí)行。

先說(shuō)下背景,前段時(shí)間有一個(gè)需求,需要將服務(wù)A生成的一個(gè)文件傳遞到服務(wù)B,交予服務(wù)B去做處理,最開始的時(shí)候使用的spring-cloud-starter-openfeign,發(fā)現(xiàn)這一塊是不支持的,然后引入了io.github.openfeign.form ,解決,但過(guò)一段時(shí)間又有新需求,在傳遞文件的同時(shí),還傳遞對(duì)象和一些其他參數(shù),這個(gè)時(shí)候發(fā)現(xiàn)feign就有些不行了。這個(gè)時(shí)候引入了feign-httpclient,暫時(shí)解決。用了一段時(shí)間,發(fā)現(xiàn)大文件的時(shí)候又出現(xiàn)了數(shù)據(jù)丟失等等問(wèn)題。還有其他各種坑就不說(shuō)了,都是用升級(jí)版本,引入其他的jar來(lái)解決的,但這個(gè)大文件數(shù)據(jù)丟失的問(wèn)題一直不行。

之前使用的maven重要坐標(biāo)

<!--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的傳遞數(shù)據(jù)丟失的問(wèn)題,而且版本也要注意,中文有亂碼問(wèn)題-->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
    <version>${feign-httpclient}</version>
</dependency>

決定解決這個(gè),首先說(shuō)下使用的版本,這點(diǎn)很重要、很重要、很重要!

使用的版本:

springboot 2.0.3.RELEASE
springcloud Finchley.RELEASE

替換為下面的maven。上面的那些maven地址沒(méi)必要了。

<!--版本管理-->
    <properties>
        <spring-mock-version>2.0.8</spring-mock-version>
        <!--netflix.feign 核心,使用openfeign有問(wèn)題-->
        <netflix.feign-version>8.17.0</netflix.feign-version>
    </properties>

<!--遠(yuǎn)程服務(wù)調(diào)用,springboot2.0版本以上,需要導(dǎo)入下面的包才能使用 @EnableFeignClients 注解-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

        <!--feign服務(wù)直接調(diào)用,支持文件、基礎(chǔ)數(shù)據(jù)類型、對(duì)象,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轉(zhuǎn)MultipartFile-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-mock</artifactId>
            <version>${spring-mock-version}</version>
        </dependency>

注意,我已經(jīng)測(cè)試過(guò) openfeign、feign-httpclient,如果使用這些版本的并不能解決文件傳遞的問(wèn)題,雖然可以接收文件,但是文件是殘缺的,一定要替換成上面的maven才行。

核心思路就是:對(duì)編碼器重寫,Encoder的原理就是將每個(gè)參數(shù)json序列化,設(shè)置requestHeader為Multipart/form-data,采用表單請(qǐng)求去請(qǐng)求生成者提供的接口。這個(gè)方法能夠同時(shí)發(fā)送多個(gè)實(shí)體文件,以及MultipartFile[]的數(shù)組.

首先對(duì)編碼器重寫,

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
 * 創(chuàng)建時(shí)間: 2020/10/14. 15:06
 * 地點(diǎn):廣州
 * 目的: 自定義表單編碼器。feign 實(shí)現(xiàn)多pojo傳輸與MultipartFile上傳 編碼器,需配合開啟feign自帶注解使用
 *      用于支持多對(duì)象和文件的上傳
 *
 *      Encoder的原理就是將每個(gè)參數(shù)json序列化,設(shè)置requestHeader為Multipart/form-data,采用表單請(qǐng)求去請(qǐng)求生成者提供的接口。
 *      這個(gè)方法能夠同時(shí)發(fā)送多個(gè)實(shí)體文件,以及MultipartFile[]的數(shù)組.
 *
 *      參考資料:
 *              https://github.com/pcan/feign-client-test
 * 備注說(shuō)明:
 */
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() {}

    /**
     * 實(shí)現(xiàn)一個(gè) HttpOutputMessage
     */
    private class HttpOutputMessageImpl implements HttpOutputMessage{
        /**
         * 輸出流,請(qǐng)求體
         */
        private final OutputStream body;
        /**
         * 請(qǐng)求頭
         */
        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;
        }
    }

    /**
     * 判斷是否表單請(qǐng)求
     * @param type
     * @return
     */
    static boolean isFormRequest(Type type){
        return MAP_STRING_WILDCARD.equals(type);
    }

    /**
     * 內(nèi)部靜態(tài)類,保存 MultipartFile 數(shù)據(jù)
     */
    static class MultipartFileResource extends InputStreamResource {
        /**
         * 文件名
         */
        private final String filename;
        /**
         * 文件大小
         */
        private final long size;

        /**
         * 構(gòu)造方法
         * @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);
        }
    }

    /**
     * 對(duì)有文件、表單的進(jìn)行編碼
     * @param formMap
     * @param multipartHeaders
     * @param template
     */
    private void encodeMultipartFormRequest(Map<Object, ?> formMap, HttpHeaders multipartHeaders, RequestTemplate template){
        if (formMap == null){
            throw new EncodeException("無(wú)法對(duì)格式為null的請(qǐng)求進(jìn)行編碼。");
        }

        LinkedMultiValueMap<Object, Object> map = new LinkedMultiValueMap<>();
        //對(duì)每個(gè)參數(shù)進(jìn)行檢查校驗(yàn)
        for (Entry<Object, ?> entry : formMap.entrySet()){
            Object value = entry.getValue();
            //不同的數(shù)據(jù)類型進(jìn)行不同的編碼邏輯處理
            if (isMultipartFile(value)){
                //單個(gè)文件
                map.add(entry.getKey(), encodeMultipartFile((MultipartFile)value));

            } else if (isMultipartFileArray(value)){
                //多個(gè)文件
                encodeMultipartFiles(map, (String) entry.getKey(), Arrays.asList((MultipartFile[]) value));

            } else {
                //普通請(qǐng)求數(shù)據(jù)
                map.add(entry.getKey(), encodeJsonObject(value));
            }
        }

        encodeRequest(map, multipartHeaders, template);
    }

    /**
     * 對(duì)請(qǐng)求進(jìn)行編碼
     * @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("無(wú)法對(duì)請(qǐng)求進(jìn)行編碼:", e);
        }

        HttpHeaders headers = dummyRequest.getHeaders();
        if (headers != null){
            for (Entry<String, List<String>> entry : headers.entrySet()){
                template.header(entry.getKey(), entry.getValue());
            }
        }

        /*
        請(qǐng)使用模板輸出流。。。如果文件太大,這將導(dǎo)致問(wèn)題,因?yàn)檎麄€(gè)請(qǐng)求都將在內(nèi)存中。
         */
        template.body(outputStream.toByteArray(), UTF_8);
    }

    /**
     * 編碼為json對(duì)象
     * @param obj
     * @return
     */
    private HttpEntity<?> encodeJsonObject(Object obj){
        HttpHeaders jsonPartHeaders = new HttpHeaders();
        jsonPartHeaders.setContentType(MediaType.APPLICATION_JSON);
        return new HttpEntity<>(obj, jsonPartHeaders);
    }

    /**
     * 編碼MultipartFile文件,將其轉(zhuǎn)換為HttpEntity,同時(shí)設(shè)置 Content-type 為 application/octet-stream
     * @param map 當(dāng)前請(qǐng)求 map.
     * @param name 數(shù)組字段的名稱
     * @param fileList 要處理的文件
     */
    private void encodeMultipartFiles(LinkedMultiValueMap<Object, Object> map, String name, List<? extends MultipartFile> fileList){
        HttpHeaders filePartHeaders = new HttpHeaders();
        //設(shè)置 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("無(wú)法對(duì)請(qǐng)求進(jìn)行編碼:", e);
        }
    }

    /**
     * 編碼MultipartFile文件,將其轉(zhuǎn)換為HttpEntity,同時(shí)設(shè)置 Content-type 為 application/octet-stream
     * @param file 要編碼的文件
     * @return
     */
    private HttpEntity<?> encodeMultipartFile(MultipartFile file){
        HttpHeaders filePartHeaders = new HttpHeaders();
        //設(shè)置 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("無(wú)法對(duì)請(qǐng)求進(jìn)行編碼:", e);
        }
    }

    /**
     * 判斷是否多個(gè) MultipartFile
     * @param object
     * @return
     */
    private boolean isMultipartFileArray(Object object){
        return object != null && object.getClass().isArray() && MultipartFile.class.isAssignableFrom(object.getClass().getComponentType());
    }

    /**
     * 判斷是否MultipartFile文件
     * @param object 要判斷的對(duì)象
     * @return
     */
    private boolean isMultipartFile(Object object){
        return object instanceof MultipartFile;
    }


}

將該編碼器注冊(cè)為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 實(shí)現(xiàn)多pojo傳輸與MultipartFile上傳 編碼器,需配合開啟feign自帶注解使用
     * @return
     */
    @Bean
    public Encoder feignSpringFormEncoder(){
        //注入自定義編碼器
        return new FeignSpringFormEncoder();
    }


}

這個(gè)時(shí)候就基本告一段落,

所有的請(qǐng)求按照這個(gè)標(biāo)準(zhǔn)來(lái)寫

/**
     * 示例代碼:請(qǐng)求方式和路徑之間須有一個(gè)空格。 表單提交的話請(qǐng)求方式只能是post
     * 支持如下的所有請(qǐng)求方式。
     * 請(qǐng)求參數(shù)需要 @Param 修飾
     * 在接收端,采用@RequestPart注解接收每一個(gè)參數(shù)。所有接收都用 @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 來(lái)做請(qǐng)求參數(shù)的注入

我測(cè)試的時(shí)候,使用 如下這些參數(shù),都可以完成傳遞、

 /**
     * 示例代碼:feign請(qǐng)求測(cè)試
     * @return
     */
    public String test01(){
        try {
            String name = "中文";
            String nametwo = "two";

            MultipartFile file = fileToMultipartFile(new File("E:\\臨時(shí)\\1.xlsx"));
            MultipartFile file2 = fileToMultipartFile(new File("E:\\臨時(shí)\\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("測(cè)試結(jié)果:{}", resultJson.getData());
                return (String) resultJson.getData();
            } else {
                log.error("測(cè)試失敗,失敗原因,{}", resultJson.getMsg());
                return null;
            }
        } catch (Exception e) {
            e.printStackTrace();
            log.error("服務(wù)不可用或服務(wù)調(diào)用失敗,上傳數(shù)據(jù)失敗");
            return null;
        }
    }

接收端同樣要注意,要使用@RequestPart 來(lái)接收參數(shù)。

/**
     * 演示用demo,用來(lái)測(cè)試這些類型是不是都可以接收
     * @param name 普通參數(shù)
     * @param file 普通文件
     * @param advertiserMap 普通map對(duì)象
     * @param materials 普通list對(duì)象
     * @param user 對(duì)象
     * @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對(duì)象大小:{}", advertiserMap.size());
        log.info("list對(duì)象大小:{}", materials.size());
        log.info("用戶:{}", user.toString());
        log.info("文件名:{},文件大小:{},文件名:{}", files[0].getOriginalFilename(), files[0].getSize(), files[0].getName());

        return new ResultJson("查詢成功", null);
    }

注意,基礎(chǔ)的數(shù)據(jù)類型,String 之類的可以不用寫注解也可以接收。

到此,關(guān)于“Feign怎么解決服務(wù)之間傳遞文件、傳遞list,map、對(duì)象等情況”的學(xué)習(xí)就結(jié)束了,希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí),快去試試吧!若想繼續(xù)學(xué)習(xí)更多相關(guān)知識(shí),請(qǐng)繼續(xù)關(guān)注創(chuàng)新互聯(lián)網(wǎng)站,小編會(huì)繼續(xù)努力為大家?guī)?lái)更多實(shí)用的文章!

網(wǎng)站題目:Feign怎么解決服務(wù)之間傳遞文件、傳遞list,map、對(duì)象等情況
文章URL:http://bm7419.com/article14/psssde.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供營(yíng)銷型網(wǎng)站建設(shè)Google網(wǎng)站收錄、網(wǎng)站建設(shè)、全網(wǎng)營(yíng)銷推廣、網(wǎng)站策劃

廣告

聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)

手機(jī)網(wǎng)站建設(shè)