Как развернуть файл WAR в Tomcat

Краткое практическое руководство по установке и настройке Apache Tomcat.

Read more →

Узнайте, как настроить приложение Spring Boot для развертывания на сервере Tomcat.

Read more →

Узнайте, как настроить HTTP-сервер Apache Tomcat для работы на порте 80.

Read more →

Если вы работали с Tomcat раньше, они будут вам очень знакомы:

$CATALINA_HOME

Эта переменная указывает на каталог, где установлен наш сервер.

$CATALINA_BASE

Эта переменная указывает на каталог конкретного экземпляра Tomcat, у вас может быть установлено несколько экземпляров. Если эта переменная не задана явно, ей будет присвоено то же значение, что и$CATALINA_HOME.

Веб-приложения развертываются в каталоге$CATALINA_HOME\webapps.

Document root. Относится к каталогу верхнего уровня веб-приложения, где все ресурсы приложения расположены в виде файлов JSP, страниц HTML, классов Java и изображений.

Context path. Относится к расположению, которое относится к адресу сервера и представляет имя веб-приложения.

Например, если наше веб-приложение помещено в каталог$CATALINA_HOME\webapps\myapp, к нему будет обращаться URLhttp://localhost/myapp, а его контекстный путь будет/myapp.

WAR. Расширение файла, который упаковывает иерархию каталогов веб-приложения в формате ZIP и является сокращением от Web Archive. Веб-приложения Java обычно упаковываются как файлы WAR для развертывания. Эти файлы могут быть созданы в командной строке или с помощью IDE, например Eclipse.

После развертывания нашего файла WAR Tomcat распаковывает его и сохраняет все файлы проекта в каталогеwebapps в новом каталоге, названном в честь проекта.

Мы можем запустить сервер Tomcat, просто запустив сценарийstartup, расположенный в$CATALINA_HOMEin\startup. В каждой установке есть.bat и.sh.

Выберите соответствующую опцию в зависимости от того, используете ли вы операционную систему Windows или Unix.

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

Чтобы иметь доступ к панели управления, пользователю с правами администратора требуется рольmanager-gui. Позже нам нужно будет развернуть файл WAR с помощью Maven, для этого нам также понадобится рольmanager-script.

Сделаем эти изменения в$CATALINA_HOME\conf omcat-users:

Более подробную информацию о различных ролях Tomcat можно найти, выполнивthis official link.

Наконец, убедитесь, что в каталоге установки Tomcat есть разрешение на чтение / запись.

Чтобы проверить правильность настройки Tomcat, запустите сценарий запуска (startup.bat /startup.sh), если на консоли не отображаются ошибки, мы можем дважды проверить, посетивhttp://localhost:8080.

Если вы видите целевую страницу Tomcat, значит, мы правильно установили сервер.

По умолчанию Tomcat настроен на прослушивание соединений на порту8080. Если есть другое приложение, которое уже связано с этим портом, консоль запуска сообщит нам.

Чтобы изменить порт, мы можем отредактировать файл конфигурации сервераserver.xml, расположенный в$CATALINA_HOME\conf\server.xml.. По умолчанию конфигурация коннектора выглядит следующим образом:

Например, если мы хотим изменить наш порт на8081, то нам нужно будет изменить атрибут порта коннектора следующим образом:

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

В этом разделе мы рассмотрим, как использовать плагин Cargo Maven для развертывания WAR в Tomcat, в этом случае мы развернем его в экземпляре версии 7.

Чтобы получить полный контроль над всем процессом, мы начнем с нуля, создав новое веб-приложение на Java из командной строки:

Это создаст полное веб-приложение Java в каталогеcargo-deploy. Если мы создадим, развернем и загрузим это приложение как есть, оно напечатаетHello World! в браузере.

В отличие от плагина Tomcat7 Maven, плагин Cargo Maven требует наличия этого файла.

Поскольку наше веб-приложение не содержит сервлетов, наш файлweb.xml будет очень простым. Итак, перейдите в папкуWEB-INF нашего недавно созданного проекта и создайте файлweb.xml со следующим содержимым:

Чтобы Maven мог распознавать команды Cargo без ввода полного имени, нам нужно добавить плагин Cargo Maven в группу плагинов в Mavensettings.xml.

Как непосредственный дочерний элемент корневого элемента<settings></settings>, добавьте это:

В этом подразделе мы отредактируем нашpom.xml в соответствии с нашими новыми требованиями к развертыванию.

Добавьте плагин следующим образом:

Последняя версия на момент написания -1.5.0. Однако последнюю версию всегда можно найтиhere.

Обратите внимание, что мы явно определяем упаковку как WAR, без этого наша сборка не будет выполнена. В разделе плагинов мы добавим плагин cargo maven2. Дополнительноwe add a configuration section where we tell Maven that we are using a Tomcat container and also an existing installation.

Устанавливая тип контейнера наinstalled, мы сообщаем Maven, что у нас есть экземпляр, установленный на машине, и предоставляем абсолютный URL-адрес для этой установки.

Устанавливая тип конфигурации наexisting, мы сообщаем Tomcat, что у нас есть существующая настройка, которую мы используем, и дальнейшая настройка не требуется.

Альтернативой может быть указание Cargo загрузить и настроить версию, указанную с помощью URL. Однако наше внимание сосредоточено на развертывании WAR.

Стоит отметить, что независимо от того, используем ли мы Maven 2.x или Maven 3.x, плагин Cargo maven2 работает для обоих.

Теперь мы можем установить наше приложение, выполнив:

и развернуть его, выполнив:

Если все пойдет хорошо, мы сможем запустить наше веб-приложение, загрузивhttp://localhost:8080/cargo-deploy.

Чтобы выполнить удаленное развертывание, нам нужно только изменить раздел конфигурации нашегоpom.xml. Удаленное развертывание означает, что у нас нет локальной установки Tomcat, но мы имеем доступ к панели управления менеджера на удаленном сервере.

Итак, давайте изменимpom.xml так, чтобы раздел конфигурации выглядел так:

На этот раз мы меняем тип контейнера сinstalled наremote и тип конфигурации сexisting наruntime. Наконец, мы добавляем в конфигурацию свойства аутентификации и удаленного URL.

Убедитесь, что роли и пользователи уже присутствуют в$CATALINA_HOME/conf/tomcat-users.xml, как и раньше.

Если вы редактируете тот же проект для развертыванияremote, сначала отмените развертывание существующей WAR:

очистить проект:

установить его:

наконец, разверните его:

Это оно.

Мы можем встроить установку в eclipse, выбрав пункт менюwindow на панели задач, а затемpreferences из раскрывающегося списка.

На левой панели появившегося окна мы найдем древовидную сетку элементов предпочтений. Затем мы можем перейти кeclipse → servers или просто ввестиservers в строке поиска.

Затем мы выбираем установочный каталог, если он еще не открыт для нас, и выбираем загруженную нами версию Tomcat.

На правой стороне панели появится страница конфигурации, где мы выбираем опцию Включить, чтобы активировать эту версию сервера и перейти к папке установки.

Мы применяем изменения, и в следующий раз, когда мы откроем представление серверов из подменю Eclipsewindows → show view, будет присутствовать только что настроенный сервер, и мы сможем запускать, останавливать и развертывать на нем приложения.

Чтобы развернуть веб-приложение в Tomcat, оно должно существовать в нашей рабочей области.

Откройте представлениеservers изwindow → show view и найдите серверы. В открытом состоянии мы можем просто щелкнуть правой кнопкой мыши по настроенному нами серверу и выбратьadd deployment в появившемся контекстном меню.

В появившемся диалоговом окнеNew Deployment откройте раскрывающийся списокproject и выберите веб-проект.

Под полем со спискомProject есть разделDeploy Type, когда мы выбираемExploded Archive(development mode),our changes in the application will be synced live without having to redeploy, это лучший вариант во время разработки, поскольку он очень эффективен.

ВыборPackaged Archive(production mode) потребует от нас повторного развертывания каждый раз, когда мы вносим изменения и видим их в браузере. Это лучше всего для производства, но, тем не менее, Eclipse делает это одинаково легко.

Обычно мы выбираем развертывание WAR через Eclipse, чтобы облегчить отладку. Может наступить время, когда мы захотим развернуть его не в том месте, которое используется встроенными серверами Eclipse. Наиболее распространенный случай, когда наш производственный сервер подключен к сети, и мы хотим обновить веб-приложение.

Мы можем обойти эту процедуру, развернув в производственном режиме, отметивDeploy Location в диалоговом окнеNew Deployment и выбрав оттуда WAR.

Во время развертывания вместо выбора встроенного сервера мы можем выбрать параметр<Externally Launched> в представленииservers рядом со списком встроенных серверов. Мы переходим в каталогwebapps внешней установки Tomcat.

Откройте менюRun и щелкните параметрыEdit Configurations.

На панели слева найдитеTomcat Server, если его там нет, щелкните значок + в меню, найдитеTomcat и выберитеLocal. В поле имени введитеTomcat 7/8 (в зависимости от вашей версии).

Нажмите кнопкуConfigure… и в полеTomcat Home перейдите к домашнему местоположению вашей установки и выберите его.

При желании установите для страницыStartup значениеhttp://localhost:8080/ иHTTP port: 8080, измените порт соответствующим образом.

Перейдите на вкладкуDeployment и нажмите на символ +, выберите артефакт, который вы хотите добавить на сервер, и нажмите OK.

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

Если файл WAR находится на сервере, на котором запущен экземпляр Tomcat, то мы можем заполнить обязательное полеContext Path, которому предшествует косая черта «/».

Допустим, мы хотим, чтобы к нашему веб-приложению можно было обращаться из браузера с URL-адресомhttp://localhost:8080/myapp, тогда в нашем поле пути контекста будет/myapp.

Мы пропускаем полеXML Configuration file URL и переходим к полюWAR or Directory URL. Здесь мы вводим абсолютный URL к файлу Web ARchive, как он появляется на нашем сервере. Допустим, наш файл находится вC:/apps/myapp.war, затем мы вводим это местоположение. Не забывайте расширение WAR.

После этого мы можем нажать кнопкуdeploy. Страница перезагрузится, и мы должны увидеть сообщение:

в верхней части страницы.

Кроме того, наше приложение также должно появиться в разделеApplications страницы.

Просто нажмите кнопкуchoose file, перейдите к месту расположения файла WAR и выберите его, затем нажмите кнопкуdeploy.

В обоих случаях, если все пойдет хорошо, консоль Tomcat сообщит нам, что развертывание прошло успешно, с сообщением, подобным следующему: