spring boot + vue でマルチパートファイルのアップロード

Question

現状

Java側でクライアントからPOSTしたファイルオブジェクトを受け取れていない（nullになる）

java側実装

• MultipartFile型で待ち受けている。（以下の実装ではログ出力も含めています）

import org.springframework.web.multipart.MultipartFile;

@PostMapping("/upload-file")
	public ResponseEntity<Object> upload(@AuthenticationPrincipal UserDetails userDetails,
			@RequestBody MultipartFile files) {
		log.error("ふぁいるあっぷろーど");
		log.info("Hello, {}", files);

vue側実装

<template>
  <form method="POST" action enctype="multipart/form-data" id="fileinfo">
        <input
          id="upload_file"
          type="file"
          name="file"
          style="display:none"
          @change="upload"
        />
      </form>
</template>
<script>
//FormDataオブジェクトに詰めてactionへdispatch
async upload(file, fileList) {
    const form = document.getElementById('fileinfo')[0]
    const files = new FormData()
    files.append('upload_file', form.value)
    await Promise.all([
      this.$store
        .dispatch('/upload', files)
</script>

async upload({ commit }, file) {
    const response = await this.$axios.$post<UploadRsltTransfer>(
      '/upload-file',
      file
    )

結果(リクエストヘッダー）

結果（サーバ側ログ）

実装についてご指摘をいただけると大変うれしく思います。よろしくお願いします。

Answer 1

Java側のコードに問題があるようです。Vue側については開発経験があまり無いのと提示されているコードが断片的なのでよくわかりません。
とりあえず、動作確認できたサンプルコードを下記に提示しますのでご参考になれば幸いです。

サンプルコード (Spring Boot)

ポストされたファイルを受け取るには@RequestBody MultipartFileではなく、@RequestParam("file") MultipartFileである必要があります。

環境

• OpenJDK 13.0.1
• Spring Boot 2.2.1

アプリケーションのエンドポイントはhttp://localhost:8080/uploadです。
アップロードされた画像ファイルをBase64エンコードしてレスポンスします。

@CrossOrigin(origins = "http://localhost:3000")
@PostMapping(value = "/upload", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<Map<String, String>> fileUpload(@RequestParam("name") String name,
                                                      @RequestParam("file") MultipartFile uploadFile) throws Exception {

  if (uploadFile.isEmpty()) {
    return ResponseEntity.badRequest().build();
  }

  log.info("name:{}", name);
  log.info("uploadFile name:{}", uploadFile.getOriginalFilename());
  log.info("uploadFile size:{}", uploadFile.getSize());  

  byte[] image = uploadFile.getBytes();
  String base64EncodedImage = "data:image/jpeg;base64," + new String(Base64.encodeBase64(image), StandardCharsets.US_ASCII);  
  Map<String, String> res = Map.of("base64", base64EncodedImage, "name", name);

  return ResponseEntity.ok(res);
}

動作確認コマンド

demo.jpgという画像ファイルをエンドポイントへpostできるかcurlで動作確認します。このようにバックエンド側だけでテストしてみて、問題がフロントとバンクエンドのどちらにあるか切り分けます。

curl -v -X POST "localhost:8080/upload" -F "name=demo.jpg" -F "file=@demo.jpg;type=image/jpg"

postが成功すると下記のjsonオブジェクトがレスポンスされます。

{"base64":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDA ...省略... igD/2Q==","name":"demo.jpg"}

サンプルコード (Nuxt.js)

環境

• Nuxt.js 2.10
• SSR モード

コンポーネント

pages/fileupload.vue

<template>

  <div>
    <form>
      <input @change="uploadFile" type="file" name="file" />
    </form>
  </div>
  <div v-for="(file, i) in files" :key="i">
    <span>{{ i }} - {{ file.name }}</span>
    <img :src="file.image" />
  </div>

</template>

<script>
import { mapState, mapActions } from 'vuex'

export default {
  computed: {
    ...mapState({
      files: (state) => state.fileupload.files
    })
  },
  methods: {
    ...mapActions({
      uploadFile: 'fileupload/uploadFile'
    })
  }
}
</script>

vuex

store/fileupload.js

export const state = () => ({
  files: []
})

export const actions = {
  async uploadFile(context, event) {
    const file = (event.target.files || event.dataTransfer.files)[0]

    const formData = new FormData()
    formData.append('name', file.name)
    formData.append('file', file)

    const response = await this.$axios
      .post('http://localhost:8080/upload', formData, {
        headers: { 'Content-Type': 'multipart/form-data' }
      })
      .then((response) => {
        context.commit('add', {
          name: response.data.name,
          image: response.data.base64
        })
      })
      .catch((error) => {
        return error.response
      })

    return response
  }
}

export const mutations = {
  add(state, payload) {
    state.files.push({
      name: payload.name,
      image: payload.image
    })
  }
}

Comments

[sanezane]

大変丁寧な回答ありがとうございます。
ご指摘の通りサーバ側に問題がありました。
切り分けの仕方がとても勉強になりました。高評価10くらいつけたいような回答でした。
コンテンツタイプ（mutipartなど）やcurlなどの基礎知識をもっと使いこなせるようにしなければ。