HttpClient MultipartEntityBuilder 上傳文件

時間 2019-12-04

標籤 httpclient multipartentitybuilder 上傳文件欄目系統網絡简体版

原文原文鏈接

　在HttpCient4.3以後上傳文件主要使用的類是位於org.apache.http.entity.mime下的MultipartEntityBuilder（原先的MultipartEntity已經基本棄用了）。

　　1.首先是設置上傳的模式；

　　setMode(HttpMultipartMode mode)，其中mode主要有BROWSER_COMPATIBLE，RFC6532，STRICT三種，默認值是STRICT。

　　2.其次是建立MultipartEntityBuilder對象，並添加須要上傳的數據；

　　a.利用MultipartEntityBuilder.create()來建立對象；

　　b.addBinaryBody：以二進制的形式添加數據，能夠添加File、InputStream、byte[]類型的數據。

　　addBinaryBody(String name, File file, ContentType contentType, String filename)

　　addBinaryBody(String name, InputStream stream, ContentType contentType, String filename)

　　addBinaryBody(String name, byte[] b, ContentType contentType, String filename)

　　c.addTextBody：添加文本數據

　　addTextBody(String name, String text, ContentType contentType)

　　d.addPart：以Key/Value的形式添加ContentBody類型的數據

　　addPart(String name, ContentBody contentBody)

　　更多函數能夠參考：https://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntityBuilder.html。在GACHA API中，主要是上傳圖片，因此在測試中選用了addBinaryBody。其中，第一個參數name的值，是服務器已經定義好的，服務器會根據這個字段來讀取咱們上傳的文件流，不匹配則會報錯。關於contentType，能夠參考：http://tool.oschina.net/commons，不一樣文件擴展名所對應的類型。而file/stream和fileName，就是咱們所要上傳文件的信息。當用瀏覽器的開發者工具查看API請求時，咱們會看到這些/參數基本位於API請求中的 Request Payload字段。

　　3.而後是利用build()方法建立一個HttpEntity對象；

　　4.最後將HttpEntity對象添加到指定的URL上，採用HttpPost的setEntity的方法；

　　5.最後的最後，就是調用HttpClient對象發送請求，並獲取服務器的響應

在HttpCient4.3以前上傳文件主要使用MultipartEntity這個類，但如今這個類已經不在推薦使用了。隨之替代它的類是MultipartEntityBuilder。php

下面讓咱們瞭解一下MultipartEntityBuilder類：

MultipartEntityBuilder這個類主要用於建立HttpEntity。它的主要方法有：html

修飾符和類型java	方法和描述android
MultipartEntityBuilderapache	addBinaryBody(String name, byte[] b) api 將字節數組以二進制的形式添加數據。數組
MultipartEntityBuilder瀏覽器	addBinaryBody(String name, byte[] b, ContentType contentType, String filename) 服務器將字節數組以二進制的形式添加數據。app
MultipartEntityBuilder	addBinaryBody(String name, File file) 將文件以二進制的形式添加數據。
MultipartEntityBuilder	addBinaryBody(String name, File file, ContentType contentType, String filename) 將文件以二進制的形式添加數據。
MultipartEntityBuilder	addBinaryBody(String name, InputStream stream)
MultipartEntityBuilder	addBinaryBody(String name, InputStream stream, ContentType contentType, String filename) 將輸入流以二進制的形式添加數據。
MultipartEntityBuilder	addPart(String name, ContentBody contentBody) 添加ContentBody 類型的數據。
MultipartEntityBuilder	addTextBody(String name, String text) 添加文本數據。
MultipartEntityBuilder	addTextBody(String name, String text, ContentType contentType) 以指定的內容類型添加文本數據。
HttpEntity	build() 建立一個HttpEntity。
static MultipartEntityBuilder	create() 建立一個MultipartEntityBuilder對象。
MultipartEntityBuilder	setBoundary(String boundary) 設置邊界。
MultipartEntityBuilder	setCharset(Charset charset) 設置請求的編碼格式。
MultipartEntityBuilder	setLaxMode()
MultipartEntityBuilder	setMode(HttpMultipartMode mode) 設置模式。
MultipartEntityBuilder	setStrictMode()

主要方法說明：

addBinaryBody、addPart、addTextBody方法用於添加要上傳的數據，從上面的表格中能夠發現用於添加數據的方法，都是key-value類型。因此在服務器端咱們能夠經過request.getPart("keyname")方式獲取對應key的數據。也能夠經過request.getParts()方式獲取客戶端經過以上三種方法提交全部數據。

1.經過addBinaryBody方法直接能夠添加File、InputStream、byte[]類型的數據。

2.經過addPart方法只能添加ContentBody類型的數據，在org.apache.http.entity.mime.content包中已經提供了String、File以及InputStream對應的ContentBody類型的子類，如FileBody、InputStreamBody、StringBody，經過這些類咱們能夠將String、File以及InputStream類型的數據轉換成ContentBody類型的數據。

3.經過addTextBody方法咱們能夠很方便的添加文本數據。

2.經過HttpCient上傳文件

Android端須要添加httpcore-4.3.2.jar、httpmime-4.3.5.jar兩個包。兩個包缺一不可。

在這裏我用的是最新版的HttpCient，你們能夠從http://hc.apache.org/downloads.cgi上下載所須要的jar包，若是上面的網站打不開，你們也不用擔憂，我已經將項目中所須要的jar包上傳到CSDN上《httpcomponents-client-4.3.5-bin.zip》須要的朋友能夠去下載。

Android端項目核心代碼：

[java] view plain copy

HttpClient client=new DefaultHttpClient();// 開啓一個客戶端 HTTP 請求
HttpPost post = new HttpPost(url);//建立 HTTP POST 請求
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
// builder.setCharset(Charset.forName("uft-8"));//設置請求的編碼格式
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);//設置瀏覽器兼容模式
int count=0;
for (File file:files) {
// FileBody fileBody = new FileBody(file);//把文件轉換成流對象FileBody
// builder.addPart("file"+count, fileBody);
builder.addBinaryBody("file"+count, file);
count++;
}
builder.addTextBody("method", params.get("method"));//設置請求參數
builder.addTextBody("fileTypes", params.get("fileTypes"));//設置請求參數
HttpEntity entity = builder.build();// 生成 HTTP POST 實體
post.setEntity(entity);//設置請求參數
HttpResponse response = client.execute(post);// 發起請求並返回請求的響應
if (response.getStatusLine().getStatusCode()==200) {
return true;
}
return false;

[java] view plain copy

HttpClient client=new DefaultHttpClient();// 開啓一個客戶端 HTTP 請求
HttpPost post = new HttpPost(url);//建立 HTTP POST 請求
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
// builder.setCharset(Charset.forName("uft-8"));//設置請求的編碼格式
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);//設置瀏覽器兼容模式
int count=0;
for (File file:files) {
// FileBody fileBody = new FileBody(file);//把文件轉換成流對象FileBody
// builder.addPart("file"+count, fileBody);
builder.addBinaryBody("file"+count, file);
count++;
}
builder.addTextBody("method", params.get("method"));//設置請求參數
builder.addTextBody("fileTypes", params.get("fileTypes"));//設置請求參數
HttpEntity entity = builder.build();// 生成 HTTP POST 實體
post.setEntity(entity);//設置請求參數
HttpResponse response = client.execute(post);// 發起請求並返回請求的響應
if (response.getStatusLine().getStatusCode()==200) {
return true;
}
return false;

代碼分析：

上面代碼主要實現了多文件上傳，爲了方便服務器端保存文件，上面代碼設置了名稱爲fileTypes的參數，fileTypes是由上傳的文件類型名拼接成的字符串，如」.jpg.png.docx「；

服務器端能夠經過獲取名爲fileTypes的參數，而後將其拆分紅字符數組，便可獲得要保存文件的類型。

服務器端項目核心代碼：

服務器段主要用到Servlet3.0的API，主要用到的方法有：

1. request.getParameter("");//獲取客戶端經過addTextBody方法添加的String類型的數據。

2. request.getPart("");//獲取客戶端經過addBinaryBody、addPart、addTextBody方法添加的指定數據，返回Part類型的對象。

3. request.getParts();//獲取客戶端經過addBinaryBody、addPart、addTextBody方法添加的全部數據，返回Collection<Part>類型的對象。

4. part.getName();//獲取上傳文件的名稱即上傳時指定的key。

5. part.getSize()//獲取上傳文件的大小單位爲字節。

[java] view plain copy

String fileTypes=request.getParameter("fileTypes");//獲取客戶端上傳的全部文件類型
String[]typeArray=fileTypes.substring(1).split("\\.");//將文件類型字符串拆分紅String數組
try {
Iterator<Part>iterator=request.getParts().iterator();
int count=0;
while (iterator.hasNext()) {//遍歷客戶端上傳的全部文件
if (count>=typeArray.length)break;//若是超出文件類型數組的大小則跳出循環
Part part = (Part) iterator.next();
// System.out.println("part.getSize()"+part.getSize());//獲取上傳文件的大小
// System.out.println("part.getName()"+part.getName());//獲取上傳文件的名及添加數據時的key名
File file=new File("E:\\upload\\"+count+"."+typeArray[count++]);
InputStream inputStream=part.getInputStream();
FileOutputStream fos=new FileOutputStream(file);
byte[]buffer=new byte[1024];
int len=0;
while ((len=inputStream.read(buffer))!=-1) {
fos.write(buffer,0, len);
}
inputStream.close();
fos.close();
}
}catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

[java] view plain copy

String fileTypes=request.getParameter("fileTypes");//獲取客戶端上傳的全部文件類型
String[]typeArray=fileTypes.substring(1).split("\\.");//將文件類型字符串拆分紅String數組
try {
Iterator<Part>iterator=request.getParts().iterator();
int count=0;
while (iterator.hasNext()) {//遍歷客戶端上傳的全部文件
if (count>=typeArray.length)break;//若是超出文件類型數組的大小則跳出循環
Part part = (Part) iterator.next();
// System.out.println("part.getSize()"+part.getSize());//獲取上傳文件的大小
// System.out.println("part.getName()"+part.getName());//獲取上傳文件的名及添加數據時的key名
File file=new File("E:\\upload\\"+count+"."+typeArray[count++]);
InputStream inputStream=part.getInputStream();
FileOutputStream fos=new FileOutputStream(file);
byte[]buffer=new byte[1024];
int len=0;
while ((len=inputStream.read(buffer))!=-1) {
fos.write(buffer,0, len);
}
inputStream.close();
fos.close();
}
}catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

代碼分析：

服務器端是經過Servlet實現的，經過調用request.getParameter("fileTypes")方法來獲取客戶端上傳的全部文件類型，而後將文件類型字符串拆分紅String數組。經過request.getParts()方法取出客戶端經過addBinaryBody、addPart、addTextBody上傳的全部數據，而後遍歷數據集合便可進行文件的保存。

因爲事先和客戶端協定，添加上傳文件的順序在添加請求參數以前，因此能夠根據拆分出的文件類型數組的長度判斷出客戶端上傳文件的個數，所以當上面代碼遍歷超出了類型數組的長度時程序跳出循環，再也不進行文件的保存，由於下面的Part都是些參數，而不是要保存的文件了。

程序運行效果圖：

3.完成項目代碼：

MainActivity.java

[java] view plain copy

package com.jph.ufh.activity;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import com.jph.ufh.R;
import com.jph.ufh.service.UploadService;
import android.app.Activity;
import android.os.Bundle;
import android.os.Environment;
import android.os.Handler;
import android.os.Message;
import android.view.View;
import android.widget.Toast;
/**
* 經過httpClient批量上傳文件
* @author jph
* Date：2014.10.09
*/
public class MainActivity extends Activity {
private ArrayList<File>files;
private Map<String, String>params;
Handler mHandler=new Handler(){
@Override
public void handleMessage(Message msg) {
// TODO Auto-generated method stub
switch (msg.what) {
case UploadService.UPLOAD_SUCCESS:
Toast.makeText(MainActivity.this, "上傳成功", Toast.LENGTH_LONG).show();
break;
}
super.handleMessage(msg);
}
};
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
files=new ArrayList<File>();
params=new HashMap<String, String>();
}
public void upload(View v) {
files.clear();
params.clear();
File file=new File(Environment.getExternalStorageDirectory(),"kaola.jpg");
File file2=new File(Environment.getExternalStorageDirectory(),"test.docx");
File file3=new File(Environment.getExternalStorageDirectory(),"test.jpg");
files.add(file);
files.add(file2);
files.add(file3);
StringBuffer sbFileTypes=new StringBuffer();
for (File tempFile:files) {
String fileName=tempFile.getName();
sbFileTypes.append(getFileType(fileName));
}
params.put("fileTypes",sbFileTypes.toString());
params.put("method", "upload");
UploadService uploadService=new UploadService(mHandler);
uploadService.uploadFileToServer(params, files);
}
/**
* 獲取文件的類型
* @param fileName ：文件名
* @return 文件類型
*/
private String getFileType(String fileName) {
// TODO Auto-generated method stub
return fileName.substring(fileName.lastIndexOf("."), fileName.length());
}
}

[java] view plain copy

package com.jph.ufh.activity;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import com.jph.ufh.R;
import com.jph.ufh.service.UploadService;
import android.app.Activity;
import android.os.Bundle;
import android.os.Environment;
import android.os.Handler;
import android.os.Message;
import android.view.View;
import android.widget.Toast;
/**
* 經過httpClient批量上傳文件
* @author jph
* Date：2014.10.09
*/
public class MainActivity extends Activity {
private ArrayList<File>files;
private Map<String, String>params;
Handler mHandler=new Handler(){
@Override
public void handleMessage(Message msg) {
// TODO Auto-generated method stub
switch (msg.what) {
case UploadService.UPLOAD_SUCCESS:
Toast.makeText(MainActivity.this, "上傳成功", Toast.LENGTH_LONG).show();
break;
}
super.handleMessage(msg);
}
};
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
files=new ArrayList<File>();
params=new HashMap<String, String>();
}
public void upload(View v) {
files.clear();
params.clear();
File file=new File(Environment.getExternalStorageDirectory(),"kaola.jpg");
File file2=new File(Environment.getExternalStorageDirectory(),"test.docx");
File file3=new File(Environment.getExternalStorageDirectory(),"test.jpg");
files.add(file);
files.add(file2);
files.add(file3);
StringBuffer sbFileTypes=new StringBuffer();
for (File tempFile:files) {
String fileName=tempFile.getName();
sbFileTypes.append(getFileType(fileName));
}
params.put("fileTypes",sbFileTypes.toString());
params.put("method", "upload");
UploadService uploadService=new UploadService(mHandler);
uploadService.uploadFileToServer(params, files);
}
/**
* 獲取文件的類型
* @param fileName ：文件名
* @return 文件類型
*/
private String getFileType(String fileName) {
// TODO Auto-generated method stub
return fileName.substring(fileName.lastIndexOf("."), fileName.length());
}
}

UploadService.java

[java] view plain copy print ?

package com.jph.ufh.service;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Map;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.mime.HttpMultipartMode;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.DefaultHttpClient;
import android.os.Handler;
/**
* 採用HttpClient上傳文件,支持多文件上傳
* @author jph
* Date:2014.10.09
*/
public class UploadService {
private static String url="http://10.219.57.16:8080/ServerForUpload/ServletForUpload";
// private static String url="http://10.110.6.58:8080/ServerForUpload/ServletForUpload";
public static final int UPLOAD_SUCCESS=0x123;
public static final int UPLOAD_FAIL=0x124;
private Handler handler;
public UploadService(Handler handler) {
// TODO Auto-generated constructor stub
this.handler=handler;
}
/**
* @param params 請求參數，包括請求的的方法參數method如：「upload」，
* 請求上傳的文件類型fileTypes如：「.jpg.png.docx」
* @param files 要上傳的文件集合
*/
public void uploadFileToServer(final Map<String, String> params, final ArrayList<File>files) {
// TODO Auto-generated method stub
new Thread(new Runnable() {
@Override
public void run() {
// TODO Auto-generated method stub
try {
if (uploadFiles(url,params,files)) {
handler.sendEmptyMessage(UPLOAD_SUCCESS);//通知主線程數據發送成功
}else {
//將數據發送給服務器失敗
}
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}).start();
}
/**
* @param url servlet的地址
* @param params 要傳遞的參數
* @param files 要上傳的文件
* @return true if upload success else false
* @throws ClientProtocolException
* @throws IOException
*/
private boolean uploadFiles(String url,Map<String, String>params,ArrayList<File>files) throws ClientProtocolException, IOException {
HttpClient client=new DefaultHttpClient();// 開啓一個客戶端 HTTP 請求
HttpPost post = new HttpPost(url);//建立 HTTP POST 請求
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
// builder.setCharset(Charset.forName("uft-8"));//設置請求的編碼格式
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);//設置瀏覽器兼容模式
int count=0;
for (File file:files) {
// FileBody fileBody = new FileBody(file);//把文件轉換成流對象FileBody
// builder.addPart("file"+count, fileBody);
builder.addBinaryBody("file"+count, file);
count++;
}
builder.addTextBody("method", params.get("method"));//設置請求參數
builder.addTextBody("fileTypes", params.get("fileTypes"));//設置請求參數
HttpEntity entity = builder.build();// 生成 HTTP POST 實體
post.setEntity(entity);//設置請求參數
HttpResponse response = client.execute(post);// 發起請求並返回請求的響應
if (response.getStatusLine().getStatusCode()==200) {
return true;
}
return false;
}
}