如何上传文件及content-type的设置

前言

在使用 fetch / axios 时常常会涉及到文件上传，以及其他请求，其中包括一些 content-type ，被这些不同类型到 content-type 搞得头大，到底什么时候该用怎么样的类型呢，本文将会梳理这些问题。

实例分析，如何上传一张图片

表单提交方式

表单<form>用来收集用户提交的数据，发送到服务器。下面代码中包含：文件选择框(获取本地文件)，提交按钮(提交表单控件)。

<form action="http://localhost:8899/react/aa" method="post" enctype="multipart/form-data">
    <input type="file" name="image"  multiple="multiple" />
    <input type="submit" value="提交"/>
</form>

用户点击“提交”按钮，每一个控件都会生成一个键值对，键名是控件的name属性，键值是控件的value属性。我们采用node作为服务端，使用 koa-body 解析 post 方式传递的文件

// 服务端获取请求中的文件
router.post('/aa',  async ctx => {
  console.log(ctx.request.files);
})

使用 axios 请求

表单数据以键值对的形式向服务器发送，这个过程是浏览器自动完成的。但是有时候，我们希望通过脚本完成过程，构造和编辑表单键值对。浏览器原生提供了 FormData 对象 来完成这项工作。

new FormData(form)

let formdata = new FormData(form);

FormData()构造函数的参数是一个表单元素，这个参数是可选的。如果省略参数，就表示一个空的表单，否则就会处理表单元素里面的键值对。一般我们使用的方法就是构建一个空的表单对象，FormData 提供很多实例方法,我们可以通过 append 方法来添加表单中的键值对。

formdata.append(key1,value1)
formdata.append(key2,value2)

下面的代码通过 axios 提交 formdata 表单数据来实现文件上传

 <input type="file" @change="onChange">
    methods:{
        onChange(event){
            const params = new FormData()
            params.append('file',event.target.files[0])
             axios.post('http://localhost:8899/react/aa',params,{
              headers:{
                'content-type':'multipart/form-data'
              }
            })
        }
    }

查看了 axios 源码 发现其实上传文件不需要设置 content-type 源码 lib/adapters/xhr.js 文件中定义了浏览器使用 XHR ：

module.exports = function xhrAdapter(config) {
  return new Promise(function dispatchXhrRequest(resolve, reject) {
        // config 是传入的配置对象 如： {url,method,data,headers}
        // 获取传入的参数和请求头
        var requestData = config.data;
        var requestHeaders = config.headers;
        // 判断是否为 formData 实例，如果是删除 请求头中的 content-type
        if (utils.isFormData(requestData)) {
          delete requestHeaders['Content-Type']; // Let the browser set it
        }
  })
}

isFormData 实现: FormData 就是表单对象的构造函数， 使用 instanceof 来检测构造函数的 prototype 属性是否出现在实例对象的原型链上。

/** * Determine if a value is a FormData * * @param {Object} val The value to test * @returns {boolean} True if value is an FormData, otherwise false */
function isFormData(val) {
  return (typeof FormData !== 'undefined') && (val instanceof FormData);
}

给content-type 设置默认值

lib/defaults.js 文件

defaults.headers = {
  common: {
    'Accept': 'application/json, text/plain, */*'
  }
};

utils.forEach(['delete', 'get', 'head'], function forEachMethodNoData(method) {
  defaults.headers[method] = {};
});

utils.forEach(['post', 'put', 'patch'], function forEachMethodWithData(method) {
  defaults.headers[method] = utils.merge(DEFAULT_CONTENT_TYPE);
});

判断传入数据的类型来设置不通的content-type

当使用 axios 发起请求时，会通过默认设置的 transformRequest 在发送给服务器前改变请求的数据,'PUT', 'POST', 'PATCH' and 'DELETE' 只对这几种请求方式有效。

 // lib/defaults.js 文件
 transformRequest: [function transformRequest(data, headers) {
    normalizeHeaderName(headers, 'Accept');
    normalizeHeaderName(headers, 'Content-Type');
    if (utils.isFormData(data) ||
      utils.isArrayBuffer(data) ||
      utils.isBuffer(data) ||
      utils.isStream(data) ||
      utils.isFile(data) ||
      utils.isBlob(data)
    ) {
      return data;
    }
    if (utils.isArrayBufferView(data)) {
      return data.buffer;
    }
    if (utils.isURLSearchParams(data)) {
      setContentTypeIfUnset(headers, 'application/x-www-form-urlencoded;charset=utf-8');
      return data.toString();
    }
    if (utils.isObject(data)) {
      setContentTypeIfUnset(headers, 'application/json;charset=utf-8');
      return JSON.stringify(data);
    }
    return data;
  }],

所以一般情况下使用 axios 请求不需要设置 content-type 如果有些特殊情况需要处理的可以放在 transformRequest:[function(data,headers){return data}] 中做处理

使用 fetch 请求

为了展示清楚，直接简化fetch请求的封装，具体可以查看下面的 codepen 示例,这里主要是为了展示使用 fetch 上传文件时，同时设置了 headers 请求时会出现什么问题，将代码设置如下：

fetch(api,{
    url,
    headers:{
        'content-type':'multipart/form-data'
    },
    mode:'no-cors'
})

当我们发起图片上传请求时，得到两处报错，在报错右处有错误产生的文件地方，点击这个文件可以看到

500 (Internal Server Error) 是请求api服务端报的错，Unexpected end of input 是浏览器运行 response.json()报的错。为什么浏览器会报 Unexpected end of input 后面我会单独讲，接下来我们看下服务端的报错原因。

上传的文件内容是需要通过 boundary 来标明分割线的，正确的Content-Type: mutlipart/form-data; boundary = —–xxxx这种形式。 查看我们当前上传的请求：

来对比一下正确的图片上传时 content-type 的格式：

在使用 fetch 请求时，设置 Content-type 就会丢失 boundary 参数，因此在上传文件时，不需要设置 headers 字段，浏览器会自动生成完整的 content-type（包含 boundary）。

移除 headers 字段后，fetch api可以正常的上传文件了！！

codepen 示例

codepen示例

Unexpected end of input 报错

其实这就是 js 语法错误,下面代码中使用 fetch api 获取资源后返回一个响应的 response 对象，如果我们指定 content-type 为 application/json 那么服务端会返回给我们一个 json 格式的字符串，所以当我们调用 resopnse.json() 时候可以解析出正确当对象。

fetch(api).then(response=>response.json()).then(res=>res)

你可以把 resopnse.json() 理解为 JSON.parse(),所以可以通过 JSON.parse() 来模拟前面的 Unexpected end of input 报错浏览器在读取我们的代码时，碰到了不可预知的错误，导致浏览器 无语进行下面的读取如下面的代码都会输出这个错误。

JSON.parse("{")
JSON.parse('[{"test": 4}')

常见都还有 Unexpected token < in JSON at position 0 继续模拟下该错误发生的场景，前端继续使用 response.json去解析服务端返回的数据。而在服务端不按照 content-type 预定的值传回，就会得到这个报错。

// 服务端
router.post('/aa',  async ctx => {
  ctx.body = '<div>内容</div>'
})

如果想简单的模拟直接使用 JSON.parse("<h1>1</h1>")就会得到同样的结果。下面的代码都是一个道理。

JSON.parse("{sd}")
// Unexpected token s in JSON at position 1
JSON.parse("d}")
// Unexpected token d in JSON at position 0

JSON.parse()支持的类型如下：

JSON.parse('{}');              // {}
JSON.parse('true');            // true
JSON.parse('"foo"');           // "foo"
JSON.parse('[1, 5, "false"]'); // [1, 5, "false"]
JSON.parse('null');            // null
JSON.parse('1');               // 1

所以想要正确的解析服务端的返回值，前后端要统一设定好 content-type 对应传输的数据类型，响应对象response也支持其他多个方法

整理 content-type

axios

get 请求方式

请求方式为 get 只会使用 application/x-www-form-urlencoded 编码方式

axios.get('/user',{
              params:{
                id:1,
                name:'dd',
                person:'张三'
              }
            })

理论上会请求 http://localhost:8080/user?id=1&name=dd&person=张三 但是对于特殊字符会进行 Url编码。
Url编码通常也被称为百分号编码（Url Encoding，also known as percent-encoding），是因为它的编码方式非常简单，使用%百分号加上两位的字符——0123456789ABCDEF——代表一个字节的 十六进制形式。Url编码默认使用的字符集是US-ASCII。例如a在US-ASCII码中对应的字节是0x61，那么Url编码之后得到的就 是%61
所以经过编码以后实际请求路径变成 http://localhost:8080/user?id=1&name=dd&person=%E5%BC%A0%E4%B8%89

post 请求方式

1. application/x-www-form-urlencoded格式
   默认使用该方式，使用该方式时需要对传入对参数处理成 name=hehe&age=10 格式，引入如果你传入对是一个对象，在 axios 默认配置中会将 content-type 设置为 application/json;charset=utf-8

	const service = axios.create({
      baseURL,
      headers
    })
    // 判断是否使用 'application/x-www-form-urlencoded' content-type
    if (isFormUrlencoded) {
      let list: string[] = []
      for (let key in params) {
        list.push(`${key}=${encodeURIComponent(params[key])}`)
      }
      fetchResult = service({
        url,
        method: 'POST',
        // 将 {a:1,b=2} 处理成 a=1&b=2 的格式，并且将他传递给 data 字段
        data: list.join('&')
      })
    } else {
      fetchResult = service.post(url, params)
    }

2. text/plain

   axios.post('http://localhost:8899/react/aa','我就是内容',{
             headers:{
                'content-type':'text/plain'
             }
           })
   

3. multipart/form-data 上传文件是不需要设置该类型，浏览器会自动添加!!!
4. application/json axios.post('http://localhost:8899/react/aa',{name:'dd',age:18})

fetch

get 方式 application/x-www-form-urlencoded 编码

get 传参数的方式需要添加到路径上，所以 Url编码的工作需要我们手动实现

// 在URL中写上传递的参数
fetch('http://localhost:8080?a=1&b=2', { 
    method: 'GET'
  })
  
 // 处理传入的 params 参数
    for(let key in params){
      param += `${key}=${encodeURIComponent(params[key])}&`
    }

post 方式

1. application/x-www-form-urlencoded

fetch('http://localhost:8080',{
    method:'POST',
    headers:{
        'content-type':'application/x-www-form-urlencoded'
    },
    mode:'no-cors',
    body:'name=dd&age=12'
})

2. application/json

需要使用 JSON.stringify() 将对象转换成 JSON 字符串，body作为接受数据的字段

fetch(url, {
  method: 'POST', // or 'PUT'
  body: JSON.stringify(data), 
  headers: new Headers({
    'Content-Type': 'application/json'
  })
})

3. multipart/form-data 上传文件是不需要设置该类型，浏览器会自动添加!!!

let data = new FormData()
data.append('file',target.files[0])
fetch(url,{
    body:data,
    method:"POST",
    headers:{}
})

参考

axios
FormData 对象的使用
Error when POST file multipart/form-data
Chrome: Uncaught SyntaxError: Unexpected end of input
Web开发须知URL编码与解码 请求头截图