Controller统一返回结果文件下载怎么处理？

我们经常会使用一个自定义的Controller返回结果Response，例如：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
public class Response<T> {

    private static final int SUCCESS = 0;
    private static final int ERROR = 1;

    private String message;
    private int code;
    private T data;

    public Response(String message, int code, T data) {
        this.message = message;
        this.code = code;
        this.data = data;
    }

    public static Response<Void> error(String msg) {
        return new Response<>(msg, ERROR, null);
    }

    public static <T> Response<T> success(T data) {
        return new Response<>("success", SUCCESS, data);
    }

    @JsonProperty
    public T data() {
        return this.data;
    }

    @JsonProperty
    public int code() {
        return this.code;
    }

    @JsonProperty
    public String message() {
        return this.message;
    }

    @JsonIgnore
    public boolean isFileData() {
        return data() instanceof FileData;
    }
}

但是，关于文件下载，我们一般就是在Controller修改HttpServletResponse或者使用ResponseEntity。如果，我不想在Controller中写这些，我想跟其他方法一样直接返回Response，那该怎么做呢？

要做到这一点，我们就得在Controller返回之后，HTTP响应之前做一些操作。然后我就发现了ResponseBodyAdvice接口。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@ControllerAdvice
@Order(Ordered.HIGHEST_PRECEDENCE)
public class ControllerResponseAdvice implements ResponseBodyAdvice<Response<?>> {

    @ResponseBody
    @ExceptionHandler(Exception.class)
    public Response<Void> handler(Exception ex) {
        return Response.error(ex.getMessage());
    }

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    @Override
    public Response<?> beforeBodyWrite(Response<?> body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if (body.isFileData()) {
            FileData data = (FileData) body.data();
            ServletServerHttpResponse res = ((ServletServerHttpResponse)response);
            res.getHeaders().setContentType(MediaType.MULTIPART_FORM_DATA);
            res.getHeaders().set("Content-Disposition", "attachment;fileName*=UTF-8''" + data.filename());

            try(OutputStream outputStream = res.getBody()) {
                outputStream.write(data.filedata());
            } catch (Exception e) {
                return Response.error("下载失败");
            }
        }
        return body;
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
public class FileData {
    private final String filename;
    private final byte[] filedata;

    public FileData(String filename, byte[] filedata) {
        this.filename = filename;
        this.filedata = filedata;
    }

    public String filename() {
        return this.filename;
    }

    public byte[] filedata() {
        return this.filedata;
    }
}

这里，我们在beforeBodyWrite使用FileData来判断是否是下载文件。

统一异常处理，会在beforeBodyWrite方法之前执行。

然后在Controller这样使用就行了。

1
2
3
4
5
6
7
8
9
@RestController
@RequestMapping("/demo")
public class DemoController {

    @RequestMapping("/download")
    public Response<FileData> download() throws Exception {
 		return Response.success(fileData)
    }
}

这里注意要使用@RestController，或者使用@ResponseBody。

一起都源于我的突发奇想。