WebMvcConfigurer 使用注意事项

左手的ㄟ右手 2022-11-17 13:33 204阅读 0赞

下载功能参考链接 : [https://dzone.com/articles/java-springboot-rest-api-to-uploaddownload-file-on][https_dzone.com_articles_java-springboot-rest-api-to-uploaddownload-file-on]

今天准备用 spring boot 写个简单的下载文件的功能，网上找了个下载文件的代码拷过来，下载的时候结果发现报错了。

### 1. 下面是完整的下载代码: ###

package com.example.demo.controller;
    
    import org.springframework.core.io.Resource;
    import org.springframework.core.io.UrlResource;
    import org.springframework.http.HttpHeaders;
    import org.springframework.http.MediaType;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.net.MalformedURLException;
    import java.nio.file.Path;
    import java.nio.file.Paths;
    
    /** * @Author:shifengqiang * @Date:2021/4/9 11:00 上午 */
    @RestController
    public class DownloadController { 
    
        @RequestMapping(value = "/test")
        public ResponseEntity<Resource> downloadFileFromLocal() { 
            Path path = Paths.get("/Users/shifengqiang/Desktop/testSize.txt");
            org.springframework.core.io.Resource resource = null;
            try { 
                resource = new UrlResource(path.toUri());
            } catch (MalformedURLException e) { 
                e.printStackTrace();
            }
            return ResponseEntity.ok()
                    .contentType(MediaType.TEXT_PLAIN)
                    .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + "test.txt" + "\"")
                    .body(resource);
        }
    
    }

### 2. 下载的时候报了这样的错: ###

2021-04-09 14:25:13.755  INFO 31920 --- [  XNIO-1 task-2] WEB_LOG                                  : [1617949513j1MpqmZtwn9]#[DownloadController.downloadFileFromLocal begin:]#reqArgs:[[]].
    2021-04-09 14:25:13.759  WARN 31920 --- [  XNIO-1 task-2] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.web.HttpMediaTypeNotAcceptableException: Could not find acceptable representation]
    2021-04-09 14:25:13.763  INFO 31920 --- [  XNIO-1 task-2] WEB_LOG                                  : [1617949513lhO48wA1nI5]#[BasicErrorController.errorHtml begin:]#reqArgs:[[]].

### 3. 初步分析问题 ###

根据报错的代码，找了会儿原因，没找到。不过大概知道可能是哪里出了问题，跟踪代码发现没有找到合适的 HttpMessageConverter 来处理下载文件的响应。

重新搭建了个新的 spring boot demo ，结果同样的代码拷过来可以下载了。然后 debug ，跟踪两个工程的相关代码的异同。

发现了这儿有差异 :  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoZnFibHVlc3RvbmU_size_16_color_FFFFFF_t_70]  
demo 工程中 this.messageConverters 是空的，所以添加了默认的 converters 。然而，另一个工程的却不为空，所以没有把文件下载需要的 ResourceHttpMessageConverter 添加进去，所以导致了下载文件报错。

最后发现实现我们的一个配置类继承了 WebMvcConfigurer 这个类。

### 4. 我们的实现代码 ###

package demo;
    
    import org.apache.dubbo.config.annotation.Reference;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.http.converter.HttpMessageConverter;
    import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
    import org.springframework.web.servlet.config.annotation.EnableWebMvc;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    
    import javax.annotation.Resource;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.List;
    
    /** * @Date 2019/3/26 14:48 * @Description */
    @Configuration
    @EnableWebMvc
    public class WebConfiguration implements WebMvcConfigurer { 
    
        @Resource
        private JacksonConfig jacksonConfig;
        
        @Override
        public void configureMessageConverters(List<HttpMessageConverter<?>> converters) { 
            // 排除掉原来的MappingJackson2HttpMessageConverter
            List<MappingJackson2HttpMessageConverter> originalConverters = new ArrayList<>();
            for (HttpMessageConverter<?> converter : converters) { 
                if (converter instanceof MappingJackson2HttpMessageConverter) { 
                    originalConverters.add((MappingJackson2HttpMessageConverter) converter);
                }
            }
            if (originalConverters.size() > 0) { 
                converters.removeAll(originalConverters);
            }
            MappingJackson2HttpMessageConverter jackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
            jackson2HttpMessageConverter.setObjectMapper(jacksonConfig.objectMapper());
            converters.add(jackson2HttpMessageConverter);
        }
    }

我们的配置类为了实现把 **枚举类** 返回给前端的时候序列化成自定义的格式，所以继承了 WebMvcConfigurer 这个类。然后改写了 MappingJackson2HttpMessageConverter 的 ObjectMapper 对象映射逻辑。由于在这儿添加了自定义的 converter 之后，后续的地方就不会添加默认的 converters 了。

后来加了:

converters.add(new ResourceHttpMessageConverter());

代码之后，可以下载了。

为什么添加了自定义的 converter 之后，就不会再添加默认的 converters 了呢？道理很简单，因为添加了自定义的之后，再添加默认的就可能会造成冲突。所以就完全交给开发者去控制了。所以，在开发的时候还是要把相关的代码和文档都充分吃透再动手改写，需要把和自定义 converter 没有冲突的其他 converters 也都加进去 ，要不然容易给后面的人挖坑儿。

[https_dzone.com_articles_java-springboot-rest-api-to-uploaddownload-file-on]: https://dzone.com/articles/java-springboot-rest-api-to-uploaddownload-file-on
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoZnFibHVlc3RvbmU_size_16_color_FFFFFF_t_70]: /images/20221022/aade8d29bbb34382be3aeef94c6f7095.png