如何利用JQuery封装一个自定义通用JS操作方便在其他项目中使用?
xsobi 2024-12-07 18:09 1 浏览
想要利用JQuery封装一个通用的JS操作,提供给其他项目使用,首先需要明确的就是我们需要通过JQuery的封装来完成什么操作,并且这些操作必须是能够在多个项目中进行复用的操作。例如比较常见的操作有:Ajax请求封装、表单的处理、DOM操作、动画效果支持、通用事件的处理、对于数据的校验等操作。
有了这些操作之后,接下来我们就来看看如何对这些操作进行封装。
定义自执行匿名函数 (IIFE)
想要实现JQuery的封装,首先我们先来了解一个概念,就是匿名函数(IIFE, Immediately Invoked Function Expression),通过匿名函数(IIFE, Immediately Invoked Function Expression)来封装代码,可以避免与全局变量产生冲突,并且可以控制模块的作用域,而且在JQuery中内部本身也是通过这种方式来进行实现的,如下所示。
(function($) {
// 插件代码
})(jQuery);
我们可以将$符作为参数传递给函数,然后就确保代码内部使用的$都是只想JQuery的,即使在外部调用了其他的库,重写了$符也还是一样的效果。
封装通用操作
了解了匿名函数操作之后,接下来我们就来通过几个小例子来展示如何实现JQuery的封装。这里我们首先来演示一下封装一个Ajax请求。
封装AJAX请求
(function($) {
$.extend({
// 封装GET请求
getRequest: function(url, data, successCallback, errorCallback) {
$.ajax({
url: url,
type: 'GET',
data: data,
dataType: 'json',
success: function(response) {
if (typeof successCallback === 'function') {
successCallback(response);
}
},
error: function(xhr, status, error) {
if (typeof errorCallback === 'function') {
errorCallback(xhr, status, error);
}
}
});
},
// 封装POST请求
postRequest: function(url, data, successCallback, errorCallback) {
$.ajax({
url: url,
type: 'POST',
data: data,
dataType: 'json',
success: function(response) {
if (typeof successCallback === 'function') {
successCallback(response);
}
},
error: function(xhr, status, error) {
if (typeof errorCallback === 'function') {
errorCallback(xhr, status, error);
}
}
});
}
});
})(jQuery);
封装表单验证
当然除了对Ajax的封装之外,我们还可以创建对表单验证的封装,方便在其他项目中对表单验证操作的进行复用。
(function($) {
$.fn.validateForm = function() {
let isValid = true;
this.find('input, select, textarea').each(function() {
if ($(this).data('required') && !$(this).val()) {
isValid = false;
$(this).addClass('error'); // 添加错误样式
} else {
$(this).removeClass('error'); // 移除错误样式
}
});
return isValid;
};
})(jQuery);
使用方式
$('form').on('submit', function(e) {
e.preventDefault();
if ($(this).validateForm()) {
// 表单验证通过,继续处理
} else {
alert('请检查表单中的错误');
}
});
封装常用动画
这里我们演示一个滑动显示与隐藏动画的操作,如下所示。
(function($) {
$.fn.slideToggleElement = function(speed) {
return this.each(function() {
let $el = $(this);
if ($el.is(':visible')) {
$el.slideUp(speed);
} else {
$el.slideDown(speed);
}
});
};
})(jQuery);
使用方法
$('#myElement').slideToggleElement(300);
扩展或增强现有的jQuery功能
当然除了对我们特定功能的扩展封装之外,我们还可以对JQuery的现有功能进行增强。例如我们可以通过 $.extend() 来扩展全局的 jQuery 对象,或者通过 $.fn.extend() 来扩展实例对象。前者更适合全局操作,后者适合对选中的元素进行操作。
全局扩展
(function($) {
$.extend({
customGlobalFunction: function() {
// 全局的自定义方法
console.log('This is a custom global function');
}
});
})(jQuery);
实例方法扩展
(function($) {
$.fn.extend({
customElementMethod: function() {
return this.each(function() {
// 针对每个元素执行的操作
console.log($(this).text());
});
}
});
})(jQuery);
在项目中使用
封装完成之后,接下最重要的事情就是,在项目中进行使用。我们可以将上面的操作封装成一个独立的JS文件,然后再使用的时候可以随时进行调用。例如common-utils.js,然后在使用的时候可以通过如下的方式进行引用。
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<script src="path/to/your/common-utils.js"></script>
然后在其他项目中就可以直接调用你的通用方法
$.getRequest('/api/data', {}, function(response) {
console.log(response);
}, function(xhr, status, error) {
console.error(error);
});
总结
在实际的项目使用过程中,我们可以根据业务需求来不断的对封装操作进行扩展和优化,例如可以在封装操作中添加缓存、根据不同环境的处理、根据不同状态码进行统一的封装处理等操作。这样我们的代码不仅是项目可复用,而且还可以做到高度可维护可扩展。
相关推荐
- 好用的云函数!后端低代码接口开发,零基础编写API接口
-
前言在开发项目过程中,经常需要用到API接口,实现对数据库的CURD等操作。不管你是专业的PHP开发工程师,还是客户端开发工程师,或者是不懂编程但懂得数据库SQL查询,又或者是完全不太懂技术的人,通过...
- 快速上手:Windows 平台上 cURL 命令的使用方法
-
在工作流程中,为了快速验证API接口有效性,团队成员经常转向直接执行cURL命令的方法。这种做法不仅节省时间,而且促进了团队效率的提升。对于使用Windows系统的用户来说,这里有一套详细...
- 使用 Golang net/http 包:基础入门与实战
-
简介Go的net/http包是构建HTTP服务的核心库,功能强大且易于使用。它提供了基本的HTTP客户端和服务端支持,可以快速构建RESTAPI、Web应用等服务。本文将介绍ne...
- #小白接口# 使用云函数,人人都能编写和发布自己的API接口
-
你只需编写简单的云函数,就可以实现自己的业务逻辑,发布后就可以生成自己的接口给客户端调用。果创云支持对云函数进行在线接口编程,进入开放平台我的接口-在线接口编程,设计一个新接口,设计和配置好接口参...
- 极度精神分裂:我家没有墙面开关,但我虚拟出来了一系列开关
-
本内容来源于@什么值得买APP,观点仅代表作者本人|作者:iN在之前和大家说过,在iN的家里是没有墙面开关的。...
- window使用curl命令的注意事项 curl命令用法
-
cmd-使用curl命令的注意点前言最近在cmd中使用curl命令来测试restapi,发现有不少问题,这里记录一下。在cmd中使用curl命令的注意事项json不能由单引号包括起来json...
- Linux 系统curl命令使用详解 linuxctrl
-
curl是一个强大的命令行工具,用于在Linux系统中进行数据传输。它支持多种协议,包括HTTP、HTTPS、FTP等,用于下载或上传数据,执行Web请求等。curl命令的常见用法和解...
- Tornado 入门:初学者指南 tornados
-
Tornado是一个功能强大的PythonWeb框架和异步网络库。它最初是为了处理实时Web服务中的数千个同时连接而开发的。它独特的Web服务器和框架功能组合使其成为开发高性能Web...
- PHP Curl的简单使用 php curl formdata
-
本文写给刚入PHP坑不久的新手们,作为工具文档,方便用时查阅。CURL是一个非常强大的开源库,它支持很多种协议,例如,HTTP、HTTPS、FTP、TELENT等。日常开发中,我们经常会需要用到cur...
- Rust 服务器、服务和应用程序:7 Rust 中的服务器端 Web 应用简介
-
本章涵盖使用Actix提供静态网页...
- 我给 Apache 顶级项目提了个 Bug apache顶级项目有哪些
-
这篇文章记录了给Apache顶级项目-分库分表中间件ShardingSphere提交Bug的历程。说实话,这是一次比较曲折的Bug跟踪之旅。10月28日,我们在GitHub上提...
- linux文件下载、服务器交互(curl)
-
基础环境curl命令描述...
- curl简单使用 curl sh
-
1.curl--help#查看关键字2.curl-A“(添加user-agent<name>SendUser-Agent<name>toserver)”...
- 常用linux命令:curl 常用linux命令大全
-
//获取网页内容//不加任何选项使用curl时,默认会发送GET请求来获取内容到标准输出$curlhttp://www.baidu.com//输出<!DOCTYPEh...
- 三十七,Web渗透提高班之hack the box在线靶场注册及入门知识
-
一.注册hacktheboxHackTheBox是一个在线平台,允许测试您的渗透技能和代码,并与其他类似兴趣的成员交流想法和方法。它包含一些不断更新的挑战,并且模拟真实场景,其风格更倾向于CT...
- 一周热门
- 最近发表
-
- 好用的云函数!后端低代码接口开发,零基础编写API接口
- 快速上手:Windows 平台上 cURL 命令的使用方法
- 使用 Golang net/http 包:基础入门与实战
- #小白接口# 使用云函数,人人都能编写和发布自己的API接口
- 极度精神分裂:我家没有墙面开关,但我虚拟出来了一系列开关
- window使用curl命令的注意事项 curl命令用法
- Linux 系统curl命令使用详解 linuxctrl
- Tornado 入门:初学者指南 tornados
- PHP Curl的简单使用 php curl formdata
- Rust 服务器、服务和应用程序:7 Rust 中的服务器端 Web 应用简介
- 标签列表
-
- grid 设置 (58)
- 移位运算 (48)
- not specified (45)
- patch补丁 (31)
- strcat (25)
- 导航栏 (58)
- context xml (46)
- scroll (43)
- element style (30)
- dedecms模版 (53)
- vs打不开 (29)
- nmap (30)
- webgl开发 (24)
- parse (24)
- c 视频教程下载 (33)
- paddleocr (28)
- listview排序 (33)
- firebug 使用 (31)
- transactionmanager (30)
- characterencodingfilter (33)
- getmonth (34)
- commandtimeout (30)
- hibernate教程 (31)
- label换行 (33)
- curlpost (31)