摘要：的官方文檔中將調(diào)用的入口稱作，而在的示例代碼中將其命名為，其實(shí)指的是同一個(gè)東西。其次是類至此，一個(gè)文件上傳的服務(wù)端接口已經(jīng)編寫完成。

SpringBoot的官方文檔中關(guān)于Jersey的介紹并不是很全面: 27.3 JAX-RS and Jersey，SpringBoot-Sample項(xiàng)目里面也只有非常基礎(chǔ)的代碼，對于一些復(fù)雜的常用需求，這個(gè)文檔給不了任何幫助。

為了使用Jersey提供的Restful API完成文件上傳功能，今天我花了不少時(shí)間查閱文檔資料，遇到了一些問題，然后不斷地踩坑嘗試，其中一些坑還是參照Stack Overflow的解決方案，甚至是框架官方文檔的說明而碰到的。主要問題就是，SpringBoot和Jersey的官方文檔沒有給出更詳細(xì)的內(nèi)容，Stack Overflow針對的問題很片面，不能適用于所有的情況，所以我打算將搭建項(xiàng)目的過程從頭到尾寫下來，以便有一個(gè)方便參照的教程。

我使用了Spring發(fā)布的Spring Tool Suit（STS）來創(chuàng)建項(xiàng)目，因?yàn)檫@個(gè)IDE使用SpringBoot十分方便，可以在創(chuàng)建項(xiàng)目時(shí)引入一些技術(shù)棧。

我使用的Java版本是JDK 8，后面會(huì)用到CURL這個(gè)命令行工具來測試相關(guān)的接口，大家可以先準(zhǔn)備好，以便學(xué)習(xí)過程連貫。

這個(gè)項(xiàng)目命名為demo-app，默認(rèn)包為org.demo，我在創(chuàng)建時(shí)僅添加了Jersey的支持，SpringBoot版本是1.5.10。

如果沒有STS，也可以用Eclipse創(chuàng)建一個(gè)Maven項(xiàng)目，Pom文件配置如下：

    4.0.0
    org.demo
    demo-app
    0.0.1-SNAPSHOT
    jar
    
        org.springframework.boot
        spring-boot-starter-parent
        1.5.10.RELEASE
         
    

    
        UTF-8
        UTF-8
        1.8
    

    
        
            org.springframework.boot
            spring-boot-starter-jersey
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

項(xiàng)目創(chuàng)建完成后，需要添加一個(gè)jersey-media-multipart的依賴，在pom中dependencies標(biāo)簽中添加：

    org.glassfish.jersey.media
    jersey-media-multipart

這個(gè)依賴不需要版本號(hào)，因?yàn)樵?b>spring-boot-starter-parent中已經(jīng)定義了版本，我們只需要添加一個(gè)dependency在具體項(xiàng)目中即可。

項(xiàng)目創(chuàng)建好時(shí)，已經(jīng)存在一個(gè)帶有main方法的入口類DemoAppApplication，我們不需要改動(dòng)它。

Jersey的官方文檔中將Restful API調(diào)用的入口稱作Resources，而在SpringBoot的示例代碼中將其命名為Endpoint，其實(shí)指的是同一個(gè)東西。因?yàn)槭褂昧薙pringBoot，為了風(fēng)格統(tǒng)一我使用了Endpoint的命名規(guī)則，這不是強(qiáng)制的，大家也可以自定義命名規(guī)則。但建議從這兩者中選擇一種，以便大家方便理解。

首先增加一個(gè)HelloEndpoint類：

package org.demo;

import java.io.IOException;
import java.io.InputStream;

import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.MediaType;

import org.apache.tomcat.util.http.fileupload.ByteArrayOutputStream;
import org.apache.tomcat.util.http.fileupload.IOUtils;
import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
import org.glassfish.jersey.media.multipart.FormDataParam;
import org.springframework.stereotype.Component;

@Component
@Path("/file")
public class FileUploadEndpoint {

    @POST
    @Consumes(MediaType.MULTIPART_FORM_DATA)
    public String upload(@FormDataParam("file") InputStream fis,
            @FormDataParam("file") FormDataContentDisposition fileDisposition) {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        try {
            IOUtils.copy(fis, baos);
            String content = new String(baos.toByteArray());
            return content;
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }
}

它十分類似于SpringMVC的Controller，但是擁有更規(guī)范更嚴(yán)格的REST風(fēng)格，而且它不能像SpringMVC一樣通過返回一個(gè)視圖名稱指向某個(gè)視圖。

其次是JerseyConfig類：

package org.demo;

import javax.ws.rs.ApplicationPath;

import org.glassfish.jersey.media.multipart.MultiPartFeature;
import org.glassfish.jersey.server.ResourceConfig;
import org.springframework.stereotype.Component;

@Component
@ApplicationPath("/rest/demo")
public class JerseyConfig extends ResourceConfig {

    public JerseyConfig() {
        register(MultiPartFeature.class);
        register(FileUploadEndpoint.class);
    }

}

至此，一個(gè)文件上傳的服務(wù)端接口已經(jīng)編寫完成。關(guān)于表單頁面這里不多做說明，因?yàn)檫@個(gè)項(xiàng)目不是一個(gè)Web項(xiàng)目，而是Web Service的服務(wù)端，不能在項(xiàng)目中直接訪問靜態(tài)Web資源。也不建議使用特殊方法滿足這種需要，我們應(yīng)當(dāng)保持項(xiàng)目的純凈。

需要注意@ApplicationPath這個(gè)注解，它決定了所有Endpoint的基礎(chǔ)路徑。

下面我們來測試一下這個(gè)Restful API是否能正常工作，運(yùn)行DemoAppApplication，等待項(xiàng)目部署。

接下來準(zhǔn)備使用CURL測試，CURL可以到官網(wǎng)下載操作系統(tǒng)對應(yīng)的版本。創(chuàng)建一個(gè)demo.txt文件保存到任意目錄，文件內(nèi)容寫入Test my restful api with curl.，使用英文是為了避免CMD命令行中的中文出現(xiàn)亂碼的情況，這里不用過多在意，我們只要關(guān)注結(jié)果。

進(jìn)入demo.txt文件所在的目錄，按住Shift打開CMD或者PowerShell（Linux系統(tǒng)下打開終端定位到該目錄），執(zhí)行：curl -X POST -F "[email protected]" http://localhost:8080/rest/demo/file

如果得到Test my restful api with curl.的回顯，說明Restful API部署成功，并且能夠接收上傳的文件。

在實(shí)現(xiàn)利用Jersey完成文件上傳的過程中，我遇到的一些問題需要大家特別關(guān)注：

SpringBoot沒有默認(rèn)添加jersey-media-multipart依賴，僅預(yù)先定義了需要的版本，如果未引入這個(gè)包，將無法使用@FormDataParam注解和Multipart相關(guān)的類，無法對Multipart內(nèi)容進(jìn)行解析；

JerseyConfig中需要注冊MultiPartFeature.class，否則會(huì)出現(xiàn)報(bào)錯(cuò)，無法正確注入文件輸入流對象。報(bào)錯(cuò)的時(shí)機(jī)根據(jù)是否延遲加載決定，如果application.properties定義了spring.jersey.servlet.load-on-startup=1，會(huì)在項(xiàng)目啟動(dòng)時(shí)報(bào)錯(cuò)；否則會(huì)在首次上傳文件，初始化FileUploadEndpoint時(shí)報(bào)錯(cuò)。

關(guān)于FileUploadEndpoint.upload()方法，有些文檔和教程中，fileDisposition對象使用了ContentDisposition類來定義，盡管它是FormDataContentDisposition的父類，但仍然會(huì)報(bào)錯(cuò)，原因未知。建議直接使用FormDataContentDisposition