如何正確使用MockMultipartFile實現文件上傳功能

一、MockMultipartFile是什麼

在測試文件上傳功能時，需要構造一個mock file。MockMultipartFile適用於我們的測試環境，它是Spring MVC框架提供的一個支持文件上傳的工具類。MockMultipartFile類可以用來生成一個基於內存的文件模擬實例，我們可以利用其提供的各種設置方法，生成一個代表某個資源的MultipartFile，將其傳遞給Bean（或者Service等其他處理上傳文件的組件）, 完成文件上傳的測試。

二、如何使用MockMultipartFile

在使用之前，需要先通過maven指定依賴

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-test</artifactId>
    <version>4.3.14.RELEASE</version>
    <scope>test</scope>
</dependency>

接著，我們可以在測試方法中使用MockMultipartFile生成一個模擬的上傳文件

MockMultipartFile file = new MockMultipartFile("file", "filename.txt", "text/plain", "File content".getBytes());

我們可以看到，構造方法需要指定4個參數。

• 第一個參數：上傳文件的名字，即表單中元素的name屬性值
• 第二個參數：上傳的文件名字
• 第三個參數：上傳文件的MediaType（媒體類型）
• 第四個參數：上傳文件的byte數組

三、如何測試文件上傳功能

一般來說，測試文件上傳功能有兩種方式：

• 模擬Spring MVC發送multipart/form-data請求
• 使用MockMultipartHttpServletRequest模擬multipart/form-data請求

四、使用MockMvc單元測試文件上傳功能

MockMvc是Spring MVC提供的一套測試工具，可以模擬Spring MVC的運行環境，測試我們的Controller的輸出結果是否正確。

首先我們需要構造一個MockMvc實例

@RunWith(SpringRunner.class)
@SpringBootTest
public class FileUploadControllerTest {

    private MockMvc mvc;

    @Autowired
    private WebApplicationContext webApplicationContext;

    @Before
    public void setUp() throws Exception {
        mvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
    }

    // 測試方法
}

接下來我們可以寫一個測試方法，測試文件上傳功能是否正確。

@Test
public void testUpload() throws Exception {
    //構造文件上傳請求
    MvcResult result = mvc.perform(MockMvcRequestBuilders.fileUpload("/upload")
            .file(new MockMultipartFile("file", "filename.txt", "text/plain", "hello world".getBytes())))
            .andExpect(status().isOk())
            .andReturn();
    //獲取響應結果
    String content = result.getResponse().getContentAsString();
    assertEquals("上傳成功", content);
}

上面的代碼中，我們通過MockMvcRequestBuilders.fileUpload(“/upload”)構造一個文件上傳的請求，通過file()方法上傳一個文件。最後按照常規的方式驗證返回結果是否正確。

五、使用MockMultipartHttpServletRequest測試文件上傳功能

MockMvc測試是模擬了Spring MVC的運行環境，測試效果更真實。但是有時候我們也需要直接測試我們的Service或者Bean層，沒有必要模擬整個Spring MVC的運行環境。這個時候我們就可以使用MockMultipartHttpServletRequest，直接構造一個multipart/form-data類型的Request，然後將其傳遞給Service層進行測試。

@RunWith(SpringRunner.class)
@SpringBootTest
public class FileUploadServiceTest {
 
    @Autowired
    private FileUploadService service;
 
    @Test
    public void testUpload() throws Exception {
        //構造文件上傳請求
        MockHttpServletRequest request = new MockHttpServletRequest();
        request.setContentType("multipart/form-data");
        MockMultipartHttpServletRequest mockRequest = new MockMultipartHttpServletRequest(request);
        MockMultipartFile file = new MockMultipartFile("file", "filename.txt", "text/plain", "hello world".getBytes());
        mockRequest.addFile(file);
 
        String result = service.upload(mockRequest.getFile("file"));
        assertEquals("上傳成功", result);
    }
}

上面的代碼中，我們構造了一個MockHttpServletRequest對象，設置請求類型為multipart/form-data。接著，我們構造了一個MockMultipartHttpServletRequest對象，並添加了一個MockMultipartFile對象作為上傳附件。最後，將構造的MockMultipartHttpServletRequest對象傳遞給了Service層進行測試，也就是service.upload()方法。

六、總結

本文主要介紹了如何使用MockMultipartFile類實現文件上傳功能的模擬測試和真正的單元測試。通過這種方式，我們不僅可以在Spring MVC項目中方便地測試文件上傳功能，也可以在非Spring MVC項目中測試上傳文件的代碼是否正常。