Spring——》feign下载文件

淡淡的烟草味﹌ 2024-04-01 17:00 70阅读 0赞

> 推荐链接：  
> [总结——》【Java】][Java]  
> [总结——》【Mysql】][Mysql]  
> [总结——》【Spring】][Spring]  
> [总结——》【SpringBoot】][SpringBoot]  
> [总结——》【MyBatis、MyBatis-Plus】][MyBatis_MyBatis-Plus]

#### Spring——》feign下载文件 ####

*  一、服务提供者：good-house-push
 *   *  1、ITmallSyncEsfCommunityController
     *  2、TmallEsfCommunitySyncController
     *  3、IEsfCommunitySyncService
     *  4、EsfCommunitySyncService
     *  5、HttpServletResponseUtils
 *  二、服务消费者：house-platform-api
 *   *  1、ITmallSyncEsfCommunityApi
     *  2、TmallCityOpenController

## 一、服务提供者：good-house-push ##

### 1、ITmallSyncEsfCommunityController ###

方法的返回值一定是void，不要指定返回内容

public interface ITmallSyncEsfCommunityController {
        
    
        @ApiOperation(value = "根据批次号，下载同步二手房小区的错误日志列表")
        @GetMapping("/api/tmall/syncEsfCommunity/logList/downloadError/{batchNo}")
        void downloadErrorLogListByBatchNo(@PathVariable(name = "batchNo") String batchNo, HttpServletResponse response);
    }

### 2、TmallEsfCommunitySyncController ###

@Slf4j
    @Api(value = "同步二手房小区", tags = "同步二手房小区")
    @RestController
    public class TmallEsfCommunitySyncController implements ITmallSyncEsfCommunityController {
        
    
        @Autowired
        IEsfCommunitySyncService esfCommunitySyncService;
    
        @Override
        public void downloadErrorLogListByBatchNo(String batchNo, HttpServletResponse response) {
        
            esfCommunitySyncService.downloadErrorLogListByBatchNo(batchNo, response);
        }
    }

### 3、IEsfCommunitySyncService ###

public interface IEsfCommunitySyncService {
        
        void downloadErrorLogListByBatchNo(String batchNo, HttpServletResponse response);
    }

### 4、EsfCommunitySyncService ###

@Slf4j
        @Service
        public class EsfCommunitySyncServiceImpl implements IEsfCommunitySyncService {
        
            @Override
            public void downloadErrorLogListByBatchNo(String batchNo, HttpServletResponse response) {
        
                List<EsfCommunitySyncLog> list = esfCommunitySyncLogService.selectList(new EsfCommunitySyncLog().setBatchNo(batchNo).setStatus(0));
                if (CollectionUtils.isEmpty(list)) {
        
                    return;
                }
                List<EsfCommunitySyncLogDownloadRes> result = BeanCopyUtil.copyListProperties(list, EsfCommunitySyncLogDownloadRes::new);
                HttpServletResponseUtils.downloadExcel(response, EsfCommunitySyncLogDownloadRes.class, result, batchNo + ".xlsx", null);
            }
        }

### 5、HttpServletResponseUtils ###

public class HttpServletResponseUtils {
        
        public static void downloadExcel(HttpServletResponse response, Class clazz, Collection collection, String fileName, String sheetName) {
        
    
            Assert.notNull(response, "response 为空");
            Assert.notNull(clazz, "clazz 为空");
            Assert.notEmpty(collection, "collection 为空");
            Assert.hasText(fileName, "fileName 为空");
    
            if (!StringUtils.hasText(sheetName)) {
        
                sheetName = "sheet1";
            }
    
            // 这里注意 有同学反应使用swagger 会导致各种问题，请直接用浏览器或者用postman
            response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            response.setCharacterEncoding("utf-8");
    
    
            try {
        
                // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
                String urlEncoderfileName = URLEncoder.encode(fileName, "UTF-8").replaceAll("\\+", "%20");
    
                response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + urlEncoderfileName + ".xlsx");
                EasyExcel.write(response.getOutputStream(), clazz).sheet(sheetName).doWrite(collection);
            } catch (IOException e) {
        
                log.error("downloadExcel 报错, 报错信息:{}", e);
                throw new RuntimeException(e);
            }
        }
    }

## 二、服务消费者：house-platform-api ##

### 1、ITmallSyncEsfCommunityApi ###

方法的返回值设置为Response

@FeignClient(value = "${feign.client.config.good-house-push.name}", url = "${feign.client.config.good-house-push.url}", path = "${feign.client.inner.path}", configuration = CatFeignConfiguration.class)
    public interface ITmallSyncEsfCommunityApi{
        
    
        @ApiOperation("根据批次号，下载同步二手房小区的错误日志列表")
        @GetMapping({
        "/api/tmall/syncEsfCommunity/logList/downloadError/{batchNo}"})
        Response downloadErrorLogListByBatchNo(@PathVariable(name = "batchNo") String batchNo);
    }

### 2、TmallCityOpenController ###

将服务提供者的文件下载响应的响应体(文件内容)复制到服务消费者对外的文件下载响应体中

@Slf4j
    @Api(tags = "天猫城市开通管理")
    @RestController
    @RequestMapping(value = "/tmall", produces = "application/json;charset=utf-8")
    public class TmallController {
        
    
        @Autowired
        private ITmallSyncEsfCommunityApi tmallSyncEsfCommunityApi;
        
        @ApiOperation(value = "根据批次号，下载同步二手房小区的错误日志列表")
        @GetMapping("/cityopen/syncEsfCommunity/logList/downloadError/{batchNo}")
        void downloadErrorLogListByBatchNo(@PathVariable(name = "batchNo") String batchNo, HttpServletResponse response) {
        
    
            InputStream inputStream = null;
            try {
        
                Response serviceResponse = tmallSyncEsfCommunityApi.downloadErrorLogListByBatchNo(batchNo);
                Response.Body body = serviceResponse.body();
                inputStream = body.asInputStream();
                BufferedInputStream bufferedInputStream = new BufferedInputStream(inputStream);
                response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
                response.setCharacterEncoding("utf-8");
                response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + batchNo + ".xlsx");
                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();
            }
        }
    }

[Java]: https://blog.csdn.net/weixin_43453386/article/details/84788317
[Mysql]: https://blog.csdn.net/weixin_43453386/article/details/88667709
[Spring]: https://blog.csdn.net/weixin_43453386/article/details/124900806
[SpringBoot]: https://blog.csdn.net/weixin_43453386/article/details/84788714
[MyBatis_MyBatis-Plus]: https://blog.csdn.net/weixin_43453386/article/details/84788053