Yesod (веб-фреймворк)

Yesod

Автор (ы)	Майкл Снойман
Разработчик (и)	Майкл Снойман и др.
Первоначальный выпуск	2010
Стабильный выпуск	1.6.18 / 2020-05-31
Репозиторий	github.com / yesodweb / yesod
Написано на	Haskell
Операционная система	Кросс-платформенная
Доступно в	Haskell
Тип	Веб-фреймворк
Лицензия	Лицензия MIT
Веб-сайт	www.yesodweb.com

Yesod (IPA: ; Иврит : יְסוֺד, «Фонд») - это бесплатный веб-фреймворк с открытым исходным кодом на основе Haskell для продуктивной разработки шрифтов. -safe, REST на основе модели (где URL идентифицируют ресурсы, а методы HTTP идентифицируют переходы), высокопроизводительные веб-приложения, разработанные et al.

Yesod основан на шаблонах для создания экземпляров для перечисленных сущностей и функций обработки динамического содержимого с помощью конструкций Template Haskell для размещения шаблонов содержимого eDSL, называемых QuasiQuotes, где содержимое преобразуется в кодовые выражения с помощью инструкций метапрограммирования.

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

Yesod разделяет свои функции на отдельные библиотеки, поэтому вы можете выбрать свою {базу данных, рендеринг html, формы и т. д.} функциональную библиотеку по вашему выбору.

• 1 Архитектура MVC
  • 1.1 Контроллер
    • 1.1.1 Интерфейс сервера
    • 1.1.2 Тип основания
    • 1.1.3 Hello World
    • 1.1.4 Ресурсы, маршруты и Обработчики методов HTTP
    • 1.1.5 Данные запроса, параметры, файлы cookie, языки и другая информация заголовка
    • 1.1.6 Аутентификация и авторизация
    • 1.1.7 Сеансы
      • 1.1.7.1 Сессионные сообщения
    • 1.1. 8 Подсайты
    • 1.1.9 Обработка форм и создание макета
  • 1.2 Вид
    • 1.2.1 Шаблоны на основе отступов для древовидной разметки
      • 1.2.1.1 Интерполяция шаблонов - Шекспировские шаблоны
      • 1.2.1.2 Другие шаблоны
    • 1.2.2 Локализуемые сообщения
    • 1.2.3 Навигационные крошки
    • 1.2.4 XML-карта сайта поисковой системы
    • 1.2.5 Представления веб-новостей
  • 1.3 Модель
    • 1.3.1 Использование in-memory изменяемые данные (в базовом типе данных)
    • 1.3.2 Уровень базы данных
  • 1.4 Электронная почта
  • 1.5 Facebook
• 2 Цикл разработки
  • 2.1 Инструмент «Помощник Yesod»
  • 2.2 Развертывание с Keter: монитор сервера веб-приложений и обратный прокси-сервер
• 3 Интеграция с JavaScript, созданным на основе функциональных языков
• 4 См. Также
• 5 Ссылки
• 6 Внешние ссылки
  • 6.1 Руководства по блогам
  • 6.2 Сравнения
  • 6.3 Другие языки
  • 6.4 В дистрибутивах GNU / Linux

Контроллер

Интерфейс сервера

Yesod использует интерфейс веб-приложения API, сокращенно WAI, для изоляции сервлетов, или веб-приложения., С серверов, с обработчиками для серверных протоколов CGI, FastCGI, SCGI, Warp, Launch (открыть как локальный URL-адрес в браузере по умолчанию, закрыть сервер при закрытии окна),

Тип основания

См. исх. Yesod требует типа данных, который создает экземпляры классов контроллера . Это называется фундаментным типом. В приведенном ниже примере оно называется «MyApp».

Модель REST идентифицирует веб-ресурс с помощью веб-пути. Здесь ресурсы REST получают имена с суффиксом R (например, «HomeR») и перечислены в шаблоне описания карты сайта parseRoutes. Из этого списка берутся имена маршрутов и имена обработчиков диспетчеризации.

Yesod использует метапрограммирование Template Haskell для генерации кода из шаблонов во время компиляции, обеспечивая совпадение имен в шаблонах и все проверки типов (например, имена веб-ресурсов и имена обработчиков).

При вставке вызова mkYesod это вызовет примитивы Template Haskell для генерации кода, соответствующего элементам типа маршрута, и экземплярам классов диспетчерского контроллера для отправки вызовов GET для маршрута HomeR к подпрограмме с именем, составляющей их обе как «getHomeR», ожидая существующего обработчика, который соответствует имени.

Hello World

Пример «Hello world» на основе интерфейса сервера CGI (фактические типы обработчиков изменились, но философия осталась):

{- file wai-cgi-hello.hs -} {- # LANGUAGE PackageImports, TypeFamilies, QuasiQuotes, MultiParamTypeClasses, TemplateHaskell, OverloadedStrings # -} import "wai" Network.Wai import "wai-extra" Network.Wai.Handler.CGI (запустить) - взаимозаменяемый обработчик WAI import "yesod" Yesod import "yesod-core" Yesod.Handler (getRequest) import "text" Data.Text (Text) import "shakespeare" Text.Cassius (Color (..), colorBlack) - - данные типа Foundation MyApp = MyApp - шаблон карты сайта, путь к списку, имя ресурса и принятые методы - mkYesod принимает имя типа основания в качестве параметра. для составления имен диспетчерских функций mkYesod "MyApp" [parseRoutes | / HomeR GET |] экземпляр Yesod MyApp - шаблон CSS со структурой отступов myStyle :: [Text] → CssUrl url myStyle paramStyle = [cassius |.box border: 1px solid # {boxColor} |], где boxColor = case paramStyle of ["высококонтрастный"] → colorBlack _ → Color 0 0 255 - HTML-шаблон со структурированным отступом myHtml :: [(Text, Text)] → URL-адрес HtmlUrl myHtml params = [деревня |

Привет, мир! Есть # {параметры длины} параметры : $ if null params 
Ничего не перечислить $ else 
$ forall param <- params 
# {fst param}: # {snd param} |]

getHomeR :: Handler RepHtml getHomeR = do req <- getRequest let params = reqGetParams req paramStyle <- lookupGetParams "style" defaultLayout $ do -- adding widgets to the Widget monad (a ''Writer'' monad) setTitle "Yesod example" toWidgetHead $ myStyle paramStyle toWidgetBody $ myHtml params -- there are ''run'' function variants for different WAI handlers main = toWaiApp MyApp>>= run

# cgi test export REMOTE_ADDR = 127.0.0.1 export REQUEST_METHOD = GET export PATH_INFO = / export QUERY_STRING = 'p1 = abc; p2 ​​= def; style = high-Contrast './wai-cgi-hello

Ресурсы, маршруты и обработчики HTTP-методов

См. исх. Yesod следует модели REpresentational State Transfer доступа к веб-документам, идентифицируя документы. и каталоги как ресурсы с конструктором маршрута, названным с суффиксом R в верхнем регистре (например, HomeR).

Таблица маршрутов

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

Захват сегмента URL-адреса в качестве параметра возможен с указанием префикса '#' для одиночного сегментный захват или "*" для многосегментного захвата, за которым следует тип параметра.

- с учетом типа основания MyApp mkYesod "MyApp" [parseRoutes | / HomeR - HTTP-методы не указаны: все методы принимаются / blog BlogR GET POST - префикс '#' указывает сегмент пути как параметр обработчика маршрута / article / # ArticleId ArticleR GET PUT - префикс '*' указывает параметр как последовательность частей пути / ветка / * Тексты BranchR GET - для упрощения грамматики составные типы должны использовать псевдоним, например. type Тексты для '' [Text] '' |]

• Применение предыдущего шаблона генерирует следующие конструкторы маршрута:

data Route MyApp = HomeR - в шаблонах указывается как: @ {HomeR} | BlogR - в шаблонах: @ {BlogR} | ArticleR ArticleId - в шаблонах: @ {ArticleR myArticleId} | Тексты BranchR - в шаблонах: @ {BranchR myBranchSegments}

• Для каждого поддерживаемого метода HTTP должна быть создана функция-обработчик, чтобы соответствовать именам отправки, сгенерированным mkYesod из шаблона parseRoutes, путем добавления префикса имени метода (или префикс «обработчик», если метод не указан) к ресурсу, как описано (фактические типы обработчиков версий изменились, но философия осталась):

- для «/ HomeR» - HTTP-методы не указаны ⇒ только один обработчик с префиксом 'handler' 'handlerHomeR :: HasReps t ⇒ Handler t - для "/ blog BlogR GET POST" getBlogR :: HasReps t ⇒ Handler t postBlogR :: HasReps t ⇒ Handler t - for "/ article / #ArticleId ArticleR GET PUT "getArticleR :: HasReps t ⇒ ArticleId → Handler t putArticleR :: HasReps t ⇒ ArticleId → Handler t

Запросить данные, параметры, файлы cookie, языки и другую информацию заголовка

См. Исх.

Аутентификация и авторизация

См. Исх. Плагины аутентификации: OpenId, BrowserId, Email, GoogleEmail, HashDB, RpxNow.

Существует важный параметр для автоматического перенаправления после аутентификации.

Сеансы

См. Исх. Бэкэнды сеанса: ClientSession (он сохраняет сеанс в файле cookie), ServerSession (он хранит большую часть данных сеанса на сервере)

>>Чтобы избежать чрезмерных накладных расходов на полосу пропускания, рабочие сайты могут обслуживать свой статический контент из отдельного имя домена, чтобы избежать накладных расходов на передачу файла cookie сеанса для каждого запроса

Сообщения сеанса

Успешное, неудачное или ориентировочное сообщение может быть сохранено (setMessage) в сеансе и будет показано, если оно существует, с помощью процедуры default_layout через шаблон default_layout.hamlet, очищаемый при консультации.

Подсайты

Подсайты с общим префиксом URL для рабочих процессов, обслуживания файлов или разделения сайта. См. Ссылку

Встроенные дочерние сайты: Static, Auth

Обработка форм и создание макета

См. Ссылку

Тип формы здесь является объектом который используется в контроллере для синтаксического анализа и обработки полей формы, вводимых пользователем, и создания пары (FormResult, Widget), где виджет содержит макет следующей визуализации формы с сообщениями об ошибках и метками. Его также можно использовать для создания новой формы с пробелами или значениями по умолчанию.

Тип формы принимает форму функции фрагмента HTML, который должен быть встроен в представление, которое будет содержать скрытые поля для целей безопасности.

Объект формы создается из Applicative / Monadic композиции полей для комбинированного / последовательного анализа входных данных полей.

Существует три типа форм:

• Аппликативная (с табличной компоновкой),
• Монадическая (со свободным стилем компоновки), обе в модуле Yesod.Form.Functions,
• Входные данные (только для синтаксического анализа, представление не создается) в модуле Yesod.Form.Input.

Генераторы полей, имена которых состоят из начального типа формы (a | m | i), за которым следует (req | opt) {- обязательно или необязательно -}, иметь компонент fieldParse и компонент fieldView.

• функция runForm {Post | Get} запускает синтаксические анализаторы поля для поля формы input и генерирует пару (FormResult, Widget) из представлений, предлагающих новый виджет формы с полученными значениями полей формы по умолчанию. Суффикс функции - это метод http, используемый при отправке формы.
• , в то время как generateForm {Post | Get} игнорирует входные данные от клиента и генерирует пустой виджет или виджет формы по умолчанию.

Фактические параметры и типы функции имеют менял через версии Yesod. Проверьте подписи в книге Yesod и библиотеки.

Магия заключается в экземпляре Applicative типа данных FormResult, где (<*>) собирает сообщения об ошибках для случая FormFailure [textErrMsg]значения результатов

Monadic формы допускают произвольную компоновку форм и улучшенную обработку членов hiddenField.

Образец аппликативной формы:

- запись для данных полей нашей формы Person = Person {personName :: Text, personAge :: Int, personLikings :: Maybe Text} - тип Form имеет дополнительный параметр для встраиваемого фрагмента html, содержащий скрытое поле токена CSRF для типа безопасности Sub master x = Html → MForm sub master (FormResult x, Widget) { - - для сообщений в функциях проверки: @param master: экземпляр yesod для использования в renderMessage (возврат из getYesod обработчика) @param languages: языки страниц для использования в renderMessage - необязательная запись по умолчанию: @param mbPersonDefaults: Just defaults_record, или ничего для пустой формы -} personForm :: MyFoundationType → [Text] → Maybe Person → Sub master P erson {- '' aopt '' (необязательный компонент поля AForm) для полей "Может быть", '' areq '' (обязательный fld AForm comp.) вставит атрибут "required" -} Основные языки personForm mbPersonDefaults = renderTable $ Person <$>areq TextField fldSettingsName mbNameDefault <*>areq customPersonAgeField fldSettingsAge mbAgeDefault <*>Aopt textareaField fldSettingsLikings mbLikingsDefault где mbNameDefault = БПМЖ PERSONNAME mbPersonDefaults mbAgeDefault = БПМЖ персонажа mbPersonDefaults mbLikingsDefault = БПМЖ personLikings mbPersonDefaults - "fieldSettingsLabel" возвращает первоначальную fieldSettings запись - недавно Запись «FieldSettings» может быть определена из метки String, поскольку она реализует IsString fldSettingsName = (fieldSettingsLabel MsgName) {fsAttrs = [(«maxlength», «20»)]} fldSettingsAge = fieldSettingsLabel MsgAge fldSettingsLikings = (fieldSettingsLikings) ("столбцы", "40"), ("строки", "10")]} customPersonAgeField = проверить validateAge intField validateAge y | y < 18 = Left $ renderMessage master languages MsgUnderAge | otherwise = Right y

View

Показанные типы соответствуют более старой версии, но философия остается.

Монада Handler возвращает контент в одном или нескольких форматах как компоненты типов, реализующих класс HasReps {RepHtml, RepJson, RepXml, RepPlain, двойной RepHtmlJson, пару или список пар [(ContentType, Содержание)],..}. Примеры Json:

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

• Виджеты: HTML DOM код фрагменты, созданные с помощью определенных команд (например, setTitle) или из шаблонов структуры (html ) / поведения (JavaScript ) / стиля (css ), типы которых создают экземпляры классов ToWidget, ToWidgetHead или ToWidgetBody.

Монада виджетов, основанная на монаде Writer и аргументе defaultLayout, облегчает объединение виджетов вместе.

Шаблоны на основе отступов для древовидной разметки

• квазиквотер деревень (синтаксический анализатор кода шаблона Haskell времени компиляции), указанный в T.H. Оксфордские скобки синтаксис [qq |... |]представляет структурированный HTML-шаблон на основе отступов. (См. Документ.)

'$' ставит префикс строк логических операторов.

Автоматические закрывающие теги генерируются только для тега в начальной позиции строки.

• квазиквотер whamlet возвращает выражение Widget. (сохраняет toWidget перед [деревня |.. |]).

toWidget [деревня | $ doctype 5