在 Azure 应用服务中部署和配置 Tomcat 或 Java SE 应用

本文介绍 Azure 应用服务中 Java 应用的最常见部署和运行时配置。 如果是第一次使用 Azure 应用服务，则应首先阅读 Java 快速入门。 可以在 应用服务常见问题解答中找到有关使用应用服务（不特定于 Java 开发）的一般问题的解答。

Azure 应用服务以三种形式在完全托管的服务上运行 Java Web 应用程序：

• Java Standard Edition （SE）：可以运行部署为 Java 存档 （JAR） 包的应用，其中包含嵌入式服务器（例如 Spring Boot、Quarkus、Dropwizard 或具有嵌入式 Tomcat 或 Jetty 服务器的应用）。
• Tomcat：内置 Tomcat 服务器可以运行部署为 Web 应用程序存档（WAR）包的应用。

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

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

java -version

sh /usr/local/tomcat/version.sh

find / -name "version.sh"

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

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

有关版本支持的详细信息，请参阅应用服务语言运行时支持策略。

过时的运行时被维护组织弃用，或者被发现存在重大漏洞。 因此，将从门户中的创建和配置页面中删除它们。 当门户中隐藏了过时的运行时后，任何仍使用该运行时的应用程序都会继续运行。

如果要创建具有门户上不再显示的过时运行时版本的应用，请使用 Azure CLI、ARM 模板或 Bicep。 通过这些部署替代方法，可以创建已在门户中移除的但仍受支持的弃用运行时。

如果从应用服务平台完全删除运行时，Azure 订阅所有者会在删除之前收到电子邮件通知。

通过使用 适用于 Azure Web 应用的 Maven 插件，可以使用项目根目录中的一个命令轻松准备项目：

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

此命令通过提示选择现有 Azure Web 应用或创建新应用来添加 azure-webapp-maven-plugin 插件和相关配置。 在配置期间，它会尝试检测应用程序是否应部署到 Java Standard Edition（SE）、Tomcat。 然后可以使用以下命令将 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> 

1. 通过将适用于 Azure Web 应用的 Gradle 插件添加到 build.gradle 来设置该插件:

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

2. 配置 Web 应用详细信息。 如果相应的 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
   

Azure 在常用的 Java 集成开发环境中提供无缝的 Java 应用服务开发体验，包括：

• VS Code： 使用 Visual Studio Code 的 Java Web 应用。
• IntelliJ IDEA： 使用 IntelliJ 为 Azure 应用服务创建 Hello World Web 应用。
• Eclipse IDE： 使用 Eclipse 为 Azure 应用服务创建 Hello World Web 应用。

Maven 插件、使用 azure/webapps-deploy@v3 和更新版本的 GitHub Actions 或 az webapp deploy 命令等部署客户端使用 OneDeploy，它通过在后台调用 Kudu 站点的 /api/publish 终结点进行调用。 有关此 API 的详细信息，请参阅此文档。

不要使用 FTP 部署 WAR 或 JAR。 FTP 工具设计用来上传启动脚本、依赖项或其他运行时文件。 它不是用于部署 Web 应用的最佳选项。

若要重写或重定向 URL，请使用某个可用的 URL 重写程序，例如 UrlRewriteFilter。

可以通过 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>

若要通过容器打开直接的 SSH 会话，应用应该处于正在运行状态。

将以下 URL 粘贴到浏览器中，将 <app-name> 替换为应用名称：

https://<app-name>.scm.chinacloudsites.cn/webssh/host

如果尚未进行身份验证，则需通过要连接的 Azure 订阅进行身份验证。 完成身份验证以后，可以看到一个浏览器内 shell，可以在其中的容器中运行命令。

若要从本地计算机打开远程 SSH 会话，请参阅从远程 shell 打开 SSH 会话。

内置的 Java 映像建立在 Alpine Linux 操作系统上。 使用 apk 包管理器安装任何故障排除工具或命令。

Azure 应用服务上的所有 Java 运行时都附带 Java 开发工具包 (JDK) 飞行记录器，用于分析 Java 工作负载。 可以使用它来记录 Java 虚拟机（JVM）、系统和应用程序事件，以及排查应用程序中的问题。

若要了解有关 Java 探查器的详细信息，请访问 Azure Application Insights 文档。

应用服务上的所有 Java 运行时都附带 Java Flight Recorder。 可以使用它记录 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"

使用 FTPS 将 JFR 文件下载到本地计算机。 若要分析 JFR 文件，请下载并安装 Java Mission Control （JMC）。 有关如何使用 Java Mission Control 的说明，请参阅 JMC 文档 和 安装说明。

如果应用程序使用 Logback 或 Log4j 进行跟踪，则可以将这些跟踪转发到 Azure Application Insights 中以供查看。 使用日志记录框架配置说明，参考Application Insights 中的探索 Java 跟踪日志。

Azure 应用服务原生支持通过 Azure 门户和 Azure CLI 进行优化和自定义。 请查看以下文章了解非特定于 Java 的 Web 应用配置：

• 配置应用设置
• 设置自定义域
• 配置 TLS/SSL 绑定
• 配置 Kudu 站点

将应用设置 JAVA_COPY_ALL 设为 true，以将应用内容从共享文件系统复制到本地辅助角色。 此设置有助于解决文件锁定问题。

若要设置分配的内存或其他 JVM 运行时选项，请使用这些选项创建名为 的JAVA_OPTS。 应用服务在启动时，会将此设置作为环境变量传递给 Java 运行时。

若要通过 Maven 插件配置应用设置，请在 Azure 插件部分中添加设置/值标记。 以下示例设置特定的最小和最大 Java 堆大小：

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

默认情况下，应用服务会将 JVM 最大堆大小设置为应用服务计划可用的总内存的 70%。 若要禁用默认设置，可以使用应用设置WEBSITE_DISABLE_JAVA_HEAP_CONFIGURATION=“true”。

增强应用程序在平台上的性能可能涉及调整堆大小，以更好地满足特定需求。 优化应用程序堆设置时，请查看应用服务计划详细信息，并考虑多个应用程序和部署槽的要求来查找最佳内存分配。

在 Azure 门户中应用程序的“应用程序设置”中启用 Web 套接字支持。 需要重启应用程序才能使设置生效。

通过以下命令使用 Azure CLI 启用 Web 套接字支持：

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 门户中 Web 应用的“应用程序设置”下，创建名为 且包含值 JAVA_OPTS 的新应用设置。

或者，可以使用应用服务 Maven 插件配置应用设置。 在插件配置中添加设置名称和值标记：

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

你可能会在容器日志中看到以下消息：

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 响应只是指示该路径不存在，但它让应用服务知道容器处于正常状态并已准备就绪，可以响应请求。

应用服务允许用户选择 JVM 的主版本（例如 Java 8 或 Java 11）和补丁版本（例如 1.8.0_232 或 11.0.5）。 还可以选择在新的次要版本可用时自动更新补丁版本。 在大多数情况下，生产应用应使用 JVM 的固定补丁版本。 这可防止在补丁版本自动更新期间发生意外中断。 所有 Java Web 应用都使用 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"/>

<xsl:attribute name="appServiceErrorPage">
    <xsl:value-of select="'${appService.valves.appServiceErrorPage}'"/>
</xsl:attribute>

<xsl:attribute name="showReport">
    <xsl:value-of select="'${catalina.valves.showReport}'"/>
</xsl:attribute>

<xsl:attribute name="showServerInfo">
    <xsl:value-of select="'${catalina.valves.showServerInfo}'"/>
</xsl:attribute>

请访问面向 Java 开发人员的 Azure 中心查找 Azure 快速入门、教程和 Java 参考文档。

• 应用服务 Linux 常见问题解答
• 环境变量和应用设置参考