Развертывание и настройка приложения Tomcat, JBoss или Java SE в службе приложение Azure

В этой статье показана наиболее распространенная конфигурация развертывания и среды выполнения для приложений Java в Служба приложений. Если вы раньше не использовали Службу приложений Azure, мы рекомендуем сначала ознакомиться с кратким руководством по Java. Ответы на общие вопросы об использовании службы приложений, не относящиеся к разработке для Java, можно найти в разделе вопросов и ответов о Службе приложений Azure.

приложение Azure служба запускает веб-приложения Java в полностью управляемой службе в трех вариантах:

• Java SE — может запускать приложение, развернутое как JAR-пакет, содержащий внедренный сервер (например, Spring Boot, Dropwizard, Quarkus или один с внедренным сервером Tomcat или Jetty).
• Tomcat — встроенный сервер Tomcat может запускать приложение, развернутое как пакет WAR.
• JBoss EAP — поддерживается только для приложений Linux в ценовой категории "Премиум" версии 3 и "Изолированная версия 2". Встроенный сервер JBoss EAP может запускать приложение, развернутое как пакет WAR или EAR.

Отображение версии Java

az webapp config show --resource-group <resource-group-name> --name <app-name> --query linuxFxVersion

az webapp list-runtimes --os linux | grep "JAVA\|TOMCAT\|JBOSSEAP"

az webapp config show --name <app-name> --resource-group <resource-group-name> --query "[javaVersion, javaContainer, javaContainerVersion]"

az webapp list-runtimes --os windows | grep java

Дополнительные сведения о поддержке версий см. в Служба приложений политике поддержки среды выполнения языка.

Развертывание приложения

Build Tools

Maven

Подключаемый модуль Maven для веб-приложений Azure позволяет легко подготовить проект Maven на Java для веб-приложения Azure с помощью одной команды в корневом каталоге проекта:

mvn com.microsoft.azure:azure-webapp-maven-plugin:2.13.0:config

Эта команда добавляет подключаемый azure-webapp-maven-plugin модуль и связанную конфигурацию, запрашивая выбрать существующее веб-приложение Azure или создать новую. Во время настройки он пытается определить, следует ли развертывать приложение в Java SE, Tomcat или (только Linux) JBoss EAP. После этого вы можете развернуть приложение Java в Azure, используя приведенную ниже команду.

mvn package azure-webapp:deploy

Ниже приведен пример конфигурации в pom.xml:

<plugin> 
  <groupId>com.microsoft.azure</groupId>  
  <artifactId>azure-webapp-maven-plugin</artifactId>  
  <version>2.11.0</version>  
  <configuration>
    <subscriptionId>111111-11111-11111-1111111</subscriptionId>
    <resourceGroup>spring-boot-xxxxxxxxxx-rg</resourceGroup>
    <appName>spring-boot-xxxxxxxxxx</appName>
    <pricingTier>B2</pricingTier>
    <region>westus</region>
    <runtime>
      <os>Linux</os>      
      <webContainer>Java SE</webContainer>
      <javaVersion>Java 17</javaVersion>
    </runtime>
    <deployment>
      <resources>
        <resource>
          <type>jar</type>
          <directory>${project.basedir}/target</directory>
          <includes>
            <include>*.jar</include>
          </includes>
        </resource>
      </resources>
    </deployment>
  </configuration>
</plugin> 

Gradle

1. Настройте подключаемый модуль Gradle для Azure веб-приложения, добавив подключаемый модуль в вашbuild.gradle:

   plugins {
     id "com.microsoft.azure.azurewebapp" version "1.10.0"
   }
   

2. Настройте сведения о веб-приложении. Соответствующие ресурсы Azure создаются, если они не существуют. Ниже приведен пример конфигурации, дополнительные сведения см. в этом документе.

   azurewebapp {
       subscription = '<your subscription id>'
       resourceGroup = '<your resource group>'
       appName = '<your app name>'
       pricingTier = '<price tier like 'P1v2'>'
       region = '<region like 'westus'>'
       runtime {
         os = 'Linux'
         webContainer = 'Tomcat 10.0' // or 'Java SE' if you want to run an executable jar
         javaVersion = 'Java 17'
       }
       appSettings {
           <key> = <value>
       }
       auth {
           type = 'azure_cli' // support azure_cli, oauth2, device_code and service_principal
       }
   }
   

3. Выполните развертывание с помощью одной команды.

   gradle azureWebAppDeploy
   

Интерфейсы IDE

Azure поддерживает удобные возможности для разработки Java-приложений в Службе приложений в популярных интегрированных средах разработки Java, включая:

• VS Code: веб-приложения Java с Visual Studio Code
• IntelliJ IDEA:создание веб-приложения Hello World для Службы приложений Azure с помощью IntelliJ
• Eclipse:создание веб-приложения Hello World для Службы приложений Azure с помощью Eclipse

API Kudu

Не развертывайте .war или .jar с помощью FTP. Средство FTP предназначено для передачи сценариев запуска, зависимостей или других файлов среды выполнения. Это не оптимальный выбор для развертывания веб-приложений.

Перезапись или перенаправление URL-адреса

Чтобы переписать или перенаправить URL-адрес, используйте один из доступных средств перезаписи URL-адресов, например UrlRewriteFilter.

Ведение журнала и отладка приложений

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

Потоковая передача журналов диагностики

az webapp log config --name <app-name> --resource-group <resource-group-name> --docker-container-logging filesystem

az webapp log tail --name <app-name> --resource-group <resource-group-name>

az webapp log config --resource-group <resource-group-name> --name <app-name> --docker-container-logging filesystem --level Verbose

az webapp log tail --resource-group <resource-group-name> --name <app-name>

Дополнительные сведения см. в разделе Потоковая передача журналов в Cloud Shell.

Доступ к консоли SSH в Linux

Чтобы открыть прямой сеанс SSH с контейнером, необходимо запустить приложение.

Вставьте следующий URL-адрес в браузер и замените <app-name> именем вашего приложения:

https://<app-name>.scm.azurewebsites.net/webssh/host

Если вы не прошли аутентификацию, это потребуется сделать, подключившись с помощью подписки Azure. После выполнения проверки подлинности отобразится оболочка в браузере. Здесь можно запускать команды внутри контейнера.

Чтобы открыть удаленный сеанс SSH на локальном компьютере см. инструкцию в разделе Открытие сеанса SSH из удаленной оболочки.

Средства устранения неполадок Linux

Встроенные образы Java основаны на операционной системе Alpine Linux. Используйте диспетчер пакетов apk, чтобы установить любые средства или команды для устранения неполадок.

Профилировщик Java

Все среды выполнения Java в службе приложение Azure входят в JDK Flight Recorder для профилирования рабочих нагрузок Java. Его можно использовать для записи событий JVM, системы и приложений и устранения неполадок в приложениях.

Дополнительные сведения о Профилировщике Java см. в документации по приложение Azure Insights.

«Черный ящик»

Все среды выполнения Java в Служба приложений входят в пакет записи тестов Java. Его можно использовать для записи событий JVM, системы и приложений и устранения неполадок в приложениях Java.

078990bbcd11:/home# jcmd
Picked up JAVA_TOOL_OPTIONS: -Djava.net.preferIPv4Stack=true
147 sun.tools.jcmd.JCmd
116 /home/site/wwwroot/app.jar

jcmd 116 JFR.start name=MyRecording settings=profile duration=30s filename="/home/jfr_example.jfr"

az webapp config appsettings set -g <your_resource_group> -n <your_app_name> --settings JAVA_OPTS=-XX:StartFlightRecording=disk=true,name=continuous_recording,dumponexit=true,maxsize=1024m,maxage=1d

jcmd <pid> JFR.dump name=continuous_recording filename="/home/recording1.jfr"

jcmd <pid> JFR.start name=TimedRecording settings=profile duration=30s filename="C:\home\timed_recording_example.JFR"

Анализ файлов .jfr

Используйте FTPS, чтобы скачать JFR-файл на локальный компьютер. Чтобы проанализировать JFR-файл, скачайте и установите Java Mission Control. Инструкции по Java Mission Control см. в документации по JMC и инструкциям по установке.

Ведение журнала приложений

Если приложение использует Logback или Log4j для трассировки, то эти данные трассировки можно передать в Azure Application Insights для просмотра, выполнив инструкции по настройке платформы ведения журнала в разделе Просмотр журналов трассировки Java в Application Insights.

Настройка

Служба приложений Azure поддерживает настройку с помощью портала Azure и интерфейса командной строки. Ознакомьтесь со следующими статьями о настройке конкретных веб-приложений не на платформе Java:

• Настройка параметров приложения
• Настройка личного домена
• Настройка привязок TLS/SSL
• Добавление CDN
• Настройка сайта Kudu

Локальное копирование содержимого приложения

Задайте параметр JAVA_COPY_ALL приложения, чтобы true скопировать содержимое приложения в локальную рабочую роль из общей файловой системы. Этот параметр помогает устранить проблемы с блокировкой файлов.

Настройка параметров среды выполнения Java

Чтобы настроить выделенную память или другие параметры среды выполнения виртуальной машины Java, создайте параметр приложения с именем JAVA_OPTS с параметрами. При запуске Служба приложений Azure передает этот параметр в качестве переменной среды в среду выполнения Java.

Чтобы настроить параметр приложения из подключаемого модуля Maven, добавьте теги "параметр/значение" в раздел подключаемого модуля Azure. В следующем примере задаются минимальный и максимальный размеры кучи для Java.

<appSettings>
    <property>
        <name>JAVA_OPTS</name>
        <value>-Xms1024m -Xmx1024m</value>
    </property>
</appSettings>

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

• Экземпляры B1 и S1: -Xms1024m -Xmx1024m
• Экземпляры B2 и S2: -Xms3072m -Xmx3072m
• Экземпляры B3 и S3: -Xms6144m -Xmx6144m
• Экземпляры P1v2: -Xms3072m -Xmx3072m
• Экземпляры P2v2: -Xms6144m -Xmx6144m
• Экземпляры P3v2: -Xms12800m -Xmx12800m
• Экземпляры P1v3: -Xms6656m -Xmx6656m
• Экземпляры P2v3: -Xms14848m -Xmx14848m
• Экземпляры P3v3: -Xms30720m -Xmx30720m
• Экземпляры I1: -Xms3072m -Xmx3072m
• Экземпляры I2: -Xms6144m -Xmx6144m
• Экземпляры I3: -Xms12800m -Xmx12800m
• Экземпляры I1v2: -Xms6656m -Xmx6656m
• Экземпляры I2v2: -Xms14848m -Xmx14848m
• Экземпляры I3v2: -Xms30720m -Xmx30720m

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

Включение веб-сокетов

Включите для приложения поддержку веб-сокетов на портале Azure в разделе Параметры приложения. Чтобы параметр вступил в силу, необходимо перезапустить приложение.

Включите поддержку веб-сокетов с помощью Azure CLI, выполнив следующую команду.

az webapp config set --name <app-name> --resource-group <resource-group-name> --web-sockets-enabled true

Затем перезапустите приложение.

az webapp stop --name <app-name> --resource-group <resource-group-name>
az webapp start --name <app-name> --resource-group <resource-group-name>

Настройка кодировки по умолчанию

На портале Azure в разделе Параметры приложения для веб-приложения создайте параметр приложения JAVA_OPTS со значением -Dfile.encoding=UTF-8.

Можно также настроить параметр приложения с помощью подключаемого модуля Maven для службы приложений. Добавьте теги имени и значения параметра в конфигурацию подключаемого модуля.

<appSettings>
    <property>
        <name>JAVA_OPTS</name>
        <value>-Dfile.encoding=UTF-8</value>
    </property>
</appSettings>

robots933456 в журналах

В журналах контейнера может отобразиться следующее сообщение:

2019-04-08T14:07:56.641002476Z "-" - - [08/Apr/2019:14:07:56 +0000] "GET /robots933456.txt HTTP/1.1" 404 415 "-" "-"

Это сообщение можно проигнорировать. /robots933456.txt — это фиктивный URL-путь, с помощью которого Служба приложений проверяет, может ли контейнер обслуживать запросы. Ответ 404 означает, что путь не существует. При этом он информирует Службу приложений о том, что контейнер работоспособен и готов отвечать на запросы.

Выбор версии среды выполнения Java

Служба приложений позволяет пользователям выбрать основной номер версии виртуальной машины Java, например Java 8 или Java 11, а также номер исправления, например 1.8.0_232 или 11.0.5. Кроме того, можно выбрать автоматическое обновление номера исправления при появлении новых дополнительных версий. В большинстве случаев рабочие приложения должны использовать закрепленные версии JVM исправлений. Это предотвращает непредвиденные сбои во время автоматического обновления версии исправлений. Все веб-приложения Java используют 64-разрядные виртуальные машины JVM и не настраивается.

Если вы решили закрепить дополнительную версию, необходимо периодически обновлять дополнительную версию JVM в приложении. Чтобы убедиться, что приложение выполняется на более новой дополнительной версии, создайте промежуточный слот и добавите дополнительную версию в промежуточном слоте. Убедившись, что приложение работает правильно в новой дополнительной версии, вы можете переключить промежуточные и рабочие слоты.

<Connector port="${port.http}" address="127.0.0.1" maxHttpHeaderSize="16384" compression="on" URIEncoding="UTF-8" connectionTimeout="${site.connectionTimeout}" maxThreads="${catalina.maxThreads}" maxConnections="${catalina.maxConnections}" protocol="HTTP/1.1" redirectPort="8443"/>

az webapp config appsettings set --resource-group myResourceGroup --name myApp --settings WEBSITE_TOMCAT_CONNECTION_TIMEOUT=120000

az webapp config appsettings set --resource-group myResourceGroup --name myApp --settings WEBSITE_CATALINA_MAXTHREADS=100

az webapp config appsettings set --resource-group myResourceGroup --name myApp --settings WEBSITE_CATALINA_MAXCONNECTIONS=5000

<Host appBase="${site.appbase}" xmlBase="${site.xmlbase}" unpackWARs="${site.unpackwars}" workDir="${site.tempdir}" errorReportValveClass="com.microsoft.azure.appservice.AppServiceErrorReportValve" name="localhost" autoDeploy="true">

<Valve prefix="site_access_log.${catalina.instance.name}" pattern="%h %l %u %t &quot;%r&quot; %s %b %D %{x-arr-log-id}i" directory="${site.logdir}/http/RawLogs" maxDays="${site.logRetentionDays}" className="org.apache.catalina.valves.AccessLogValve" suffix=".txt"/>

Следующие шаги

Посетите центр Azure для разработчиков Java, чтобы найти краткие руководства Azure, руководства и справочную документацию по Java.

• Служба приложений под управлением Linux: вопросы и ответы
• Справка по переменным среды и параметрам приложений