okHttp 解决文件上传中文名错误 Unexpected char

错误描述

使用 okHttp 调用接口进行文件上传，以下代码报错：Unexpected char 0x6d4b at 34 in Content-Disposition value: form-data

java 复制代码

RequestBody fileBody = RequestBody.create(MediaType.parse("application/octet-stream"), file);
MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", fileName, fileBody);

解决方法

这个问题只在 OkHttp 3.12.0、3.12.1、3.12.2 版本中出现，应该是一个bug，后续版本解决了这个问题，所以你可以：

避免使用上述的 OkHttp 版本
手动生成 Headers ，代码如下：

java 复制代码

List<MultipartBody.Part> parts = new ArrayList<>();
// 添加文件参数
RequestBody fileBody = RequestBody.create(MediaType.parse("application/octet-stream"), file);
Headers fileHeaders = new Headers.Builder().addUnsafeNonAscii(
        "Content-Disposition","form-data; name=\"file\"; filename=\"" + fileName + "\"").build();
MultipartBody.Part filePart = MultipartBody.Part.create(fileHeaders , fileBody);
parts.add(filePart);

原因分析

报错的原因是OkHttp的Header检查机制不允许在Content-Disposition头中使用非ASCII字符，所以执行 MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", fileName, fileBody); 这段代码时就会报错。

我们来查看源码分析一下 createFormData 方法：调用了 Headers.of() 方法来生成 Headers ,再来查看 Headers.of()方法
这里执行了 checkValue(value, name); 方法，在这个方法里检查 value 中是否包含非ASCII字符。

解决过程

问题出在 MultipartBody.Part.createFormData() 方法，所以就不能调用这个方法来创建 MultipartBody.Part 。 MultipartBody.Part.createFormData() 方法内部是调用MultipartBody.Part.create() 来创建 MultipartBody.Part 的

java 复制代码

return create(Headers.of(new String[]{"Content-Disposition", disposition.toString()}), body);

那么就可以改用 MultipartBody.Part.create() 来创建 MultipartBody.Part 此方法需要传入 Headers 对象，那么我们来查看Headers 对象需要怎么创建。我留意到 Headers.Builder 中有这么一个方法 :addUnsafeNonAscii()

java 复制代码

public Builder addUnsafeNonAscii(String name, String value) {
    Headers.checkName(name);
    return this.addLenient(name, value);
}

调用此方法能够不对 Form 参数的值校验是否包含非 ASCII 字符，所以调用该方法来生成 Headers就能避免此问题。将原先代码：

java 复制代码

RequestBody fileBody = RequestBody.create(MediaType.parse("application/octet-stream"), file);
MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", fileName, fileBody);

改为

java 复制代码

RequestBody fileBody = RequestBody.create(MediaType.parse("application/octet-stream"), file);
Headers fileHeaders = new Headers.Builder().addUnsafeNonAscii(
        "Content-Disposition","form-data; name=\"file\"; filename=\"" + fileName + "\"").build();
MultipartBody.Part filePart = MultipartBody.Part.create(fileHeaders , fileBody);

将原先使用 MultipartBody.Part.createFormData() 方法生成 MultipartBody.Part ，改为使用 MultipartBody.Part.create 生成MultipartBody.Part，并且手动创建 Headers 对象。

参考

okhttp上传文件中文名报错问题分析。分析java.lang.IllegalArgumentException: Un - 掘金