[Vue] ファミリーバケットのアクシオス

概要

Axios は、nodejs とブラウザーで実行できる Promise ベースのネットワーク リクエスト ライブラリであり、同型です。つまり、同じコード セットがブラウザーと Nodejs の両方で実行できます。Axios はサーバー側でネイティブの Nodejs http モジュールを使用しますが、クライアント ブラウザでは xmlhttprequests を使用します。これは本質的に XHR のカプセル化ですが、Promise の実装バージョンです。

Promise
は主に非同期計算に使用されるオブジェクトで、非同期操作をキューに入れ、目的の順序で実行し、期待される結果を返します。

これは約束を意味し、一定期間後に結果が得られます。保留中、履行済み、拒否された待機中、成功、失敗の 3 つの状態があり、状態が変化すると、then() の応答関数がトリガーされて、コールバック地獄を解決するフォローアップは、複数の同時リクエストもサポートします

const axios = require('axios');

// 向给定ID的用户发起请求
axios.get('/user?ID=12345')
  .then(function (response) {
    
    
    // 处理成功情况
    console.log(response);
  })
  .catch(function (error) {
    
    
    // 处理错误情况
    console.log(error);
  })
  .then(function () {
    
    
    // 总是会执行
  });

アクシオスの機能

ブラウザから XMLHttpRequest を作成する

Node.jsからhttpリクエストを作成する

サポート約束API

リクエストとレスポンスをインターセプトする

リクエストとレスポンスのデータを変換する

キャンセルリクエスト

JSONデータを自動変換する

クライアントは XSRF に対する防御をサポートします

インストール

npm を使用します。

$ npm install axios

バウアーを使用します。

$ bower install axios

使用糸:

$ yarn add axios

jsDelivr CDN の使用:

<script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>

unpkg CDN の使用:

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

ajax、fetch、axios について

ネイティブ js を使用するのはまだ比較的面倒です。実際には、jquery などのライブラリが使用されます。カプセル化された ajax リクエストメソッドは非常に便利ですが、プロジェクト全体が大きくなり、単純に ajax を使用して jquery を導入するのは合理的ではありません

Axios は、シンプルなデザイン、シンプルな API を備えた最新のブラウザー向けに設計されており、さまざまなフロントエンド フレームワークと統合できます。これは、jquery が ajax カプセル化を実装するのと同じように、promise に基づいた ajax テクノロジーの一種のカプセル化です。 ajax を実装し、axios もその一種です

AjaxとはAsynchronous JavaScript and XMLの略で、非同期のネットワークリクエストを意味します。最大の特徴は、ページ上に更新リクエストのデータが存在しないことです。従来は、ページフォームがデータを送信する際、ユーザーが送信ボタンをクリックした後、ページは強制的に更新されます。エクスペリエンスは良くありません。しかし、mvc プログラミング自体については、現在の mvvm の波がうまくいっていないため、XHR 開発に基づいて、フェッチの代替手段もあります。

ブラウザでの ajax リクエストの実装:
ここに画像の説明を挿入
Fetchはフロントエンド開発の新しいテクノロジー製品です

Fetch API は、リクエストや応答などの HTTP パイプラインの部分にアクセスして操作するための JavaScript インターフェイスを提供します。また、ネットワーク経由でリソースを非同期にフェッチするための簡単で賢明な方法を提供するグローバル fetch() メソッドも提供します。この機能は、以前は XMLHttpRequest を使用して実装されていました。Fetch は、Service Worker などの他のテクノロジで簡単に使用できる、より優れた代替手段を提供します。Fetch は、CORS や HTTP の拡張機能など、他の HTTP 関連の概念を定義するための単一の論理的な場所も提供します。

fetch はより高度な技術的方向性を表しますが、現在の互換性はあまり良くないため、プロジェクトで使用する場合は注意してください。

Axios API

関連する設定を axios に渡してリクエストを作成できます

アクシオス(構成)

// 发起一个post请求
axios({
    
    
  method: 'post',
  url: '/user/12345',
  data: {
    
    
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});
// 在 node.js 用GET请求获取远程图片
axios({
    
    
  method: 'get',
  url: 'http://bit.ly/2mTM3nY',
  responseType: 'stream'
})
  .then(function (response) {
    
    
    response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
  });

axios(url[, config])

// 发起一个 GET 请求 (默认请求方式)
axios('/user/12345');

便宜上、サポートされているすべてのリクエスト メソッドにエイリアスが提供されています。

axios.request(config)
axios.get(url[, config])
axios.delete(url[, config])
axios.head(url[, config])
axios.options(url[, config])
axios.post( url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])

Axios インスタンス

インスタンスの作成
カスタム構成で新しいインスタンスを作成できます。

axios.create([config])
const instance = axios.create({
    
    
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {
    
    'X-Custom-Header': 'foobar'}
});

インスタンス メソッド
使用可能なインスタンス メソッドは次のとおりです。指定された構成はインスタンスの構成とマージされます。

axios#request(config)
axios#get(url[, config])
axios#delete(url[, config])
axios#head(url[, config])
axios#options(url[, config])
axios#post(url[, data[, config]])
axios#put(url[, data[, config]])
axios#patch(url[, data[, config]])
axios#getUri([config])

構成をリクエストする

これらは、リクエストの作成時に使用できる構成オプションです。URL のみが必要です。メソッドが指定されていない場合、リクエストはデフォルトで GET メソッドになります。

{
    
    
  // `url` 是用于请求的服务器 URL
  url: '/user',

  // `method` 是创建请求时使用的方法
  method: 'get', // 默认值

  // `baseURL` 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。
  // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  baseURL: 'https://some-domain.com/api/',

  // `transformRequest` 允许在向服务器发送前,修改请求数据
  // 它只能用于 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  // 数组中最后一个函数必须返回一个字符串, 一个Buffer实例,ArrayBuffer,FormData,或 Stream
  // 你可以修改请求头。
  transformRequest: [function (data, headers) {
    
    
    // 对发送的 data 进行任意转换处理

    return data;
  }],

  // `transformResponse` 在传递给 then/catch 前,允许修改响应数据
  transformResponse: [function (data) {
    
    
    // 对接收的 data 进行任意转换处理

    return data;
  }],

  // 自定义请求头
  headers: {
    
    'X-Requested-With': 'XMLHttpRequest'},

  // `params` 是与请求一起发送的 URL 参数
  // 必须是一个简单对象或 URLSearchParams 对象
  params: {
    
    
    ID: 12345
  },

  // `paramsSerializer`是可选方法,主要用于序列化`params`
  // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  paramsSerializer: function (params) {
    
    
    return Qs.stringify(params, {
    
    arrayFormat: 'brackets'})
  },

  // `data` 是作为请求体被发送的数据
  // 仅适用 'PUT', 'POST', 'DELETE 和 'PATCH' 请求方法
  // 在没有设置 `transformRequest` 时,则必须是以下类型之一:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属: FormData, File, Blob
  // - Node 专属: Stream, Buffer
  data: {
    
    
    firstName: 'Fred'
  },
  
  // 发送请求体数据的可选语法
  // 请求方式 post
  // 只有 value 会被发送,key 则不会
  data: 'Country=Brasil&City=Belo Horizonte',

  // `timeout` 指定请求超时的毫秒数。
  // 如果请求时间超过 `timeout` 的值,则请求会被中断
  timeout: 1000, // 默认值是 `0` (永不超时)

  // `withCredentials` 表示跨域请求时是否需要使用凭证
  withCredentials: false, // default

  // `adapter` 允许自定义处理请求,这使测试更加容易。
  // 返回一个 promise 并提供一个有效的响应 (参见 lib/adapters/README.md)。
  adapter: function (config) {
    
    
    /* ... */
  },

  // `auth` HTTP Basic Auth
  auth: {
    
    
    username: 'janedoe',
    password: 's00pers3cret'
  },

  // `responseType` 表示浏览器将要响应的数据类型
  // 选项包括: 'arraybuffer', 'document', 'json', 'text', 'stream'
  // 浏览器专属:'blob'
  responseType: 'json', // 默认值

  // `responseEncoding` 表示用于解码响应的编码 (Node.js 专属)
  // 注意:忽略 `responseType` 的值为 'stream',或者是客户端请求
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // 默认值

  // `xsrfCookieName` 是 xsrf token 的值,被用作 cookie 的名称
  xsrfCookieName: 'XSRF-TOKEN', // 默认值

  // `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认值

  // `onUploadProgress` 允许为上传处理进度事件
  // 浏览器专属
  onUploadProgress: function (progressEvent) {
    
    
    // 处理原生进度事件
  },

  // `onDownloadProgress` 允许为下载处理进度事件
  // 浏览器专属
  onDownloadProgress: function (progressEvent) {
    
    
    // 处理原生进度事件
  },

  // `maxContentLength` 定义了node.js中允许的HTTP响应内容的最大字节数
  maxContentLength: 2000,

  // `maxBodyLength`(仅Node)定义允许的http请求内容的最大字节数
  maxBodyLength: 2000,

  // `validateStatus` 定义了对于给定的 HTTP状态码是 resolve 还是 reject promise。
  // 如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),
  // 则promise 将会 resolved,否则是 rejected。
  validateStatus: function (status) {
    
    
    return status >= 200 && status < 300; // 默认值
  },

  // `maxRedirects` 定义了在node.js中要遵循的最大重定向数。
  // 如果设置为0,则不会进行重定向
  maxRedirects: 5, // 默认值

  // `socketPath` 定义了在node.js中使用的UNIX套接字。
  // e.g. '/var/run/docker.sock' 发送请求到 docker 守护进程。
  // 只能指定 `socketPath` 或 `proxy` 。
  // 若都指定,这使用 `socketPath` 。
  socketPath: null, // default

  // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
  // and https requests, respectively, in node.js. This allows options to be added like
  // `keepAlive` that are not enabled by default.
  httpAgent: new http.Agent({
    
     keepAlive: true }),
  httpsAgent: new https.Agent({
    
     keepAlive: true }),

  // `proxy` 定义了代理服务器的主机名,端口和协议。
  // 您可以使用常规的`http_proxy` 和 `https_proxy` 环境变量。
  // 使用 `false` 可以禁用代理功能,同时环境变量也会被忽略。
  // `auth`表示应使用HTTP Basic auth连接到代理,并且提供凭据。
  // 这将设置一个 `Proxy-Authorization` 请求头,它会覆盖 `headers` 中已存在的自定义 `Proxy-Authorization` 请求头。
  // 如果代理服务器使用 HTTPS,则必须设置 protocol 为`https`
  proxy: {
    
    
    protocol: 'https',
    host: '127.0.0.1',
    port: 9000,
    auth: {
    
    
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

  // see https://axios-http.com/zh/docs/cancellation
  cancelToken: new CancelToken(function (cancel) {
    
    
  }),

  // `decompress` indicates whether or not the response body should be decompressed 
  // automatically. If set to `true` will also remove the 'content-encoding' header 
  // from the responses objects of all decompressed responses
  // - Node only (XHR cannot turn off decompression)
  decompress: true // 默认值

}

応答構造

リクエストに対するレスポンスには次の情報が含まれます。

{
    
    
  // `data` 由服务器提供的响应
  data: {
    
    },

  // `status` 来自服务器响应的 HTTP 状态码
  status: 200,

  // `statusText` 来自服务器响应的 HTTP 状态信息
  statusText: 'OK',

  // `headers` 是服务器响应头
  // 所有的 header 名称都是小写,而且可以使用方括号语法访问
  // 例如: `response.headers['content-type']`
  headers: {
    
    },

  // `config` 是 `axios` 请求的配置信息
  config: {
    
    },

  // `request` 是生成此响应的请求
  // 在node.js中它是最后一个ClientRequest实例 (in redirects),
  // 在浏览器中则是 XMLHttpRequest 实例
  request: {
    
    }
}

then を使用すると、次のような応答が返されます。

axios.get('/user/12345')
  .then(function (response) {
    
    
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.config);
  });

catch を使用する場合、または then の 2 番目の引数として拒否コールバックを渡す場合、応答はエラー オブジェクトを通じて取得できます。エラー処理セクションで説明したとおりです。

デフォルトの割り当て

デフォルト設定
すべてのリクエストに適用されるデフォルト設定を指定できます。

グローバル軸のデフォルト

axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

カスタムインスタンスのデフォルト

// 创建实例时配置默认值
const instance = axios.create({
    
    
  baseURL: 'https://api.example.com'
});

// 创建实例后修改默认值
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

設定の優先順位
設定は優先順位に従ってマージされます。その順序は、lib/defaults.js にあるライブラリのデフォルト、次にインスタンスのデフォルト属性、最後にリクエストの構成パラメータです。後のものが前のものより優先されます。以下に例を示します。

// 使用库提供的默认配置创建实例
// 此时超时配置的默认值是 `0`
const instance = axios.create();

// 重写库的超时默认值
// 现在,所有使用此实例的请求都将等待2.5秒,然后才会超时
instance.defaults.timeout = 2500;

// 重写此请求的超时时间,因为该请求需要很长时间
instance.get('/longRequest', {
    
    
  timeout: 5000
});

インターセプター

リクエストまたはレスポンスが then または catch によって処理される前にインターセプトします。

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    
    
    // 在发送请求之前做些什么
    return config;
  }, function (error) {
    
    
    // 对请求错误做些什么
    return Promise.reject(error);
  });

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    
    
    // 2xx 范围内的状态码都会触发该函数。
    // 对响应数据做点什么
    return response;
  }, function (error) {
    
    
    // 超出 2xx 范围的状态码都会触发该函数。
    // 对响应错误做点什么
    return Promise.reject(error);
  });

後でインターセプターを削除する必要がある場合は、次のようにすることができます。

const myInterceptor = axios.interceptors.request.use(function () {
    
    /*...*/});
axios.interceptors.request.eject(myInterceptor);

インターセプターはカスタム axios インスタンスに追加できます。

const instance = axios.create();
instance.interceptors.request.use(function () {
    
    /*...*/});

エラー処理

axios.get('/user/12345')
  .catch(function (error) {
    
    
    if (error.response) {
    
    
      // 请求成功发出且服务器也响应了状态码,但状态代码超出了 2xx 的范围
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.headers);
    } else if (error.request) {
    
    
      // 请求已经成功发起,但没有收到响应
      // `error.request` 在浏览器中是 XMLHttpRequest 的实例,
      // 而在node.js中是 http.ClientRequest 的实例
      console.log(error.request);
    } else {
    
    
      // 发送请求时出了点问题
      console.log('Error', error.message);
    }
    console.log(error.config);
  });

validateStatus 構成オプションを使用すると、エラーをスローする HTTP コードをカスタマイズできます。

axios.get('/user/12345', {
    
    
  validateStatus: function (status) {
    
    
    return status < 500; // 处理状态码小于500的情况
  }
})

toJSON を使用して、HTTP エラーに関する詳細情報を取得します。

axios.get('/user/12345')
  .catch(function (error) {
    
    
    console.log(error.toJSON());
  });

キャンセルリクエスト

AbortController
v0.22.0 以降、Axios はフェッチ API メソッド - AbortController をサポートしてリクエストをキャンセルします。

const controller = new AbortController();

axios.get('/foo/bar', {
    
    
   signal: controller.signal
}).then(function(response) {
    
    
   //...
});
// 取消请求
controller.abort()

CancelToken は非推奨になりました
キャンセル トークンを使用してリクエストをキャンセルすることもできます。

Axios のキャンセル トークン API は、キャンセル可能な Promise プロポーザルに基づいています。

この API は v0.22.0 以降非推奨になっているため、新しいプロジェクトでは使用しないでください。

キャンセル トークンは、次のように CancelToken.source ファクトリ メソッドを使用して作成できます。

const CancelToken = axios.CancelToken;
const source = CancelToken.source();

axios.get('/user/12345', {
    
    
  cancelToken: source.token
}).catch(function (thrown) {
    
    
  if (axios.isCancel(thrown)) {
    
    
    console.log('Request canceled', thrown.message);
  } else {
    
    
    // 处理错误
  }
});

axios.post('/user/12345', {
    
    
  name: 'new name'
}, {
    
    
  cancelToken: source.token
})

// 取消请求(message 参数是可选的)
source.cancel('Operation canceled by the user.');
也可以通过传递一个 executor 函数到 CancelToken 的构造函数来创建一个 cancel token:

const CancelToken = axios.CancelToken;
let cancel;

axios.get('/user/12345', {
    
    
  cancelToken: new CancelToken(function executor(c) {
    
    
    // executor 函数接收一个 cancel 函数作为参数
    cancel = c;
  })
});

// 取消请求
cancel();

注: 同じキャンセル トークンまたはシグナルを使用して、複数のリクエストをキャンセルできます。

当面は、同じリクエストに対しても両方のキャンセル API を使用できます。

const controller = new AbortController();

const CancelToken = axios.CancelToken;
const source = CancelToken.source();

axios.get('/user/12345', {
    
    
  cancelToken: source.token,
  signal: controller.signal
}).catch(function (thrown) {
    
    
  if (axios.isCancel(thrown)) {
    
    
    console.log('Request canceled', thrown.message);
  } else {
    
    
    // 处理错误
  }
});

axios.post('/user/12345', {
    
    
  name: 'new name'
}, {
    
    
  cancelToken: source.token
})

// 取消请求 (message 参数是可选的)
source.cancel('Operation canceled by the user.');
// 或
controller.abort(); // 不支持 message 参数

キャンセルリクエスト

デフォルトでは、axios は JavaScript オブジェクトを JSON にシリアル化します。application/x-www-form-urlencoded 形式でデータを送信するには、次のオプションのいずれかを使用できます。

ブラウザブラウザ
では、URLSearchParams API を次のように使用できます。

const params = new URLSearchParams();
params.append('param1', 'value1');
params.append('param2', 'value2');
axios.post('/foo', params);

すべてのブラウザ (caniuse.com を参照) が URLSearchParams をサポートしているわけではありませんが、ポリフィルは利用可能であることに注意してください (必ずグローバル環境をポリフィルしてください)。

あるいは、qs ライブラリを使用してデータをエンコードすることもできます。

const qs = require('qs');
axios.post('/foo', qs.stringify({
    
     'bar': 123 }));
或者用另一种方式 (ES6),

import qs from 'qs';
const data = {
    
     'bar': 123 };
const options = {
    
    
  method: 'POST',
  headers: {
    
     'content-type': 'application/x-www-form-urlencoded' },
  data: qs.stringify(data),
  url,
};
axios(options);

Node.js
クエリ文字列
node.js では、次のようにクエリ文字列モジュールを使用できます。

const querystring = require('querystring');
axios.post('http://something.com/', querystring.stringify({
    
     foo: 'bar' }));

または、次のように「url module」の「URLSearchParams」を使用します。

const url = require('url');
const params = new url.URLSearchParams({
    
     foo: 'bar' });
axios.post('http://something.com/', params.toString());

qs ライブラリを使用することもできます。

注:
ネストされたオブジェクトを文字列化する必要がある場合は、qs ライブラリを使用することをお勧めします。そのユースケースでは、querystring メソッドには既知の問題があるためです (https://github.com/nodejs/node-v0.x-archive/issues/1665) )。

フォーム データ
node.js では、次のように form-data ライブラリを使用できます。

const FormData = require('form-data');
 
const form = new FormData();
form.append('my_field', 'my value');
form.append('my_buffer', new Buffer(10));
form.append('my_file', fs.createReadStream('/foo/bar.jpg'));

axios.post('https://example.com', form, {
    
     headers: form.getHeaders() })

あるいは、インターセプターを使用します。

axios.interceptors.request.use(config => {
    
    
  if (config.data instanceof FormData) {
    
    
    Object.assign(config.headers, config.data.getHeaders());
  }
  return config;
});

リクエストボディのエンコーディング

Axios 中国語文書
フロントエンド基本シリーズ (1) Axios

おすすめ

転載: blog.csdn.net/weixin_44231544/article/details/132333585