HttpClient发送Post请求————StringEntity 和 UrlEncodedFormEntity 的区别

Bertha 。 2022-09-12 03:47 222阅读 0赞

一直用hutool的工具类做http调用，今天有空看了一下apache的httpclient，在实现带参数的post请求的时候看到有两个entity可以作为参数，再分别看了两个类在这做一下笔记。

**首先说StringEntity**

StringEntity extends AbstractHttpEntity implements Cloneable

继承于AbstractHttpEntity类，这个类做参数的时候设置比较灵活，通过类的构造方法可以看到有两个参数，一个是具体的参数值（string串），另一个是ContentType，通过重写的构造方法看到，当不指定ContentType时默认的ContentType是text/plain，具体看下图构造方法：  
![在这里插入图片描述][7a6dc044cfa74891ab10d843cd9f5890.png]  
默认通过一个参数构造方法创建对象，ContentType的值是 ContentType.DEFAULT\_TEXT，找到来源，  
DEFAULT\_TEXT的值是 create(“text/plain”, Consts.ISO\_8859\_1)设定的  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARmlybemZiA_size_20_color_FFFFFF_t_70_g_se_x_16]

HttpPost post=new HttpPost("https://api.weixin.qq.com/cgi-bin/template/api_set_industry?access_token=ACCESS_TOKEN");
    JSONObject param=new JSONObject();
    param.put("key","value");
    StringEntity  requestentity=new StringEntity(param.toString());
    requestentity.setContentType(ContentType.APPLICATION_JSON.toString());
    post.setEntity(requestentity);

所以当要通过post发送json数据时就要额外设置Contentype为application/json或在初始化时传入一个Contentype类型。其他类型也一样可以自由设置，要注意的就是默认值，以免忘记设定而造成请求出错。

**2.UrlEncodeFormEntity**  
UrlEncodeFormEntity继承字上面的StringEntity ，可以认为指定类型的entity，说到指定类型，UrlEncodeFormEntity默认指定了他的ContentType就是application/x-www-form-urlencoded，所以使用这个类做参数，会将参数以key1=value1&key2=value2的键值对形式发出。类似于传统的application/x-www-form-urlencoded表单上传。

对于ContentType指定的值：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARmlybemZiA_size_20_color_FFFFFF_t_70_g_se_x_16 1]  
从构造方法看到在初始化时就指定了ContentType，也就决定了参数的形式，还要注意到参数是以UrlEncodeFormEntity放到HttpPost对象里的，但是UrlEncodeFormEntity创建时必须是NameValuePair类型的对象或对象的集合作为他的构造参数，不能是String类型，上面的构造方法里面可以看到参数类型是Iterable<? extends NameValuePair> parameters，这是一个死的限制，也就是说要用UrlEncodeFormEntity作为参数传递，那数据格式组装就必须要用NameValuePair类型：

List<NameValuePair> params=new ArrayList<>();
    		params.add(new BasicNameValuePair("key1","value1"));
    		params.add(new BasicNameValuePair("key2","value2"));
    		params.add(new BasicNameValuePair("key3","value3"));
    		UrlEncodedFormEntity  entity=new UrlEncodedFormEntity(params,"UTF-8");
    		post.setEntity(entity);

如上面示例代码，只能是这种类型构建参数

综上所述，StringEntity可以用来灵活设定参数格式形式，而UrlEncodeFormEntity则适合于传统表单格式的参数形式，至于到底用什么形式，也要看请求目标服务的数据接收形式喽

> 总结：  
> 1.传统表单格式的参数形式，使用UrlEncodeFormEntity设置参数  
> 2.其他灵活设定参数格式形式，使用StringEntity设置参数

[7a6dc044cfa74891ab10d843cd9f5890.png]: /images/20220828/8b622608812241a1be58c42937e86811.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARmlybemZiA_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/723e4a0d299b4f8a8892e04c307fc4db.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARmlybemZiA_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220828/8bc6021c5a4d4fa7a0e982ffe85a4f91.png