form表单的进阶学习

林光

前言

在上一篇文章由form表单来说说前后台数据之间的交互讲解了一些浏览器和服务器在表单之间的联系,貌似感觉已经是掌握了form表单,但现实是残酷的,在最近的一个项目中才发现form表单还有一个大块知识,在上篇文章只是点了一下的。这块内容用的地方还蛮多的,那就是文件上传。

1、FormData

上篇文章中提到组织表单的方法是使用jquery的serializeArray函数,但是这个方法对于input[type="file"]是无效的,也就是说它无法将文件的内容整合到form表单中去,相关问题可以参考jquery的官方issue:https://bugs.jquery.com/ticket/2656。 其中的解释是:

The serialize method can't get the contents of the file so I don't understand why it would need to serialize the file form field. You'd have to use one of the Ajax File upload plugins to get the contents via AJAX.  

那么我们是否可以不使用插件来获取提交的表单呢?of course!

1.1、FormData的作用

这就是我们要介绍的FormData。根据FormData的MDN解释:

FormData接口提供了一种简单的方式去构建键值对来表示它们的字段和值,并且可以很容易地通过`XMLHttpRequest.send()`发送给服务器。它使用了和表单的编码类型设置为`multipart/form-data`一样的格式。

FormData对象可以使用`for...of`的形式来遍历而不是使用`entries()`:`for (var p of myFormData)`等价于` for (var p of myFormData.entries())`  

这样的解释让我至少明白了两点:

  1. FormData可以用来处理带有multipart/form-data编码类型的表单,一般都是带有input[type="file"]的表单;
  2. FormData里面字段的检查可以通过for...in来检查。(这个对象在浏览器中用console.log是打印不出来的)

那么就有童鞋肯定会问:

  1. 使用FormData来提交不带有input[type="file"]类型的表单不可以吗?
  2. 使用FormData来提交不带有input[type="file"]类型的表单但是使用编码类型为x-www-form-urlencoded又会怎么样呢?
  3. 如果我不使用FormData的话就不能提交带有input[type="file"]的表单了吗?

那么我们使用demo来解释这两个问题:

  • 可以的,此时编码类型是multipart/form-data,也即是表单的提交方式大致会是这样的:

    我们可以看到这种编码类型的表单与众不同的。服务器端如果使用使用express4以上的版本的话需要安装额外的middleware来处理这类型的请求,否则你会在req.bodyreq.paramreq.query中没有发现任何你的表单数据。这些后面会讲。那么为什么我们依然不提倡使用这种方法来提交那些简单的表单(大部分网站都是如此):

    你肯定发现了我们提交的表单就是简简单单几个字符,但是加上那些boundary之后造成表单数据变大了,也就是说即使是最有效率的二进制编码也比我们直接将表单数据写到MIME头部花的时间来得长!

Tips: 但是x-www-form-urlencoded处理那些不是字母数字的时候便显得有些吃力了,因为浏览器都会将那些非字母数字的转译为%HH,也就是说每一个非字母数字都会由3个字节来替换,这对于表单很长的时候便很不友好了,于是才有了multipart/form-data的出现。

  • 回答第二个问题,如果是那样的话,那么我们在服务端(express4)中就可以看到req.body
{ '------WebKitFormBoundary5Kj2oSfHZKrZjYjs\r\nContent-Disposition: form-data; name': '"user"\r\n\r\ndd\r\n------WebKitFormBoundary5Kj2oSfHZKrZjYjs\r\nContent-Disposition: form-data; name="email"\r\n\r\nddd\r\n------WebKitFormBoundary5Kj2oSfHZKrZjYjs--\r\n' }

看吧,这样你让服务器如何解析呢???这纯粹给自己添堵。

1.2、结论

综上所述,当我们在使用表单的时候含有input[type="file"]或者含有很多非字母数字的时候,我们需要使用FormData来提交表单,并且编码类型必须是multipart/form-data。那么大致使用的范例是:

<!DOCTYPE html>  
<html lang="en">  
<head>  
    <meta charset="UTF-8">
    <title>testing form group</title>
    <script type="text/javascript" src="http://cdn.bootcss.com/jquery/3.1.0/jquery.min.js"></script>
    <script type="text/javascript">
    function onSubmit(){
        var myForm = document.getElementById('form');
        var formData = new FormData(myForm);
        for (var p of formData){
            console.log(p);
        }
        $.ajax({
            type: 'POST',
            url: '/get',
            data: formData,
            dataType: 'json',
            processData: false,
            contentType: false,
            success: function(data){console.log(data)},
            error: function(jqXHR){console.log(jqXHR)},
        })

    }
    </script>
</head>  
<body>  
    <form action="" method="post" name='info' id='form'>
        <input type="text" name="user" />
        <input type="text" name="email" />
        <input type="file" name="file" />
        <input type="file" name="file1" />
    </form>
    <button type="button" name='submit' onclick="onSubmit()">提交</button>
</body>  
</html>  

注意

我们的$.ajax中配置了processData: false和contentType: false是为了阻止jquery进一步处理数据:
processData (默认: true)
类型: Boolean
默认情况下,通过data选项传递进来的数据,如果是一个对象(技术上讲只要不是字符串),都会处理转化成一个查询字符串,以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息,请设置为 false。

1.3、FormData的API

  1. FormData.append(): 追加一个新的值到已存在的key中或者添加一个新的key;
  2. FormData.delete(): 删除一个键值对
  3. FormData.entries(): 返回一个迭代器以便可以遍历对象里面的键值对
  4. FormData.get():返回第一个给定key的值
  5. FormData.getAll():返回给定key的所有值的数组
  6. FormData.has():判断FormData对象是否有给定的键值对
  7. FormData.keys():返回一个迭代器以允许遍历所有键值对的键
  8. FormData.set(): 修改一个已存在的key中的值或者添加新的键值对
  9. FormData.values(): 返回一个迭代器以允许遍历所有键值对的值

2. 关于input[type="file"]

关于这个类型的input有几点还是需要提一下,要不下次我自己又忘掉了:

  1. 使用multiple属性可以一次性选择多个文件,使用accept属性可以执行对应的MIME类型
  2. $(element).files得到的是一个file数组,你可以获取上传文件的名字以及上传文件的个数:.namelength
  3. 说到上传文件,有时候你可能需要去校验文件名称或者后缀,那么这时候的正则表达式便派上用场了,如果校验一个格式为xxx-vx.x.{json|yaml}(比如bower-v0.1.json)的文件,会用到的正则表达式是:
var reg = /^\w+\-v\d+\.{1}\d+\.(json|yaml)$/i;  
/*Check if the user has not selected uploaded file*/
    if ($(Element).val() === ''){
      finalRes.delete('file');
    } else {
      var fileCount = $(Element)[0].files.length;
      for (var i = 0; i < fileCount; i++) {
        if (reg.test($(Element)[0].files[i].name )){
          console.log('match');
        }else{
          alert('上传的文件名格式不正确');
          return;
        }
      }
    }

那么去掉后缀的时候你可以使用replace(/.(json|yaml)$/, '')来去掉后缀名。 4. 清空表单的一个好的函数是:

  function clearAllFields(){
    $(':input','#project-info')
    .not(':button, :submit, :reset, :hidden')
    .val('')
    .removeAttr('checked')
    .removeAttr('selected');
  }

注意

$(element)表示的是你上传文件的input的标签。
finalRes是你new FormData之后的表单值

3、Express服务器端的处理

从Express4.x之后,移出了很多的middleware之后,对于处理multipart/form-data编码类型的表单需要自己安装的了。这类的package很多,我自己选择使用了multiparty这个middleware。具体的使用方法可以参考官网:https://github.com/expressjs/node-multiparty。

该middleware的使用方法有两种:

  1. 使用事件监听的形式
  2. 使用回调形式

我在项目中使用了回调的形式:

router.post('/get', function(req, res, next) {  
  var form = new multiparty.Form();
  form.parse(req, function(err, fields, files) {

    if (fields === undefined || files === undefined){
      console.log('client send empty data  in posting new project');
      return res.status(200).json({err:"请求数据为空,请重新提交", status:'failure'});
    }
    console.log(fields, files);
    console.log('Upload completed!');
  });
});

其中的fields和files中的字段是根据你在表单中提供的name的形式来组织的,以第一小节的前端代码来说,那么此时的结果应该是:

{ user: [ 'test' ], email: [ 'test1' ] } 
{ file: 
   [ { fieldName: 'file',
       originalFilename: 'test.html',
       path: '/home/private/test/QForTTWBipWSPSTpKsUGlRHE.html',
       headers: [Object],
       size: 876 } ],
  file1: 
   [ { fieldName: 'file1',
       originalFilename: 'test1.html',
       path: '/home/private/test/aT5T2B_pkkxEVv5OUzjjCxIB.html',
       headers: [Object],
       size: 558 } ] }

这时默认文件已经被上传到了默认的文件夹,根据官网的解释,如果没有在初始化的时候配置uploadDir,那么将会上传到系统的os.tmpdir()

至于事件类型的实现方式也是类似的,可以参考其官网给的demo。

至此对于From表单的理解应该是可以告一段落了,下班去了~~~~~~~~~

参考

  1. http://www.css88.com/jqapi-1.9/jQuery.ajax/
  2. https://developer.mozilla.org/en-US/docs/Web/API/FormData
  3. https://github.com/expressjs/node-multiparty