如何在JavaScript函数外部安全有效地获取内部变量-js教程-PHP中文网

如何在javascript函数外部安全有效地获取内部变量

本文深入探讨了在JavaScript中从函数外部访问局部变量的两种主要方法：通过函数返回值和使用全局变量。我们将详细分析这两种策略的实现方式、适用场景及其优缺点，并结合实际代码示例，帮助开发者理解如何有效管理变量作用域，尤其是在处理动态生成的数据和更新UI元素时。

理解JavaScript函数作用域

在JavaScript中，函数内部声明的变量（使用let、const或var）默认具有局部作用域。这意味着这些变量只能在该函数内部访问，外部代码无法直接引用它们。这种机制有助于防止变量名冲突，提高代码模块化和可维护性。然而，在某些场景下，我们需要在函数执行后获取其内部产生的某个值，例如一个动态生成的ID，并将其用于更新外部的DOM元素。

本文将围绕一个常见的场景——在一个包含异步操作的函数中获取一个局部变量id，并将其用于更新一个外部的输入框——来演示两种解决方案。

方法一：通过函数返回值获取变量

最推荐和最符合函数式编程原则的方法是让函数返回它需要暴露给外部的值。当函数执行完毕后，它会将指定的值作为结果返回给调用者。

立即学习“Java免费学习笔记（深入）”；

实现原理

修改目标函数，使其在完成其主要逻辑后，将需要外部访问的局部变量作为其返回值。调用该函数时，将返回值赋给一个外部变量即可。

适用场景

此方法适用于变量在函数内部同步生成，并且外部代码需要立即获取并使用该值的场景。即使函数内部包含异步操作，只要所需变量在函数主体同步部分确定，此方法依然有效。

代码示例

考虑原始函数get_data_mapping_for_id，它在开始时同步获取id值。我们可以修改它以返回这个id。

/**
 * 根据路径元素获取其data-map-id属性值，并执行一系列UI及数据加载操作。
 * @param {HTMLElement|string} path - 触发事件的DOM元素或其选择器。
 * @returns {string|null} 返回获取到的data-map-id值，如果不存在则返回null。
 */
function get_data_mapping_for_id(path) {
    // 同步获取id值
    let id = $(path).attr('data-map-id');

    // 假设 Swal.fire, $.get, jsonToHTMLTable 等是已定义的外部函数或库调用
    // 这里的异步操作不会影响id的同步获取和返回
    Swal.fire({
        title: 'Loading data...',
        willOpen: function() {
            $('.site-plan').addClass("zoom-svg");
            $('path[data-map-id="' + id + '"]').addClass("highlight-path")
            Swal.showLoading();

            // 假设 endPoint 是一个已定义的API端点
            $.get(endPoint, {
                action: 'get_data_mapping_for_id',
                id: id // 使用局部id
            }, function(data) {
                Swal.hideLoading();
                let jsonResp = JSON.parse(data);
                const table = jsonToHTMLTable(jsonResp, $(path)); // 假设 jsonToHTMLTable 已定义
                Swal.update({
                    title: jsonResp.title,
                    html: table,
                    confirmButtonText: 'OK'
                });
            });
        },
        willClose: function() {
            $('.site-plan').removeClass("zoom-svg");
            $('path[data-map-id="' + id + '"]').removeClass("highlight-path");
        }
    });

    // 返回获取到的id值
    return id;
}

// 外部调用并使用返回的id
$(document).ready(function() {
    // 假设有一个元素可以触发这个函数，例如一个具有data-map-id属性的path元素
    // 这里我们模拟一个path元素作为参数
    const mockPathElement = $('path[data-map-id="some-initial-id"]'); // 替换为实际的选择器或DOM元素

    // 调用函数并捕获返回值
    const retrievedId = get_data_mapping_for_id(mockPathElement);

    // 在外部使用获取到的id设置输入框的值
    if (retrievedId) {
        $('#pIP').val(retrievedId); // 假设 #pIP 是目标输入框的ID
        console.log("通过函数返回值成功获取并设置输入框值:", retrievedId);
    } else {
        console.log("未能从函数中获取到id值。");
    }
});

登录后复制

优缺点

优点：
- 代码清晰： 函数的输入和输出一目了然，易于理解和维护。
- 无副作用： 不会修改全局状态，减少了潜在的命名冲突和调试难度。
- 可测试性强： 易于进行单元测试，因为函数的行为是可预测的，只依赖于输入并产生输出。
缺点：
- 如果函数内部需要等待异步操作完成后才能确定最终的返回值，那么简单的return语句将无法满足需求。在这种情况下，需要结合Promise或回调函数来处理异步结果。

方法二：使用全局变量

另一种方法是将局部变量的值赋给一个在全局作用域中声明的变量。这样，该变量在函数执行后即可在程序的任何地方访问。

实现原理

在所有函数之外（即全局作用域）声明一个变量。然后，在函数内部，将局部变量的值赋给这个全局变量。

钉钉 AI 助理

钉钉AI助理汇集了钉钉AI产品能力，帮助企业迈入智能新时代。

204

查看详情

适用场景

当需要在程序的多个不直接关联的部分访问同一个值，且对全局状态的修改有明确的控制和容忍度时，可以使用此方法。例如，配置信息、用户会话ID等。

代码示例

// 在全局作用域声明一个变量
let globalDynamicId = null;

/**
 * 根据路径元素获取其data-map-id属性值，并执行一系列UI及数据加载操作。
 * 同时将获取到的id值赋给全局变量。
 * @param {HTMLElement|string} path - 触发事件的DOM元素或其选择器。
 */
function get_data_mapping_for_id(path) {
    let id = $(path).attr('data-map-id');
    globalDynamicId = id; // 将局部id赋值给全局变量

    // 假设 Swal.fire, $.get, jsonToHTMLTable 等是已定义的外部函数或库调用
    Swal.fire({
        title: 'Loading data...',
        willOpen: function() {
            $('.site-plan').addClass("zoom-svg");
            $('path[data-map-id="' + id + '"]').addClass("highlight-path")
            Swal.showLoading();

            $.get(endPoint, {
                action: 'get_data_mapping_for_id',
                id: id
            }, function(data) {
                Swal.hideLoading();
                let jsonResp = JSON.parse(data);
                const table = jsonToHTMLTable(jsonResp, $(path));
                Swal.update({
                    title: jsonResp.title,
                    html: table,
                    confirmButtonText: 'OK'
                });
            });
        },
        willClose: function() {
            $('.site-plan').removeClass("zoom-svg");
            $('path[data-map-id="' + id + '"]').removeClass("highlight-path");
        }
    });
    // 函数执行完毕，globalDynamicId 已被赋值
}

// 外部调用函数后，即可访问全局变量
$(document).ready(function() {
    const mockPathElement = $('path[data-map-id="another-initial-id"]'); // 替换为实际的选择器或DOM元素
    get_data_mapping_for_id(mockPathElement);

    // 此时 globalDynamicId 应该包含了函数内部获取的id值
    if (globalDynamicId) {
        $('#pIP').val(globalDynamicId);
        console.log("通过全局变量成功设置输入框值:", globalDynamicId);
    } else {
        console.log("全局变量尚未被赋值，或函数未能成功获取id。");
    }
});

登录后复制

优缺点

优点：
- 访问方便： 一旦设置，全局变量可以在程序的任何地方直接访问，无需通过函数调用链传递。
缺点：
- 全局污染： 容易造成命名冲突，尤其是在大型项目或使用第三方库时。
- 难以维护： 全局变量的状态可以在任何地方被修改，使得代码行为难以预测，增加了调试难度。
- 可测试性差： 函数不再是纯粹的，其行为依赖于外部全局状态，增加了测试的复杂性。

注意事项与最佳实践

优先使用返回值： 在大多数情况下，通过函数返回值来传递数据是更优的选择，因为它遵循了数据封装的原则，减少了模块间的耦合。
谨慎使用全局变量： 除非有明确且充分的理由（例如，确实需要在多个不相关模块间共享数据，并且已经考虑了潜在的风险），否则应尽量避免使用全局变量。如果必须使用，可以考虑将其封装在命名空间对象中，以减少全局污染。

异步操作与数据获取时机：

在上述示例中，id是在get_data_mapping_for_id函数开始时同步获取的。因此，无论是返回id还是将其赋给全局变量，id的值都会在函数调用后立即可用。
如果需要获取的值是异步操作（如$.get）的结果，那么简单的返回值或全局赋值将无法立即获取到最终值。在这种情况下，函数应该返回一个Promise，或者接受一个回调函数作为参数，在异步操作完成后通过resolve或回调函数将数据传递出去。

例如，如果id是在$.get的回调中才确定的，那么函数可能需要这样设计：

function get_data_mapping_for_id_async(path) {
    return new Promise((resolve, reject) => {
        let id = $(path).attr('data-map-id'); // id仍是同步获取
        Swal.fire({
            // ... 异步逻辑 ...
            willOpen: function() {
                $.get(endPoint, { action: 'get_data_mapping_for_id', id }, function(data) {
                    // ... 处理数据 ...
                    resolve(id); // 在异步操作完成后，将id值解析出去
                }).fail(function() {
                    reject("Error loading data.");
                });
            }
        });
    });
}

// 使用方式
get_data_mapping_for_id_async(mockPathElement).then(retrievedId => {
    $('#pIP').val(retrievedId);
}).catch(error => {
    console.error(error);
});

登录后复制