Что этот Javascript "требует"?

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

var pg = require('pg'); //native libpq bindings = `var pg = require('pg').native`
var conString = "tcp://postgres:[email protected]/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, и он просто говорит "require not defined".

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

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

Ответ 1

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

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 являются API-интерфейсами модульной системы, специфичной для Node.js. Браузеры не реализуют эту модульную систему.

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

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

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

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

Ответ 2

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

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

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

Теперь require() - это специальный вызов функции, определенный как часть спецификации CommonJS. В node он разрешает библиотеки и модули в пути поиска 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');

Ответ 3

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

В файле 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

Ответ 4

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

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

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

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

Теперь все содержимое script будет загружено на страницу - чтобы вы могли напрямую обращаться к своим переменным и методам.

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

Ответ 5

Вы знаете, как, когда вы запускаете 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 ("./local-file");

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


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