Tải Thư viện Javascript “Vanilla” vào Node.js

Có một số thư viện Javascript của bên thứ ba có một số chức năng mà tôi muốn sử dụng trong máy chủ Node.js. (Cụ thể là tôi muốn sử dụng thư viện javascript QuadTree mà tôi đã tìm thấy.) Nhưng những thư viện này chỉ là .jscác tệp đơn giản và không phải "thư viện Node.js".

Do đó, các thư viện này không tuân theo exports.var_namecú pháp mà Node.js mong đợi cho các mô-đun của nó. Theo như tôi hiểu, điều đó có nghĩa là khi bạn làm module = require('module_name');hoặc module = require('./path/to/file.js');bạn sẽ kết thúc với một mô-đun không có chức năng truy cập công khai, v.v.

Câu hỏi của tôi sau đó là "Làm cách nào để tải một tệp javascript tùy ý vào Node.js để tôi có thể sử dụng chức năng của nó mà không cần phải viết lại để nó hoạt động exports?"

Tôi là người mới sử dụng Node.js, vì vậy hãy cho tôi biết nếu có một số lỗ hổng trong hiểu biết của tôi về cách nó hoạt động.

CHỈNH SỬA : Nghiên cứu kỹ hơn về mọi thứ và bây giờ tôi thấy rằng mẫu tải mô-đun mà Node.js sử dụng thực sự là một phần của tiêu chuẩn được phát triển gần đây để tải các thư viện Javascript được gọi là CommonJS . Nó nói điều này ngay trên trang tài liệu mô-đun cho Node.js , nhưng tôi đã bỏ lỡ điều đó cho đến bây giờ.

Có thể cuối cùng câu trả lời cho câu hỏi của tôi là "hãy đợi cho đến khi các tác giả trong thư viện của bạn bắt đầu viết giao diện CommonJS hoặc tự làm điều đó."

Có một phương pháp tốt hơn nhiều so với việc sử dụng eval: vmmô-đun.

Ví dụ: đây là execfilemô-đun của tôi , mô-đun này đánh giá tập lệnh tại pathmột trong hai contexthoặc trong ngữ cảnh chung:

var vm = require("vm");
var fs = require("fs");
module.exports = function(path, context) {
  context = context || {};
  var data = fs.readFileSync(path);
  vm.runInNewContext(data, context, path);
  return context;
}

Và nó có thể được sử dụng như thế này:

> var execfile = require("execfile");
> // `someGlobal` will be a global variable while the script runs
> var context = execfile("example.js", { someGlobal: 42 });
> // And `getSomeGlobal` defined in the script is available on `context`:
> context.getSomeGlobal()
42
> context.someGlobal = 16
> context.getSomeGlobal()
16

Nơi example.jschứa:

function getSomeGlobal() {
    return someGlobal;
}

Ưu điểm lớn của phương pháp này là bạn có toàn quyền kiểm soát các biến toàn cục trong tập lệnh được thực thi: bạn có thể chuyển vào các toàn cầu tùy chỉnh (qua context) và tất cả các toàn cầu được tạo bởi tập lệnh sẽ được thêm vào context. Gỡ lỗi cũng dễ dàng hơn vì các lỗi cú pháp và những thứ tương tự sẽ được thông báo với tên tệp chính xác.

Đây là những gì tôi nghĩ là câu trả lời 'đúng nhất' cho tình huống này.

Giả sử bạn có một tệp kịch bản được gọi là quadtree.js.

Bạn nên xây dựng một tùy chỉnh node_modulecó cấu trúc thư mục kiểu này ...

./node_modules/quadtree/quadtree-lib/
./node_modules/quadtree/quadtree-lib/quadtree.js
./node_modules/quadtree/quadtree-lib/README
./node_modules/quadtree/quadtree-lib/some-other-crap.js
./node_modules/quadtree/index.js

Mọi thứ trong ./node_modules/quadtree/quadtree-lib/thư mục của bạn là các tệp từ thư viện bên thứ 3 của bạn.

Sau đó, ./node_modules/quadtree/index.jstệp của bạn sẽ chỉ tải thư viện đó từ hệ thống tệp và thực hiện công việc xuất mọi thứ đúng cách.

var fs = require('fs');

// Read and eval library
filedata = fs.readFileSync('./node_modules/quadtree/quadtree-lib/quadtree.js','utf8');
eval(filedata);

/* The quadtree.js file defines a class 'QuadTree' which is all we want to export */

exports.QuadTree = QuadTree

Bây giờ bạn có thể sử dụng quadtreemô-đun của mình giống như bất kỳ mô-đun nút nào khác ...

var qt = require('quadtree');
qt.QuadTree();

Tôi thích phương pháp này vì không cần phải thay đổi bất kỳ mã nguồn nào của thư viện bên thứ 3 của bạn - vì vậy nó dễ bảo trì hơn. Tất cả những gì bạn cần làm khi nâng cấp là xem mã nguồn của chúng và đảm bảo rằng bạn vẫn đang xuất các đối tượng thích hợp.

Cách đơn giản nhất là: eval(require('fs').readFileSync('./path/to/file.js', 'utf8')); Điều này hoạt động tốt để thử nghiệm trong trình bao tương tác.

AFAIK, đó thực sự là cách các mô-đun phải được tải. Tuy nhiên, thay vì xếp tất cả các hàm đã xuất vào exportsđối tượng, bạn cũng có thể gắn chúng vào this(nếu không sẽ là đối tượng toàn cục).

Vì vậy, nếu bạn muốn giữ cho các thư viện khác tương thích, bạn có thể làm như sau:

this.quadTree = function () {
  // the function's code
};

hoặc, khi thư viện bên ngoài đã có không gian tên riêng, ví dụ: jQuery(không phải bạn có thể sử dụng không gian đó trong môi trường phía máy chủ):

this.jQuery = jQuery;

Trong môi trường không phải Node, thissẽ phân giải thành đối tượng toàn cục, do đó biến nó thành một biến toàn cục ... mà nó đã có. Vì vậy, nó không nên phá vỡ bất cứ điều gì.

Chỉnh sửa : James Herdman có một bài viết hay về node.js cho người mới bắt đầu, cũng đề cập đến vấn đề này.

Tôi không chắc liệu mình có thực sự sử dụng nó hay không vì nó là một giải pháp khá hack, nhưng có một cách để giải quyết vấn đề này là xây dựng một trình nhập mô-đun nhỏ như thế này ...

Trong tệp ./node_modules/vanilla.js:

var fs = require('fs');

exports.require = function(path,names_to_export) {
    filedata = fs.readFileSync(path,'utf8');
    eval(filedata);
    exported_obj = {};
    for (i in names_to_export) {
        to_eval = 'exported_obj[names_to_export[i]] = ' 
            + names_to_export[i] + ';'
        eval(to_eval); 
    }
    return exported_obj;
}

Sau đó, khi bạn muốn sử dụng chức năng của thư viện, bạn sẽ cần chọn thủ công những tên cần xuất.

Vì vậy, đối với một thư viện như tệp ./lib/mylibrary.js...

function Foo() { //Do something... }
biz = "Blah blah";
var bar = {'baz':'filler'};

Khi bạn muốn sử dụng chức năng của nó trong mã Node.js của mình ...

var vanilla = require('vanilla');
var mylibrary = vanilla.require('./lib/mylibrary.js',['biz','Foo'])
mylibrary.Foo // <-- this is Foo()
mylibrary.biz // <-- this is "Blah blah"
mylibrary.bar // <-- this is undefined (because we didn't export it)

Tuy nhiên, không biết tất cả điều này sẽ hoạt động tốt như thế nào trong thực tế.

Tôi đã có thể làm cho nó hoạt động bằng cách cập nhật tập lệnh của họ, rất dễ dàng, chỉ cần thêm vào module.exports =nơi thích hợp ...

Ví dụ: tôi lấy tệp của họ và tôi sao chép vào './libs/apprise.js'. Sau đó, nơi nó bắt đầu với

function apprise(string, args, callback){

Tôi đã gán chức năng cho module.exports =như vậy:

module.exports = function(string, args, callback){

Vì vậy, tôi có thể nhập thư viện vào mã của mình như sau:

window.apprise = require('./libs/apprise.js');

Và tôi đã rất tốt để đi. YMMV, đây là với webpack .

Một include(filename)chức năng đơn giản với thông báo lỗi tốt hơn (ngăn xếp, tên tệp, v.v.) eval, trong trường hợp có lỗi:

var fs = require('fs');
// circumvent nodejs/v8 "bug":
// https://github.com/PythonJS/PythonJS/issues/111
// http://perfectionkills.com/global-eval-what-are-the-options/
// e.g. a "function test() {}" will be undefined, but "test = function() {}" will exist
var globalEval = (function() {
    var isIndirectEvalGlobal = (function(original, Object) {
        try {
            // Does `Object` resolve to a local variable, or to a global, built-in `Object`,
            // reference to which we passed as a first argument?
            return (1, eval)('Object') === original;
        } catch (err) {
            // if indirect eval errors out (as allowed per ES3), then just bail out with `false`
            return false;
        }
    })(Object, 123);
    if (isIndirectEvalGlobal) {
        // if indirect eval executes code globally, use it
        return function(expression) {
            return (1, eval)(expression);
        };
    } else if (typeof window.execScript !== 'undefined') {
        // if `window.execScript exists`, use it
        return function(expression) {
            return window.execScript(expression);
        };
    }
    // otherwise, globalEval is `undefined` since nothing is returned
})();

function include(filename) {
    file_contents = fs.readFileSync(filename, "utf8");
    try {
        //console.log(file_contents);
        globalEval(file_contents);
    } catch (e) {
        e.fileName = filename;
        keys = ["columnNumber", "fileName", "lineNumber", "message", "name", "stack"]
        for (key in keys) {
            k = keys[key];
            console.log(k, " = ", e[k])
        }
        fo = e;
        //throw new Error("include failed");
    }
}

Nhưng nó thậm chí còn bẩn hơn với nodejs: bạn cần xác định điều này:

export NODE_MODULE_CONTEXTS=1
nodejs tmp.js

Nếu không, bạn không thể sử dụng các biến toàn cục trong các tệp được bao gồm include(...).