layui怎么封装一个全局公用的通用Ajax网络请求工具

冬晨酱_3836

冬晨酱_3836

2026-11-05

216人浏览

原创

不能直接改 layui.ajax 或用 $.ajaxSetup,因其被 Layui 封装且不暴露原型链,$.ajaxSetup 在 Layui 内部请求中会被默认配置覆盖而失效;推荐用 layui.define 封装统一 ajax 模块,自动注入 token、处理 JSON 序列化、支持 FormData、拦截 401 跳转登录,并显式配置 withCredentials 和后端 CORS 响应头。

layui怎么封装一个全局公用的通用ajax网络请求工具

为什么不能直接改 layui.ajax 或用 $.ajaxSetup

因为 layui.ajax 是封装过的函数,不暴露原型链;$.ajaxSetup 在 Layui 内部请求中基本失效——它会被 Layui 自己的默认配置覆盖,尤其在 table.render、form.on('submit') 等场景下完全不生效。强行用会导致 headers 丢失、contentType 错乱、甚至跨域失败。

推荐做法:用 layui.define 封装自己的模块

这是最干净、可维护性最强的方式,所有业务代码统一走你封装的入口,便于加 loading、错误重试、token 刷新、日志埋点等逻辑。

在 /modules/common.js(路径按 layui.config({ base: '/modules/' }) 配置)中写:

layui.define(['jquery'], function(exports){
  var $ = layui.jquery;

  var common = {
    ajax: function(options) {
      var defaults = {
        dataType: 'json',
        contentType: 'application/json;charset=UTF-8',
        headers: {}
      };
      
      // 自动注入 token(兼容 localStorage / sessionStorage)
      var token = localStorage.getItem('access_token') || sessionStorage.getItem('access_token');
      if (token) {
        defaults.headers.Authorization = 'Bearer ' + token;
      }

      // 合并配置
      var opts = $.extend(true, {}, defaults, options);

      // POST 且 data 是对象时,自动 JSON.stringify
      if (opts.type && opts.type.toUpperCase() === 'POST' && typeof opts.data === 'object' && !(opts.data instanceof FormData)) {
        opts.data = JSON.stringify(opts.data);
      }

      return $.ajax(opts);
    }
  };

  exports('common', common);
});

使用时:

layui.use(['common'], function(){
  var common = layui.common;
  common.ajax({
    url: '/api/user',
    type: 'GET',
    success: function(res) { console.log(res); }
  });
});
  • 所有请求都走 common.ajax,headers、序列化、token 注入全可控
  • FormData 类型不会被误转成 JSON,上传文件不受影响
  • 返回值仍是 jqXHR 对象,可链式调用 .done()、.fail()

注意跨域和凭据传递的硬性要求

如果后端是跨域接口且需要带 cookie 或 token,光设 headers 不够,必须显式开启凭据支持:

深蓝色网站后台管理系统layui框架模板-AdminPro
深蓝色网站后台管理系统layui框架模板-AdminPro

一款深蓝色网站后台管理系统layui框架模板

下载
  • 在封装的 ajax 函数里补上:xhrFields: { withCredentials: true }
  • 后端响应头必须包含:Access-Control-Allow-Origin: https://your-domain.com(不能是 *)
  • 同时要返回:Access-Control-Allow-Credentials: true

漏掉任意一条,浏览器会静默丢弃响应,控制台只报「CORS error」但无细节。

别忘了拦截 401 并跳转登录

token 过期时后端通常返回 401,这时候该清 token 并跳转登录页——这个逻辑不适合塞进每个 success 回调里,应该统一收口:

common.ajax = function(options) {
  // ...前面的配置合并逻辑

  return $.ajax(opts).fail(function(xhr) {
    if (xhr.status === 401) {
      localStorage.removeItem('access_token');
      location.href = '/login.html';
      return;
    }
    // 其他错误由调用方自己处理
  });
};

这个拦截点容易被忽略:有人只在 table.request 的 done 里判断 code,但 common.ajax 是底层,401 必须在这里截住,否则后续请求全失败,用户卡在白屏。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

layui layui菜鸟教程 ajax

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2843

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

6183

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

7110

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

6918

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

983

5

ajax教程
ajax教程

php中文网为大家带来ajax教程合集,Ajax是一种用于创建快速动态网页的技术。通过在后台与服务器进行少量数据交换,Ajax可以使网页实现异步更新。这意味着可以在不重新加载整个网页的情况下,对网页的某部分进行更新。php中文网还为大家带来ajax的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.14

3280

4

ajax中文乱码解决方法
ajax中文乱码解决方法

ajax中文乱码解决方法有设置请求头部的字符编码、在服务器端设置响应头部的字符编码和使用encodeURIComponent对中文进行编码。本专题为大家提供ajax中文乱码相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

360

5

ajax传递中文乱码怎么办
ajax传递中文乱码怎么办

ajax传递中文乱码的解决办法:1、设置统一的编码方式;2、服务器端编码;3、客户端解码;4、设置HTTP响应头;5、使用JSON格式。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.11.15

3093

5

ajax网站有哪些
ajax网站有哪些

使用ajax的网站有谷歌、维基百科、脸书、纽约时报、亚马逊、stackoverflow、twitter、hacker news、shopify和basecamp等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.09.24

1161

6

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
ThinkPHP配置开发与CMS后台实战
ThinkPHP配置开发与CMS后台实战

共87课时 | 13.1万人学习

第二十三期_综合实战
第二十三期_综合实战

共89课时 | 11.4万人学习

Layui 快速入门精讲
Layui 快速入门精讲

共5课时 | 1.6万人学习