【企业微信开发笔记】调用上传临时素材文件接口报empty media data错误

背景

在Spring MVC（4.3.8）下使用HttpClient（4.5.3）调用企业微信的上传临时素材文件的接口失败，错误消息为：empty media data

接口定义参见企业微信开发文档：https://work.weixin.qq.com/api/doc#10112

分析

纯属惯性思维造成的问题。

在调用其他接口（例如：获取acces-token、获取部门列表、发送消息）使用的是GET或POST接口，传输的内容都是文本，所以，都指定了编码字符集。

而素材上传所传输的内容却是二进制，所以，无需编码；否则会造成文件项的key无法被正常识别？

有问题的代码：

HttpPost post = new HttpPost(url);
//
HttpClient client = HttpClients.createDefault();
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
builder.setCharset(Charset.forName(FsSpec.Charset_Default) );
//添加表单部分
if (params != null && !params.isEmpty()) {
	for (Map.Entry<String, String> entry : params.entrySet()) {
		builder.addTextBody(entry.getKey(), entry.getValue());
	}
}
//添加文件部分
if (file != null && file.exists()) {
	builder.addBinaryBody("file1", file, ContentType.DEFAULT_BINARY, file.getName() );
}		
post.setEntity(builder.build() );
HttpResponse response = client.execute(post);

测试OK的代码：

 

HttpPost post = new HttpPost(url);
//
HttpClient client = HttpClients.createDefault();
MultipartEntityBuilder builder = MultipartEntityBuilder.create();

builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
//@2017-06-28 在文件上传中，有些系统不支持指定字符集(企业微信)
//builder.setCharset(Charset.forName(FsSpec.Charset_Default) );

//先添加文件部分(无需指定编码)
if (file != null && file.exists()) {
	builder.addBinaryBody(name, file, ContentType.DEFAULT_BINARY, file.getName() );
}

//再添加表单部分(需指定编码，@2017-06-28 key和value都需要指定编码)
if (params != null && !params.isEmpty()) {
	
	//@2017-06-28 在文件上传中，有些系统不支持指定字符集(企业微信)
	builder.setCharset(Charset.forName(FsSpec.Charset_Default) );
	ContentType contentType = ContentType.create("text/plain", FsSpec.Charset_Default);
	
	for (Map.Entry<String, String> entry : params.entrySet()) {
		
		builder.addTextBody(entry.getKey(), entry.getValue(), contentType);
	}
}

post.setEntity(builder.build() );
HttpResponse response = client.execute(post);

对比不难发现有3个要点：

 

（1）MultipartEntityBuilder不在开始就指定字符集（换到了后面）；

（2）调整了表单部分和文件部分的打包顺序（先文件再表单部分）；

（3）对于表单部分，打包时既指定了MultipartEntityBuilder的字符集，又指定了内容的字符集（通过指定ContentType）

对于（1）的理解是：文件部分的内容类型为二进制，无需指定字符集；

对于（2）的理解是兼顾表单内容（需要指定字符集）。

对于（3）的理解是对表单内容（键-值对）中的值也进行编码。

有兴趣的读者可以试试。如果少了（3）你会发现当值为中文时会出现解析乱码。

但如果不指定MultipartEntityBuilder的字符集，键为中文时又会出现解析乱码。

结语

（1）文件上传不同于文本（JSON或XML），需要从内容上考虑是否使用编码（如果你把文件内容按照BASE64编码、那就按文本来了）；

（2）要兼顾文本内容和表单内容混合上传的情形；

（3）对表单内容的键和值都需要考虑编码（特别是中文的情形下）。