Konfigurera datakällor för en Tomcat-, JBoss- eller Java SE-app i Azure App Service

Den här artikeln visar hur du konfigurerar datakällor i en Java SE-, Tomcat- eller JBoss-app i App Service.

Azure App Service kör Java-webbprogram på en fullständigt hanterad tjänst i tre varianter:

• Java SE – Kan köra en app som distribueras som ett JAR-paket som innehåller en inbäddad server (till exempel Spring Boot, Dropwizard, Quarkus eller en med en inbäddad Tomcat- eller Jetty-server).
• Tomcat – Den inbyggda Tomcat-servern kan köra en app som distribueras som ett WAR-paket.
• JBoss EAP – Stöds endast för Linux-appar på prisnivåerna Premium v3 och Isolerad v2. Den inbyggda JBoss EAP-servern kan köra en app som distribueras som ett WAR- eller EAR-paket.

Kommentar

För Spring-program rekommenderar vi att du använder Azure Spring Apps. Du kan dock fortfarande använda Azure App Service som mål. Mer information finns i Vägledning för Java-arbetsbelastningsmål.

Konfigurera datakällan

För att ansluta till datakällor i Spring Boot-program rekommenderar vi att du skapar anslutningssträng och matar in dem i filen application.properties.

1. I avsnittet "Konfiguration" på App Service-sidan anger du ett namn för strängen, klistrar in JDBC-anslutningssträng i värdefältet och anger typen "Anpassad". Du kan också ange den här anslutningssträng som platsinställning.

   Den här anslutningssträng är tillgänglig för vårt program som en miljövariabel med namnet CUSTOMCONNSTR_<your-string-name>. Exempel: CUSTOMCONNSTR_exampledb

2. I filen application.properties refererar du till den här anslutningssträng med miljövariabelns namn. I vårt exempel använder vi följande kod:

   app.datasource.url=${CUSTOMCONNSTR_exampledb}
   

Mer information finns i Spring Boot-dokumentationen om dataåtkomst och externaliserade konfigurationer.

Dricks

Som standard kan Linux Tomcat-containrar automatiskt konfigurera delade datakällor åt dig på Tomcat-servern. Det enda du kan göra är att lägga till en appinställning som innehåller en giltig JDBC-anslutningssträng till en Oracle-, SQL Server-, PostgreSQL- eller MySQL-databas (inklusive anslutningsautentiseringsuppgifterna) och App Service lägger automatiskt till den coo-svarande delade databasen till /usr/local/tomcat/conf/context.xml åt dig med hjälp av en lämplig drivrutin som är tillgänglig i containern. Ett scenario från slutpunkt till slutpunkt med den här metoden finns i Självstudie: Skapa en Tomcat-webbapp med Azure App Service på Linux och MySQL.

De här anvisningarna gäller för alla databasanslutningar. Du måste fylla platshållarna med den valda databasens drivrutinsklassnamn och JAR-fil. Tillhandahålls är en tabell med klassnamn och drivrutinsnedladdningar för vanliga databaser.

Databas	Namn på drivrutinsklass	JDBC-drivrutin
PostgreSQL	org.postgresql.Driver	Ladda ned
MySQL	com.mysql.jdbc.Driver	Ladda ned (välj "Plattformsoberoende")
SQL Server	com.microsoft.sqlserver.jdbc.SQLServerDriver	Ladda ned

Om du vill konfigurera Tomcat att använda Java Database Connectivity (JDBC) eller Java Persistence API (JPA) anpassar CATALINA_OPTS du först miljövariabeln som tomcat läser in vid start. Ange dessa värden via en appinställning i Plugin-programmet App Service Maven:

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

Eller ange miljövariablerna på sidan Inställningar för konfigurationsprogram>i Azure Portal.

Bestäm sedan om datakällan ska vara tillgänglig för ett program eller för alla program som körs på Tomcat-servleten.

Datakällor på programnivå

1. Skapa en context.xml fil i meta-INF/ -katalogen i projektet. Skapa meta-INF/-katalogen om den inte finns.

2. I context.xml lägger du till ett Context element för att länka datakällan till en JNDI-adress. driverClassName Ersätt platshållaren med drivrutinens klassnamn från tabellen ovan.

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

3. Uppdatera programmets web.xml för att använda datakällan i ditt program.

   <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>
   

Delade resurser på servernivå

Linux

Om du lägger till en delad datakälla på servernivå måste du redigera Tomcats server.xml. Det mest tillförlitliga sättet att göra detta på är följande:

1. Ladda upp ett startskript och ange sökvägen till skriptet i Startkommando för konfiguration>. Du kan ladda upp startskriptet med FTP.

Startskriptet gör en xsl-transformering till server.xml-filen och matar ut den resulterande XML-filen till /usr/local/tomcat/conf/server.xml. Startskriptet ska installera libxslt via apk. XSL-filen och startskriptet kan laddas upp via FTP. Nedan visas ett exempel på ett startskript.

# Install libxslt. Also copy the transform file to /home/tomcat/conf/
apk add --update libxslt

# 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

I följande exempel lägger XSL-filen till en ny anslutningsnod i 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 Connnector if there's 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>

Slutför konfigurationen

Placera slutligen drivrutins-JAR:erna i Tomcat-klassökvägen och starta om App Service.

1. Kontrollera att JDBC-drivrutinsfilerna är tillgängliga för Tomcat-klassladdaren genom att placera dem i katalogen /home/site/lib . I Cloud Shell kör du az webapp deploy --type=lib för varje drivrutins-JAR:

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

Om du har skapat en datakälla på servernivå startar du om App Service Linux-programmet. Tomcat återställs CATALINA_BASE till /home/tomcat och använder den uppdaterade konfigurationen.

Windows

Du kan inte direkt ändra en Tomcat-installation för serveromfattande konfiguration eftersom installationsplatsen är skrivskyddad. För att göra konfigurationsändringar på servernivå i windows Tomcat-installationen är det enklaste sättet att göra följande vid appstart:

1. Kopiera Tomcat till en lokal katalog (%LOCAL_EXPANDED%) och använd den som CATALINA_BASE (se Tomcat-dokumentation om den här variabeln).
2. Lägg till dina delade datakällor i %LOCAL_EXPANDED%\tomcat\conf\server.xml med XSL-transformering.

Lägga till en startfil

Skapa en fil med namnet startup.cmd %HOME%\site\wwwroot directory. Den här filen körs automatiskt innan Tomcat-servern startar. Filen bör ha följande innehåll:

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

Lägga till PowerShell-konfigurationsskriptet

Lägg sedan till konfigurationsskriptet med namnet configure.ps1 i katalogen %HOME%_\site med följande kod:

# Locations of xml and xsl files
$target_xml="$Env:LOCAL_EXPANDED\tomcat\conf\server.xml"
$target_xsl="$Env:HOME\site\server.xsl"

# 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
        echo  'Error'$ErrorMessage':'$FailedItem':' $_.Exception;
        return 0
    }
    return 1
}

# Start here

# Check for marker file indicating that config has already been done
if(Test-Path "$Env:LOCAL_EXPANDED\tomcat\config_done_marker"){
    return 0
}

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

md -Path "$Env:LOCAL_EXPANDED\tomcat"

# Copy Tomcat to local
# Using the environment variable $AZURE_TOMCAT90_HOME uses the 'default' version of Tomcat
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 $target_xml -xsl $target_xsl -output $target_xml

# Mark that the operation was a success if successful
if($success){
    New-Item -Path "$Env:LOCAL_EXPANDED\tomcat\config_done_marker" -ItemType File
}

Det här PowerShell slutför följande steg:

1. Kontrollera om det redan finns en anpassad Tomcat-kopia. Om det gör det kan startskriptet sluta här.
2. Kopiera Tomcat lokalt.
3. Lägg till delade datakällor i den anpassade Tomcat-konfigurationen med XSL-transformering.
4. Ange att konfigurationen har slutförts.

Lägg till XSL-transformeringsfil

Ett vanligt användningsfall för att anpassa den inbyggda Tomcat-installationen är att ändra konfigurationsfilerna server.xml, context.xmleller web.xml Tomcat. App Service ändrar redan dessa filer för att tillhandahålla plattformsfunktioner. Om du vill fortsätta att använda dessa funktioner är det viktigt att bevara innehållet i dessa filer när du gör ändringar i dem. För att åstadkomma detta använder du en XSL-transformering (XSLT).

Lägg till en XSL-transformeringsfil med namnet configure.ps1 i katalogen %HOME%_\site . Du kan använda följande XSL-transformeringskod för att lägga till en ny anslutningsnod i server.xml. Identitetstransformeringen i början bevarar det ursprungliga innehållet i konfigurationsfilen.

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

    <!-- Identity transform: this 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 Connnector if there's 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>

Ange CATALINA_BASE appinställning

Plattformen måste också veta var din anpassade version av Tomcat är installerad. Du kan ange installationens plats i appinställningen CATALINA_BASE .

Du kan använda Azure CLI för att ändra den här inställningen:

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

Eller så kan du ändra inställningen manuellt i Azure Portal:

1. Gå till Inställningar>KonfigurationSprograminställningar>.
2. Välj Ny programinställning.
3. Använd dessa värden för att skapa inställningen:
   1. Namn: CATALINA_BASE
   2. Värde: "%LOCAL_EXPANDED%\tomcat"

Slutför konfigurationen

Slutligen placerar du drivrutins-JAR:erna i Tomcat-klassökvägen och startar om Din App Service. Kontrollera att JDBC-drivrutinsfilerna är tillgängliga för Tomcat-klassladdaren genom att placera dem i katalogen /home/site/lib . I Cloud Shell kör du az webapp deploy --type=lib för varje drivrutins-JAR:

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

Det finns tre grundläggande steg när du registrerar en datakälla med JBoss EAP: ladda upp JDBC-drivrutinen, lägga till JDBC-drivrutinen som en modul och registrera modulen. App Service är en tillståndslös värdtjänst, så konfigurationskommandona för att lägga till och registrera datakällmodulen måste skriptas och tillämpas när containern startar.

1. Hämta databasens JDBC-drivrutin.

2. Skapa en XML-moduldefinitionsfil för JDBC-drivrutinen. I följande exempel visas en moduldefinition för PostgreSQL.

   <?xml version="1.0" ?>
   <module xmlns="urn:jboss:module:1.1" name="org.postgres">
       <resources>
       <!-- ***** IMPORTANT : REPLACE THIS PLACEHOLDER *******-->
       <resource-root path="/home/site/deployments/tools/postgresql-42.2.12.jar" />
       </resources>
       <dependencies>
           <module name="javax.api"/>
           <module name="javax.transaction.api"/>
       </dependencies>
   </module>
   

3. Placera dina JBoss CLI-kommandon i en fil med namnet jboss-cli-commands.cli. JBoss-kommandona måste lägga till modulen och registrera den som en datakälla. I följande exempel visas JBoss CLI-kommandona för PostgreSQL.

   #!/usr/bin/env bash
   module add --name=org.postgres --resources=/home/site/deployments/tools/postgresql-42.2.12.jar --module-xml=/home/site/deployments/tools/postgres-module.xml
   
   /subsystem=datasources/jdbc-driver=postgres:add(driver-name="postgres",driver-module-name="org.postgres",driver-class-name=org.postgresql.Driver,driver-xa-datasource-class-name=org.postgresql.xa.PGXADataSource)
   
   data-source add --name=postgresDS --driver-name=postgres --jndi-name=java:jboss/datasources/postgresDS --connection-url=${POSTGRES_CONNECTION_URL,env.POSTGRES_CONNECTION_URL:jdbc:postgresql://db:5432/postgres} --user-name=${POSTGRES_SERVER_ADMIN_FULL_NAME,env.POSTGRES_SERVER_ADMIN_FULL_NAME:postgres} --password=${POSTGRES_SERVER_ADMIN_PASSWORD,env.POSTGRES_SERVER_ADMIN_PASSWORD:example} --use-ccm=true --max-pool-size=5 --blocking-timeout-wait-millis=5000 --enabled=true --driver-class=org.postgresql.Driver --exception-sorter-class-name=org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLExceptionSorter --jta=true --use-java-context=true --valid-connection-checker-class-name=org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLValidConnectionChecker
   

4. Skapa ett startskript som startup_script.sh anropar JBoss CLI-kommandona. I följande exempel visas hur du anropar din jboss-cli-commands.cli. Senare konfigurerar du App Service för att köra det här skriptet när containern startar.

   $JBOSS_HOME/bin/jboss-cli.sh --connect --file=/home/site/deployments/tools/jboss-cli-commands.cli
   

5. Med valfri FTP-klient laddar du upp JDBC-drivrutinen, jboss-cli-commands.cli, startup_script.shoch moduldefinitionen till /site/deployments/tools/.

6. Konfigurera platsen så att den körs startup_script.sh när containern startar. I Azure Portal går du till Startkommando för konfiguration>av allmänna inställningar>. Ange startkommandofältet till /home/site/deployments/tools/startup_script.sh. Spara dina ändringar.

För att bekräfta att datakällan har lagts till i JBoss-servern, SSH i webbappen och kör $JBOSS_HOME/bin/jboss-cli.sh --connect. När du är ansluten till JBoss kör /subsystem=datasources:read-resource du för att skriva ut en lista över datakällorna.

Nästa steg

Besök Azure for Java Developers Center för att hitta Azure-snabbstarter, självstudier och Java-referensdokumentation.

• Vanliga frågor och svar om App Service på Linux
• Referens för miljövariabler och appinställningar