springmvc文件下载

文件下载就是将文件服务器中的文件下载到本地,在springmvc中要实现文件下载可分为两个步骤:

第一步:在客户端使用一个文件下载超链接,链接里面的href属性指向后台下载文件的方法以及文件名;

第二步:在后台controller类中,使用springmvc提供的文件下载方法进行下载。

springmvc提供了一个ResponseEntity类型的对象,使用它可以很方便的定义返回的HttpHeaders对象和HttpStatus对象,通过对这两个对象的设置,即可完成下载文件时所需的配置信息。文件下载的代码如下所示:

  public ResponseEntity<byte[]> downFile(HttpServletRequest request, String filename) throws IOException {

        //指定要下载的文件所在路径
        String path = request.getServletContext().getRealPath("/upload/");
        //创建该文件对象
        File file = new File(path + File.separator + filename);
        //设置响应头
        HttpHeaders headers = new HttpHeaders();
        //通知浏览器以下载的方式打开文件
        headers.setContentDispositionFormData("attachment", filename);
        //定义以流的形式下载返回文件数据
        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);

        //使用springmvc框架的ResponseEntity对象封装返回数据
        return new ResponseEntity<byte[]>(FileUtils.readFileToByteArray(file), headers, HttpStatus.OK);
    }

说明:在downFile方法中,首先根据文件路径和需要下载的文件名来创建文件对象,然后对响应头中文件下载时的打开方式以及下载方式进行了设置,最后返回ResponseEntity封装的下载结果对象。MediaType.APPLICATION_OCTET_STREAM 表示以二进制流的形式下载数据。

对于中文名称的文件名乱码处理:

如果文件名是英文的则不会出现文件名乱码的情况,但是如果文件名中有中文,则可能出现乱码,这个时候需要对文件名进行转码处理。如下所示:

public ResponseEntity<byte[]> downFile(HttpServletRequest request, String filename) throws IOException {

        //指定要下载的文件所在路径
        String path = request.getServletContext().getRealPath("/upload/");
        //创建该文件对象
        File file = new File(path + File.separator + filename);
    
        //对文件名进行编码,防止中文文件名乱码
        filename = this.getFilename(request, filename);

        //设置响应头
        HttpHeaders headers = new HttpHeaders();
        //通知浏览器以下载的方式打开文件
        headers.setContentDispositionFormData("attachment", filename);
        //定义以流的形式下载返回文件数据
        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);

        //使用springmvc框架的ResponseEntity对象封装返回数据
        return new ResponseEntity<byte[]>(FileUtils.readFileToByteArray(file), headers, HttpStatus.OK);
    }

    /**
     * 根据浏览器的不同进行编码设置
     *
     * @param request  请求对象
     * @param filename 需要转码的文件名
     * @return 返回编码后的文件名
     * @throws IOException
     */
    public String getFilename(HttpServletRequest request, String filename) throws IOException {

        //IE不同版本User-Agent中出现的关键词
        String[] IEBrowserKeyWords = {"MSIE", "Trident", "Edge"};
        
        //获取请求头代理信息
        String userAgent = request.getHeader("User-Agent");
        for (String keyWord : IEBrowserKeyWords) {
            if (userAgent.contains(keyWord)) {
                //IE内核浏览器,统一为utf-8编码显示
                return URLEncoder.encode(filename, "UTF-8");
            }
        }

        //火狐等其他浏览器统一为ISO-8859-1编码显示
        return new String(filename.getBytes("UTF-8"), "ISO-8859-1");
    }

以上就是springmvc的文件下载内容。

原文地址:https://www.cnblogs.com/jasonboren/p/13431107.html