Проект: веб-сайт по обмену опытом
На встречах по обмену опытом люди с общими интересами встречаются и делают небольшие неформальные презентации на тему своих знаний. На встрече по обмену опытом среди фермеров кто-нибудь может рассказать о выращивании сельдерея. На встрече программистов вы можете выступить с рассказом про Node.js
Такие встречи – отличный способ расширить свой кругозор, узнать о новинках области, или просто пообщаться с людьми со схожими интересами. Во многих городах есть встречи любителей JavaScript. Обычно их посещение бесплатное, и я нашёл те, которые посещал, дружелюбными и гостеприимными.
В последней главе-проекте мы устроим веб-сайт по обслуживанию выступлений, которые делаются на таких встречах. Представьте себе группу людей, которые регулярно встречаются в офисе одного из участников, чтобы поговорить о моноциклах. Проблема в том, что когда предыдущий организатор встреч переехал в другой город, никто не занял его место. Нам нужна система, которая позволит участникам предлагать и обсуждать темы друг с другом, без участия организатора.
Встречи моноциклистов
Как и в предыдущей главе, код написан для Node.js и запустить его в браузере не получится. Полный код доступен по ссылке.
Дизайн
У проекта есть серверная часть, написанная для Node.js, и клиентская, написанная для браузера. Серверная хранит системные данные и передаёт их клиенту. Также она отдаёт файлы HTML и JavaScript, которые создают систему на стороне клиента.
На сервере есть список тем для следующего собрания, и клиент их показывает. У каждой темы есть имя выступающего, название, описание и список комментариев. Клиент позволяет предлагать новые темы (добавлять их в список), удалять темы и комментировать существующие. Когда пользователь вносит это изменение, клиент делает HTTP-запрос, чтобы сообщить об этом серверу.
Будет создано приложение для показа текущих предложений тем и комментариев по ним. Когда кто-то где-то добавляет новую тему или оставляет комментарий, у всех людей, открывших страницу в браузере, изменения должны происходить мгновенно. Это непростая задача, потому что веб-сервер не может открывать соединение с клиентом, и потому что нет годного способа узнать, кто из клиентов сейчас просматривает данный веб-сайт.
Общепринятым решением проблемы являются длинные запросы (long polling), которые послужили одной из мотиваций к разработке Node.
Длинные запросы
Чтобы мгновенно оповестить клиента об изменениях, нам нужно соединение с клиентом. Браузеры традиционно не принимают запросов на соединения, и клиенты всё равно скрыты за устройствами, которые эти соединения не приняли бы, поэтому начинать соединение с сервера смысла не имеет.
Можно сделать так, чтобы клиент открывал соединение и держал его, чтобы сервер имел возможность отправлять через него информацию по необходимости.
Но запрос HTTP разрешает только простой обмен информацией – клиент отправляет запрос, сервер возвращает ответ, и всё. Есть технология под названием web sockets, которая поддерживается современными браузерами, позволяющая открывать соединения для обмена произвольными данными. Но их довольно сложно использовать.
В этой главе мы обратимся к относительно простой технологии, длинным запросам, когда клиенты постоянно запрашивают сервер о новой информации через обычные HTTP-запросы, а сервер просто медлит с ответом, когда ему нечего сообщить.
Пока клиент постоянно держит открытый запрос, он будет получать информацию с сервера немедленно. К примеру, если у Алисы в браузере открыто приложение для обмена опытом, браузер сделает запрос на обновления и будет ожидать ответа. Когда Боб из своего браузера отправит тему «Экстремальный спуск на моноцикле с горы», сервер заметит, что Алиса ждёт обновлений, и отправит информацию по новой теме в ответ на её ждущий запрос. Браузер Алисы получит данные и обновит страницу, показав новую тему.
Для предотвращения завершения соединений по таймауту (по истечению времени неактивные соединения обрываются), технология длинных запросов обычно устанавливает максимальное время для каждого запроса, по прошествии которого сервер в любом случае ответит, даже если ему нечего сообщить, а затем клиент запустит новый запрос. Периодическое обновление запроса делает технику более надёжной, позволяя клиентам восстанавливаться после временных обрывов или проблем на сервере.
У занятого сервера, использующего длинные запросы, могут висеть открытыми тысячи запросов, а, следовательно, и TCP соединений. Node хорошо подходит для такой системы, потому, что он позволяет с лёгкостью управлять многими соединениями без создания отдельных потоков.
Интерфейс HTTP
Перед тем, как мы начнём делать сервер или клиент, подумаем об их точке соприкосновения: интерфейсе HTTP, через который они взаимодействуют.
Интерфейс будет основан на JSON, и, как и в файловом сервере в главе 20, мы будем с выгодой использовать методы HTTP. Интерфейс сосредоточен вокруг пути /talks. Пути, которые не начинаются с /talks, будут использоваться для отдачи статичных файлов – HTML и JavaScript, определяющих клиентскую часть.
Запрос GET к /talks возвращает документ JSON типа этого:
1
{"serverTime": 1405438911833,
2
"talks": [{"title": "Unituning ",
3
"presenter": "Васисуалий",
4
"summary": "Украшаем свой моноцикл",
5
"comment": []}]}
Copied!
Поле serverTime используется для надёжности длинных запросов. Вернёмся к нему позже.
Создание новой темы происходит через запрос PUT к URL вида /talks/Unituning, где часть после второго слеша – название темы. Тело запрос PUT должно содержать объект JSON, в котором описаны свойства presenter и summary.
Поскольку заголовки тем могут содержать пробелы и другие символы, которые нельзя вставлять в URL, при создании URL их надо закодировать при помощи функции encodeURIComponent.
1
console.log("/talks/" + encodeURIComponent("How to Idle"));
2
// → /talks/How%20to%20Idle
Copied!
Запрос на создание темы может выглядеть так:
1
PUT /talks/How%20to%20Idle HTTP/1.1
2
Content-Type: application/json
3
Content-Length: 92
4
5
{«presenter»: «Даша»,
6
«summary»: «Неподвижно стоим на моноцикле»}
Copied!
Такие URL поддерживают запросы GET для получения JSON-представления темы и DELETE для удаления темы.
Добавление комментария происходит через POST запрос к URL вида /talks/Unituning/comments, с объектом JSON, содержащим свойства author и message в теле запроса.
1
POST /talks/Unituning/comments HTTP/1.1
2
Content-Type: application/json
3
Content-Length: 72
4
5
{«author»: «Alice»,
6
«message»: «Will you talk about raising a cycle?»}
Copied!
Для поддержки длинных запросов, запросы GET к /talks могут включать параметр под именем changesSince, показывающий, что клиенту нужны обновления, случившиеся после заданной точки во времени. Когда обновления появляются, они сразу же возвращаются. Когда их нет, запрос задерживается, пока что-нибудь не случится, или пока не пройдёт заданный период времени (мы зададим 90 секунд).
Время используется в формате количества миллисекунд с начала 1970 года, в том же формате, что возвращает Date.now(). Чтобы удостовериться, что клиент получает все обновления, и не получает одно и то же обновление дважды, клиент должен передать время, в которое он в последний раз получил информацию с сервера. Часы сервера могут не совпадать с клиентом, и даже если б они совпадали, клиент не мог бы знать точное время, в которое сервер отправлял ответ, потому что передача данных по сети занимает время.
Поэтому в ответах на запросы GET к /talks и существует свойство serverTime. Оно сообщает клиенту точное время по часам сервера, когда были созданы передаваемые данные. Клиент просто сохраняет время и передаёт его вместе со следующим запросом, чтобы убедиться, что он получает только те обновления, которых ещё не получал.
1
GET /talks?changesSince=1405438911833 HTTP/1.1
2
3
(прошло время)
4
5
HTTP/1.1 200 OK
6
Content-Type: application/json
7
Content-Length: 95
8
9
{«serverTime»: 1405438913401,
10
«talks»: [{«title»: «Unituning»,
11
«deleted»: true}]}
Copied!
Когда тема меняется, создаётся или комментируется, в ответ на следующий запрос включается полная информация о теме. Когда тема удаляется, включаются только название и свойство deleted. Клиент может добавлять темы с заголовками, которые он ещё не видел, к странице, обновлять темы, которые он уже показывает, и удалять темы, которые были удалены.
Протокол, описываемый в этой главе, не осуществляет контроль доступа. Каждый может комментировать, менять и удалять темы. Так как интернет полон хулиганов, размещение такой системы в онлайне без защиты, скорее всего, закончится плохо.
Простым решением было бы разместить систему за обратным прокси – это HTTP-сервер, которая принимает соединения снаружи системы и перенаправляет их на сервера HTTP, работающие локально. Такой proxy можно настроить, чтобы он спрашивал имя и пароль пользователя, и вы могли бы устроить так, чтобы пароль был только у членов вашей группы.
Сервер
Начнём с написания серверной части программы. Код работает на Node.js
Роутинг
Для запуска сервера будет использоваться http.createServer. В функции, обрабатывающей новый запрос, мы должны различать запросы (определяемые методом и путём), которые мы поддерживаем. Это можно сделать через длинную цепочку if / else, но можно и красивее.
Роутер – компонент, помогающий распределить запрос к функции, которая может его обработать. Можно сказать роутеру, что запросы PUT с путём, совпадающим с регуляркой /^\/talks\/(+)$/ (что совпадает с /talks/, за которым идёт название темы), могут быть обработаны заданной функцией. Кроме того, он может помочь извлечь осмысленные части пути, в нашем случае – название темы, заключённое в кавычки, и передать их вспомогательной функции.
В NPM есть много хороших модулей роутинга, но тут мы сами себе такой напишем, чтобы продемонстрировать принцип его работы.
Вот файл router.js, который будет запрашиваться через require из модуля сервера:
1
var Router = module.exports = function() {
2
this.routes = [];
3
};
4
5
Router.prototype.add = function(method, url, handler) {
6
this.routes.push({method: method,
7
url: url,
8
handler: handler});
9
};
10
11
Router.prototype.resolve = function(request, response) {
12
var path = require("url").parse(request.url).pathname;
13
14
return this.routes.some(function(route) {
15
var match = route.url.exec(path);
16
if (!match || route.method != request.method)
17
return false;
18
19
var urlParts = match.slice(1).map(decodeURIComponent);
20
route.handler.apply(null, [request, response]
21
.concat(urlParts));
22
return true;
23
});
24
};
Copied!
Модуль экспортирует конструктор Router. Объект router позволяет регистрировать новые обработчики с методом add, и распределять запросы методом resolve.
Последний вернёт булевское значение, показывающее, был ли найден обработчик. Метод some массива путей будет пробовать их по очереди (в порядке, в каком они были заданы), и остановится с возвратом true, если путь найден.
Функции обработчиков вызываются с объектами request и response. Когда регулярка, проверяющая URL, возвращает группы, то представляющие их строки передаются в обработчик в качестве дополнительных аргументов. Эти строчки надо декодировать из URL-стиля %20.
Выдача файлов
Когда тип запроса не совпадает ни с одним из типов, которые обрабатывает роутер, сервер должен интерпретировать его как запрос файла из общей директории. Можно было бы использовать файловый сервер из главы 20 для выдачи этих файлов, но нам не нужна поддержка PUT и DELETE, зато нам нужны дополнительные функции типа поддержки кеширования. Поэтому, давайте использовать проверенный и протестированный файловый сервер из NPM.
Я выбрал ecstatic. Это не единственный сервер на NPM, но он хорошо работает и удовлетворяет нашим требованиям. Модуль ecstatic экспортирует функцию, которую можно вызвать с объектом конфигурации, чтобы она выдала функцию обработчика. Мы используем опцию root, чтобы сообщить серверу, где нужно искать файлы. Обработчик принимает параметры request и response, и его можно передать напрямую в createServer, чтобы создать сервер, который отдаёт только файлы. Но сначала нам нужно проверить те запросы, которые мы обрабатываем особо – поэтому мы обёртываем его в ещё одну функцию.
1
var http = require("http");
2
var Router = require("./router");
3
var ecstatic = require("ecstatic");
4
5
var fileServer = ecstatic({root: "./public"});
6
var router = new Router();
7
8
http.createServer(function(request, response) {
9
if (!router.resolve(request, response))
10
fileServer(request, response);
11
}).listen(8000);
12
13
Функции respond и respondJSON используются в коде сервера, чтобы можно было отправлять ответы одним вызовом функции.
14
15
function respond(response, status, data, type) {
16
response.writeHead(status, {
17
"Content-Type": type || "text/plain"
18
});
19
response.end(data);
20
}
21
22
function respondJSON(response, status, data) {
23
respond(response, status, JSON.stringify(data),
24
"application/json");
25
}
Copied!
Темы как ресурсы
Сервер хранит предложенные темы в объекте talks, у которого именами свойств являются названия тем. Они будут выглядеть как ресурсы HTTP по адресу /talks/[title], поэтому нам нужно добавить в роутер обработчиков, реализующих различные методы, которые клиенты могут использовать для работы с ними.
Обработчик для запросов GET одной темы должен найти её и либо вернуть данные в JSON, либо выдать ошибку 404.
1
var talks = Object.create(null);
2
3
router.add("GET", /^\/talks\/([^\/]+)$/,
4
function(request, response, title) {
5
if (title in talks)
6
respondJSON(response, 200, talks[title]);
7
else
8
respond(response, 404, "No talk '" + title + "' found");
9
});
10
11
Удаление темы делается удалением из объекта talks.
12
13
router.add("DELETE", /^\/talks\/([^\/]+)$/,
14
function(request, response, title) {
15
if (title in talks) {
16
delete talks[title];
17
registerChange(title);
18
}
19
respond(response, 204, null);
20
});
Copied!
Функция registerChange, которую мы определим позже, уведомляет длинные запросы об изменениях.
Чтобы было просто получать контент тел запросов, закодированных при помощи JSON, мы определяем функцию readStreamAsJSON, которая читает всё содержимое потока, разбирает его по правилам JSON и затем делает обратный вызов.
1
function readStreamAsJSON(stream, callback) {
2
var data = "";
3
stream.on("data", function(chunk) {
4
data += chunk;
5
});
6
stream.on("end", function() {
7
var result, error;
8
try { result = JSON.parse(data); }
9
catch (e) { error = e; }
10
callback(error, result);
11
});
12
stream.on("error", function(error) {
13
callback(error);
14
});
15
}
Copied!
Один из обработчиков, которому нужно читать ответы в JSON – это обработчик PUT, который используется для создания новых тем. Он должен проверить, есть ли у данных свойства presenter и summary, которые должны быть строками. Данные, приходящие снаружи, всегда могут оказаться мусором, и мы не хотим, чтобы из-за плохого запроса была сломана наша система.
Если данные выглядят приемлемо, обработчик сохраняет объект, представляющий новую тему, в объекте talks, при этом, возможно, перезаписывая существующую тему с таким же заголовком, и опять вызывает registerChange.
1
router.add("PUT", /^\/talks\/([^\/]+)$/,
2
function(request, response, title) {
3
readStreamAsJSON(request, function(error, talk) {
4
if (error) {
5
respond(response, 400, error.toString());
6
} else if (!talk ||
7
typeof talk.presenter != "string" ||
8
typeof talk.summary != "string") {
9
respond(response, 400, "Bad talk data");
10
} else {
11
talks[title] = {title: title,
12
presenter: talk.presenter,
13
summary: talk.summary,
14
comments: []};
15
registerChange(title);
16
respond(response, 204, null);
17
}
18
});
19
});
Copied!
Добавление комментария к теме работает сходным образом. Мы используем readStreamAsJSON для получения содержимого сообщения, проверяем результирующие данные и сохраняем их как комментарий, если они приемлемы.
1
router.add("POST", /^\/talks\/([^\/]+)\/comments$/,
2
function(request, response, title) {
3
readStreamAsJSON(request, function(error, comment) {
4
if (error) {
5
respond(response, 400, error.toString());
6
} else if (!comment ||
7
typeof comment.author != "string" ||
8
typeof comment.message != "string") {
9
respond(response, 400, "Bad comment data");
10
} else if (title in talks) {
11
talks[title].comments.push(comment);
12
registerChange(title);
13
respond(response, 204, null);
14
} else {
15
respond(response, 404, "No talk '" + title + "' found");
16
}
17
});
18
});
Copied!
Попытка добавить комментарий к несуществующей теме должна возвращать ошибку 404.
Поддержка длинных запросов
Самый интересный аспект сервера – часть, которая поддерживает длинные запросы. Когда на адрес /talks поступает запрос GET, это может быть простой запрос всех тем, или запрос на обновления с параметром changesSince.
Есть много различных ситуаций, в которых нам нужно отправить клиенту список тем, поэтому мы сначала определим вспомогательную функцию, присоединяющую поле serverTime к таким ответам.
1
function sendTalks(talks, response) {
2
respondJSON(response, 200, {
3
serverTime: Date.now(),
4
talks: talks
5
});
6
}
Copied!
Обработчик должен посмотреть на все параметры запроса в его URL, чтобы проверить, не задан ли параметр changesSince. Если дать функции parse модуля “url” второй аргумент значения true, он также распарсит вторую часть URL – query, часть запроса. У возвращаемого объекта будет свойство query, в котором будет ещё один объект, с именами и значениями параметров.
1
router.add("GET", /^\/talks$/, function(request, response) {
2
var query = require("url").parse(request.url, true).query;
3
if (query.changesSince == null) {
4
var list = [];
5
for (var title in talks)
6
list.push(talks[title]);
7
sendTalks(list, response);
8
} else {
9
var since = Number(query.changesSince);
10
if (isNaN(since)) {
11
respond(response, 400, "Invalid parameter");
12
} else {
13
var changed = getChangedTalks(since);
14
if (changed.length > 0)
15
sendTalks(changed, response);
16
else
17
waitForChanges(since, response);
18
}
19
}
20
});
Copied!
При отсутствии параметра changesSince обработчик просто строит список всех тем и возвращает его.
Иначе, сперва надо проверить параметр changeSince на предмет того, что это число. Функция getChangedTalks, которую мы вскоре определим, возвращает массив изменённых тем с некоего заданного времени. Если она возвращает пустой массив, то серверу нечего возвращать клиенту, так что он сохраняет объект response (при помощи waitForChanges), чтобы ответить попозже.
1
var waiting = [];
2
3
function waitForChanges(since, response) {
4
var waiter = {since: since, response: response};
5
waiting.push(waiter);
6
setTimeout(function() {
7
var found = waiting.indexOf(waiter);
8
if (found > -1) {
9
waiting.splice(found, 1);
10
sendTalks([], response);
11
}
12
}, 90 * 1000);
13
}
Copied!
Метод splice используется для вырезания куска массива. Ему задаётся индекс и количество элементов, и он изменяет массив, удаляя это количество элементов после заданного индекса. В этом случае мы удаляем один элемент – объект, ждущий ответ, чей индекс мы узнали через indexOf. Если вы передадите дополнительные аргументы в splice, их значения будут вставлены в массив на заданной позиции, и заместят удалённые элементы.
Когда объект response сохранён в массиве waiting, задаётся таймаут. После 90 секунд он проверяет, ждёт ли ещё запрос, и если да – отправляет пустой ответ и удаляет его из массива waiting.
Чтобы найти именно те темы, которые сменились после заданного времени, нам надо отслеживать историю изменений. Регистрация изменения при помощи registerChange запомнит это изменение, вместе с текущим временем, в массиве changes. Когда случается изменение, это значит – есть новые данные, поэтому всем ждущим запросам можно немедленно ответить.
1
var changes = [];
2
3
function registerChange(title) {
4
changes.push({title: title, time: Date.now()});
5
waiting.forEach(function(waiter) {
6
sendTalks(getChangedTalks(waiter.since), waiter.response);
7
});
8
waiting = [];
9
}
Copied!
Наконец, getChangedTalks использует массив changes, чтобы построить массив изменившихся тем, включая объекты со свойством deleted для тем, которых уже не существует. При построении массива getChangedTalks должна убедиться, что одна и та же тема не включается дважды, так как тема могла измениться несколько раз с заданного момента времени.
1
function getChangedTalks(since) {
2
var found = [];
3
function alreadySeen(title) {
4
return found.some(function(f) {return f.title == title;});
5
}
6
for (var i = changes.length - 1; i >= 0; i--) {
7
var change = changes[i];
8
if (change.time <= since)
9
break;
10
else if (alreadySeen(change.title))
11
continue;
12
else if (change.title in talks)
13
found.push(talks[change.title]);
14
else
15
found.push({title: change.title, deleted: true});
16
}
17
return found;
18
}
Copied!
Вот и всё с кодом сервера. Запуск написанного кода даст вам сервер, работающий на порту 8000, который выдаёт файлы из публичной поддиректории и управляет интерфейсом тем по адресу /talks.
Клиент
Клиентская часть веб-сайта по управлению темами состоит из трёх файлов: HTML-страница, таблица стилей и файл JavaScript.
HTML
Серверы по общепринятой схеме в случае запроса пути, соответствующего директории, отдают файл под именем index.html из этой директории. Модуль файлового сервера ecstatic поддерживает это соглашение. При запросе пути / сервер ищет файл ./public/index.html (где ./public – это корневая директория) и возвращает его, если он там есть.
Значит, если надо показать страницу, когда браузер будет запрашивать наш сервер, её надо положить в public/index.html. Вот начало файла index:
1
<!doctype html>
2
3
<title>Обмен опытом</title>
4
<link rel="stylesheet" href="skillsharing.css">
5
6
<h1>Обмен опытом</h1>
7
8
<p>Ваше имя: <input type="text" id="name"></p>
9
10
<div id="talks"></div>
Copied!
Определяется заголовок и включается таблица стилей, где определяются стили – в числе прочего, рамочка вокруг тем. Затем добавлен заголовок и поле name. Пользователь должен вписать своё имя, чтобы оно было присоединено к его темам и комментариям.
Элемент
<div> с ID “talks” будет содержать список тем. Скрипт заполняет список, когда он получает его с сервера.Затем идёт форма для создания новой темы.
1
<form id="newtalk">
2
<h3>Submit a talk</h3>
3
Заголовок: <input type="text" style="width: 40em" name="title">
4
<br>
5
Summary: <input type="text" style="width: 40em" name="summary">
6
<button type="submit">Отправить </button>
7
</form>
Copied!
Скрипт добавит обработчик события “submit” в форму, из которого он сможет сделать HTTP-запрос, сообщающий серверу про тему.
Затем идёт загадочный блок, у которого стиль display установлен в none, и который поэтому не виден на странице. Догадаетесь, зачем он нужен?
1
<div id="template" style="display: none">
2
<div>
3
<h2>{{title}}</h2>
4
<div>by <span>{{presenter}}</span></div>
5
<p>{{summary}}</p>
6
<div></div>
7
<form>
8
<input type="text" name="comment">
9
<button type="submit">Добавить комментарий</button>
10
<button type="button">Удалить тему</button>
11
</form>
12
</div>
13
<div>
14
<span>{{author}}</span>: {{message}}
15
</div>
16
</div>
Copied!
Создание сложных структур DOM через JavaScript приводит к уродливому коду. Можно сделать его покрасивее при помощи вспомогательных функций типа elt из главы 13, но результат всё равно будет выглядеть хуже, чем HTML, который в каком-то смысле является языком для построения DOM-структур.
Для создания DOM-структур для тем обсуждений, наша программа определит простую систему шаблонов, которая использует скрытые структуры, включаемые в документ, для создания новых структур – заменяя метки в файле между двойными фигурными кавычками на значения для конкретной темы.
И наконец, HTML включает файл скрипта, содержащего клиентский код.
1
<script src="skillsharing_client.js"></script>
Copied!
Запуск
Первое, что клиент должен сделать при загрузке страницы, это запросить с сервера текущий набор тем. Так как мы будем делать много HTTP-запросов, мы определим небольшую обёртку вокруг XMLHttpRequest, которая примет объект для настройки запроса и обратного вызова по окончанию запроса.
1
function request(options, callback) {
2
var req = new XMLHttpRequest();
3
req.open(options.method || "GET", options.pathname, true);
4
req.addEventListener("load", function() {
5
if (req.status < 400)
6
callback(null, req.responseText);
7
else
8
callback(new Error("Request failed: " + req.statusText));
9
});
10
req.addEventListener("error", function() {
11
callback(new Error("Network error"));
12
});
13
req.send(options.body || null);
14
}
Copied!
Начальный запрос показывает полученные темы на экране и начинает процесс длинных запросов, вызывая waitForChanges.
1
var lastServerTime = 0;
2
3
request({pathname: "talks"}, function(error, response) {
4
if (error) {
5
reportError(error);
6
} else {
7
response = JSON.parse(response);
8
displayTalks(response.talks);
9
lastServerTime = response.serverTime;
10
waitForChanges();
11
}
12
});
Copied!
Перменная lastServerTime используется для отслеживания времени последнего обновления, полученного с сервера. После начального запроса, вид тем у клиента соответствует виду тем сервера, которые был у него в момент запроса. Таким образом, свойство serverTime, включаемое в ответ, предоставляет правильное начальное значение lastServerTime.
Когда запрос не удался, нам не надо, чтобы страница просто сидела и ничего не делала. Мы определим простую функцию под названием reportError, которая хотя бы покажет пользователю диалог, сообщающий об ошибке.
1
function reportError(error) {
2
if (error)
3
alert(error.toString());
4
}
Copied!
Функция проверяет, есть ли ошибка, и выводит сообщение только при её наличии. Таким образом, мы можем напрямую передавать эту функцию в запрос для тех запросов, ответ на которые можно игнорировать. Тогда если запрос завершится с ошибкой, то об ошибке будет сообщено пользователю.
Показ тем
Чтобы иметь возможность обновлять список тем при поступлении изменений, клиент должен отслеживать темы, которые он показывает сейчас. Тогда, если поступает новая версия темы, которая уже есть на экране, её можно заменить прямо на месте обновлённой версией. Сходным образом, когда поступает информация об удалении темы, нужный элемент DOM можно удалить из документа.
Функция displayTalks используется как для построения начального экрана, так и для его обновления при изменениях. Она будет использовать объект shownTalks, связывающий заголовки тем с узлами DOM, чтобы запомнить темы, которые уже есть на экране.
1
var talkDiv = document.querySelector("#talks");
2
var shownTalks = Object.create(null);
3
4
function displayTalks(talks) {
5
talks.forEach(function(talk) {
6
var shown = shownTalks[talk.title];
7
if (talk.deleted) {
8
if (shown) {
9
talkDiv.removeChild(shown);
10
delete shownTalks[talk.title];
11
}
12
} else {
13
var node = drawTalk(talk);
14
if (shown)
15
talkDiv.replaceChild(node, shown);
16
else
17
talkDiv.appendChild(node);
18
shownTalks[talk.title] = node;
19
}
20
});
21
}
Copied!
Структура DOM для тем строится по шаблону, включённому в HTML документ. Сначала нужно определить instantiateTemplate, который находит и заполняет шаблон.
Параметр name – имя шаблона. Чтобы найти элемент шаблона, мы ищем элементы, у которых имя класса совпадает с именем шаблона, который является дочерним у элемента с ID “template”. Метод querySelector облегчает этот процесс. На странице есть шаблоны “talk” и “comment”.
1
function instantiateTemplate(name, values) {
2
function instantiateText(text) {
3
return text.replace(/\{\{(\w+)\}\}/g, function(_, name) {
4
return values[name];
5
});
6
}
7
function instantiate(node) {
8
if (node.nodeType == document.ELEMENT_NODE) {
9
var copy = node.cloneNode();
10
for (var i = 0; i < node.childNodes.length; i++)
11
copy.appendChild(instantiate(node.childNodes[i]));
12
return copy;
13
} else if (node.nodeType == document.TEXT_NODE) {
14
return document.createTextNode(
15
instantiateText(node.nodeValue));
16
}
17
}
18
19
var template = document.querySelector("#template ." + name);
20
return instantiate(template);
21
}
Copied!
Метод cloneNode, который есть у всех узлов DOM, создаёт копию узла. Он не скопирует дочерние узлы, если не передать ему первым аргументом true. Функция instantiate рекурсивно создаёт копию шаблона, заполняя его по ходу дела.
Второй аргумент instantiateTemplate должен быть объектом, чьи свойства содержат строки, которые надо ввести в шаблон. Метка вроде будет заменена значением свойства “title”.
Этот подход к шаблонам довольно груб, но для создания drawTalk его будет достаточно.
1
function drawTalk(talk) {
2
var node = instantiateTemplate("talk", talk);
3
var comments = node.querySelector(".comments");
4
talk.comments.forEach(function(comment) {
5
comments.appendChild(
6
instantiateTemplate("comment", comment));
7
});
8
9
node.querySelector("button.del").addEventListener(
10
"click", deleteTalk.bind(null, talk.title));
11
12
var form = node.querySelector("form");
13
form.addEventListener("submit", function(event) {
14
event.preventDefault();
15
addComment(talk.title, form.elements.comment.value);
16
form.reset();
17
});
18
return node;
19
}
Copied!
После завершения обработки шаблона “talk” нужно много чего подлатать. Во-первых, нужно вывести комментарии, путём многократного добавления шаблона “comment” и добавления результатов к узлу класса «comments». Затем, обработчики событий нужно присоединить к кнопке, которая удаляет задачу и к форме, добавляющей комментарий.
Обновление сервера
Обработчики событий, зарегистрированные в drawTalk, вызывают функции deleteTalk и addComment непосредственно для действий, необходимых для удаления темы или добавления комментария. Это будет нужно для построения URL, которые ссылаются на темы с заданным именем, для которых мы определяем вспомогательную функцию talkURL.
1
function talkURL(title) {
2
return "talks/" + encodeURIComponent(title);
3
}
Copied!
Функция deleteTalk запускает запрос DELETE и сообщает об ошибке в случае неудачи.
1
function deleteTalk(title) {
2
request({pathname: talkURL(title), method: "DELETE"},
3
reportError);
4
}
Copied!
Для добавления комментария нужно построить его представление в формате JSON и отправить его как часть POST-запроса.
1
function addComment(title, comment) {
2
var comment = {author: nameField.value, message: comment};
3
request({pathname: talkURL(title) + "/comments",
4
body: JSON.stringify(comment),
5
method: "POST"},
6
reportError);
7
}
Copied!
Переменная nameField, используемая для установки свойства комментария author, ссылается на поле
<input> вверху страницы, которое позволяет пользователю задать его имя. Мы также подключаем это поле к localStorage, чтобы его не приходилось заполнять каждый раз при перезагрузке страницы.1
var nameField = document.querySelector("#name");
2
3
nameField.value = localStorage.getItem("name") || "";
4
5
nameField.addEventListener("change", function() {
6
localStorage.setItem("name", nameField.value);
7
});
8
9
Форма внизу страницы для создания новой темы получает обработчик событий “submit”. Этот обработчик запрещает действие по умолчанию (что привело бы к перезагрузке страницы), очищает форму и запускает PUT-запрос для создания темы.
10
11
var talkForm = document.querySelector("#newtalk");
12
13
talkForm.addEventListener("submit", function(event) {
14
event.preventDefault();
15
request({pathname: talkURL(talkForm.elements.title.value),
16
method: "PUT",
17
body: JSON.stringify({
18
presenter: nameField.value,
19
summary: talkForm.elements.summary.value
20
})}, reportError);
21
talkForm.reset();
22
});
Copied!
Обнаружение изменений
Хочу отметить, что разные функции, изменяющие состояние приложения, создавая или удаляя темы, или добавляя к ним комментарии, абсолютно не заботятся о том, чтобы их деятельность была видна на экране. Они просто говорят что-то серверу и надеются на механизм длинных запросов, который должен вызывать соответствующие изменения.
Учитывая созданную на сервере систему и то, как мы определили displayTalks для обработки изменений тем, которые уже есть на странице, сам механизм длинных запросов оказывается неожиданно простым.
1
function waitForChanges() {
2
request({pathname: "talks?changesSince=" + lastServerTime},
3
function(error, response) {
4
if (error) {
5
setTimeout(waitForChanges, 2500);
6
console.error(error.stack);
7
} else {
8
response = JSON.parse(response);
9
displayTalks(response.talks);
10
lastServerTime = response.serverTime;
11
waitForChanges();
12
}
13
});
14
}
Copied!
Эта функция вызывается однажды, когда программа запускается, и затем продолжает вызывать себя, чтобы убедиться, что запросы всегда работают. Когда запрос не удаётся, мы не вызываем reportError, чтобы не раздражать пользователя всплывающим окном каждый раз при проблеме соединения с сервером. Вместо этого ошибка выводится в консоль (для облегчения отладки), и делается следующая попытка через 2.5 секунды.
Когда запрос удаётся, на экран выводятся новые данные, и lastServerTime обновляется, чтобы отражать тот факт, что мы получили данные в соответствии с этим новым моментом времени. Запрос сразу стартует заново, и ждёт следующего обновления.
Если вы запустите сервер, и откроете два окна браузера с адресом localhost:8000, вы увидите, что действия, выполняемые вами в одном окне, моментально отображаются в другом.
Упражнения
Следующие упражнения заключаются в изменении системы, описанной в этой главе. Для работы над ними, убедитесь, что вы скачали код и установили Node.js.
Сохранение состояния на диск
Сервер держит все данные в памяти. Если он упадёт или перезапустится, все темы и комментарии будут потеряны.
Расширьте его функциональность с тем, чтобы он сохранял данные на диске и автоматически загружал их при перезагрузке. Не волнуйтесь насчёт эффективности, сделайте самый простой вариант.
Обнуление полей комментариев
Общая перерисовка всех тем работает неплохо, потому что нет различия между узлом DOM и его заменой, когда они одинаковые. Но есть исключения. Если вы начнётё печатать что-либо в поле комментария к теме в одном окне браузера, а затем в другом окне добавите комментарий к этой теме, поле в первом окне будет перерисовано, и будет потеряно и его содержимое, и фокус.
При горячем обсуждении, когда несколько человек добавляют комментарии к одной теме, это очень раздражало бы. Можете ли вы придумать, как избежать этого?
Улучшенные шаблоны
Большинство шаблонизаторов делают больше, чем просто заполняют шаблоны строками. По меньшей мере они позволяют добавлять в шаблоны условия, аналогично оператору if, и повторения частей шаблона, аналогично циклам.
Если б мы могли повторять кусок шаблона для каждого элемента массива, второй шаблон («comment») был бы нам не нужен. Мы могли просто сказать шаблону “talk”, чтобы он повторялся для массива, содержащегося в свойстве comments, и создавал бы узлы, которые являются комментариями, для каждого элемента массива.
Это могло бы выглядеть так:
1
<div>
2
<div template-repeat="comments">
3
<span>{{author}}</span>: {{message}}
4
</div>
5
</div>
Copied!
Идея в следующем: когда при обработке шаблона встречается атрибут template-repeat, повторяющим шаблон, код проходит циклом по массиву, содержащемуся в свойстве, названном так же, как этот атрибут. Контекст шаблона (переменная values в instantiateTemplate) при работе цикла показывала бы на текущий элемент массива так, чтобы метку искали бы в объекте comment, а не в теме.
Перепишите instantiateTemplate так, чтобы она это умела, и потом поменяйте шаблоны, чтоб они использовали эту возможность, и уберите лишние строки для создания комментариев из функции drawTalk.
Как бы вы организовали условное создание узлов, чтобы можно было опускать части шаблона, если определённое значение равно true или false?
А кто без скрипта?
Если кто-нибудь зайдёт на наш сайт с отключенным JavaScript, они получат сломанную неработающую страницу. Это не очень-то хорошо.
Некоторые разновидности веб-приложений не получится сделать без JavaScript. Для других не хватает финансирования или терпения, чтобы заботиться о посетителях без скриптов. Но для посещаемых страниц считается вежливым поддержать таких пользователей.
Попробуйте придумать способ, которым бы веб-сайт по обмену опытом можно было бы сделать работающим без JavaScript. Придётся ввести автоматические обновления страниц, а перезагружать странички пользователям придётся по старинке. Но было бы неплохо уметь просматривать темы, создавать новые и отправлять комментарии.
Не заставляю вас его реализовывать. Достаточно описать возможное решение. Кажется ли вам такой вариант сайта более или менее элегантным, чем тот, что мы уже сделали?
Last modified 2yr ago
Copy link