JAX-RS中没有很多完整的文件上传示例,尤其是RESTEasy 。 在这里,我们向您展示两个完整的RESTEasy示例,以处理从HTML表单上传文件。
- 通过
MultipartFormDataInput
处理上传文件的正常方法 - 通过
@MultipartForm
上传的文件映射到POJO类
1. RESTEasy多部分依赖
在RESTEasy中,您需要“ resteasy-multipart-provider.jar ”来处理分段文件上传。
档案:pom.xml
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-jaxrs</artifactId>
<version>2.2.1.GA</version>
</dependency>
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-multipart-provider</artifactId>
<version>2.2.0.GA</version>
</dependency>
<!-- optional, good for handle I/O task -->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.0.1</version>
</dependency>
2.文件上传HTML表单
简单的HTML表单即可上传文件。
<html>
<body>
<h1>JAX-RS Upload Form</h1>
<form action="rest/file/upload" method="post" enctype="multipart/form-data">
<p>
Select a file : <input type="file" name="uploadedFile" size="50" />
</p>
<input type="submit" value="Upload It" />
</form>
</body>
</html>
3.1 MultipartFormDataInput示例
第一个示例,上传的文件将自动映射到“ MultipartFormDataInput ”。
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import org.apache.commons.io.IOUtils;
import org.jboss.resteasy.plugins.providers.multipart.InputPart;
import org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput;
@Path("/file")
public class UploadFileService {
private final String UPLOADED_FILE_PATH = "d:\\";
@POST
@Path("/upload")
@Consumes("multipart/form-data")
public Response uploadFile(MultipartFormDataInput input) {
String fileName = "";
Map<String, List<InputPart>> uploadForm = input.getFormDataMap();
List<InputPart> inputParts = uploadForm.get("uploadedFile");
for (InputPart inputPart : inputParts) {
try {
MultivaluedMap<String, String> header = inputPart.getHeaders();
fileName = getFileName(header);
//convert the uploaded file to inputstream
InputStream inputStream = inputPart.getBody(InputStream.class,null);
byte [] bytes = IOUtils.toByteArray(inputStream);
//constructs upload file path
fileName = UPLOADED_FILE_PATH + fileName;
writeFile(bytes,fileName);
System.out.println("Done");
} catch (IOException e) {
e.printStackTrace();
}
}
return Response.status(200)
.entity("uploadFile is called, Uploaded file name : " + fileName).build();
}
/**
* header sample
* {
* Content-Type=[image/png],
* Content-Disposition=[form-data; name="file"; filename="filename.extension"]
* }
**/
//get uploaded filename, is there a easy way in RESTEasy?
private String getFileName(MultivaluedMap<String, String> header) {
String[] contentDisposition = header.getFirst("Content-Disposition").split(";");
for (String filename : contentDisposition) {
if ((filename.trim().startsWith("filename"))) {
String[] name = filename.split("=");
String finalFileName = name[1].trim().replaceAll("\"", "");
return finalFileName;
}
}
return "unknown";
}
//save to somewhere
private void writeFile(byte[] content, String filename) throws IOException {
File file = new File(filename);
if (!file.exists()) {
file.createNewFile();
}
FileOutputStream fop = new FileOutputStream(file);
fop.write(content);
fop.flush();
fop.close();
}
}
在此示例中,如果您从本地C驱动器中选择文件“ c:\\ abc.png ”,请单击“提交”按钮,然后它将上传到“ d:\\ abc.png ”。
下载它– JAX-RS-FileUpload-Resteasy-Example1.zip (8 KB)
3.2 MultipartForm示例
本示例会将上传的文件映射到POJO类,您需要像3.1示例一样处理inputPart
。
POJO文件,将上传的文件映射到此类。
import javax.ws.rs.FormParam;
import org.jboss.resteasy.annotations.providers.multipart.PartType;
public class FileUploadForm {
public FileUploadForm() {
}
private byte[] data;
public byte[] getData() {
return data;
}
@FormParam("uploadedFile")
@PartType("application/octet-stream")
public void setData(byte[] data) {
this.data = data;
}
}
处理上载的文件。
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.Response;
import org.jboss.resteasy.annotations.providers.multipart.MultipartForm;
@Path("/file")
public class UploadFileService {
@POST
@Path("/upload")
@Consumes("multipart/form-data")
public Response uploadFile(@MultipartForm FileUploadForm form) {
String fileName = "d:\\anything";
try {
writeFile(form.getData(), fileName);
} catch (IOException e) {
e.printStackTrace();
}
System.out.println("Done");
return Response.status(200)
.entity("uploadFile is called, Uploaded file name : " + fileName).build();
}
// save to somewhere
private void writeFile(byte[] content, String filename) throws IOException {
File file = new File(filename);
if (!file.exists()) {
file.createNewFile();
}
FileOutputStream fop = new FileOutputStream(file);
fop.write(content);
fop.flush();
fop.close();
}
}
问题是,您无法获取上传的文件名! 要解决此问题,您可以以HTML形式放置一个文本框,以便用户能够键入上载的文件名,然后通过@FormParam("filename")
将其映射到“ FileUploadForm ”。
下载它– JAX-RS-FileUpload-Resteasy-Example2.zip (8 KB)
结论
总体而言,RESTEasy能够很好地处理多部分内容,但是要获取上载的文件头信息(如文件名)相当困难。 或者,也许我不知道如何使用RESTEasy API?
注意
如果您有更优雅的方式来获取上传的文件名,请发表评论或纠正我。