0. 系列文章

項目源碼請猛戳這里!!!

1. 前言

在上篇文章中，我們處理了發送``post請求時body里的參數，請求已經能夠正常發出了，但是服務端接收請求后好像不能正確解析發送的數據，這是為什么呢？實際上是因為我們雖然執行 send方法的時候把普通對象data轉換成一個JSON 字符串，但是我們請求header的Content-Type是text/plain;charset=UTF-8，導致了服務端接受到請求並不能正確解析請求 body 的數據。OK，知道問題所在后，那我們就來對請求的header`處理一下。

2. 需求分析

在發送請求的時候，我們需要支持可以配置 headers 屬性，如下：

axios({
  method: 'post',
  url: '/api/handleRequestHeader/post',
  headers: {
    'content-type': 'application/json;charset=utf-8'
  },
  data: {
    a: 1,
    b: 2
  }
})

並且在當我們傳入的 data 為普通對象的時候，headers 如果沒有配置 Content-Type 屬性，需要自動設置請求 header 的 Content-Type 字段為：application/json;charset=utf-8。

3. 實現processHeaders 函數

根據需求分析，我們要實現一個工具函數，對 request 中的 headers 做一層加工。我們在 helpers 目錄新建 headers.ts 文件。

// helpers/headers.ts
import { isObject } from "./util";

export function processHeaders(headers: any, data: any): any {
  
  if (isObject(data)) {
    if (headers && !headers["Content-Type"]) {
      headers["Content-Type"] = "application/json;charset=utf-8";
    }
  }
  return headers;
}

首先，我們先利用之前封裝好的工具函數isObject判斷傳入的data是不是普通對象；

然后，在判斷是否傳入了headers以及headers里面是否有Content-Type字段，如果傳入了headers並且在傳入的headers里面沒有Content-Type字段，那么，我們就默認的給它加上headers["Content-Type"] = "application/json;charset=utf-8";。

OK，這樣看起來似乎是可以了，但是，還有個需要注意的地方，雖然headers里面的字段名是不區分大小寫的，但是標准規定的是請求和響應的 Header 字段名是首字母大寫這種格式,所以為了防止用戶傳入的字段名是其他格式，如全是小寫content-type,所以我們先要把 header字段名規范化。那么我們寫一個headers字段名規范化的函數，如下：

function normalizeHeaderName(headers: any, normalizedName: string): void {
  if (!headers) {
    return;
  }
  Object.keys(headers).forEach(name => {
    if (name !== normalizedName &&name.toUpperCase() === normalizedName.toUpperCase()) {
      headers[normalizedName] = headers[name];
      delete headers[name];
    }
  });
}

該函數支持傳入headers對象和一個字段規范化的目的格式，例如，我們想要把headers中的Content-Type字段統一規范化成Content-Type，那么我們可以這樣調用：normalizeHeaderName(headers, "Content-Type");

函數內部會遍歷傳入的headers的所有的字段名，通過判斷字段名如果與目的格式不同，並且都轉換成大寫后相同，那么表明該字段就是要規范化的字段，那么，我們就向傳入的headers里面新增目的格式的字段，並且字段值為原字段值，然后刪除掉不規范的字段名，這樣就達到了字段名規范的效果。

OK，最終的processHeaders 函數即為如下形式：

import { isObject } from "./util";

function normalizeHeaderName(headers: any, normalizedName: string): void {
  if (!headers) {
    return;
  }
  Object.keys(headers).forEach(name => {
    if (
      name !== normalizedName &&
      name.toUpperCase() === normalizedName.toUpperCase()
    ) {
      headers[normalizedName] = headers[name];
      delete headers[name];
    }
  });
}

export function processHeaders(headers: any, data: any): any {
  normalizeHeaderName(headers, "Content-Type");
  if (isObject(data)) {
    if (headers && !headers["Content-Type"]) {
      headers["Content-Type"] = "application/json;charset=utf-8";
    }
  }
  return headers;
}

4. 利用processHeaders 函數處理請求headers

由於我們支持用戶傳入headers，所以我們需要修改一下之前的 AxiosRequestConfig 接口類型的定義，添加 headers 這個可選屬性，如下：

// src/types/index.ts
export interface AxiosRequestConfig {
    url: string
    method?: Method
    headers?:any
    data?: any
    params?: any
}

添加好之后，我們回到src/index.ts中，定義 transformHeaders 函數，去處理請求 headers ，內部調用了我們剛剛實現的的 processHeaders方法。

然后我們在 processConfig 內部添加了這段邏輯，在處理完 url 后接着對 config 中的 `headers做處理。

// src/index.ts

import {processHeaders} from "./helpers/header";
function processConfig(config: AxiosRequestConfig): void {
  config.url = transformUrl(config);
  config.headers = transformHeaders(config);
  config.data = transformRequestData (config)
}

function transformHeaders(config:AxiosRequestConfig):any {
  const {headers={},data} = config;
  return processHeaders(headers,data)
}

5. 給請求添加headers

以上種種操作都是在處理headers，要真真正正的給請求添加上header，還需要在xhr.ts中進行添加：

import {AxiosRequestConfig} from './types'

export default function xhr(config: AxiosRequestConfig): void {
  const {data = null, url, method = 'get', headers} = config

  const request = new XMLHttpRequest()

  request.open(method.toUpperCase(), url, true)

  Object.keys(headers).forEach(name => {
    if (data === null && name.toLowerCase() === 'content-type') {
      delete headers[name]
    }
    request.setRequestHeader(name, headers[name])
  })

  request.send(data)
}

通過遍歷傳入的headers,將其每一個字段都通過request對象上的setRequestHeader方法給真真正正的添加到請求上，這里，我們附加了一個小小的判斷，即當傳入的data為null時，此時的Content-Type是沒有意義的，所以我們將其刪掉。

OK，headers處理完也真正的添加到請求上了，我們接下來就寫個demo測試下效果怎么樣。

6. demo編寫

在 examples 目錄下創建 handleRequestHeader目錄，在 handleRequestHeader目錄下創建 index.html:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>handleRequestHeader demo</title>
</head>
<body>
<script src="/__build__/handleRequestHeader.js"></script>
</body>
</html>

接着再創建 app.ts 作為入口文件：

import axios from "../../src/index";

axios({
  method: "post",
  url: "/api/handleRequestHeader/post",
  data: {
    a: 1,
    b: 2
  }
});

axios({
  method: "post",
  url: "/api/handleRequestHeader/post",
  headers: {
    "content-type": "application/json; charset=UTF-8",
    “Accept”: "application/json,text/plain,*/*"
  },
  data: {
    a: 1,
    b: 2
  }
});

const paramsString = "q=URLUtils.searchParams&topic=api";
const searchParams = new URLSearchParams(paramsString);

axios({
  method: "post",
  url: "/api/handleRequestHeader/post",
  data: searchParams
});

接着在 server/server.js 添加新的接口路由：

router.post("/api/handleRequestHeader/post", function(req, res) {
  res.json(req.body);
});

最后在根目錄下的index.html中加上啟動該demo的入口：

<li><a href="examples/handleRequestHeader">handleRequestHeader</a></li>

OK,我們在命令行中執行：

# 同時開啟客戶端和服務端
npm run server | npm start

接着我們打開 chrome 瀏覽器，訪問 http://localhost:8000/ 即可訪問我們的 demo 了，我們點擊 handleRequestHeader，通過F12的 network 部分我們可以看到：

當我們請求的數據是普通對象並且沒有配置 headers 的時候，會自動為其添加 Content-Type:application/json;charset=utf-8；

當我們配置的headers中的content-type不是規范化的字段名時，也會自動的規范化；

同時我們發現當 data 是某些類型如 URLSearchParams 的時候，瀏覽器會自動為請求 header加上合適的 Content-Type。

(完)

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 使用Typescript重構axios(六)——實現基礎功能：獲取響應數據使用Typescript重構axios(十四)——實現攔截器使用Typescript重構axios(二十八)——自定義序列化請求參數使用Typescript重構axios(十七)——增加axios.create接口使用Typescript重構axios(二十四)——防御XSRF攻擊使用Typescript重構axios(二十九)——添加baseURL 基於TypeScript從零重構axios 基於TypeScript從零重構axios完整資源使用Typescript重構axios(二十六)——添加HTTP授權auth屬性使用axios實現登錄功能