百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

如何利用JQuery封装一个自定义通用JS操作方便在其他项目中使用?

yuyutoo 2024-11-14 19:53 6 浏览 0 评论

想要利用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);
});

总结

在实际的项目使用过程中,我们可以根据业务需求来不断的对封装操作进行扩展和优化,例如可以在封装操作中添加缓存、根据不同环境的处理、根据不同状态码进行统一的封装处理等操作。这样我们的代码不仅是项目可复用,而且还可以做到高度可维护可扩展。

相关推荐

墨尔本一华裔男子与亚裔男子分别失踪数日 警方寻人

中新网5月15日电据澳洲新快网报道,据澳大利亚维州警察局网站消息,22岁的华裔男子邓跃(Yue‘Peter’Deng,音译)失踪已6天,维州警方于当地时间13日发布寻人通告,寻求公众协助寻找邓跃。华...

网络交友须谨慎!美国犹他州一男子因涉嫌杀害女网友被捕

伊森·洪克斯克(图源网络,侵删)据美国广播公司(ABC)25日报道,美国犹他州一名男子于24日因涉嫌谋杀被捕。警方表示,这名男子主动告知警局,称其杀害了一名在网络交友软件上认识的25岁女子。雷顿警...

一课译词:来龙去脉(来龙去脉 的意思解释)

Mountainranges[Photo/SIPA]“来龙去脉”,汉语成语,本指山脉的走势和去向,现比喻一件事的前因后果(causeandeffectofanevent),可以翻译为“i...

高考重要考点:range(range高考用法)

range可以用作动词,也可以用作名词,含义特别多,在阅读理解中出现的频率很高,还经常作为完形填空的选项,而且在作文中使用是非常好的高级词汇。...

C++20 Ranges:现代范围操作(现代c++白皮书)

1.引言:C++20Ranges库简介C++20引入的Ranges库是C++标准库的重要更新,旨在提供更现代化、表达力更强的方式来处理数据序列(范围,range)。Ranges库基于...

学习VBA,报表做到飞 第二章 数组 2.4 Filter函数

第二章数组2.4Filter函数Filter函数功能与autofilter函数类似,它对一个一维数组进行筛选,返回一个从0开始的数组。...

VBA学习笔记:数组:数组相关函数—Split,Join

Split拆分字符串函数,语法Split(expression,字符,Limit,compare),第1参数为必写,后面3个参数都是可选项。Expression为需要拆分的数据,“字符”就是以哪个字...

VBA如何自定义序列,学会这些方法,让你工作更轻松

No.1在Excel中,自定义序列是一种快速填表机制,如何有效地利用这个方法,可以大大增加工作效率。通常在操作工作表的时候,可能会输入一些很有序的序列,如果一一录入就显得十分笨拙。Excel给出了一种...

Excel VBA入门教程1.3 数组基础(vba数组详解)

1.3数组使用数组和对象时,也要声明,这里说下数组的声明:'确定范围的数组,可以存储b-a+1个数,a、b为整数Dim数组名称(aTob)As数据类型Dimarr...

远程网络调试工具百宝箱-MobaXterm

MobaXterm是一个功能强大的远程网络工具百宝箱,它将所有重要的远程网络工具(SSH、Telnet、X11、RDP、VNC、FTP、MOSH、Serial等)和Unix命令(bash、ls、cat...

AREX:携程新一代自动化回归测试工具的设计与实现

一、背景随着携程机票BU业务规模的不断提高,业务系统日趋复杂,各种问题和挑战也随之而来。对于研发测试团队,面临着各种效能困境,包括业务复杂度高、数据构造工作量大、回归测试全量回归、沟通成本高、测试用例...

Windows、Android、IOS、Web自动化工具选择策略

Windows平台中应用UI自动化测试解决方案AutoIT是开源工具,该工具识别windows的标准控件效果不错,但是当它遇到应用中非标准控件定义的UI元素时往往就无能为力了,这个时候选择silkte...

python自动化工具:pywinauto(python快速上手 自动化)

简介Pywinauto是完全由Python构建的一个模块,可以用于自动化Windows上的GUI应用程序。同时,它支持鼠标、键盘操作,在元素控件树较复杂的界面,可以辅助我们完成自动化操作。我在...

时下最火的 Airtest 如何测试手机 APP?

引言Airtest是网易出品的一款基于图像识别的自动化测试工具,主要应用在手机APP和游戏的测试。一旦使用了这个工具进行APP的自动化,你就会发现自动化测试原来是如此简单!!连接手机要进行...

【推荐】7个最强Appium替代工具,移动App自动化测试必备!

在移动应用开发日益火爆的今天,自动化测试成为了确保应用质量和用户体验的关键环节。Appium作为一款广泛应用的移动应用自动化测试工具,为测试人员所熟知。然而,在不同的测试场景和需求下,还有许多其他优...

取消回复欢迎 发表评论: