java spring boot multipartFile with application/octet-stream 抛出异常

spring boot multipartFile with application/octet-stream throws exception

提问by Raveesh Sharma

I wanted to build a simple Rest api using Spring boot which accepts any given file and then performs some operations on it . I went through the spring examples on multipartFile https://spring.io/guides/gs/uploading-files/and I decided to follow the same approach. The files that will be uploaded through my rest api will have some specific extension. So,i gave the content-type as application/octet-stream . When I try to run my unit test cases for the same, I always get the exception of

我想使用 Spring boot 构建一个简单的 Rest api，它接受任何给定的文件，然后对其执行一些操作。我浏览了 multipartFile https://spring.io/guides/gs/uploading-files/上的 spring 示例，我决定采用相同的方法。将通过我的 rest api 上传的文件将具有一些特定的扩展名。因此，我将内容类型指定为 application/octet-stream 。当我尝试运行我的单元测试用例时，我总是得到一个例外

nested exception is org.springframework.web.multipart.MultipartException: The current request is not a multipart request

This exception does not appear if the content type is text/plain or if there is no 'consumes' parameter in the requestMapping.

如果内容类型为 text/plain 或 requestMapping 中没有“consumes”参数，则不会出现此异常。

My controller code looks as follows :

我的控制器代码如下所示：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RequestPart;
import org.springframework.web.multipart.MultipartFile;

@Controller
@RequestMapping("/v1/sample")
public class SampleController {

    private static Logger log = LoggerFactory.getLogger(SampleController.class);

    @RequestMapping(path = "/{id}/upload",
                    consumes = {MediaType.APPLICATION_OCTET_STREAM_VALUE},
                    method = RequestMethod.POST)
    public ResponseEntity<String> uploadfile(@PathVariable String id,
            @RequestParam("file") MultipartFile upgradeFile) {
        log.info("Obtained a upload request for the id {}",id );
        return new ResponseEntity<String>("file upload has been accepted.",
                HttpStatus.ACCEPTED);
    }

}

And my unit test snippet is as follows :

我的单元测试片段如下：

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.fileUpload;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import static org.springframework.test.web.servlet.setup.MockMvcBuilders.webAppContextSetup;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockMultipartFile;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import com.stellapps.devicemanager.fota.Application;

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@SpringApplicationConfiguration(classes = Application.class)
@EnableWebMvc
public class ControllerTest {

    @Autowired
    private WebApplicationContext webApplicationContext;

    private MockMvc mockMvc;

    @Before
    public void mockMvcBuilder() {
        this.mockMvc = webAppContextSetup(webApplicationContext).build();
    }

    @Test
        public void test_ValidPayload() {
            String uri = "/v1/sample/1234/upload";
            Path path = Paths.get("src/test/resources/someFile");
            try {
                byte[] bytes = Files.readAllBytes(path);
                 MockMultipartFile multipartFile =
                            new MockMultipartFile("file", "someFile.diff", "application/octet-stream", bytes);
                 mockMvc.perform(fileUpload(uri).file(multipartFile).contentType(MediaType.APPLICATION_OCTET_STREAM_VALUE))
                    .andExpect(status().isAccepted());
            } catch (IOException e1) {
                // TODO Auto-generated catch block
                e1.printStackTrace();
            } catch (Exception e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }
}

If I use text/plain as the content-type and i give a normal text file, it goes through fine. If I add the content-type as application/octet-stream it throws the following exception

如果我使用 text/plain 作为内容类型并且我给出一个普通的文本文件，它会顺利通过。如果我将内容类型添加为 application/octet-stream，它会抛出以下异常

    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java:192)
Caused by: org.springframework.web.multipart.MultipartException: The current request is not a multipart request
    at org.springframework.web.servlet.mvc.method.annotation.RequestPartMethodArgumentResolver.assertIsMultipartRequest(RequestPartMethodArgumentResolver.java:204)
    at org.springframework.web.servlet.mvc.method.annotation.RequestPartMethodArgumentResolver.resolveArgument(RequestPartMethodArgumentResolver.java:129)
    at org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:99)
    at org.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:161)
    at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:128)
    at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:110)
    at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:817)
    at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:731)
    at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:85)
    at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:959)
    at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:893)
    at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:968)

How Do I make my request accept application/octet-stream and what changes should I make to the test case to ensure it succeeds.

我如何让我的请求接受 application/octet-stream 以及我应该对测试用例进行哪些更改以确保它成功。

UPDATE:

更新：

Removing the consumes header and by not specifying the content-type in MockPartFile is one of the way to upload a file. I suppose by default the controller takes it as application/octet-stream

删除消耗标头并在 MockPartFile 中不指定内容类型是上传文件的方法之一。我想默认情况下，控制器将其作为应用程序/八位字节流

UPDATE:

更新：

Thank you for the response. I was using an earlier version of spring (1.3.1) and after going through the answer, I updated my spring version and the test case to match it and It started working.

感谢您的答复。我使用的是较早版本的 spring (1.3.1)，在完成答案后，我更新了 spring 版本和测试用例以匹配它，它开始工作。

采纳答案by satya-j

Try below steps

尝试以下步骤

• Remove the consumesfrom the RequestMapping attributes.
• MockMultipartFile multipartFile = new MockMultipartFile("file","somename","multipart/form-data", fileinputstream);

• Change to MockMvc:

  mockMvc.perform(MockMvcRequestBuilders.fileUpload("/v1/sample/1234/payload")                
              .file(multipartFile)
              .andExpect(status().isOk());
  

• 从 RequestMapping 属性中删除消耗。
• MockMultipartFile multipartFile = new MockMultipartFile("file","somename","multipart/form-data", fileinputstream);

• 更改为 MockMvc：

  mockMvc.perform(MockMvcRequestBuilders.fileUpload("/v1/sample/1234/payload")                
              .file(multipartFile)
              .andExpect(status().isOk());
  

For help check Upload file using Spring mvc and MockMVC

如需帮助检查 使用 Spring mvc 和 MockMVC 上传文件

EDIT:

编辑：

I've tried a sample spring-boot-rest app with your scenario. Seems application/octet-stream is no issue. Please check my repo https://github.com/satya-j/boot-file-manager

我已经在你的场景中尝试了一个示例 spring-boot-rest 应用程序。似乎应用程序/八位字节流没有问题。请检查我的回购 https://github.com/satya-j/boot-file-manager