Spring Controller @RequestBody with file upload is it possible?

Question

I have a Controller like this and I want to submit a form with file uploading as well as some form data like label as shown below. Also, I want to do that using @RequestBody so I can use the @Valid annotation on the wrapper as more variables will be added.

public @ResponseBody WebResponse<Boolean> updateEUSettings(
    final Locale locale,
    @Validated @ModelAttribute final EUPSettingsWrapper endUserPortalSettingsWrapper) {
}

And my wrapper is:

public class EUPSettingsWrapper {

    private String label;
    private MultipartFile logo;
// getter , setters..etc...
}

But I would like to convert it into a @RequestBody from ModelAttributes.

The way I'm trying is by having the file upload separated as request parameter like this:

public @ResponseBody WebResponse<Boolean> updateEUSettings(
    final Locale locale,
    @Validated @RequestBody final EUPSettingsWrapper endUserPortalSettingsWrapper, 
    @RequestParam(value = "file1", required = true) final MultipartFile logo) {

    endUserPortalSettingsWrapper.setLogo(logo);

    // ...
}

In my mock MVC, I am setting:

getMockMvc().perform(fileUpload(uri).file(logo)
                        .accept(MediaType.APPLICATION_JSON)
                        .content(JSONUtils.toJSON(wrapper))
                        .contentType(MediaType.MULTIPART_FORM_DATA))
                        .andExpect(status().isOk());

But I'm getting an error like this which says:

org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'multipart/form-data' not supported

Does anyone have a good idea of how Multipart file uploads can be used with @RequestBody? Anything I am doing wrong above?

See this baeldung.com/sprint-boot-multipart-requests

Pavindu
– Pavindu

2022-01-09 11:55:50 +00:00
Commented Jan 9, 2022 at 11:55 — Pavindu
– Pavindu, Commented Jan 9, 2022 at 11:55

Max Farsikov · Accepted Answer · 2018-08-21 11:04:17Z

55

You can actually simplify your life here since all you are doing is submitting a form that contains some fields and file. You don't need @RequestBody for what you are trying to do. You can use regular Spring MVC features, so your controller method would look like:

@ResponseBody
public WebResponse<Boolean> updateEUSettings(
     Locale locale, 
     @Valid EUPSettingsWrapper endUserPortalSettingsWrapper, 
     @RequestParam(value = "file1", required = true) MultipartFile logo
) {


}

The client that submits the request to this controller will need to have a form with enctype="multipart/form-data".

In your Spring MVC test you would write something like this:

getMockMvc().perform(fileUpload(uri).file("file1", "some-content".getBytes()) 
                        .param("someEuSettingsProperty", "someValue")
                        .param("someOtherEuSettingsProperty", "someOtherValue")
                        .accept(MediaType.APPLICATION_JSON)
                        .contentType(MediaType.MULTIPART_FORM_DATA))
                        .andExpect(status().isOk());

edited Aug 21, 2018 at 11:04

Max Farsikov

2,8191 gold badge23 silver badges29 bronze badges

answered May 8, 2014 at 6:15

geoand

64.8k24 gold badges185 silver badges201 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Christos Karapapas Over a year ago

Very interesting, but how does the data looks in the Ajax POST request? Do you create a Object to represent EUPSettingsWrapper and a FormData to represent the MultipartFile and then you assign the FormData to, let's say, obj.logo ? Also do you JSON.stringify() that obj or not?

geoand Over a year ago

Unfortunately I don't really remember since the answer is pretty old :)

Dharmendrasinh Chudasama Over a year ago

Another way is encode your file bytes into base64 and then generated string can be use in request json, generally this patten is not recommended but for special schenarios: {"name":"aa","logo":encodeBase64(fileByteArray)} for encoding follow given url: stackoverflow.com/questions/22172604/…

Gueorgui Obregon · Accepted Answer · 2017-08-07 21:23:40Z

13

I couldn't find a way to use @RequestBody.

However, you can do something like this:

@RequestMapping(value = "/uploadStuff", method = RequestMethod.POST)
public MyViewDto doStuff(@RequestPart("json") @Valid MyDto dto,
                         @RequestPart("file") MultipartFile file) { ... }

You can test it like this:

MockMultipartFile jsonFile = new MockMultipartFile("json", "",
            "application/json", "{}".getBytes());
MockMultipartFile dataFile = new MockMultipartFile("file", "foo.zip", "application/octet-stream", bytes);

mockMvc.perform(fileUpload("/uploadStuff")
            .file(dataFile)
            .file(jsonFile))
            .andExpect(status().isOk());

edited Aug 7, 2017 at 21:23

Gueorgui Obregon

5,0833 gold badges36 silver badges60 bronze badges

answered Jul 31, 2015 at 19:28

hookumsnivy

2412 silver badges8 bronze badges

1 Comment

Akshay Naik Over a year ago

org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'application/octet-stream' not supported

Ankur Jain · Accepted Answer · 2014-05-08 05:52:45Z

12

Please add the following bean in your spring-servlet.xml to add the support for multipart request.

<bean id="multipartResolver"
    class="org.springframework.web.multipart.commons.CommonsMultipartResolver" />

Also don't forget to add the dependency for commons-fileupload jar

answered May 8, 2014 at 5:52

Ankur Jain

1,4043 gold badges18 silver badges27 bronze badges

1 Comment

Kenny Over a year ago

Also see this answer for how to set it up in a Java-based configuration: stackoverflow.com/a/29883166/3960852

Andy B · Accepted Answer · 2018-01-23 12:42:11Z

-1

I struggled a little with this and ended up passing as simple parameters. Fine if you don't have lots to pass in your request:

myMethod(@RequestParam("file") MultipartFile myFile,
        @RequestParam("param1") Float param1, @RequestParam("param2") String param2 {}

answered Jan 23, 2018 at 12:42

Andy B

6298 silver badges15 bronze badges

Comments

Jason Glez · Accepted Answer · 2018-10-25 00:08:49Z

-2

For Spring 4 and later you can do the following to get the full object:

public ResponseEntity<Object> upload(@Payload EUPSettingsWrapper wrapper) {

}

Note: Also should work without the tag

public ResponseEntity<Object> upload(EUPSettingsWrapper wrapper) {

}

answered Oct 25, 2018 at 0:08

Jason Glez

1,5201 gold badge18 silver badges19 bronze badges

Collectives™ on Stack Overflow

Spring Controller @RequestBody with file upload is it possible?

5 Answers 5

3 Comments

1 Comment

1 Comment

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

3 Comments

1 Comment

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related