Что этот Javascript «требует»?

Я пытаюсь заставить Javascript читать / писать в базу данных PostgreSQL. Я нашел этот проект на GitHub. Мне удалось получить следующий пример кода для запуска в узле.

var pg = require('pg'); //native libpq bindings = `var pg = require('pg').native`
var conString = "tcp://postgres:1234@localhost/postgres";

var client = new pg.Client(conString);
client.connect();

//queries are queued and executed one after another once the connection becomes available
client.query("CREATE TEMP TABLE beatles(name varchar(10), height integer, birthday timestamptz)");
client.query("INSERT INTO beatles(name, height, birthday) values($1, $2, $3)", ['Ringo', 67, new Date(1945, 11, 2)]);
client.query("INSERT INTO beatles(name, height, birthday) values($1, $2, $3)", ['John', 68, new Date(1944, 10, 13)]);

//queries can be executed either via text/parameter values passed as individual arguments
//or by passing an options object containing text, (optional) parameter values, and (optional) query name
client.query({
  name: 'insert beatle',
  text: "INSERT INTO beatles(name, height, birthday) values($1, $2, $3)",
  values: ['George', 70, new Date(1946, 02, 14)]
});

//subsequent queries with the same name will be executed without re-parsing the query plan by postgres
client.query({
  name: 'insert beatle',
  values: ['Paul', 63, new Date(1945, 04, 03)]
});
var query = client.query("SELECT * FROM beatles WHERE name = $1", ['John']);

//can stream row results back 1 at a time
query.on('row', function(row) {
  console.log(row);
  console.log("Beatle name: %s", row.name); //Beatle name: John
  console.log("Beatle birth year: %d", row.birthday.getYear()); //dates are returned as javascript dates
  console.log("Beatle height: %d' %d\"", Math.floor(row.height/12), row.height%12); //integers are returned as javascript ints
});

//fired after last row is emitted
query.on('end', function() { 
  client.end();
});

Затем я попытался запустить его на веб-странице, но ничего не произошло. Я проверил на консоли Javascript, и он просто говорит, «не определено».

Так что же это «требует»? Почему это работает в узле, но не на веб-странице?

Кроме того, прежде чем я получил его на работу в узле, я должен был сделать npm install pg. О чем это? Я посмотрел в каталоге и не нашел файл pg. Куда это поместило, и как Javascript находит это?

Так что же это «требует»?

require()не является частью стандартного JavaScript API. Но в Node.js это встроенная функция со специальной целью: загружать модули .

Модули - это способ разбить приложение на отдельные файлы вместо того, чтобы поместить все ваше приложение в один файл. Эта концепция также присутствует в других языках с небольшими различиями в синтаксисе и поведении, таких как C include, Python importи так далее.

Одно большое различие между модулями Node.js и JavaScript браузера заключается в том, как к коду одного скрипта получают доступ из кода другого скрипта.

• В браузере JavaScript скрипты добавляются через <script>элемент. При выполнении все они имеют прямой доступ к глобальной области видимости, «разделяемому пространству» среди всех сценариев. Любой скрипт может свободно определять / модифицировать / удалять / вызывать что угодно в глобальной области видимости.

• В Node.js каждый модуль имеет свою область видимости. Модуль не может получить прямой доступ к вещам, определенным в другом модуле, если он не решит выставить их. Чтобы выставить вещи из модуля, они должны быть назначены exportsили module.exports. Чтобы модуль получил доступ к другому модулю exportsили module.exports, он должен использоватьrequire() .

В вашем коде var pg = require('pg');загружает pgмодуль, клиент PostgreSQL для Node.js. Это позволяет вашему коду получать доступ к функциональности API клиента PostgreSQL через pgпеременную.

Почему это работает в узле, но не на веб-странице?

require(), module.exportsИ exportsявляются интерфейсами из системы модулей, специфичные для Node.js. Браузеры не реализуют эту модульную систему.

Кроме того, прежде чем я получил его на работу в узле, я должен был сделать npm install pg. О чем это?

NPM - это служба репозитория пакетов, в которой размещаются опубликованные модули JavaScript. npm installэто команда, которая позволяет вам скачивать пакеты из их репозитория

Куда это поместило, и как Javascript находит это?

Npm cli помещает все загруженные модули в node_modulesкаталог, в котором вы работали npm install. Node.js имеет очень подробную документацию о том, как модули находят другие модули, включая поиск node_modulesкаталога.

Хорошо, давайте сначала начнем с разграничения Javascript в веб-браузере и Javascript на сервере (CommonJS и Node).

Javascript - это язык, традиционно ограниченный веб-браузером с ограниченным глобальным контекстом, определяемым главным образом так называемым уровнем объектной модели документов (DOM) уровня 0 (Javascript API Netscape Navigator).

Серверный Javascript устраняет это ограничение и позволяет Javascript вызывать различные фрагменты собственного кода (например, библиотеку Postgres) и открывать сокеты.

Теперь require()это специальный вызов функции, определенный как часть спецификации CommonJS. В узле он разрешает библиотеки и модули в пути поиска Node, который теперь обычно определяется как node_modulesв том же каталоге (или каталоге вызванного файла javascript) или общесистемном пути поиска.

Чтобы попытаться ответить на остальную часть вашего вопроса, нам нужно использовать прокси между кодом, выполняющимся в браузере и на сервере базы данных.

Поскольку мы обсуждаем Node, и вы уже знаете, как выполнить запрос оттуда, имеет смысл использовать Node в качестве этого прокси.

В качестве простого примера, мы собираемся создать URL, который возвращает несколько фактов о Beatle с заданным именем в виде JSON.

/* your connection code */

var express = require('express');
var app = express.createServer();
app.get('/beatles/:name', function(req, res) {
    var name = req.params.name || '';
    name = name.replace(/[^a-zA_Z]/, '');
    if (!name.length) {
        res.send({});
    } else {
        var query = client.query('SELECT * FROM BEATLES WHERE name =\''+name+'\' LIMIT 1');
        var data = {};
        query.on('row', function(row) {
            data = row;
            res.send(data);
        });
    };
});
app.listen(80, '127.0.0.1');

Используется для загрузки модулей. Давайте использовать простой пример.

В файле circle_object.js:

var Circle = function (radius) {
    this.radius = radius
}
Circle.PI = 3.14

Circle.prototype = {
    area: function () {
        return Circle.PI * this.radius * this.radius;
    }
}

Мы можем использовать это через require, например:

node> require('circle_object')
{}
node> Circle
{ [Function] PI: 3.14 }
node> var c = new Circle(3)
{ radius: 3 }
node> c.area()

require()Метод используется для загрузки и кэш - модулей JavaScript. Итак, если вы хотите загрузить локальный относительный модуль JavaScript в приложение Node.js, вы можете просто использовать require()метод.

Пример:

var yourModule = require( "your_module_name" ); //.js file extension is optional

Я заметил, что в то время как другие ответы объясняли, что требуется и что он используется для загрузки модулей в Node, они не дали полного ответа о том, как загружать модули узлов при работе в браузере.

Это довольно просто сделать. Установите ваш модуль, используя npm, как вы описываете, и сам модуль будет находиться в папке, обычно называемой node_modules.

Теперь самый простой способ загрузить его в ваше приложение - сослаться на него из html с помощью тега script, который указывает на этот каталог. т.е. если ваш каталог node_modules находится в корне проекта на том же уровне, что и ваш index.html, вы должны записать это в свой index.html:

<script src="node_modules/ng"></script>

Весь этот скрипт теперь будет загружен на страницу, так что вы сможете напрямую обращаться к его переменным и методам.

Существуют и другие подходы, которые более широко используются в более крупных проектах, такие как загрузчик модулей, например require.js . Из этих двух я сам не использовал Require, но думаю, многие считают, что это путь.

Вы знаете, как, когда вы запускаете JavaScript в браузере, у вас есть доступ к переменным, таким как «окно» или Math? Вам не нужно объявлять эти переменные, они написаны для использования в любое время.

Хорошо, когда вы запускаете файл в среде Node.js, есть переменная, которую вы можете использовать. Это называется "модуль". Это объект. У него есть свойство, которое называется «экспорт». И это работает так:

В файле, который мы назовем example.js, вы напишите:

example.js

module.exports = "some code";

Теперь вы хотите эту строку "некоторый код" в другом файле.

Мы назовем другой файл otherFile.js

В этом файле вы пишете:

otherFile.js

let str = require('./example.js')

Это требование require () отправляется в файл, который вы помещаете в него, находит все данные, хранящиеся в свойстве module.exports. Часть вашего кода let str = ... означает, что все, что требуется для возврата оператора, сохраняется в переменной str.

Итак, в этом примере конечным результатом является то, что в otherFile.js у вас теперь есть это:

let string = "некоторый код";

• или -

let str = ('./example.js').module.exports

Замечания:

имя файла, которое записывается внутри оператора require: если это локальный файл, это должен быть путь к файлу example.js. Кроме того, расширение .js добавлено по умолчанию, поэтому мне не пришлось его писать.

Вы делаете нечто подобное, когда требуются библиотеки node.js, такие как Express. В файле express.js есть объект с именем 'module' со свойством с именем 'exports'.

Итак, это выглядит примерно так: под капотом (я новичок, поэтому некоторые из этих деталей могут быть не точными, но для демонстрации концепции:

express.js

module.exports = function() {
    //It returns an object with all of the server methods
    return {
        listen: function(port){},
        get: function(route, function(req, res){}){}
     }
}

Если вам требуется модуль, он выглядит следующим образом: const moduleName = require ("module-name");

Если вам требуется локальный файл, он выглядит следующим образом: const localFile = require ("./ path / to / local-file");

(обратите внимание на ./ в начале имени файла)

Также обратите внимание, что по умолчанию экспорт является объектом. Например, module.exports = {} Итак, вы можете написать module.exports.myfunction = () => {} перед присвоением значения для module.exports. Но вы также можете заменить объект, написав module.exports = "Я больше не объект".

Два вида module.exports / require:

(см. здесь )

Файл экспорта версии 1 (misc.js):

var x = 5;
var addX = function(value) {
  return value + x;
};
module.exports.x = x;
module.exports.addX = addX;

другой файл:

var misc = require('./misc');
console.log("Adding %d to 10 gives us %d", misc.x, misc.addX(10));

Файл экспорта версии 2 (user.js):

var User = function(name, email) {
  this.name = name;
  this.email = email;
};
module.exports = User;

другой файл:

var user = require('./user');
var u = new user();