前言:因自己負責的項目(jetty內嵌啟動的SpringMvc)中需要實現文件上傳,而自己對java文件上傳這一塊未接觸過,且對 Http 協議較模糊,故這次采用漸進的方式來學習文件上傳的原理與實踐。該博客重在實踐。
一. Http協議原理簡介
HTTP是一個屬於應用層的面向對象的協議,由於其簡捷、快速的方式,適用於分布式超媒體信息系統。它於1990年提出,經過幾年的使用與發展,得到不斷地完善和擴展。目前在WWW中使用的是HTTP/1.0的第六版,HTTP/1.1的規范化工作正在進行之中,而且HTTP-NG(Next Generation of HTTP)的建議已經提出。
簡單來說,就是一個基於應用層的通信規范:雙方要進行通信,大家都要遵守一個規范,這個規范就是HTTP協議。
1.特點:
(1)支持客戶/服務器模式。
(2)簡單快速:客戶向服務器請求服務時,只需傳送請求方法和路徑。請求方法常用的有GET、HEAD、POST。每種方法規定了客戶與服務器聯系的類型不同。由於HTTP協議簡單,使得HTTP服務器的程序規模小,因而通信速度很快。
(3)靈活:HTTP允許傳輸任意類型的數據對象。正在傳輸的類型由Content-Type加以標記。
(4)無連接:無連接的含義是限制每次連接只處理一個請求。服務器處理完客戶的請求,並收到客戶的應答后,即斷開連接。采用這種方式可以節省傳輸時間。
(5)無狀態:HTTP協議是無狀態協議。無狀態是指協議對於事務處理沒有記憶能力。缺少狀態意味着如果后續處理需要前面的信息,則它必須重傳,這樣可能導致每次連接傳送的數據量增大。另一方面,在服務器不需要先前信息時它的應答就較快。
注意:其中(4)(5)是面試中常用的面試題。雖然HTTP協議(應用層)是無連接,無狀態的,但其所依賴的TCP協議(傳輸層)卻是常連接、有狀態的,而TCP協議(傳輸層)又依賴於IP協議(網絡層)。
2.HTTP消息的結構
(1)Request 消息分為3部分,第一部分叫請求行, 第二部分叫http header消息頭, 第三部分是body正文,header和body之間有個空行, 結構如下圖
(2)Response消息的結構, 和Request消息的結構基本一樣。 同樣也分為三部分,第一部分叫request line狀態行, 第二部分叫request header消息體,第三部分是body正文, header和body之間也有個空行, 結構如下圖
下面是使用Fiddler捕捉請求baidu的Request消息機構和Response消息機構:
因為沒有輸入任何表單信息,故request的消息正文為空,大家可以找一個登錄的頁面試試看。
先到這里,HTTP協議的知識網上很豐富,在這里就不再熬述了。
二. 文件上傳的三種實現
1. Jsp/servlet 實現文件上傳
這是最常見也是最簡單的方式
(1)實現文件上傳的Jsp頁面
(2)負責接文件的FileUploadServlet
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.log4j.Logger;
// @WebServlet(name = "FileLoadServlet", urlPatterns = {"/fileload"})
publicclass FileLoadServlet extends HttpServlet {
privatestatic Logger logger = Logger.getLogger(FileLoadServlet.class);
privatestaticfinallong serialVersionUID = 1302377908285976972L;
@Override
protectedvoid service(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {
logger.info("------------ FileLoadServlet ------------");
if(request.getContentLength()> 0){
InputStream inputStream =null;
FileOutputStream outputStream =null;
try{
inputStream = request.getInputStream();
// 給新文件拼上時間毫秒,防止重名
long now = System.currentTimeMillis();
File file =new File("c:/","file-"+ now +".txt");
file.createNewFile();
outputStream =new FileOutputStream(file);
byte temp[]=newbyte[1024];
int size =-1;
while((size = inputStream.read(temp))!=-1){// 每次讀取1KB,直至讀完
outputStream.write(temp, 0, size);
}
logger.info("File load success.");
}catch(IOException e){
logger.warn("File load fail.", e);
request.getRequestDispatcher("/fail.jsp").forward(request, response);
}finally{
outputStream.close();
inputStream.close();
}
}
request.getRequestDispatcher("/succ.jsp").forward(request, response);
}
}
FileUploadServlet的配置,推薦采用servlet3.0注解的方式更方便
<servlet>
<servlet-name>FileLoadServlet</servlet-name>
<servlet-class>com.juxinli.servlet.FileLoadServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>FileLoadServlet</servlet-name>
<url-pattern>/fileload</url-pattern>
</servlet-mapping>
(3)運行效果
點擊"submit"
頁面轉向文件上傳成功的頁面,再去C盤看看,發現多了一個文件:file-1433417127748.txt,這個就是剛上傳的文件
我們打開看看,發現和原來的文本有些不一樣
結合前面講的HTTP協議的消息結構,不難發現這些文本就是去掉"請求頭"后的"Request消息體"。所以,如果要得到與上傳文件一致的文本,還需要一些字符串操作,這些就留給大家了。
另外,大家可以試試一個Jsp頁面上傳多個文件,會有不一樣的精彩哦o(∩_∩)o ,不解釋。
2. 模擬Post請求/servlet 實現文件上傳
剛才我們是使用Jsp頁面來上傳文件,假如客戶端不是webapp項目呢,顯然剛才的那種方式有些捉襟見襯了。
這里我們換種思路,既然頁面上通過點擊可以實現文件上傳,為何不能通過HttpClient來模擬瀏覽器發送上傳文件的請求呢。關於HttpClient ,大家可以自己去了解。
(1)還是這個項目,啟動servlet服務
(2)模擬請求的FileLoadClient
import java.io.BufferedReader;
import java.io.File;
import java.io.InputStream;
import java.io.InputStreamReader;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.multipart.FilePart;
import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity;
import org.apache.commons.httpclient.methods.multipart.Part;
import org.apache.log4j.Logger;
publicclass FileLoadClient {
privatestatic Logger logger = Logger.getLogger(FileLoadClient.class);
publicstatic String fileload(String url, File file){
String body ="{}";
if(url ==null|| url.equals("")){
return"參數不合法";
}
if(!file.exists()){
return"要上傳的文件名不存在";
}
PostMethod postMethod =new PostMethod(url);
try{
// FilePart:用來上傳文件的類,file即要上傳的文件
FilePart fp =new FilePart("file", file);
Part[] parts ={ fp };
// 對於MIME類型的請求,httpclient建議全用MulitPartRequestEntity進行包裝
MultipartRequestEntity mre =new MultipartRequestEntity(parts, postMethod.getParams());
postMethod.setRequestEntity(mre);
HttpClient client =new HttpClient();
// 由於要上傳的文件可能比較大 , 因此在此設置最大的連接超時時間
client.getHttpConnectionManager().getParams().setConnectionTimeout(50000);
int status = client.executeMethod(postMethod);
if(status == HttpStatus.SC_OK){
InputStream inputStream = postMethod.getResponseBodyAsStream();
BufferedReader br =new BufferedReader(new InputStreamReader(inputStream));
StringBuffer stringBuffer =new StringBuffer();
String str ="";
while((str = br.readLine())!=null){
stringBuffer.append(str);
}
body = stringBuffer.toString();
}else{
body ="fail";
}
}catch(Exception e){
logger.warn("上傳文件異常", e);
}finally{
// 釋放連接
postMethod.releaseConnection();
}
return body;
}
publicstaticvoid main(String[] args)throws Exception {
String body = fileload("http://localhost:8080/jsp_upload-servlet/fileload",new File("C:/1111.txt"));
System.out.println(body);
}
}
(3)在Eclipse中運行FileLoadClient程序來發送請求,運行結果:
<html><head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /></head><body><h2>File upload success</h2><a href="index.jsp">return</a></body></html>
打印了:文件上傳成功的succ.jsp頁面
有沒有發現什么,是不是和前面Jsp頁面上傳的結果類似?對的,還是去掉"請求頭"后的"Request消息體"。
這種方式也很簡單,負責接收文件的FileUploadServlet沒有變,只要在客戶端把文件讀取到流中,然后模擬請求servlet就行了。
3.模擬Post請求/Controller(SpringMvc)實現文件上傳
終於到第三種方式了,主要難點在於搭建maven+jetty+springmvc環境,接收文件的service和模擬請求的客戶端 和上面相似。
(1)模擬請求的FileLoadClient未變
import java.io.BufferedReader;
import java.io.File;
import java.io.InputStream;
import java.io.InputStreamReader;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.multipart.FilePart;
import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity;
import org.apache.commons.httpclient.methods.multipart.Part;
import org.apache.log4j.Logger;
publicclass FileLoadClient {
privatestatic Logger logger = Logger.getLogger(FileLoadClient.class);
publicstatic String fileload(String url, File file){
String body ="{}";
if(url ==null|| url.equals("")){
return"參數不合法";
}
if(!file.exists()){
return"要上傳的文件名不存在";
}
PostMethod postMethod =new PostMethod(url);
try{
// FilePart:用來上傳文件的類,file即要上傳的文件
FilePart fp =new FilePart("file", file);
Part[] parts ={ fp };
// 對於MIME類型的請求,httpclient建議全用MulitPartRequestEntity進行包裝
MultipartRequestEntity mre =new MultipartRequestEntity(parts, postMethod.getParams());
postMethod.setRequestEntity(mre);
HttpClient client =new HttpClient();
// 由於要上傳的文件可能比較大 , 因此在此設置最大的連接超時時間
client.getHttpConnectionManager().getParams().setConnectionTimeout(50000);
int status = client.executeMethod(postMethod);
if(status == HttpStatus.SC_OK){
InputStream inputStream = postMethod.getResponseBodyAsStream();
BufferedReader br =new BufferedReader(new InputStreamReader(inputStream));
StringBuffer stringBuffer =new StringBuffer();
String str ="";
while((str = br.readLine())!=null){
stringBuffer.append(str);
}
body = stringBuffer.toString();
}else{
body ="fail";
}
}catch(Exception e){
logger.warn("上傳文件異常", e);
}finally{
// 釋放連接
postMethod.releaseConnection();
}
return body;
}
publicstaticvoid main(String[] args)throws Exception {
String body = fileload("http://localhost:8080/fileupload/upload",new File("C:/1111.txt"));
System.out.println(body);
}
}
(2)servlet換為springMvc中的Controller
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.log4j.Logger;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@Controller
@RequestMapping("/fileupload")
publicclass FileUploadService {
private Logger logger = Logger.getLogger(FileUploadService.class);
@RequestMapping(consumes ="multipart/form-data", value ="/hello", method = RequestMethod.GET)
publicvoid hello(HttpServletRequest request, HttpServletResponse response)throws IOException {
response.getWriter().write("Hello, jetty server start ok.");
}
@RequestMapping(consumes ="multipart/form-data", value ="/upload", method = RequestMethod.POST)
publicvoid uploadFile(HttpServletRequest request, HttpServletResponse response)throws IOException {
String result ="";
if(request.getContentLength()> 0){
InputStream inputStream =null;
FileOutputStream outputStream =null;
try{
inputStream = request.getInputStream();
// 給新文件拼上時間毫秒,防止重名
long now = System.currentTimeMillis();
File file =new File("c:/","file-"+ now +".txt");
file.createNewFile();
outputStream =new FileOutputStream(file);
byte temp[]=newbyte[1024];
int size =-1;
while((size = inputStream.read(temp))!=-1){// 每次讀取1KB,直至讀完
outputStream.write(temp, 0, size);
}
logger.info("File load success.");
result ="File load success.";
}catch(IOException e){
logger.warn("File load fail.", e);
result ="File load fail.";
}finally{
outputStream.close();
inputStream.close();
}
}
response.getWriter().write(result);
}
}
(3)啟動jetty的核心代碼,在Eclipse里面右鍵可以啟動,也可以把項目打成jar報啟動
import org.apache.log4j.Logger;
import org.eclipse.jetty.server.Connector;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.ServerConnector;
import org.eclipse.jetty.webapp.WebAppContext;
publicclass Launcher
{
privatestatic Logger logger = Logger.getLogger(Launcher.class);
privatestaticfinalint PORT = 8080;
privatestaticfinal String WEBAPP ="src/main/webapp";
privatestaticfinal String CONTEXTPATH ="/";
privatestaticfinal String DESCRIPTOR ="src/main/webapp/WEB-INF/web.xml";
/*
* 創建 Jetty Server,指定其端口、web目錄、根目錄、web路徑
* @param port
* @param webApp
* @param contextPath
* @param descriptor
* @return Server
*/
publicstatic Server createServer(int port, String webApp, String contextPath, String descriptor){
Server server =new Server();
//設置在JVM退出時關閉Jetty的鈎子
//這樣就可以在整個功能測試時啟動一次Jetty,然后讓它在JVM退出時自動關閉
server.setStopAtShutdown(true);
ServerConnector connector =new ServerConnector(server);
connector.setPort(port);
//解決Windows下重復啟動Jetty不報告端口沖突的問題
//在Windows下有個Windows + Sun的connector實現的問題,reuseAddress=true時重復啟動同一個端口的Jetty不會報錯
//所以必須設為false,代價是若上次退出不干凈(比如有TIME_WAIT),會導致新的Jetty不能啟動,但權衡之下還是應該設為False
connector.setReuseAddress(false);
server.setConnectors(new Connector[]{connector});
WebAppContext webContext =new WebAppContext(webApp, contextPath);
webContext.setDescriptor(descriptor);
// 設置webapp的位置
webContext.setResourceBase(webApp);
webContext.setClassLoader(Thread.currentThread().getContextClassLoader());
server.setHandler(webContext);
return server;
}
/**
* 啟動jetty服務
*/
publicvoid startJetty(){
final Server server = Launcher.createServer(PORT, WEBAPP, CONTEXTPATH, DESCRIPTOR);
try{
server.start();
server.join();
}catch(Exception e){
logger.warn("啟動 jetty server 失敗", e);
System.exit(-1);
}
}
publicstaticvoid main(String[] args){
(new Launcher()).startJetty();
// jetty 啟動后的測試url
// http://localhost:8080/fileupload/hello
}
}
springMvc的配置不貼了,大家可以下載源碼下來看。
(4)運行效果
上傳包含1W個文件的文件夾,正常
大型文件續傳功能正常 。
文件批量上傳正常
服務器中已經根據日期+GUID生成了目錄
數據庫中也有記錄
后端代碼邏輯大部分是相同的,目前能夠支持MySQL,Oracle,SQL。在使用前需要配置一下數據庫,可以參考我寫的這篇文章:http://blog.ncmem.com/wordpress/2019/08/09/%e4%b8%8a%e4%bc%a0%e6%9c%ac%e5%9c%b0%e6%96%87%e4%bb%b6%e7%9a%84%e4%bb%a3%e7%a0%81/