平時使用Feign做微服開發調用客戶端時,幾乎都是普通接口調用,返回一些JSON數據,今天剛好要進行Feign客戶端(服務消費者)調用服務提供者的文件下載接口,記錄一下!廢話不多說,直接上代碼:
首先是文件下載服務提供者的主要代碼:
import org.slf4j.Logger; import org.slf4j.LoggerFactory; import javax.servlet.http.HttpServletResponse; import java.io.*; import java.net.URLEncoder; public class FileUtil { private static final Logger logger = LoggerFactory.getLogger(FileUtil.class); /** * 將指定文件對象寫入到特定的Servlet響應對象,進而實現下載 * 一般用於下載已經存在的文件 * * @param response 目標Servlet響應對象 * @param file 要下載的文件對象 * @param isDeleteOriginal 是否刪除服務器文件原本,true下載后將刪除服務器上的文件 */ public static void fileDownload(HttpServletResponse response, File file, Boolean isDeleteOriginal) { try { InputStream inputStream = new FileInputStream(file); BufferedInputStream bufferedInputStream = new BufferedInputStream(inputStream); response.setHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode(file.getName(), "UTF-8")); BufferedOutputStream bufferedOutputStream = new BufferedOutputStream(response.getOutputStream()); int length = 0; byte[] temp = new byte[1024 * 10]; while ((length = bufferedInputStream.read(temp)) != -1) { bufferedOutputStream.write(temp, 0, length); } bufferedOutputStream.flush(); bufferedOutputStream.close(); bufferedInputStream.close(); inputStream.close(); if (isDeleteOriginal) { file.delete(); } } catch (FileNotFoundException e) { e.printStackTrace(); logger.error(e.getMessage()); } catch (IOException e) { e.printStackTrace(); logger.error(e.getMessage()); } } }
服務提供者的Controller接口方法:
@GetMapping(value = "/file") public void downloadFile(@RequestParam String path, HttpServletResponse response) { File file = new File(path); FileUtil.fileDownload(response, file, false); }
接着是Feign客戶端(服務消費者)的代碼:
先是Feign接口聲明:
import feign.Response; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.http.MediaType; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; @FeignClient(name = "provider-user") @RequestMapping(value = "/user") public interface UserFeignClient extends FeignClientParent { @GetMapping(value = "/file",consumes = MediaType.APPLICATION_PROBLEM_JSON_VALUE) Response downloadFile(@RequestParam String path); }
然后是Feign客戶端(服務消費者)的Controller接口方法(你可以對該方法再進行提煉,變成服務消費者通用的文件下載方法):
@GetMapping(value = "/file") public void downloadFile(@RequestParam String path, HttpServletResponse response) { InputStream inputStream = null; try { Response serviceResponse = this.userFeignClient.downloadFile(path); Response.Body body = serviceResponse.body(); inputStream = body.asInputStream(); BufferedInputStream bufferedInputStream = new BufferedInputStream(inputStream); response.setHeader("Content-Disposition", serviceResponse.headers().get("Content-Disposition").toString().replace("[","").replace("]","")); BufferedOutputStream bufferedOutputStream = new BufferedOutputStream(response.getOutputStream()); int length = 0; byte[] temp = new byte[1024 * 10]; while ((length = bufferedInputStream.read(temp)) != -1) { bufferedOutputStream.write(temp, 0, length); } bufferedOutputStream.flush(); bufferedOutputStream.close(); bufferedInputStream.close(); inputStream.close(); } catch (IOException e) { e.printStackTrace(); } }
紅色代碼部分是為了保持服務提供者一致的文件下載輸出,其中就包括文件名!
總結一下,其實原理很簡單:就是將服務提供者的文件下載響應的響應體(文件內容)復制到服務消費者對外的文件下載響應體中!