Muat Pustaka Javascript "Vanilla" ke Node.js

Ada beberapa pustaka Javascript pihak ketiga yang memiliki beberapa fungsi yang ingin saya gunakan di server Node.js. (Secara khusus saya ingin menggunakan pustaka javascript QuadTree yang saya temukan.) Tetapi pustaka ini hanyalah .jsfile langsung dan bukan "pustaka Node.js".

Dengan demikian, pustaka ini tidak mengikuti exports.var_namesintaks yang diharapkan Node.js untuk modulnya. Sejauh yang saya mengerti itu berarti ketika Anda melakukannya module = require('module_name');atau module = require('./path/to/file.js');Anda akan berakhir dengan modul tanpa fungsi yang dapat diakses publik, dll.

Pertanyaan saya kemudian adalah "Bagaimana cara memuat file javascript arbitrer ke Node.js sehingga saya dapat memanfaatkan fungsinya tanpa harus menulis ulang sehingga berfungsi exports?"

Saya sangat baru di Node.js jadi tolong beri tahu saya jika ada beberapa lubang mencolok dalam pemahaman saya tentang cara kerjanya.

EDIT : Meneliti lebih banyak dan sekarang saya melihat bahwa pola pemuatan modul yang digunakan Node.js sebenarnya adalah bagian dari standar yang dikembangkan baru-baru ini untuk memuat pustaka Javascript yang disebut CommonJS . Ia mengatakan ini tepat di halaman dokumen modul untuk Node.js , tapi saya melewatkannya sampai sekarang.

Mungkin akhirnya jawaban atas pertanyaan saya adalah "tunggu sampai penulis perpustakaan Anda sempat menulis antarmuka CommonJS atau lakukan sendiri."

Ada metode yang jauh lebih baik daripada menggunakan eval: vmmodul.

Misalnya, berikut adalah execfilemodul saya , yang mengevaluasi skrip pathdi salah satu contextatau konteks global:

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;
}

Dan itu bisa digunakan seperti ini:

> 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

Dimana example.jsmengandung:

function getSomeGlobal() {
    return someGlobal;
}

Keuntungan besar dari metode ini adalah Anda memiliki kendali penuh atas variabel global dalam skrip yang dieksekusi: Anda dapat mengirimkan global kustom (melalui context), dan semua global yang dibuat oleh skrip akan ditambahkan context. Debugging juga lebih mudah karena kesalahan sintaks dan sejenisnya akan dilaporkan dengan nama file yang benar.

Inilah yang menurut saya adalah jawaban yang 'paling benar' untuk situasi ini.

Katakanlah Anda memiliki file skrip bernama quadtree.js.

Anda harus membuat kustom node_moduleyang memiliki struktur direktori semacam ini ...

./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

Semua yang ada di ./node_modules/quadtree/quadtree-lib/direktori Anda adalah file dari perpustakaan pihak ketiga Anda.

Kemudian ./node_modules/quadtree/index.jsfile Anda hanya akan memuat pustaka itu dari sistem file dan melakukan pekerjaan mengekspor dengan benar.

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

Sekarang Anda dapat menggunakan quadtreemodul Anda seperti modul node lainnya ...

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

Saya suka metode ini karena tidak perlu mengubah kode sumber apa pun dari perpustakaan pihak ketiga Anda - jadi lebih mudah untuk memeliharanya. Yang perlu Anda lakukan saat pemutakhiran adalah melihat kode sumbernya dan memastikan bahwa Anda masih mengekspor objek yang tepat.

Cara paling sederhana adalah: eval(require('fs').readFileSync('./path/to/file.js', 'utf8')); Ini berfungsi dengan baik untuk pengujian di shell interaktif.

AFAIK, begitulah modul harus dimuat. Namun, alih-alih menggunakan semua fungsi yang diekspor ke exportsobjek, Anda juga dapat memakainya ke this(apa yang akan menjadi objek global).

Jadi, jika Anda ingin menjaga pustaka lain tetap kompatibel, Anda dapat melakukan ini:

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

atau, ketika perpustakaan eksternal sudah memiliki namespace sendiri, misalnya jQuery(bukan bahwa Anda dapat menggunakan yang dalam lingkungan server-side):

this.jQuery = jQuery;

Dalam lingkungan non-Node, thisakan menyelesaikan objek global, sehingga menjadikannya variabel global ... yang sudah ada. Jadi seharusnya tidak merusak apapun.

Sunting : James Herdman memiliki artikel bagus tentang node.js untuk pemula, yang juga menyebutkan ini.

Saya tidak yakin apakah saya akan benar-benar menggunakan ini karena ini adalah solusi yang agak hacky, tetapi salah satu cara mengatasinya adalah dengan membangun importir modul mini kecil seperti ini ...

Di dalam file ./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;
}

Kemudian ketika Anda ingin menggunakan fungsionalitas perpustakaan Anda, Anda harus memilih nama mana yang akan diekspor secara manual.

Jadi untuk perpustakaan seperti file ./lib/mylibrary.js...

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

Saat Anda ingin menggunakan fungsinya di kode Node.js ...

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)

Tidak tahu seberapa baik ini semua akan berhasil dalam praktiknya.

Saya dapat membuatnya berfungsi dengan memperbarui skrip mereka, dengan sangat mudah, hanya menambahkan module.exports =jika sesuai ...

Misalnya, saya mengambil file mereka dan saya menyalin ke './libs/apprise.js'. Lalu di mana itu dimulai

function apprise(string, args, callback){

Saya menetapkan fungsi sebagai module.exports =berikut:

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

Jadi saya dapat mengimpor pustaka ke dalam kode saya seperti ini:

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

Dan saya baik untuk pergi. YMMV, ini dengan webpack .

include(filename)Fungsi sederhana dengan pesan kesalahan yang lebih baik (tumpukan, nama file, dll.) Untuk eval, jika terjadi kesalahan:

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");
    }
}

Tetapi bahkan menjadi lebih kotor dengan nodejs: Anda perlu menentukan ini:

export NODE_MODULE_CONTEXTS=1
nodejs tmp.js

Jika tidak, Anda tidak dapat menggunakan variabel global dalam file yang disertakan dengan include(...).