在 Azure 应用服务中为 Tomcat 或 Java SE 应用配置数据源

本文介绍如何在应用服务中的 Java SE Tomcat 应用中配置数据源。

Azure 应用服务在完全托管服务上以两种类型运行Java Web 应用程序：

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

配置数据源

若要连接 Spring Boot 中的数据源，我们建议创建连接字符串并将它们注入 application.properties 文件中。

在“应用服务”页的左窗格中，选择 “设置>环境变量”。在 “连接字符串 ”选项卡上，选择“ 添加”。设置字符串 的名称 ，将 JDBC 连接字符串粘贴到 “值 ”字段中，并将类型设置为 “自定义”。可以将连接字符串可选地设置为插槽设置。

应用程序可以将连接字符串作为名为 CUSTOMCONNSTR_<your-string-name> 的环境变量来访问。例如 CUSTOMCONNSTR_exampledb。
在 application.properties 文件中，使用环境变量名称引用连接字符串。对于前面的示例，你将使用此代码：
```
app.datasource.url=${CUSTOMCONNSTR_exampledb}
```

有关详细信息，请参阅有关数据访问和外部化配置的 Spring Boot 文档。

提示

如果将环境变量设置为 WEBSITE_AUTOCONFIGURE_DATABASEtrue，Linux Tomcat 容器可以在 Tomcat 服务器中自动配置共享数据源。唯一要做的就是将包含有效 JDBC 连接字符串的应用设置添加到 Oracle、SQL Server、PostgreSQL 或 MySQL 数据库（包括连接凭据）。应用服务使用容器中可用的相应驱动程序自动将相应的共享数据库添加到 /usr/local/tomcat/conf/context.xml。

这些说明适用于所有数据库连接。需要将占位符替换为所选数据库的驱动程序类名称和 JAR 文件。下表提供常见数据库的类名和驱动程序下载。

数据库	驱动程序类名称	JDBC 驱动程序
PostgreSQL	`org.postgresql.Driver`	下载
MySQL	`com.mysql.jdbc.Driver`	下载（选择平台独立。）
SQL Server	`com.microsoft.sqlserver.jdbc.SQLServerDriver`	下载

若要将 Tomcat 配置为使用 Java 数据库连接（JDBC）或 Java 持久性 API （JPA），请先自定义 CATALINA_OPTS 启动时 Tomcat 读取的环境变量。在应用服务 Maven 插件中使用应用设置设置此值：

<appSettings>
    <property>
        <name>CATALINA_OPTS</name>
        <value>"$CATALINA_OPTS -Ddbuser=${DBUSER} -Ddbpassword=${DBPASSWORD} -DconnURL=${CONNURL}"</value>
    </property>
</appSettings>

或在 Azure 门户中“设置环境变量”页的“>”选项卡上设置环境变量。

接下来，确定数据源是否适用于一个应用程序或 Tomcat servlet 上运行的所有应用程序。

应用程序级的数据源

若要配置应用程序级数据源，请执行以下作：

在项目的 META-INF/ 目录中创建一个 context.xml 文件。如果没有 META-INF/ 目录，请创建一个。

在 context.xml 中，添加一个 Context 元素以将数据源链接到 JNDI 地址。将 driverClassName 占位符替换为本文前面显示的表中驱动程序的类名。

<Context>
    <Resource
        name="jdbc/dbconnection"
        type="javax.sql.DataSource"
        url="${connURL}"
        driverClassName="<insert your driver class name>"
        username="${dbuser}"
        password="${dbpassword}"
    />
</Context>

更新应用程序的 web.xml 以便在应用程序中使用该数据源。

<resource-env-ref>
    <resource-env-ref-name>jdbc/dbconnection</resource-env-ref-name>
    <resource-env-ref-type>javax.sql.DataSource</resource-env-ref-type>
</resource-env-ref>

提示

Linux Tomcat 容器可以通过对复制到 /home/site/wwwroot的文件使用以下约定自动应用 XSLT 文件：如果 server.xml.xsl 或 server.xml.xslt 存在，这些文件将应用于 Tomcat 的文件 server.xml。如果 context.xml.xsl 存在或 context.xml.xslt 存在，这些文件将应用于 Tomcat 的 context.xml。

添加共享的服务器级数据源需要编辑 Tomcat 的 server.xml。由于目录外部 /home 的文件更改是临时的，因此需要以编程方式应用 Tomcat 配置文件的更改，如下所示：

上传启动脚本，并在“设置配置”>中设置脚本的路径。在 “堆栈设置 ”选项卡上，在 “启动”命令 框中添加路径。可以使用 FTP 上传启动脚本。

启动脚本将 XSL 转换到 server.xml 该文件，并将生成的 XML 文件输出到 /usr/local/tomcat/conf/server.xml。启动脚本应安装 libxslt ，或者 xlstproc，具体取决于 Web 应用的 Tomcat 版本的分发，如以下示例脚本中的注释中所述。可以使用 FTP 上传 XSL 文件和启动脚本。

# Install the libxslt package on Alpine-based images:
apk add --update libxslt

# Install the xsltproc package on Debian or Ubuntu-based images:
apt install xsltproc

# Also copy the transform file to /home/tomcat/conf/
# Usage: xsltproc --output output.xml style.xsl input.xml
xsltproc --output /home/tomcat/conf/server.xml /home/tomcat/conf/transform.xsl /usr/local/tomcat/conf/server.xml

以下示例 XSL 文件向 Tomcat server.xml 添加了一个新的连接器节点。

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output method="xml" indent="yes"/>

  <xsl:template match="@* | node()" name="Copy">
    <xsl:copy>
      <xsl:apply-templates select="@* | node()"/>
    </xsl:copy>
  </xsl:template>

  <xsl:template match="@* | node()" mode="insertConnector">
    <xsl:call-template name="Copy" />
  </xsl:template>

  <xsl:template match="comment()[not(../Connector[@scheme = 'https']) and
                                 contains(., '&lt;Connector') and
                                 (contains(., 'scheme=&quot;https&quot;') or
                                  contains(., &quot;scheme='https'&quot;))]">
    <xsl:value-of select="." disable-output-escaping="yes" />
  </xsl:template>

  <xsl:template match="Service[not(Connector[@scheme = 'https'] or
                                   comment()[contains(., '&lt;Connector') and
                                             (contains(., 'scheme=&quot;https&quot;') or
                                              contains(., &quot;scheme='https'&quot;))]
                                  )]
                      ">
    <xsl:copy>
      <xsl:apply-templates select="@* | node()" mode="insertConnector" />
    </xsl:copy>
  </xsl:template>

  <!-- Add the new connector after the last existing connector if there is one -->
  <xsl:template match="Connector[last()]" mode="insertConnector">
    <xsl:call-template name="Copy" />

    <xsl:call-template name="AddConnector" />
  </xsl:template>

  <!-- ... or before the first engine if there's no existing connector -->
  <xsl:template match="Engine[1][not(preceding-sibling::Connector)]"
                mode="insertConnector">
    <xsl:call-template name="AddConnector" />

    <xsl:call-template name="Copy" />
  </xsl:template>

  <xsl:template name="AddConnector">
    <!-- Add new line -->
    <xsl:text>&#xa;</xsl:text>
    <!-- This is the new connector -->
    <Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true" 
               maxThreads="150" scheme="https" secure="true" 
               keystoreFile="${{user.home}}/.keystore" keystorePass="changeit"
               clientAuth="false" sslProtocol="TLS" />
  </xsl:template>

</xsl:stylesheet>

完成配置

最后，将驱动程序 JAR 放置在 Tomcat 类路径中并重启应用服务应用。

将 JDBC 驱动程序文件放入 /home/site/lib 目录，确保它们可供 Tomcat 类加载器使用。在 Cloud Shell 中，为每个驱动程序 JAR 运行 az webapp deploy --type=lib：

az webapp deploy --resource-group <group-name> --name <app-name> --src-path <jar-name>.jar --type=lib --path <jar-name>.jar

如果你创建了服务器级数据源，请重启应用服务 Linux 应用程序。 Tomcat 会将 CATALINA_BASE 重置为 /home/tomcat 并使用更新的配置。

你无法直接修改服务器级配置的 Tomcat 安装，因为安装位置是只读属性。对 Windows Tomcat 安装进行服务器级配置更改的最简单方法是在应用启动时完成以下步骤：

将 Tomcat 复制到本地目录（%LOCAL_EXPANDED%）并使用该副本作为 CATALINA_BASE。（请参阅有关此变量的 Tomcat 文档）。
使用 XSL 转换将您的共享数据源添加到 %LOCAL_EXPANDED%\tomcat\conf\server.xml。

添加启动文件

在startup.cmd目录中创建名为%HOME%\site\wwwroot的文件。此文件在 Tomcat 服务器启动之前自动运行。该文件应包含以下内容：

C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -File  %HOME%\site\configure.ps1 > %HOME%\site\configure.log

添加 PowerShell 配置脚本

接下来，将调用 configure.ps1 的配置脚本添加到 %HOME%\site 目录。该脚本包含以下代码：

# Locations of XML and XSL files
$source_xml = "$Env:AZURE_TOMCAT90_HOME\conf\server.xml"
$target_xml = "$Env:LOCAL_EXPANDED\tomcat\conf\server.xml"
$target_xsl = "$Env:HOME\site\server.xsl"
$marker_file = "$Env:HOME\site\config_done_marker"

# Define the transform function
# Useful if transforming multiple files
function TransformXML {
    param ($xml, $xsl, $output)

    if (-not $xml -or -not $xsl -or -not $output) {
        return 0
    }

    Try {
        $xslt_settings = New-Object System.Xml.Xsl.XsltSettings;
        $XmlUrlResolver = New-Object System.Xml.XmlUrlResolver;
        $xslt_settings.EnableScript = 1;

        $xslt = New-Object System.Xml.Xsl.XslCompiledTransform;
        $xslt.Load($xsl, $xslt_settings, $XmlUrlResolver);
        $xslt.Transform($xml, $output);
    }

    Catch {
        $ErrorMessage = $_.Exception.Message
        $FailedItem = $_.Exception.ItemName
        Write-Error 'Error'$ErrorMessage':'$FailedItem':' $_.Exception;
        return 0
    }
    return 1
}

# Start here

# Check for marker file indicating that configuration has already been done
if (Test-Path "$marker_file") {
    return 0
}

# Delete previous Tomcat directory if it exists
# In case previous configuration isn't completed or a new configuration should be forcefully installed
if (Test-Path "$Env:LOCAL_EXPANDED\tomcat") {
    Remove-Item -Path "$Env:LOCAL_EXPANDED\tomcat" -Recurse -Force
}

# Copy Tomcat to local
# When you use the environment variable $AZURE_TOMCAT90_HOME, the 'default' version of Tomcat is used
New-Item "$Env:LOCAL_EXPANDED\tomcat" -ItemType Directory
Copy-Item -Path "$Env:AZURE_TOMCAT90_HOME\*" "$Env:LOCAL_EXPANDED\tomcat" -Recurse

# Perform the required customization of Tomcat
$success = TransformXML -xml $source_xml -xsl $target_xsl -output $target_xml

# Mark that the operation succeeded if it did
if ($success) {
    New-Item -Path "$marker_file" -ItemType File
}

此 PowerShell 将完成以下步骤：

检查是否存在自定义 Tomcat 副本。如果存在，启动脚本可以停止。
本地复制 Tomcat。
使用 XSL 转换将共享数据源添加到自定义 Tomcat 的配置。
指示配置已成功完成。

添加 XSL 转换文件

自定义内置 Tomcat 安装的常见用例是修改 server.xml、context.xml 或 web.xml Tomcat 配置文件。应用服务已修改这些文件以提供平台功能。若要继续使用这些功能，需要在更改这些文件时保留这些文件的内容。若要保留此内容，请使用 XSL 转换（XSLT）。

将名为 server.xsl 的 XSL 转换文件添加到 %HOME%_\site 目录。可以使用以下 XSL 转换代码将新的连接器节点添加到 server.xml。开头的“identity transform”将会保留配置文件的原始内容。

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
    <xsl:output method="xml" indent="yes"/>

    <!-- Identity transform: this transform ensures that the original contents of the file are included in the new file -->
    <!-- Ensure that your transform files include this block -->
    <xsl:template match="@* | node()" name="Copy">
      <xsl:copy>
        <xsl:apply-templates select="@* | node()"/>
      </xsl:copy>
    </xsl:template>

    <xsl:template match="@* | node()" mode="insertConnector">
      <xsl:call-template name="Copy" />
    </xsl:template>

    <xsl:template match="comment()[not(../Connector[@scheme = 'https']) and
                                   contains(., '&lt;Connector') and
                                   (contains(., 'scheme=&quot;https&quot;') or
                                    contains(., &quot;scheme='https'&quot;))]">
      <xsl:value-of select="." disable-output-escaping="yes" />
    </xsl:template>

    <xsl:template match="Service[not(Connector[@scheme = 'https'] or
                                     comment()[contains(., '&lt;Connector') and
                                               (contains(., 'scheme=&quot;https&quot;') or
                                                contains(., &quot;scheme='https'&quot;))]
                                    )]
                        ">
      <xsl:copy>
        <xsl:apply-templates select="@* | node()" mode="insertConnector" />
      </xsl:copy>
    </xsl:template>

    <!-- Add the new connector after the last existing connector if there is one -->
    <xsl:template match="Connector[last()]" mode="insertConnector">
      <xsl:call-template name="Copy" />

      <xsl:call-template name="AddConnector" />
    </xsl:template>

    <!-- ... or before the first engine if there's no existing connector -->
    <xsl:template match="Engine[1][not(preceding-sibling::Connector)]"
                  mode="insertConnector">
      <xsl:call-template name="AddConnector" />

      <xsl:call-template name="Copy" />
    </xsl:template>

    <xsl:template name="AddConnector">
      <!-- Add new line -->
      <xsl:text>&#xa;</xsl:text>
      <!-- This is the new connector -->
      <Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true" 
                 maxThreads="150" scheme="https" secure="true" 
                 keystoreFile="${{user.home}}/.keystore" keystorePass="changeit"
                 clientAuth="false" sslProtocol="TLS" />
    </xsl:template>

</xsl:stylesheet>

设置`CATALINA_BASE` 应用配置

平台还需要了解自定义版本的 Tomcat 的安装位置。可以在 CATALINA_BASE 应用设置中设置安装的位置。

可以使用 Azure CLI 更改此设置：

    az webapp config appsettings set -g $MyResourceGroup -n $MyUniqueApp --settings CATALINA_BASE="%LOCAL_EXPANDED%\tomcat"

或者，可以在 Azure 门户中手动更改设置：

转到 “设置>环境变量>”应用设置。
选择 并添加。
使用以下值创建设置：
1. 名称：CATALINA_BASE
2. 值："%LOCAL_EXPANDED%\tomcat"

完成配置

最后，将驱动程序 JAR 放置在 Tomcat 类路径中并重启你的应用服务。将 JDBC 驱动程序文件放入 /home/site/lib 目录，确保它们可供 Tomcat 类加载器使用。在 bash 中，为每个驱动程序 JAR 运行 az webapp deploy --type=lib：

az webapp deploy --resource-group <group-name> --name <app-name> --src-path <jar-name>.jar --type=lib --target-path <jar-name>.jar

Last updated on 2026-05-09

在 Azure 应用服务中为 Tomcat 或 Java SE 应用配置数据源

配置数据源

应用程序级的数据源

共享的服务器级资源

完成配置

相关内容

其他資源