Skip to content

Ajax入门

学习目标

  1. 掌握 axios 相关参数,从服务器获取并解析展示数据
  2. 掌握接口文档的查看和使用
  3. 掌握在浏览器的 network 面板中查看请求和响应的内容
  4. 了解请求和响应报文的组成部分

01.AJAX 概念和 axios 使用

了解 AJAX 概念并掌握 axios 库基本使用

  1. 什么是 AJAX ? mdn

    • 使用浏览器的 XMLHttpRequest 对象 与服务器通信

    • 浏览器网页中,使用 AJAX技术(XHR对象)发起获取省份列表数据的请求,服务器代码响应准备好的省份列表数据给前端,前端拿到数据数组以后,展示到网页

      image-20230403173156484

  2. 什么是服务器?

    • 可以暂时理解为提供数据的一台电脑
  3. 为何学 AJAX ?

    • 以前我们的数据都是写在代码里固定的, 无法随时变化
    • 现在我们的数据可以从服务器上进行获取,让数据变活
  4. 怎么学 AJAX ?

    • 这里使用一个第三方库叫 axios, 后续在学习 XMLHttpRequest 对象了解 AJAX 底层原理
    • 因为 axios 库语法简单,让我们有更多精力关注在与服务器通信上,而且后续 Vue,React 学习中,也使用 axios 库与服务器通信
  5. 需求:从服务器获取省份列表数据,展示到页面上(体验 axios 语法的使用)

    获取省份列表数据 - 目标资源地址:http://hmajax.itheima.net/api/province

    • 完成效果:

      image-20230220113157010

  6. 接下来讲解 axios 语法,步骤:

  7. 引入 axios.js 文件到自己的网页中

    axios.js文件链接: https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js

  8. 明确axios函数的使用语法

    js
    axios({
      url: '目标资源地址'
    }).then((result) => {
      // 对服务器返回的数据做后续处理
    })

    注意:请求的 url 地址, 就是标记资源的网址

    注意:then 方法这里先体验使用,由来后续会讲到

  9. 对应代码

html
<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>AJAX概念和axios使用</title>
</head>

<body>
  <!--
    axios库地址:https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js
    省份数据地址:http://hmajax.itheima.net/api/province

    目标: 使用axios库, 获取省份列表数据, 展示到页面上
    1. 引入axios库
  -->
  <p class="my-p"></p>
  <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
  <script>
    // 2. 使用axios函数
    axios({
      url: 'http://hmajax.itheima.net/api/province'
    }).then(result => {
      console.log(result)
      // 好习惯:多打印,确认属性名
      console.log(result.data.list)
      console.log(result.data.list.join('<br>'))
      // 把准备好省份列表,插入到页面
      document.querySelector('.my-p').innerHTML = result.data.list.join('<br>') 
    })
  </script>
</body>

</html>

02.认识 URL

  1. 为什么要认识 URL ? mdn

    • 虽然是后端给我的一个地址,但是哪部分标记的是服务器电脑,哪部分标记的是资源呢?所以为了和服务器有效沟通我们要认识一下
  2. 什么是 URL ?

    • 统一资源定位符,简称网址,用于定位网络中的资源(资源指的是:网页,图片,数据,视频,音频等等)

      image-20230403185206384

  3. URL 的组成?

    • 协议,域名,资源路径(URL 组成有很多部分,我们先掌握这3个重要的部分即可)

      image-20230403185305934

  4. 什么是 http 协议 ?

    • 叫超文本传输协议,规定了浏览器和服务器传递数据的格式(而格式具体有哪些稍后我们就会学到)

      image-20230403185356997

  5. 什么是域名 ?

    • 标记服务器在互联网当中的方位,网络中有很多服务器,你想访问哪一台,就需要知道它的域名才可以

      image-20230403185406674

  6. 什么是资源路径 ?

    • 一个服务器内有多个资源,用于标识你要访问的资源具体的位置

      image-20230403185428276

  7. 接下来做个需求,访问新闻列表的 URL 网址,打印新闻数据

    • 效果图如下:

    image-20230220122455915

    新闻列表数据 URL 网址:http://hmajax.itheima.net/api/news

    js
    axios({
      url: 'http://hmajax.itheima.net/api/news'
    }).then(result => {
      console.log(result)
    })

    url解释:从黑马服务器使用http协议,访问/api/news路径下的新闻列表资源

03.URL 查询参数

  1. 什么是查询参数 ?

    • 携带给服务器额外信息,让服务器返回我想要的某一部分数据而不是全部数据

    • 举例:查询河北省下属的城市列表,需要先把河北省传递给服务器

      image-20230404101257205

  2. 查询参数的语法 ?

  3. axios 如何携带查询参数?

    • 使用 params 选项即可

      js
      axios({
        url: '目标资源地址',
        params: {
          参数名: 值
        }
      }).then(result => {
        // 对服务器返回的数据做后续处理
      })

      查询城市列表的 url地址:http://hmajax.itheima.net/api/city

      参数名:pname (值要携带省份名字)

  4. 需求:获取“河北省”下属的城市列表,展示到页面,对应代码:

    html
    <!DOCTYPE html>
    <html lang="en">
    <head>
      <meta charset="UTF-8">
      <meta http-equiv="X-UA-Compatible" content="IE=edge">
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <title>查询参数</title>
    </head>
    <body>
      <!-- 
        城市列表: http://hmajax.itheima.net/api/city
        参数名: pname
        值: 省份名字
      -->
      <p></p>
      <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
      <script>
        axios({
          url: 'http://hmajax.itheima.net/api/city',
          // 查询参数
          params: {
            pname: '辽宁省'
          }
        }).then(result => {
          console.log(result.data.list)
          document.querySelector('p').innerHTML = result.data.list.join('<br>')
        })
      </script>
    </body>
    </html>

04.案例-查询-地区列表

  1. 需求:根据输入的省份名字和城市名字,查询下属地区列表

    js
    /*
          获取地区列表: http://hmajax.itheima.net/api/area
          查询参数:
            pname: 省份或直辖市名字
            cname: 城市名字
        */
        let pname = document.querySelector('.province').value
        let cname = document.querySelector('.city').value
        axios({
            url: 'http://hmajax.itheima.net/api/area',
            params: {
                pname,//ES6 与value名一致可简写
                cname
            }
        }).then(result => {
           
        })
    })

05.常用请求方法和数据提交

  1. 想要提交数据,先来了解什么是请求方法

    • 请求方法是一些固定单词的英文,例如:GET,POST,PUT,DELETE,PATCH(这些都是http协议规定的),每个单词对应一种对服务器资源要执行的操作

      image-20230220130833363

      image-20230404104319428

    • 前面我们获取数据其实用的就是GET请求方法,但是axios内部设置了默认请求方法就是GET,我们就没有写

    • 但是提交数据需要使用POST请求方法

  2. 什么时候进行数据提交呢?

    • 例如:多端要查看同一份订单数据,或者使用同一个账号进行登录,那订单/用户名+密码,就需要保存在服务器上,随时随地进行访问

      image-20230404104328384

      image-20230404104333584

  3. axios 如何提交数据到服务器呢?

    • 需要学习,method 和 data 这2个新的选项了(大家不用担心,这2个学完,axios常用的选项就都学完了)

      js
      axios({
        url: '目标资源地址',
        method: '请求方法',
        data: {
          参数名: 值
        }
      }).then(result => {
        // 对服务器返回的数据做后续处理
      })
  4. 需求:注册账号,提交用户名和密码到服务器保存

    注册用户 URL 网址:http://hmajax.itheima.net/api/register

    请求方法:POST

    参数名:

    username:用户名(要求中英文和数字组成,最少8位)

    password:密码(最少6位)

    image-20230404104350387

  5. 正确代码如下:

    js
    /*
      注册用户:http://hmajax.itheima.net/api/register
      请求方法:POST
      参数名:
        username:用户名(中英文和数字组成,最少8位)
        password:密码  (最少6位)
    
      目标:点击按钮,通过axios提交用户和密码,完成注册
    */
    document.querySelector('.btn').addEventListener('click', () => {
      axios({
        url: 'http://hmajax.itheima.net/api/register',
        method: 'POST',
        data: {
          username: 'itheima007',
          password: '7654321'
        }
      })
    })

06.axios 错误处理

  1. 如果注册相同的用户名,则会遇到注册失败的请求,也就是 axios 请求响应失败了,你会在控制台看到如图的错误:

    image-20230220131753051

  2. 在 axios 语法中要如何处理呢?

    • 因为,普通用户不会去控制台里看错误信息,我们要编写代码拿到错误并展示给用户在页面上
  3. 使用 axios 的 catch 方法,捕获这次请求响应的错误并做后续处理,语法如下:

    js
    axios({
      // ...请求选项
    }).then(result => {
      // 处理成功数据
    }).catch(error => {
      // 处理失败错误
    })
  4. 需求:再次重复注册相同用户名,提示用户注册失败的原因

    js
    document.querySelector('.btn').addEventListener('click', () => {
        axios({
          url: 'http://hmajax.itheima.net/api/register',
          method: 'post',
          data: {
            username: 'itheima007',
            password: '7654321'
          }
        }).then(result => {
          // 成功
          console.log(result)
        }).catch(error => {
          // 失败
          // 处理错误信息
          console.log(error)
          console.log(error.response.data.message)
          alert(error.response.data.message)
        })
    })

07.HTTP 协议-请求报文

  1. 首先,HTTP 协议规定了浏览器和服务器返回内容的格式

  2. 请求报文:是浏览器按照协议规定发送给服务器的内容,例如刚刚注册用户时,发起的请求报文:

    image-20230404104508764

    image-20230220132229960

  3. 这里的格式包含:

    • 请求行:请求方法,URL,协议
    • 请求头:以键值对的格式携带的附加信息,比如:Content-Type(指定了本次传递的内容类型)
    • 空行:分割请求头,空行之后的是发送给服务器的资源
    • 请求体:发送的资源
  4. 我们切换到浏览器中,来看看刚才注册用户发送的这个请求报文以及内容去哪里查看呢

  5. 代码:直接在上个代码基础上复制,然后运行查看请求报文对应关系即可

通过 Chrome 的网络面板如何查看请求体?

image-20230220132617016

08.请求报文-错误排查

  1. 学习了查看请求报文有什么用呢?
    • 可以用来确认我们代码发送的请求数据是否真的正确
  2. 配套模板代码里,对应 08 标题文件夹里是我同桌的代码,它把登录也写完了,但是无法登录,我们来到模板代码中,找到运行后,在不逐行查看代码的情况下,查看请求报文,看看它登录提交的相关信息对不对,帮他找找问题出现的原因
  3. 发现请求体数据有问题,往代码中定位,找到类名写错误了
  4. 代码:在配套文件夹素材里,找到需要对应代码,直接运行,根据报错信息,找到错误原因

09.HTTP 协议-响应报文

  1. 响应报文:是服务器按照协议固定的格式,返回给浏览器的内容

    image-20230220133141151

  2. 响应报文的组成:

    • 响应行(状态行):协议,HTTP响应状态码,状态信息
    • 响应头:以键值对的格式携带的附加信息,比如:Content-Type(告诉浏览器,本次返回的内容类型)
    • 空行:分割响应头,控制之后的是服务器返回的资源
    • 响应体:返回的资源
  3. HTTP 响应状态码:

    • 用来表明请求是否成功完成

    • 例如:404(客户端要找的资源,在服务器上不存在)

      image-20230220133344116

10.接口文档

  1. 接口文档:描述接口的文章(一般是后端工程师,编写和提供)
  2. 接口:指的使用 AJAX 和 服务器通讯时,使用的 URL,请求方法,以及参数,例如:AJAX阶段接口文档

axios二次封装

1.统一管理请求地址

javascript
//   utils/request.js
import axios from 'axios'

// 创建一个axios对象出来
const request = axios.create({
    baseURL: 'http://localhost:8088/api',
    timeout: 10000
})
  
// request 拦截器
// 可以自请求发送前对请求做一些处理
// 比如统一加token,对请求参数统一加密
request.interceptors.request.use(config => {
    // 如果是文件上传,不设置 Content-Type,让浏览器自动设置
    if (!(config.data instanceof FormData)) {
        config.headers['Content-Type'] = 'application/json;charset=utf-8';
    }
    
    const user = localStorage.getItem("user");
    if(user){
        config.headers['token'] = JSON.parse(user).userInfo.token;
    }
    
    return config
}, error => {
    return Promise.reject(error)
});

// response 拦截器
// 可以在接口响应后统一处理结果
request.interceptors.response.use(
    response => {
        // response.data即为后端返回的Result
        let res = response.data;
        // 兼容服务端返回的字符串数据
        if (typeof res === 'string') {
            res = res ? JSON.parse(res) : res
        }
        return res;
    },
    error => {
        console.log('err' + error) // for debug
        return Promise.reject(error)
    }
)

export default request

api解耦:

javascript
//  api/user.js
import request from "@/utils/request"

//登录
export function login ({ account, password }) {
    return request({
      url: '/user/login',
      method:'POST',
      params: {
        account: account,
        password: password
      }
    })
  }

  export function updateUser(userData) {
    return request({
      url: '/user/update',
      method: 'PUT',
      data: userData
    })
  }


//使用api

import { getUserList} from '@/apis/admin/user' //引入

const fetchList = async () => {
  loading.value = true
  try {
    const res = await getUserList({
      current: currentPage.value,
      size: pageSize.value,
      search: search.value,
      gender: gender.value,
      userLevel: userLevel.value
    })
    if (res.code === '0') {
      tableData.value = res.data.records
      total.value = res.data.total
    }
  } catch (e) {
    ElMessage.error('获取用户列表失败')
  } finally {
    loading.value = false
  }
}