微信小程序 wx.uploadFile 的编码坑



编写微信小程序时，用到 wx.uploadFile，用来上传图片＋文本信息．然而在编写过程中，由于官方的 demo 和文档描述很少，在几个坑上耗费了不少时间．

这里分享一个和编码有关的坑，主要是由于真机预览时 formData 中的非字母、数字的 ASCII 编码的字符如中文、泰文传输到服务端将不会自动进行转码码，并会会产生乱码及溢出，从而导致错误。

微信的 uploadFile 类似与 html 中的form带文件上传的表单 ( enctype=”multipart/form-data” ), 这样 post 上传的表单，可以包含文件，同时包含其它的键值数据。微信小程序用 uploadFile 实现类似的操作． 我的微信小程序端的uploadFile 代码如下 :

   wx.uploadFile({
            url: 'https://<upload_domain>/save',
            filePath:photoPath,　//待上传的图片，由 chooseImage获得
            name:'food_image',
            formData: {
              latitude:0.0,
              longitude:0.0,
              restaurant_id:0,
              city:'北京',
              name:'beijing' // 名称
            }, // HTTP 请求中其他额外的 form data
            success: function(res){
              console.log("addfood success",res);
            },
            fail: function(res) {
              console.log("addfood fail",res);
            },
          })
},

服务端我用的 PHP 编写，这里接受文件的接口为 save ，我将  P OST和  _FILES 里的数据直接输出到info.log 文件中用来进行调试．代码如下：

public function save(Request $request)
{
    error_log("FILES:" . json_encode($_FILES) . "\r\n", 3, "./logs/info.log");
    error_log("POST: " . json_encode($_POST) . "\r\n", 3, "./logs/info.log");
    error_log("city: " . $_POST["city"] . "\r\n", 3, "./logs/info.log");
    error_log("name: " . $_POST["name"] . "\r\n", 3, "./logs/info.log");
    error_log("latitude: " . $_POST["latitude"] . "\r\n", 3, "./logs/info.log");
    error_log("longitude: " . $_POST["longitude"] . "\r\n", 3, "./logs/info.log");
    error_log("restaurant_id: " . $_POST["restaurant_id"] . "\r\n", 3, "./logs/info.log");
    error_log("tags: " . $_POST["city"] . "\r\n", 3, "./logs/info.log");
　　echo 'success';
} 

在小程序开发工具中运行小程序，选择好图片后进行上传操作，服务器端成功接收到数据，info.log输出的数据信息如下：

FILES:{"food_image":{"name":"store_265332457o6zAJszC4WsrwhUy55eh7iKJt7EQ1480318543139.jpg","type":"image\/jpeg","tmp_name":"\/tmp\/phpe3zGok","error":0,"size":845941}}
POST: {"latitude":"0","longitude":"0","restaurant_id":"0","tags":"","city":"\u5317\u4eac","name":"\u0e1b\u0e31\u0e01\u0e01\u0e34\u0e48\u0e07"}
city: 北京
name: ปักกิ่ง
latitude: 0
longitude: 0
restaurant_id: 0

( ps：php 中，FILES 里有 tmp_name 为收到了文件，将临时文件从该路径中移动到指定目录便可保存文件，这里看到有 /tmp/phpe3zGok 临时文件，说明成功收到了文件) 将小程序预览到手机上，点击上传，但却出现了问题，如下所示：

POST 数据为空， FILES 成功收到，而单独输出的$_POST数据出现乱码(中文和泰文部分)，出现了溢出．

可以看到，非英文，数字的数据是乱码，而其它数据没有问题，显然是编码出现了问题，POST 数据输出为空，由于乱码导致了溢出使得格式错乱．

编码有问题，那么就尝试改变它的编码进行传输， uploadFile 的参数中加入

header{“chartset”:”utf-8”}
//或者　
header{"content-type":'application/x-www-form-urlencoded'}

但是都没有什么效果，依然是在微信小程序工具中有效，而手机真机预览的时候出现乱码．在看到这篇帖子 【新手跳坑指南《三十九》wx.uploadFile】 才知道header 里的数据在真机预览的时候是无效的，需要改到 formData 中，受到了启发，尝试将编码数据加入formData 中，但仅仅传输了数据，并没有改变编码．依然是小程序开发工具中调试成功，而真机预览出了问题，这个估计要微信团队来回答了。
知道 header 是个bug , 那么编码的操作暂时只能手动进行了，于是我将小程序段的数据都进行编码． 在 JavaScript 中，字符串编码函数是 encodeURI, 在小程序中尝试，也有该函数，所以我将小程序代码改为如下

wx.uploadFile({
            url: 'https://<upload_domain>/save',
            filePath:photoPath,　//待上传的图片，由 chooseImage获得
            name:'food_image',
            formData: {
              latitude:encodeURI(0.0),
              longitude:encodeURI(0.0),
              restaurant_id:encodeURI(0),
              city:encodeURI('北京'),
              name:encodeURI('beijing') // 名称
            }, // HTTP 请求中其他额外的 form data
            success: function(res){
              console.log("addfood success",res);
            },
            fail: function(res) {
              console.log("addfood fail",res);
            },
          })
},

服务器端, php 进行 url 解码的函数是 urldecode

public function save(Request $request)
{
    error_log("FILES:" . json_encode($_FILES) . "\r\n", 3, "./logs/info.log");
    error_log("POST: " . json_encode($_POST) . "\r\n", 3, "./logs/info.log");
    error_log("city: " . urldecode($_POST["city"]) . "\r\n", 3, "./logs/info.log");
    error_log("name: " . urldecode($_POST["name"]) . "\r\n", 3, "./logs/info.log");
    error_log("latitude: " . urldecode($_POST["latitude"]) . "\r\n", 3, "./logs/info.log");
    error_log("longitude: " . urldecode($_POST["longitude"]) . "\r\n", 3, "./logs/info.log");
    error_log("restaurant_id: " . urldecode($_POST["restaurant_id"]) . "\r\n", 3, "./logs/info.log");
    error_log("tags: " . urldecode($_POST["city"]) . "\r\n", 3, "./logs/info.log");
    echo 'success';
}

再次测试，真机预览测试输出如下：

ILES:{"food_image":{"name":"jpeg","type":"image\/jpeg","tmp_name":"\/tmp\/php1svqDs","error":0,"size":9561}}
POST: {"restaurant_id":"0","tags":"","longitude":"0","latitude":"0","city":"%E5%8C%97%E4%BA%AC","name":"%E0%B8%9B%E0%B8%B1%E0%B8%81%E0%B8%81%E0%B8%B4%E0%B9%88%E0%B8%87"}
city: 北京
name: ปักกิ่ง
latitude: 0
longitude: 0
restaurant_id: 0

可以看到，所有数据都正常输出，其中POST 数据中 city 和 name未解码前是 urlencode 编码形式的数据，解码后正常输出．
至此，我想使用小程序上传带文件信息到服务器端算是调通了， 希望这个方法能对出现同样问题的同学有一定帮助。

原文链接：微信小程序 wx.uploadFile 的编码坑　www.agent007.pw