HttpClient入门(2) 表单提交及文件上传

上一篇文章中,通过HttpClient实现了简单的get请求并处理服务器返回的资源,在很多的场景中,我们也需要向服务器上传我们的信息。

以下分析使用版本为:
httpclient-4.5.3.jar
httpcore-4.4.6.jar
httpmime-4.5.3.jar
jdk1.8.0_131
所有示例代码均经过运行测试

表单提交

调用第三方接口或者模拟表单提交的时候,常常会使用到post请求,与get请求不同的是,post请求的参数并不是通过URL来进行传递,而是封装在请求报文的正文中。HttpClient提供了UrlEncodedFormEntity类来处理此类场景。生成UrlEncodedFormEntity实例时需指定编码为UTF-8,否则中文到了服务端会乱码。

CloseableHttpClient httpclient = null;
CloseableHttpResponse response = null;
try {
    httpclient = HttpClients.createDefault();
    HttpPost post = new HttpPost("http://localhost:8080/Crayfish/HttpClientServer");
    HttpEntity formEntity = getFormEntity();
    post.setEntity(formEntity);
    HttpEntity entity = response.getEntity();
    System.out.println(EntityUtils.toString(entity, "UTF-8"));
} catch (Exception e) {
    e.printStackTrace();
} finally {
    CommonUtils.closeResponse(response);
    CommonUtils.closeHttpClient(httpclient);
}
public HttpEntity getFormEntity() throws UnsupportedEncodingException {
    List<NameValuePair> formParams = new ArrayList<>();
    formParams.add(new BasicNameValuePair("name", "果林椰子"));
    formParams.add(new BasicNameValuePair("password", "helloWord!"));
    return new UrlEncodedFormEntity(formParams, "UTF-8");
}

模拟服务端

为了便于测试请求效果,基于Tomcat+servlet本地搭建了一个服务端,并将接收到的请求参数直接打印到控制台,服务端相关代码如下。

protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    Map<String,String[]> paramMap = request.getParameterMap();
    for (Entry<String,String[]> paramEntry : paramMap.entrySet()) {
        String val = paramEntry.getValue()[0];
        String info = String.format("key:%s, val:%s.", paramEntry.getKey(), val);
        System.out.println(info);
    }
    response.getWriter().append("Success!");
}
服务端输出
key:name, val:果林椰子.
key:password, val:helloWord!.

文件上传

表单提交时,参数被封装进UrlEncodedFormEntity这个类中。相似地,文件上传时,文件信息被封装到MultipartFormEntity这个类中,这两个类均实现了HttpEntity接口。
为了方便实现文件上传,HttpClients提供了MultipartEntityBuilder这个工具类来生成MultipartFormEntity,MultipartEntityBuilder支持三种方式来添加文件信息,分别是File文件,byte数组,InputStream文件流。

CloseableHttpClient httpclient = null;
CloseableHttpResponse response = null;
try {
    httpclient = HttpClients.createDefault();
    HttpPost post = new HttpPost("http://localhost:8080/Crayfish/FileUpload");
    HttpEntity dataEntity = getMultiFileEntity();//File文件格式上传
//  HttpEntity dataEntity = getMultiDefaultFileEntity();//File文件格式上传(缺省)
//  HttpEntity dataEntity = getMultiArrayEntity();//byte数组格式上传
//  HttpEntity dataEntity = getMultiDefaultArrayEntity();//byte数组格式上传(缺省)
//  HttpEntity dataEntity = getMultiStreamEntity();//文件流格式上传
//  HttpEntity dataEntity = getMultiDefaultStreamEntity();//文件流格式上传(缺省)
    post.setEntity(dataEntity);
    response = httpclient.execute(post);
} catch (Exception e) {
    e.printStackTrace();
} finally {
    CommonUtils.closeResponse(response);
    CommonUtils.closeHttpClient(httpclient);
}
/**
 * File文件格式上传
*/
public HttpEntity getMultiFileEntity() {
    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
    File file = new File("F:/PIC/house.jpeg");;
    builder.addBinaryBody("file", file, ContentType.DEFAULT_BINARY, "photo.jpg");
    return builder.build();
}

/**
 * File文件格式上传(缺省)
*/
public HttpEntity getMultiDefaultFileEntity() {
    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
    File file = new File("F:/PIC/house.jpeg");
    builder.addBinaryBody("file", file);
    return builder.build();
}

/**
 * byte数组格式上传
*/
public HttpEntity getMultiArrayEntity() {
    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
    byte[] byteArr = getFileArr();
    builder.addBinaryBody("file", byteArr, ContentType.DEFAULT_BINARY, "photoArr.jpg");
    return builder.build();
}

/**
 * byte数组格式上传(缺省)
*/
public HttpEntity getMultiDefaultArrayEntity() {
    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
    byte[] byteArr = getFileArr();
    builder.addBinaryBody("file", byteArr);
    return builder.build();
}
    
public byte[] getFileArr() {
    try {
        File file = new File("F:/PIC/house.jpeg");
        FileInputStream fis = new FileInputStream(file);
        ByteArrayOutputStream bos = new ByteArrayOutputStream(1000);  
        byte[] b = new byte[1000];  
        int n;  
        while ((n = fis.read(b)) != -1) {  
            bos.write(b, 0, n);  
        }  
        fis.close();  
        bos.close();  
        return bos.toByteArray(); 
    } catch (Exception e) {
        e.printStackTrace();
        return new byte[0];
    }
}

/**
 * 文件流格式上传
*/
 public HttpEntity getMultiStreamEntity() throws FileNotFoundException {
    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
    File file = new File("F:/PIC/house.jpeg");
    InputStream stream = new FileInputStream(file);
    builder.addBinaryBody("file", stream, ContentType.DEFAULT_BINARY, "photoStream.jpg");
    return builder.build();
}

/**
 * 文件流格式上传(缺省)
*/
public HttpEntity getMultiDefaultStreamEntity() throws FileNotFoundException {
    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
    File file = new File("F:/PIC/house.jpeg");
    InputStream stream = new FileInputStream(file);
    builder.addBinaryBody("file", stream);
    return builder.build();
}
File文件格式上传

getMultiFileEntity中调用了MultipartEntityBuilder中的addBinaryBody方法,第一个参数"file"代表字段名,相当于<input type="file" name="file"/>,第二个参数是读取的文件类,第三个参数ContentType.DEFAULT_BINARY指定了发送http请求时的content-type为application/octet-stream,第四个参数代表文件名。
也可采用缺省方式getMultiDefaultFileEntity,查看源码可以发现,content-type默认为ContentType.DEFAULT_BINARY,文件名会取文件本来的名字

public MultipartEntityBuilder addBinaryBody(final String name, final File file) {
        return addBinaryBody(name, file, ContentType.DEFAULT_BINARY, file != null ? file.getName() : null);
}
byte数组格式上传

getMultiArrayEntity中调用addBinaryBody时,传入的是一个byte数组,其他参数与第一种方式相同。
byte数组方式上传,同样提供了默认方式(参见getMultiDefaultArrayEntity),但是若采用默认方式,上传到服务器后,文件名为null且没有后缀,会影响文件正常显示。

文件流格式上传

getMultiStreamEntity中调用addBinaryBody时,传入的是一个InputStream,其他参数与第一种方式相同。
文件流方式上传,也提供了默认方式(参见getMultiDefaultStreamEntity),但是若采用默认方式,上传到服务器后,文件名也会为null且没有后缀,会影响文件正常显示。

服务端接收代码

protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    try {
        DiskFileItemFactory factory = new DiskFileItemFactory();
        ServletFileUpload fileUpload = new ServletFileUpload(factory);
        List<FileItem> formItems = fileUpload.parseRequest(request);
        for (FileItem item : formItems) {
            String filename = item.getName();
            File newFile = new File("F:/eclipseOutput/PIC/"+filename);
            item.write(newFile);
        }
    } catch (Exception e) {
        e.printStackTrace();
    }   
}
附录 CommonUtils
public void closeResponse(CloseableHttpResponse response) {
    try {
        if (response != null) {
            response.close();
        }
    } catch (Exception e) {
        e.printStackTrace();
    }
}

public void closeHttpClient(CloseableHttpClient httpclient) {
    try {
        if (httpclient != null) {
            httpclient.close();
        }
    } catch (Exception e) {
        e.printStackTrace();
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,423评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,339评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,241评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,503评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,824评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,262评论 1 207
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,615评论 2 309
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,337评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,989评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,300评论 2 240
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,829评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,193评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,753评论 3 230
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,970评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,708评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,295评论 2 267
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,207评论 2 258

推荐阅读更多精彩内容