OpenCMS 文件上传 Apache Jakarta Commons-FileUpload

yuanqiao

　　Apache Jakarta Commons-FileUpload

OpenCms提供了一个Applet用于文件上传，但这一功能在定制开发中受到很大限制，OpenCms带有Commons-FileUpload包，我们可以利用其中的功能实现文件上传

FileUpload可以结合你的应用被用于不同的情况。在最简单的情况下，你可以调用一个方法处理servlet请求，得到一个对象的列表用于你的应用系统。对于其他复杂的情况，你可以使用FileUpload控制整个上传的过程，例如你可以决定不同的内容存放到不同的地方或存储到数据库中。

FileUpload需要Commons IO支持，因此在使用FileUpload前明确相关的jar文件在classpath下。

一个文件上传的请求含有一个顺序的items的列表，他们由RFC 1867规则编码，“基于表单的文件提交”。FileUpload可以解析这样的请求，并把这些items生成一个列表供应用程序使用。每个items引用FileItem接口，我们会在后面详细讨论。

每个file items有一系列的properties会被应用程序使用。如：每一个item有一个文件名和一个内容，并能提供一个InputStream用于获得数据。FileItem接口提供了一系列方法以决定上传数据的来源。

FileUpload创建新的文件使用FileItemFactory。它给了FileUpload最大的扩展性。它提供了对每一个item的控制，如存入内存或磁盘。并且这些行为是可定制的，以适应你的系统。

* 检查请求是否含有上传文件
// Check that we have a file upload request
boolean isMultipart = ServletFileUpload.isMultipartContent(request);

* 解析上传请求：
// Create a factory for disk-based file items
FileItemFactory factory = new DiskFileItemFactory();

// Create a new file upload handler
ServletFileUpload upload = new ServletFileUpload(factory);

// Parse the request
List /* FileItem */ items = upload.parseRequest(request);
现在我们得到了items的列表

如果你的应用近于最简单的情况，上面的处理就够了。但我们有时候还是需要更多的控制。
下面提供了几种控制选择：
// Create a factory for disk-based file items
DiskFileItemFactory factory = new DiskFileItemFactory();

// Set factory constraints
factory.setSizeThreshold(yourMaxMemorySize);
factory.setRepository(yourTempDirectory);

// Create a new file upload handler
ServletFileUpload upload = new ServletFileUpload(factory);

// Set overall request size constraint
upload.setSizeMax(yourMaxRequestSize);

// Parse the request
List /* FileItem */ items = upload.parseRequest(request);

当然，每一种控制方法都是独立的，但你如果想一次性设置factory，你可以在构造方法中完成：
// Create a factory for disk-based file items
DiskFileItemFactory factory = new DiskFileItemFactory(
yourMaxMemorySize, yourTempDirectory);

一旦解析完成，你需要进一步处理item的列表。
// Process the uploaded items
Iterator iter = items.iterator();
while (iter.hasNext()) {
FileItem item = (FileItem) iter.next();

if (item.isFormField()) {
processFormField(item);
} else {
processUploadedFile(item);
}
}

区分数据是否为简单的表单数据，如果是简单的数据：
// Process a regular form field
if (item.isFormField()) {
String name = item.getFieldName();
String value = item.getString();
...
}

如果是提交的文件：
我们可以得到一些属性：
// Process a file upload
if (!item.isFormField()) {
String fieldName = item.getFieldName();
String fileName = item.getName();
String contentType = item.getContentType();
boolean isInMemory = item.isInMemory();
long sizeInBytes = item.getSize();
...
}

对于这些item，我们通常要把它们写入文件，或转为一个流
// Process a file upload
if (writeToFile) {
File uploadedFile = new File(...);
item.write(uploadedFile);
} else {
InputStream uploadedStream = item.getInputStream();
...
uploadedStream.close();
}

或转为字节数组保存在内存中：
// Process a file upload in memory
byte[] data = item.get();
...

如果这个文件真的很大，你可能会希望向用户报告到底传了多少到服务端，让用户了解上传的过程
//Create a progress listener
ProgressListener progressListener = new ProgressListener(){
public void update(long pBytesRead, long pContentLength, int pItems) {
System.out.println("We are currently reading item " + pItems);
if (pContentLength == -1) {
System.out.println("So far, " + pBytesRead + " bytes have been read.");
} else {
System.out.println("So far, " + pBytesRead + " of " + pContentLength
+ " bytes have been read.");
}
}
};
upload.setProgressListener(progressListener);