前端技术

Ajax 基本入门手册

基本概念

什么是 Ajax

Ajax 的全称是 Asynchronous Javascript And XML ( 异步 JavaScript 和 XML )。在网页中利用 XMLHttpRequest 对象和服务器进行数据交互的方式。Ajax 能让我们无须刷新页面即可实现网页与服务器之间的数据交互。而现在使用 Ajax 基本上使用 json的形式

Ajax 的主要应用场景

  • 数据验证:如注册用户时,查询用户名是否已被注册
  • 搜索提示:输入关键字时,动态加载搜索提示列表
  • 数据分页显示:当点击页面的时候,根据页码值动态刷新表格里的数据
  • 数据的增删改查

Ajax 的特点

优点
  • 可以无须刷新页面而与服务器端进行通信
  • 允许根据用户事件来更新部分页面内容
缺点
  • 没有浏览历史,不能退回
  • 存在跨域问题(同源)
  • SEO 不友好

Ajax 的运行环境

Ajax 技术需要运行在服务器环境中才能生效。

XML 与 json

XML 可扩展标记语言,用于传输和存储数据,XML 和 HTML 比较类似,不同的是 HTML 都是预定义标签,而 XML 中没有预定义标签,全都是自定义标签,用来标识一些数据。

// XML 书写方法
<studio>
  <name>PUJI</name>
  <age>36</age>
  <gender>male</gender>
</studio>

// json 书写方法
{
  "name": "PUJI",
  "age": 36,
  "gender": "male"
}

URL 地址

URL ( 全称 UniformResourceLocator ) 中文叫统一资源定位符,用于标识互联网上每个资源的唯一存放位置。浏览器通过 URL 地址,可以正确确定资源的存放位置,从而成功访问到对应的资源。

组成部分

  1. 客户端与服务器之间的通信协议
  2. 存有该资源的服务器名称
  3. 资源在服务器上具体的存放位置

http://puji.design/resources/introduction.pdf

其中,http 是通信协议,puji.design 是服务器名称,resources/introduction.pdf 是资源在服务器上具体存放的位置

HTTP 协议

HTTP ( hypertext transport protocol ) 协议,中文名超文本传输协议,协议详细规定了浏览器和万维网服务器之间互相通信的规则。

通信过程

视频教程:https://www.bilibili.com/video/BV1WC4y1b78y?p=5

客户端与服务器之间的通信过程分为 请求(请求报文) – 处理 – 响应(响应报文) 三个步骤。

在 HTTP 请求和响应的过程中传递的数据块就叫报文,包括要传送的数据和一些附加信息,这些数据和信息要遵守规定好的格式。

请求报文格式与参数
    • POST /s?ie=utf-8 HTTP/1.1
    • Host: puji.design
    • Cookie: name=puji
    • Content-type: application/x-www-form-urlencoded
    • User-Agent: chrome 89
  • 空行
    • username=admin&password=admin
响应报文格式与参数
    • HTTP/1.1 200 OK
    • Content-Type: text/html;charset=utf-8
    • Content-length: 2048
    • Content-encoding: gzip
  • 空行
  • 体:如 html

Ajax 的使用

视频教程:https://www.bilibili.com/video/BV1WC4y1b78y?p=10

请求数据资源

如果要在网页中请求服务器上的数据资源,则需要用到 XMLHttpRequest 对象。XMLHttpRequest 简称 xhr 是浏览器提供的 JS 成员,通过它,可以请求服务器上的数据资源。

  1. 创建 Ajax 对象
  2. 告诉 Ajax 请求地址以及请求方法
  3. 发送请求
  4. 获取服务器端给与客户端的响应数据
// 创建 Ajax 对象
let xhr = new XMLHttpRequest()

// 告诉 Ajax 请求地址以及请求方法
xhr.open('get', 'https://puji.design', true)

// 发送请求
xhr.send()

// 获取服务器的响应数据
xhr.addEventListener('load', () => {
  console.log(xhr.responseText)
})

客户端请求服务器时,请求的方式有很多,最常见的两种请求方式分别为 get 和 post 请求。

  • get 请求通常用于获取服务器端资源(向服务器要资源)
  • post 请求通常用于向服务器提交数据(往服务器发送资源)

服务端响应的数据格式

在项目中,服务器端大多情况下会以 JSON 对象作为响应数据的格式。当客户端拿到响应数据时,要将 JSON 数据和 HTML 字符串进行拼接,然后将拼接的结果展示在页面中。

在 HTTP 请求与响应的过程中,无论请求的参数还是响应的内容,如果是对象类型,最终都会被转换为对象字符串进行传输。因此需将字符串转换为 JSON 对象

// 将 JSON 字符串转换为 JSON 对象
JSON.parse(xhr.responseText)

请求参数传递

视频教程:https://www.bilibili.com/video/BV11E411e7yF?p=7

GET 请求方式
xhr.open('get', 'https://puji.design?name=PUJI&age=36')
POST 请求方式
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded')
xhr.send('name=PUJI&age=36')

// application/x-www-form-urlencoded 设置参数格式
请求参数的格式
application/x-www-form-urlencoded
name=PUJI&age=36
application/json
{name: 'PUJI', age: 36}
JSON.stringify() // 将 JSON 对象转换为 JSON 字符串

Ajax 状态码

视频教程:https://www.bilibili.com/video/BV11E411e7yF?p=10

可以判断服务器端返回的状态码,分别进行处理, xhr.status 获取 http 状态码

  • 网络畅通,服务器端能接收到请求,服务器端返回的结果不是预期结果,返回 400 状态码
  • 网络畅通,服务器端没有接收到请求,返回 404 状态码
  • 网络畅通,服务器端能接收到请求,服务器端返回 500 状态码
  • 网络中断,请求无法发送到服务器端,使用 error 事件

同步异步的概念

同步

同一时间只执行一件事情,即代码逐行执行

异步

异步代码虽然花费时间去执行,但程序不会等待异步代码执行完成后再继续执行后续代码,而是直接执行后续代码,当后续代码执行完成后再回头看异步代码是否返回结果,如果已有结果,再调用事先准备好的回调函数处理异步代码执行的结果。

// 异步执行示例
console.log('1')
setTimeout(() => {
  console.log('3')
}, 2000)
console.log('2')

封装 Ajax 函数

视频教程:https://www.bilibili.com/video/BV11E411e7yF?p=13

// 封装 Ajax 函数
function ajax( options ) {
  let defaults = {
    type: 'get',
    url: '',
    data: {},
    header: {
      'Content-Type': 'application/x-www-form-urlencoded'
    },
    success: function () {},
    error: function () {}
  }
  // 使用 options 对象中的属性覆盖 defaults 对象中的属性
  Object.assign(defaults, options)
  let xhr = new XMLHttpRequest()
  let params = ''
  for (let attr in defaults.data ) {
    params += attr + '=' + defaults.data[attr] + '&'
  }
  // 将参数最后的 & 截取掉
  params = params.substr(0, params.length - 1)
  if ( defaults.type == 'get' ) {
    defaults.url = defaults.url + '?' + params
  }
  xhr.open(defaults.type, defaults.url)
  if ( defaults.type == 'post' ) {
    let contentType = defaults.header['Content-Type']
    xhr.setRequestHeader('Content-Type', contentType)
    if (contentType == 'application/json') {
      xhr.send(JSON.stringify(defaults.data))
    } else {
      xhr.send(params)
    }
  } else {
    xhr.send()
  }
  xhr.addEventListener('load', () => {
    let contentType = xhr.getResponseHeader('Content-Type')
    let responseText = xhr.responseText
    if (contentType.includes('application/json')) {
      responseText = JSON.parse(responseText)
    }
    if ( xhr.status == 200 ) {
      defaults.success(responseText, xhr)
    } else {
      defaults.error(responseText, xhr)
    }
  })
}

// 调用 Ajax 函数(使用默认值)
ajax({
  url: 'https://puji.design'
})

// 调用 Ajax 函数(完整)
ajax({
  type: 'post',
  header: {
    'Content-Type': 'application/json'
  }
  url: 'https://puji.design',
  data: {
    name: 'PUJI',
    age: 36
  },
  success: function (data, Object) {
    console.log(data, Object)
  }
  error: function (data, Object) {
    console.log(data, Object)
  }
})

模版引擎

视频教程:https://www.bilibili.com/video/BV11E411e7yF?p=19

使用模版引擎提供的模版语法,可以将数据和 HTML 拼接起来。

https://aui.github.io/art-template/zh-cn/index.html

jQuery 中的 Ajax

浏览器中提供的 XMLHttpRequest 用法比较复杂,所以 jQuery 对 XMLHttpRequest 进行了封装,提供了一系列 Ajax 相关的函数,极大地降低了 Ajax 的使用难度。

jQuery 中发起 Ajax 请求最常用的三个方法:

  • $.get() 向服务器请求数据
  • $.post() 向服务器提交数据
  • $.ajax() 向服务器请求或提交数据

$.get()

专门用来发起 get 请求,从而将服务器上的资源请求到客户端来进行使用。

$.get(url[, data, callback])
  • url:字符串 string 类型,必填,要请求的资源地址
  • data:对象 object 类型,选填,请求资源期间要携带的参数
  • callback:函数 function,选填,请求成功时的回调函数
// 发起不带参数的请求
$.get('https://puji.design', function(res) {
  console.log(res)
})

// 发起带参数的请求
$.get(
  'https://puji.design',
  { id: 1 },
  function(res) {
    console.log(res)
  }
)

$.post()

专门用来发起 post 请求,从而向服务器提交数据。

$.post(url[, data, callback])
  • url:字符串 string 类型,必填,要提交数据的地址
  • data:对象 object 类型,选填,要提交的数据
  • callback:函数 function,选填,数据提交成功时的回调函数
$.post(
  'https://puji.design', // 请求的 URL 地址
  { username: 'wewe', msg: 'hello' }, // 提交的数据
  function(res) {
    console.log(res)
  } // 回调函数
)

$.ajax()

$.ajax({
  type: '', // 请求的方式,如 GET / POST
  url: '', // 请求的 URL 地址
  data: { }, // 这次请求要携带的数据
  success: function(res) {} // 请求成功之后的回调函数
})
// 发起 GET 请求
$.ajax({
  type: 'GET',
  url: 'https://puji.design',
  data: { id: 1 },
  success: function(res) {
    console.log(res)
  }
})

// 发起 POST 请求
$.ajax({
  type: 'POST',
  url: 'https://puji.design',
  data: {
    username: 'wewe',
    msg: 'hello'
  },
  success: function(res) {
    console.log(res)
  }
})

接口

请求数据时,被请求的 URL 地址,就叫做数据接口(简称接口)。同时,每个接口必须有请求方式。

请求接口的过程

请求 – 处理 – 响应

接口测试工具

视频教程:https://www.bilibili.com/video/BV1zs411h74a?p=9

为了验证接口能否被正常访问,我们需要使用接口测试工具,来对数据接口进行检测。

PostMan

https://www.getpostman.com/downloads/

检测 GET 接口

  • 选择 GET 请求方式
  • 填写请求的 URL 地址
  • 填写请求的参数
  • 点击 Send 按钮发起 GET 请求
  • 查看服务器响应结构

检测 POST 接口

  • 选择 POST 请求方式
  • 填写请求的 URL 地址
  • 选择 Body 面板并勾选数据格式 ( x-www-form-urlencoded )
  • 填写要发送到服务器的数据
  • 点击 Send 按钮发起 POST 请求
  • 查看服务器响应结果

接口文档

接口文档就是接口的说明文档,它是我们调用接口的依据。好的接口文档包含了对接口 URL,参数以及输出内容的说明,我们参照接口文档就能方便的知道接口的作用,以及接口如何进行调用。

接口文档的组成部分

接口文档可以包含很多信息,也可以按需进行精简,不过一个合格的接口文档,应该包含以下6项内容,从而为接口的调用提供依据:

  • 接口名称:用来标识各个接口的简单说明,如登录接口,获取文章列表接口等
  • 接口 URL:接口的调用地址
  • 调用方式:接口的调用方式,如 GETPOST
  • 参数格式:接口需要传递的参数,每个参数必须包含参数名称参数类型是否必须参数说明这4项内容
  • 响应格式:接口的返回值详细描述,一般包含数据名称数据类型说明3项内容
  • 返回示例(可选):通过对象的形式,例举服务器返回数据的结构

参考链接

MDN文档
https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest

Bilibili 视频教程
https://www.bilibili.com/video/BV11E411e7yF

https://www.bilibili.com/video/BV1WC4y1b78y/

https://www.bilibili.com/video/BV1Kt411u7BV

内容目录

PUJI Design 朴及设计 (c) 2024. 沪ICP备17052229号