multipart/form-data MutlipartFile不是通过所有args构造函数设置的

Question

为了实现带有附加元信息的文件上载endpoint，我编写了以下@RestController:

@RestController
@RequestMapping(Resource.ROOT)
@AllArgsConstructor(onConstructor = @__({@Inject}))
public class Resource {
  public static final String ROOT = "/test";

  private final Logger logger;

  @PostMapping(consumes = MediaType.MULTIPART_FORM_DATA, produces = MediaType.APPLICATION_JSON)
  public ResponseEntity<Void> test(@Valid final Request request) {
    logger.info("request = {}", request);
    return ResponseEntity.ok().build();
  }
}

request指定为：

@Value
@AllArgsConstructor
public class Request {

  @NotNull
  String name;

  @NotNull
  MultipartFile file;
}

和一个快乐小路测试：

@SpringBootTest
@AutoConfigureMockMvc
class TestCase {

  @Autowired
  private MockMvc mockMvc;

  @Test
  void shouldReturnOk() throws Exception {
    // GIVEN
    final byte[] content = Files.readAllBytes(Path.of(".", "src/test/resources/PenPen.png"));
    final String name = "name";

    // WHEN
    // @formatter:off
    mockMvc.perform(MockMvcRequestBuilders
        .multipart(Resource.ROOT)
            .file("file", content)
            .param("name", name))

    // THEN
        .andExpect(status().isOk());
    // @formatter:on
  }
}

运行测试(./mvnw test)时，它失败，endpoint返回400错误请求而不是200确定。读取日志显示请求参数file为null:

...
     Content type = text/plain;charset=UTF-8
             Body = file: must not be null.
...

我部分理解为什么它是空。有了这些部分知识，我可以通过使request中的字段file可变来规避这个问题：

@ToString
@Getter
@AllArgsConstructor
public class Request {

  @NotNull
  private final String name;

  @Setter
  @NotNull
  private MultipartFile file;
}

“修复”问题的代码可以在Bitbucket,branchproblem-solled-by-making-field-mutable上找到。

但是，这使得request变了，我想防止这种情况发生。为了进一步研究，我展开了request上的lombok注释，并添加了一些日志记录：

public class Request {

  private static final Logger LOGGER = LoggerFactory.getLogger(Request.class);

  @NotNull
  private final String name;

  @NotNull
  private MultipartFile file;

  public Request(final String name, final MultipartFile file) {
    this.name = name;
    this.setFile(file);
  }

  public @NotNull String getName() {
    return this.name;
  }

  public @NotNull MultipartFile getFile() {
    return this.file;
  }

  public String toString() {
    return "Request(name=" + this.getName() + ", file=" + this.getFile() + ")";
  }

  public void setFile(final MultipartFile file) {
    LOGGER.info("file = {}", file);
    this.file = file;
  }
}

展开版本的代码可以在Bitbucket，分支lombok-unrolled-for-debugging上找到。

在查看现在成功的测试的日志语句时，我们可以看到request::setfile被调用了两次：

2020-09-05 09:42:31.049  INFO 11012 --- [           main] d.turing85.springboot.multipart.Request  : file = null
2020-09-05 09:42:31.056  INFO 11012 --- [           main] d.turing85.springboot.multipart.Request  : file = org.springframework.mock.web

第一个调用来自构造函数调用。我想第二个调用来自Spring表单参数映射机制中的某个地方。

我知道有可能在endpoint上单独定义表单参数，并在方法中构造request实例：

public class Resource {
  ...
  @PostMapping(consumes = MediaType.MULTIPART_FORM_DATA, produces = MediaType.APPLICATION_JSON)
  public ResponseEntity<Void> test(
      @RequestPart(name = "name") final String name,
      @RequestPart(name = "file") final MultipartFile file) {
    final Request request = new Request(name, file);
    logger.info("request = {}", request);
    return ResponseEntity.ok().build();
  }
}

然而，这将导致其他问题。例如，我们必须为MissingServletRequestPartException添加一个额外的异常映射器，并将返回的HTTP响应与Bindexception的现有响应对齐。如果可能的话，我想避免这样做。

Answer 1

 @PostMapping(consumes = MediaType.MULTIPART_FORM_DATA_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
 public ResponseEntity<Void> test(@Valid @ModelAttribute final RequestDto request) {
     return ResponseEntity.ok().build();
 }

它仍然在使用rest api调用。但我真的没有得到你的一成不变的关心。

如果定义了多部分数据setter，则可以使用modelAttribute。

@SpringBootTest
@AutoConfigureMockMvc
class FileUploadControllerIT {

    @Autowired
    private MockMvc mockMvc;

    @Test
    void shouldReturnOk() throws Exception {
        // GIVEN
        final byte[] content = Files.readAllBytes(Paths.get(Thread.currentThread().getContextClassLoader().getResource("text.txt").toURI()));
        final String name = "name";

        // WHEN
        // @formatter:off
        mockMvc.perform(MockMvcRequestBuilders
                .multipart("/context/api/v1")
                .file("multipartFile", content)
                .param("name", name))

                // THEN
                .andExpect(status().isOk());
        // @formatter:on
    }
}

上面的代码与ModelAttribute一起工作。