如何在另一个 JavaScript 文件中包含一个 JavaScript 文件?

javascript file import include

JavaScript 中是否有类似于 CSS 中的 @import 的东西,允许您在另一个 JavaScript 文件中包含一个 JavaScript 文件?

MDN docs about JavaScript modules,与 corresponding examples on github

我在这里的回答 stackoverflow.com/a/72335692/9868445 已被匿名否决,并且没有任何评论解释原因,但我仍然绝对建议您看一下。

T
T.J. Crowder

旧版本的 JavaScript 没有导入、包含或要求,因此已经开发了许多不同的方法来解决这个问题。

但自 2015 (ES6) 以来,JavaScript 已经有了 ES6 modules 标准来在 Node.js 中导入模块,most modern browsers 也支持该标准。

为了与旧版浏览器兼容,可以使用 WebpackRollup 等构建工具和/或 Babel 等转译工具。

ES6 模块

ECMAScript (ES6) 模块从 v8.5 开始是 supported in Node.js,带有 --experimental-modules 标志,至少从 Node.js v13.8.0 开始没有标志。要启用“ESM”(相对于 Node.js 以前的 CommonJS 样式模块系统 [“CJS”]),您可以在 package.json 中使用 "type": "module" 或为文件提供扩展名 .mjs。 (类似地,如果您的默认值为 ESM,则使用 Node.js 以前的 CJS 模块编写的模块可以命名为 .cjs。)

使用 package.json

{
    "type": "module"
}

然后module.js

export function hello() {
  return "Hello";
}

然后main.js

import { hello } from './module.js';
let val = hello();  // val is "Hello";

使用 .mjs,您将拥有 module.mjs

export function hello() {
  return "Hello";
}

然后main.mjs

import { hello } from './module.mjs';
let val = hello();  // val is "Hello";

浏览器中的 ECMAScript 模块

浏览器已经支持直接加载 ECMAScript 模块(不需要像 Webpack 这样的工具)since Safari 10.1、Chrome 61、Firefox 60 和 Edge 16。在 caniuse 查看当前支持。无需使用 Node.js 的 .mjs 扩展;浏览器完全忽略模块/脚本上的文件扩展名。

<script type="module">
  import { hello } from './hello.mjs'; // Or the extension could be just `.js`
  hello('world');
</script>
// hello.mjs -- or the extension could be just `.js`
export function hello(text) {
  const div = document.createElement('div');
  div.textContent = `Hello ${text}`;
  document.body.appendChild(div);
}

https://jakearchibald.com/2017/es-modules-in-browsers/ 阅读更多信息

浏览器中的动态导入

动态导入让脚本根据需要加载其他脚本:

<script type="module">
  import('hello.mjs').then(module => {
      module.hello('world');
    });
</script>

https://developers.google.com/web/updates/2017/11/dynamic-import 阅读更多信息

Node.js 需要

在 Node.js 中仍然广泛使用的旧 CJS 模块样式是 module.exports/require 系统。

// mymodule.js
module.exports = {
   hello: function() {
      return "Hello";
   }
}
// server.js
const myModule = require('./mymodule');
let val = myModule.hello(); // val is "Hello"   

JavaScript 还有其他方法可以在不需要预处理的浏览器中包含外部 JavaScript 内容。

AJAX 加载

您可以通过 AJAX 调用加载附加脚本,然后使用 eval 运行它。这是最直接的方法,但由于 JavaScript 沙盒安全模型,它仅限于您的域。使用 eval 还为错误、黑客和安全问题打开了大门。

获取加载

与动态导入一样,您可以通过 fetch 调用加载一个或多个脚本,使用 Promise 来控制使用 Fetch Inject 库的脚本依赖项的执行顺序:

fetchInject([
  'https://cdn.jsdelivr.net/momentjs/2.17.1/moment.min.js'
]).then(() => {
  console.log(`Finish in less than ${moment().endOf('year').fromNow(true)}`)
})

jQuery 加载

jQuery 库提供加载功能 in one line

$.getScript("my_lovely_script.js", function() {
   alert("Script loaded but not necessarily executed.");
});

动态脚本加载

您可以将带有脚本 URL 的脚本标记添加到 HTML 中。为了避免 jQuery 的开销,这是一个理想的解决方案。

该脚本甚至可以驻留在不同的服务器上。此外,浏览器评估代码。 <script> 标记可以插入到网页 <head> 中,也可以插入到结束 </body> 标记之前。

这是一个如何工作的示例:

function dynamicallyLoadScript(url) {
    var script = document.createElement("script");  // create a script DOM node
    script.src = url;  // set its src to the provided URL
   
    document.head.appendChild(script);  // add it to the end of the head section of the page (could change 'head' to 'body' to add it to the end of the body section instead)
}

此函数将在页面头部部分的末尾添加一个新的 <script> 标记,其中 src 属性设置为作为第一个参数提供给函数的 URL。

JavaScript Madness: Dynamic Script Loading 中讨论并说明了这两种解决方案。

检测脚本何时执行

现在,有一个大问题你必须知道。这样做意味着您远程加载代码。现代网络浏览器将加载文件并继续执行您当前的脚本,因为它们异步加载所有内容以提高性能。 (这适用于jQuery方法和手动动态脚本加载方法。)

这意味着如果您直接使用这些技巧,您将无法在要求加载后的下一行使用新加载的代码,因为它仍在加载中。

例如:my_lovely_script.js 包含 MySuperObject

var js = document.createElement("script");

js.type = "text/javascript";
js.src = jsFilePath;

document.body.appendChild(js);

var s = new MySuperObject();

Error : MySuperObject is undefined

然后按 F5 重新加载页面。它有效!令人困惑...

那么该怎么办呢?

好吧,您可以使用作者在我给您的链接中建议的技巧。综上所述,对于赶时间的人,他在脚本加载时使用事件来运行回调函数。因此,您可以将使用远程库的所有代码放在回调函数中。例如:

function loadScript(url, callback)
{
    // Adding the script tag to the head as suggested before
    var head = document.head;
    var script = document.createElement('script');
    script.type = 'text/javascript';
    script.src = url;

    // Then bind the event to the callback function.
    // There are several events for cross browser compatibility.
    script.onreadystatechange = callback;
    script.onload = callback;

    // Fire the loading
    head.appendChild(script);
}

然后在 lambda function 中加载脚本后编写要使用的代码:

var myPrettyCode = function() {
   // Here, do whatever you want
};

然后你运行所有这些:

loadScript("my_lovely_script.js", myPrettyCode);

请注意,脚本可能在 DOM 加载之后或之前执行,具体取决于浏览器以及您是否包含行 script.async = false;great article on Javascript loading in general 对此进行了讨论。

源代码合并/预处理

如本答案顶部所述,许多开发人员在他们的项目中使用 Parcel、Webpack 或 Babel 等构建/转换工具,允许他们使用即将推出的 JavaScript 语法,为旧浏览器提供向后兼容性,合并文件,缩小,执行代码拆分等

我已经通过单击菜单动态加载 div 而没有使用 URL 哈希加载页面。我的问题是当我单击同一页面 2/3 次 js 加载 2/3 次时。这就是为什么每个事件都会多次发生。我想在附加该代码之前检查已经加载到页脚/头部的 js 文件: var js = document.createElement("script"); js.type = "文本/javascript"; js.src = js文件路径; document.body.appendChild(js);

您还可以使用 Gulp (gulpjs.com) 之类的东西对它们进行预处理,并将输出作为一个被调用的文件。例如:a) 将几个 JavaScript 文件连接成一个,b) 使用 Babel 使其向后兼容,c) 缩小/丑化以删除注释、空格等。然后,您不仅组织了这些文件,还优化了它们以及通过启动可能对其他文件格式(例如 css 和图像)执行相同操作的管道。

P
Peter Mortensen

如果有人在寻找更高级的东西,请尝试 RequireJS。您将获得额外的好处,例如依赖关系管理、更好的并发性和避免重复(即多次检索脚本)。

您可以在“模块”中编写 JavaScript 文件,然后在其他脚本中将它们作为依赖项引用。或者,您可以将 RequireJS 用作简单的“获取此脚本”解决方案。

例子:

将依赖项定义为模块:

一些依赖.js

define(['lib/dependency1', 'lib/dependency2'], function (d1, d2) {

     //Your actual script goes here.   
     //The dependent scripts will be fetched if necessary.

     return libraryObject;  //For example, jQuery object
});

implementation.js 是你的“主要”JavaScript 文件,它依赖于 some-dependency.js

require(['some-dependency'], function(dependency) {

    //Your script goes here
    //some-dependency.js is fetched.   
    //Then your script is executed
});

GitHub 自述文件的摘录:

RequireJS 加载纯 JavaScript 文件以及更多定义的模块。它针对浏览器内的使用进行了优化,包括在 Web Worker 中,但它也可以在其他 JavaScript 环境中使用,例如 Rhino 和 Node。它实现了异步模块 API。 RequireJS 使用纯脚本标签来加载模块/文件,因此它应该允许轻松调试。它可以简单地用于加载现有的 JavaScript 文件,因此您可以将其添加到现有项目中,而无需重新编写 JavaScript 文件。 ...

F
Flimm

实际上有一种方法可以非异步加载 JavaScript 文件,因此您可以在加载后立即使用新加载的文件中包含的函数,我认为它适用于所有浏览器。

您需要在页面的 <head> 元素上使用 jQuery.append(),即:

$("head").append($("<script></script>").attr("src", url));

/* Note that following line of code is incorrect because it doesn't escape the
 * HTML attribute src correctly and will fail if `url` contains special characters:
 * $("head").append('<script src="' + url + '"></script>');
 */

但是,这种方法也有一个问题:如果导入的 JavaScript 文件发生错误,Firebug(还有 Firefox 错误控制台和 Chrome Developer Tools)会错误地报告它的位置,如果使用 Firebug,这是一个大问题跟踪 JavaScript 错误很多(我愿意)。 Firebug 出于某种原因根本不知道新加载的文件,因此如果该文件中发生错误,它会报告它发生在您的主 HTML 文件中,您将很难找出错误的真正原因.

但是,如果这对您来说不是问题,那么这种方法应该有效。

我实际上编写了一个名为 $.import_js() 的 jQuery 插件,它使用这种方法:

(function($)
{
    /*
     * $.import_js() helper (for JavaScript importing within JavaScript code).
     */
    var import_js_imported = [];
    
    $.extend(true,
    {
        import_js : function(script)
        {
            var found = false;
            for (var i = 0; i < import_js_imported.length; i++)
                if (import_js_imported[i] == script) {
                    found = true;
                    break;
                }
            
            if (found == false) {
                $("head").append($('<script></script').attr('src', script));
                import_js_imported.push(script);
            }
        }
    });
    
})(jQuery);

因此,导入 JavaScript 所需要做的就是:

$.import_js('/path_to_project/scripts/somefunctions.js');

我还在 Example 对此做了一个简单的测试。

它在主 HTML 中包含一个 main.js 文件,然后 main.js 中的脚本使用 $.import_js() 导入一个名为 included.js 的附加文件,该文件定义了此函数:

function hello()
{
    alert("Hello world!");
}

在包含 included.js 之后,立即调用 hello() 函数,您会收到警报。

(此答案是对 e-satis 评论的回应)。

P
Peter Mortensen

另一种在我看来更简洁的方法是发出同步 Ajax 请求,而不是使用 <script> 标记。这也是 Node.js 处理包括的方式。

这是一个使用 jQuery 的示例:

function require(script) {
    $.ajax({
        url: script,
        dataType: "script",
        async: false,           // <-- This is the key
        success: function () {
            // all good...
        },
        error: function () {
            throw new Error("Could not load script " + script);
        }
    });
}

然后,您可以在代码中使用它,就像您通常使用包含一样:

require("/scripts/subscript.js");

并且能够从下一行所需的脚本中调用一个函数:

subscript.doSomethingCool(); 
P
Peter Mortensen

可以动态生成 JavaScript 标记并将其从其他 JavaScript 代码中附加到 HTML 文档中。这将加载目标 JavaScript 文件。

function includeJs(jsFilePath) {
    var js = document.createElement("script");

    js.type = "text/javascript";
    js.src = jsFilePath;

    document.body.appendChild(js);
}

includeJs("/path/to/some/file.js");
P
Peter Mortensen

有一个好消息要告诉你。很快您将能够轻松加载 JavaScript 代码。它将成为导入 JavaScript 代码模块的标准方式,并将成为核心 JavaScript 本身的一部分。

您只需编写 import cond from 'cond.js'; 即可从文件 cond.js 加载名为 cond 的宏。

因此,您不必依赖任何 JavaScript 框架,也不必显式地进行 Ajax 调用。

参考:

静态模块分辨率

模块加载器

七年后,这个答案不起作用:“SyntaxError:导入声明可能只出现在模块的顶层”。

分享您的代码您正在尝试做的事情。

好的,这是运行良好的代码: function Include(jsFilePath) { var js = d.createElement("script"); js.type = "文本/javascript"; js.src = js文件路径; d.body.appendChild(js); } // 包括

P
Peter Mortensen

语句 import 在 ECMAScript 6 中。

句法

import name from "module-name";
import { member } from "module-name";
import { member as alias } from "module-name";
import { member1 , member2 } from "module-name";
import { member1 , member2 as alias2 , [...] } from "module-name";
import name , { member [ , [...] ] } from "module-name";
import "module-name" as name;
A
Ajeet Lakhani

也许你可以使用我在这个页面上找到的这个函数How do I include a JavaScript file in a JavaScript file?

function include(filename)
{
    var head = document.getElementsByTagName('head')[0];

    var script = document.createElement('script');
    script.src = filename;
    script.type = 'text/javascript';

    head.appendChild(script)
}
F
Flimm

这是一个没有 jQuery 的同步版本:

function myRequire( url ) {
    var ajax = new XMLHttpRequest();
    ajax.open( 'GET', url, false ); // <-- the 'false' makes it synchronous
    ajax.onreadystatechange = function () {
        var script = ajax.response || ajax.responseText;
        if (ajax.readyState === 4) {
            switch( ajax.status) {
                case 200:
                    eval.apply( window, [script] );
                    console.log("script loaded: ", url);
                    break;
                default:
                    console.log("ERROR: script not loaded: ", url);
            }
        }
    };
    ajax.send(null);
}

请注意,要获得此工作跨域,服务器将需要在其响应中设置 allow-origin 标头。

T
Talha Awan

我刚刚编写了这段 JavaScript 代码(使用 Prototype 进行 DOM 操作):

var require = (function() {
    var _required = {};
    return (function(url, callback) {
        if (typeof url == 'object') {
            // We've (hopefully) got an array: time to chain!
            if (url.length > 1) {
                // Load the nth file as soon as everything up to the
                // n-1th one is done.
                require(url.slice(0, url.length - 1), function() {
                    require(url[url.length - 1], callback);
                });
            } else if (url.length == 1) {
                require(url[0], callback);
            }
            return;
        }
        if (typeof _required[url] == 'undefined') {
            // Haven't loaded this URL yet; gogogo!
            _required[url] = [];

            var script = new Element('script', {
                src: url,
                type: 'text/javascript'
            });
            script.observe('load', function() {
                console.log("script " + url + " loaded.");
                _required[url].each(function(cb) {
                    cb.call(); // TODO: does this execute in the right context?
                });
                _required[url] = true;
            });

            $$('head')[0].insert(script);
        } else if (typeof _required[url] == 'boolean') {
            // We already loaded the thing, so go ahead.
            if (callback) {
                callback.call();
            }
            return;
        }

        if (callback) {
            _required[url].push(callback);
        }
    });
})();

用法:

<script src="prototype.js"></script>
<script src="require.js"></script>
<script>
    require(['foo.js','bar.js'], function () {
        /* Use foo.js and bar.js here */
    });
</script>

要点:http://gist.github.com/284442

D
Dan Dascalescu

以下是 Facebook 如何为其无处不在的“点赞”按钮所做的通用版本:

但:

即使所有插件都以应有的方式放入 head 标签中,但当您单击页面或刷新时,它们并不总是由浏览器运行。

我发现只在 PHP 包含中编写脚本标签更可靠。您只需编写一次,这与使用 JavaScript 调用插件一样多。

请注意,如果 pluginNames 包含特殊字符,这将不起作用,甚至可能导致安全漏洞。您需要在此处使用正确的转义:$('head').append('<script src="js/plugins/' + this + '.js"></script>');

P
Peter Mortensen

有几种方法可以在 JavaScript 中实现模块。以下是两个最受欢迎的:

ES6 模块

浏览器还不支持这种模块化系统,所以为了使用这种语法,您必须使用像 Webpack 这样的捆绑程序。无论如何,使用捆绑器会更好,因为这可以将所有不同的文件组合成一个(或几个相关的)文件。这将更快地从服务器向客户端提供文件,因为每个 HTTP 请求都伴随着一些相关的开销。因此,通过减少整体 HTTP 请求,我们提高了性能。下面是一个 ES6 模块的例子:

// main.js file

export function add (a, b) {
  return a + b;
}

export default function multiply (a, b) {
  return a * b;
}


// test.js file

import {add}, multiply from './main';   // For named exports between curly braces {export1, export2}
                                        // For default exports without {}

console.log(multiply(2, 2));  // logs 4

console.log(add(1, 2));  // logs 3

CommonJS(在 Node.js 中使用)

这个模块化系统用于 Node.js。您基本上将您的导出添加到一个名为 module.exports 的对象中。然后您可以通过 require('modulePath') 访问该对象。这里重要的是要意识到这些模块正在被缓存,因此如果您 require() 某个模块两次,它将返回已经创建的模块。

// main.js file

function add (a, b) {
  return a + b;
}

module.exports = add;  // Here we add our 'add' function to the exports object


// test.js file

const add = require('./main');

console.log(add(1,2));  // logs 3