Xitrum Guide¶

Скачать PDF

Есть также английский, японский, корейский и вьетнамский версии.

Введение
- Возможности
- Авторы
Как начать
- Создание пустого проекта Xitrum
- Запуск
- Импорт проекта в Eclipse
- Импорт проекта в IntelliJ
- Автоматическая перезагрузка
- Список игнорируемых файлов
Контроллеры и представления
- Стандартный контроллер (normal action)
- FutureAction
- Актор контроллер (actor action)
- Отправка ответа клиенту
- Шаблонизация
- Макет (Layout)
  - Макет в отдельном файле
  - Использование макета непосредственно в respondView
- Внутренние представления
- Фрагменты
- Использование шаблона смежного контроллера
  - Один контроллер - много представлений
- Компонент
RESTful APIs
- Кэш маршрутов
- Очередность маршрутов
- Несколько маршрутов для одного контроллера
- Точка в маршруте
- Регулярные выражения в маршруте
- Обработка не стандартных маршрутов
- Ссылка на контроллер
- Редирект на контроллер
- Форвардинг (перенаправление) на контроллер
- Определение Ajax запроса
- Anti-CSRF
- antiCsrfInput и antiCsrfToken
- SkipCsrfCheck
- Управление маршрутами
- Получение полных (сырых) данных запроса
- Документирование API
Шаблонизация
- Настройка
- Отключение шаблонизатора
- Реализация своего шаблонизатора
Postbacks
- Шаблон
- Форма
- Другие элементы (не формы)
- Диалог подтверждения
- Дополнительные параметры
- Отображение анимации во время Ajax загрузки
XML
- Отключения экранирования XML
- Группировка XML элементов
- Отображение XHTML
JavaScript и JSON
- JavaScript
  - Вставка JavaScript фрагментов в представление
  - Отправка JavaScript непосредственно (без представления)
- JSON
- Плагин для Knockout.js
Асинхронная обработка запросов
- WebSocket
- SockJS
- Chunked ответ
  - Бесконечный iframe
  - Event Source
Статичные файлы
- Отправка статических файлов с диска
- index.html и обработка отсутствующих маршрутов
- 404 и 500
- Использование файлов ресурсов в соответствии с WebJars
- Кэширование на стороне клиента с ETag и max-age
- GZIP
- Кэш на стороне сервера
Serve flash socket policy file
Запросы, параметры, куки, сессии
- Запросы
- Куки
  - Допустимые символы в куки
- Сессии
- object vs. val
Валидация
- Стандартные валидаторы
- Написание своих валидаторов
Загрузка файлов
- Ajax загрузка файлов
Фильтры
- Пре-фильтр (before filter)
- Пост-фильтры (after filter)
- Внешние фильтры (around filter)
- Порядок выполнения фильтров
Кэш на стороне сервера
- Кэширование страницы или контроллера
- Кэш объект
- Удаление кэша
- Конфигурация
- Как работает кэш
- xitrum.util.LocalLruCache
Интернационализация
- Используйте интернационализированные сообщения непосредственно в коде
- Извлечение сообщений в pot файл
- Где сохранять po файлы
- Выбор языка
- Валидационные сообщения
- Множественные числа
Логирование
- Использование объекта xitrum.Log
- Использование трейта xitrum.Log
- Проверка уровня логирования
- Настройка уровня и способов логирования
- Использование Fluentd
Развертывание на сервере
- Сборка
- Сборка и xitrum-package
- Подключение Scala консоли к запущенному JVM процессу
- Установка Oracle JDK на CentOS или Ubuntu
- Запускайте Xitrum в боевом режиме когда система запускается
- Настройка портов
- Настройка Linux для обработки большого числа подключений
- HAProxy
- Nginx
- Развертывание в Heroku
Масштабирование вместе с Akka and Hazelcast
Netty handlers
- Netty handler architecture
- Custom handlers
- Xitrum default handlers
Метрики
- Агрегирование метрик
- Публикация метрик
HOWTO
- Авторизация
  - Конфигурация для базовой аутентификации
  - Базовая аутентификация на конкретный контроллер
- Загрузка конфигурационных файлов
- Сериализация и десериализация
- Шифрование данных
- Множество сайтов на одном доменном имени
- Преобразование разметки (markdown) в HTML
- Мониторинг изменений файлов
- Временные директории
- Потоковые видео
Зависимости
- Библиотеки
- Связанные проекты