機能:
ブラウザーでの XMLHttpRequests リクエストの送信
node.js での http リクエストの送信 リクエストとレスポンスをインターセプトする
Promise API のサポートリクエストとレスポンスのデータの変換リクエストのキャンセルJSON データの自動変換クライアントは XSRF に対する防御をサポート
サポートされる複数の要求方法：
axios(config)
axios.request(config)
axios.get(url, [, config])
axios.delete(url, [, config])
axios.head(url, [, config]) axios.post(url, [,data[,config] ]) axios.put(url, [,data[,config] ])
axios.patch (url, [,data[,config] ])
HTML ページに直接導入して使用します。
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
1. 取得リクエストを取得する
<script>
const url = 'https://store.crmeb.net/api/pc/get_category_product'
axios({
url: url,
method: 'get', // 这里可以省略，默认为get
}).then(res => {
// 返回请求到的数据
console.log(res)
}).catch(err => {
// 返回错误信息
console.log(err)
})
</script>
2. get リクエストの URL でパラメータを渡すには、params:{}! を定義するだけです。
<script>
const url = 'https://store.crmeb.net/api/pc/get_category_product'
axios({
url: url,
method: 'get', // 这里可以省略，默认为get
// 这里的键值对会拼接成这样url?page=1&limit=3
params: {
page: 1,
limit: 3
}
}).then(res => {
// 返回请求到的数据
console.log(res)
}).catch(err => {
// 返回错误信息
console.log(err)
})
</script>
3. get リクエストに似た post リクエストを送信します。メソッドを変更してデータを投稿および定義するだけです: {}。data 内のデータは、サーバーが受信する必要があるフィールド データです。
<script>
axios({
method: 'post',
url: '/user/12345',
data: {
firstName: 'Fred',
lastName: 'Flintstone'
}
}).then(res => {
// 返回请求到的数据
console.log(res)
}).catch(err => {
// 返回错误信息
console.log(err)
});
</script>
4. 同時リクエストの送信
開発中に後続のロジックに進む前に、複数のインターフェースのデータが同時にリクエストされるまで待つ必要がある場合は、同時リクエスト、axios 同時リクエスト、all メソッドを使用できます。all メソッドのパラメータは配列であり、配列の各値はリクエストにすることができます。リクエストが完了した後、直接 .then で 2 つのリクエストのデータを結合でき、返された結果は配列になります。
<script>
axios.all([
axios({
url: 'https://store.crmeb.net/api/pc/get_products',
params: {
page: 1,
limit: 20,
cid: 57,
sid: 0,
priceOrder: '',
news: 0,
}
}),
axios({
url: 'https://store.crmeb.net/api/pc/get_company_info',
})
]).then(results => {
console.log(results)
})
</script>
配列を自動的に展開したい場合は、以下に示すように、then() メソッドに axios.spread() メソッドを渡すだけです。
<script>
axios.all([
axios({
url: 'https://store.crmeb.net/api/pc/get_products',
params: {
page: 1,
limit: 20,
cid: 57,
sid: 0,
priceOrder: '',
news: 0,
}
}),
axios({
url: 'https://store.crmeb.net/api/pc/get_company_info',
})
]).then(axios.spread((res1, res2) => {
console.log(res1);
console.log(res2);
}))
</script>
ただし、vue コンポーネント開発を使用する場合は、通常、npm を介してプロジェクトをインストールおよびインポートします。
コンポーネント化開発での使用
1. npm を使用してインストールします
npm install axios --save
一般的に、実際のプロジェクトでは、上記のように axios を直接使用してデータをリクエストするのではなく、axios を別ファイルにカプセル化します。その目的は、共通のロジックを設定ファイルに抽出し、その公開ロジックをカプセル化することです。いつか axios フレームワークがメンテナンスされなくなったり、重大なバグが発生して修正されなくなったりした場合でも、全体的な変更の目的を達成するために設定ファイルを変更するだけで済みます。各リクエストのロジックが対応するコンポーネントに書き込まれている場合、変更は悪夢のようなものになります。
2. axios リクエスト ファイル request.js をカプセル化します
。 プロジェクトの src ディレクトリにネットワーク フォルダーを作成し、その中に request.js ファイルを作成します。パスは src/network/request.js です。
// src/network/request.js
// 引入axios
import axios from 'axios'
// 这里未使用default导出，是为了以后的扩展，便于导出多个方法
export function request(config){
// 创建axios实例
const instance = axios.create({
// 这里定义每次请求的公共数据，例如全局请求头，api根地址，过期时间等
// 具体参数可参考axios的官方文档
baseURL: 'http://demo26.crmeb.net/api',
timeout: 5000
})
// 拦截请求，如果获取某个请求需要携带一些额外数据
instance.interceptors.request.use(
config => {
console.log(config);
return config;
}, err => {
console.log(err);
})
// 拦截响应
instance.interceptors.response.use(
res => {
console.log(res)
return res.data
}, err => {
console.log(err)
}
)
// 发送请求
return instance(config)
3. カプセル化されたリクエスト request を使用します。
一般に、すべてのリクエストを api.js ファイルに入れ、各リクエストをメソッドとしてカプセル化します。たとえば、すべてのリクエストをカプセル化するために、request.js と同じディレクトリに api.js ファイルを作成します。
import {
request } from '../api/request'
// 获取分类
export const getHomeCategory = () => {
return request({
url: '/category'
})
}
// 获取banner图
export const getHomeBanner = () => {
return request({
url: '/pc/get_banner'
})
}
次に、エクスポートされた関連インターフェイス メソッドをコンポーネントに導入し、呼び出します。
import {
getHomeBanner } from "../network/api"
getHomeBanner().then(res => {
console.log(res)
})
上記は傍受要求と傍受応答をまとめたシンプルなパッケージなので、初心者の方にはわかりにくいかもしれませんが、少しでも参考になればと思い、個人的な意見を交えて説明させていただきます。
インターセプターとは何ですか?
リクエストのインターセプトとは、アクセスするために一部のリクエストに追加情報が必要であることを意味します。実際のプロジェクトで最も一般的な情報は、表示するためにログインする必要がある情報です。リクエストにはアクセスするためにトークンが含まれている必要があり、ここで処理できます。また、インターセプトされた応答もあります。たとえば、データがリクエストされた後、それが要件を満たしていないことが判明した場合などです。
Axios にはグローバル インターセプト メソッドがあります。 axios.interceptors() は
インターセプトが成功した後に返される必要があります。そうでない場合は、次のようにデータをリクエストできません。
// 拦截请求，如果获取某个请求需要携带一些额外数据
instance.interceptors.request.use(
config => {
console.log(config);
return config;
}, err => {
console.log(err);
})
// 拦截响应
instance.interceptors.response.use(
res => {
console.log(res)
return res.data
}, err => {
console.log(err)
}
)
Axios は、次のようないくつかのグローバル設定も提供します。
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';
もちろん、前に作成した axios インスタンス内で、特定のインスタンスでのみ動作するように設定することもできます。
次に、axios のすべての構成情報を確認します。
データは axios の中国語ドキュメントから取得されています。
{
// `url` 是用于请求的服务器 URL
url: '/user',
// `method` 是创建请求时使用的方法
method: 'get', // default
// `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
// 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
baseURL: 'https://some-domain.com/api/',
// `transformRequest` 允许在向服务器发送前，修改请求数据
// 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
// 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
transformRequest: [function (data, headers) {
// 对 data 进行任意转换处理
return data;
}],
// `transformResponse` 在传递给 then/catch 前，允许修改响应数据
transformResponse: [function (data) {
// 对 data 进行任意转换处理
return data;
}],
// `headers` 是即将被发送的自定义请求头
headers: {
'X-Requested-With': 'XMLHttpRequest'},
// `params` 是即将与请求一起发送的 URL 参数
// 必须是一个无格式对象(plain object)或 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', 和 'PATCH'
// 在没有设置 `transformRequest` 时，必须是以下类型之一：
// - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
// - 浏览器专属：FormData, File, Blob
// - Node 专属： Stream
data: {
firstName: 'Fred'
},
// `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
// 如果请求话费了超过 `timeout` 的时间，请求将被中断
timeout: 1000,
// `withCredentials` 表示跨域请求时是否需要使用凭证
withCredentials: false, // default
// `adapter` 允许自定义处理请求，以使测试更轻松
// 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
adapter: function (config) {
/* ... */
},
// `auth` 表示应该使用 HTTP 基础验证，并提供凭据
// 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
auth: {
username: 'janedoe',
password: 's00pers3cret'
},
// `responseType` 表示服务器响应的数据类型，可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
responseType: 'json', // default
// `responseEncoding` indicates encoding to use for decoding responses
// Note: Ignored for `responseType` of 'stream' or client-side requests
responseEncoding: 'utf8', // default
// `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
xsrfCookieName: 'XSRF-TOKEN', // default
// `xsrfHeaderName` is the name of the http header that carries the xsrf token value
xsrfHeaderName: 'X-XSRF-TOKEN', // default
// `onUploadProgress` 允许为上传处理进度事件
onUploadProgress: function (progressEvent) {
// Do whatever you want with the native progress event
},
// `onDownloadProgress` 允许为下载处理进度事件
onDownloadProgress: function (progressEvent) {
// 对原生进度事件的处理
},
// `maxContentLength` 定义允许的响应内容的最大尺寸
maxContentLength: 2000,
// `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，promise 将被 resolve; 否则，promise 将被 rejecte
validateStatus: function (status) {
return status >= 200 && status < 300; // default
},
// `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
// 如果设置为0，将不会 follow 任何重定向
maxRedirects: 5, // default
// `socketPath` defines a UNIX Socket to be used in node.js.
// e.g. '/var/run/docker.sock' to send requests to the docker daemon.
// Only either `socketPath` or `proxy` can be specified.
// If both are specified, `socketPath` is used.
socketPath: null, // default
// `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项：
// `keepAlive` 默认没有启用
httpAgent: new http.Agent({
keepAlive: true }),
httpsAgent: new https.Agent({
keepAlive: true }),
// 'proxy' 定义代理服务器的主机名称和端口
// `auth` 表示 HTTP 基础验证应当用于连接代理，并提供凭据
// 这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
proxy: {
host: '127.0.0.1',
port: 9000,
auth: {
username: 'mikeymike',
password: 'rapunz3l'
}
},
// `cancelToken` 指定用于取消请求的 cancel token
// （查看后面的 Cancellation 这节了解更多）
cancelToken: new CancelToken(function (cancel) {
})
}