Configurar fontes de dados para um aplicativo Tomcat, JBoss ou Java SE no Serviço de Aplicativo do Azure

Este artigo mostra como configurar fontes de dados em um aplicativo Java SE, Tomcat ou JBoss no Serviço de Aplicativo.

O Serviço de Aplicativo do Azure executa aplicativos Web Java em um serviço totalmente gerenciado em três variantes:

• Java SE - Pode executar um aplicativo implantado como um pacote JAR que contém um servidor incorporado (como Spring Boot, Dropwizard, Quarkus ou um com um servidor Tomcat ou Jetty incorporado).
• Tomcat - O servidor Tomcat integrado pode executar um aplicativo implantado como um pacote WAR.
• JBoss EAP - Suportado apenas para aplicativos Linux nos níveis de preços Premium v3 e Isolated v2. O servidor JBoss EAP integrado pode executar um aplicativo implantado como um pacote WAR ou EAR.

Nota

Para aplicativos Spring, recomendamos o uso do Azure Spring Apps. No entanto, você ainda pode usar o Serviço de Aplicativo do Azure como destino. Consulte Java Workload Destination Guidance para obter conselhos.

Configurar a fonte de dados

Para se conectar a fontes de dados em aplicativos Spring Boot, sugerimos criar cadeias de conexão e injetá-las em seu arquivo application.properties .

1. Na seção "Configuração" da página Serviço de Aplicativo, defina um nome para a cadeia de caracteres, cole a cadeia de conexão JDBC no campo de valor e defina o tipo como "Personalizado". Opcionalmente, você pode definir essa cadeia de conexão como configuração de slot.

   Essa cadeia de conexão é acessível ao nosso aplicativo como uma variável de ambiente chamada CUSTOMCONNSTR_<your-string-name>. Por exemplo, CUSTOMCONNSTR_exampledb.

2. No arquivo application.properties , faça referência a essa cadeia de conexão com o nome da variável de ambiente. Para o nosso exemplo, usaríamos o seguinte código:

   app.datasource.url=${CUSTOMCONNSTR_exampledb}
   

Para obter mais informações, consulte a documentação do Spring Boot sobre acesso a dados e configurações externalizadas.

Gorjeta

Por padrão, os contêineres do Linux Tomcat podem configurar automaticamente fontes de dados compartilhadas para você no servidor Tomcat. A única coisa a fazer é adicionar uma configuração de aplicativo que contenha uma cadeia de conexão JDBC válida a um banco de dados Oracle, SQL Server, PostgreSQL ou MySQL (incluindo as credenciais de conexão), e o Serviço de Aplicativo adiciona automaticamente o banco de dados compartilhado cooresponding a /usr/local/tomcat/conf/context.xml para você, usando um driver apropriado disponível no contêiner. Para obter um cenário de ponta a ponta usando essa abordagem, consulte Tutorial: Criar um aplicativo Web Tomcat com o Serviço de Aplicativo do Azure no Linux e no MySQL.

Estas instruções se aplicam a todas as conexões de banco de dados. Você precisa preencher os espaços reservados com o nome da classe de driver do banco de dados escolhido e o arquivo JAR. Fornecida é uma tabela com nomes de classe e downloads de drivers para bancos de dados comuns.

Base de Dados	Nome da classe do driver	Controlador JDBC
PostgreSQL	org.postgresql.Driver	Transferir
MySQL	com.mysql.jdbc.Driver	Download (Selecione "Independente da plataforma")
SQL Server	com.microsoft.sqlserver.jdbc.SQLServerDriver	Transferir

Para configurar o Tomcat para usar o Java Database Connectivity (JDBC) ou a Java Persistence API (JPA), primeiro personalize a variável de ambiente que é lida CATALINA_OPTS pelo Tomcat na inicialização. Defina esses valores por meio de uma configuração de aplicativo no plug-in do App Service Maven:

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

Ou defina as variáveis de ambiente na página Definições do Aplicativo de Configuração>no portal do Azure.

Em seguida, determine se a fonte de dados deve estar disponível para um aplicativo ou para todos os aplicativos em execução no servlet Tomcat.

Fontes de dados no nível do aplicativo

1. Crie um arquivo context.xml no diretório META-INF/ do seu projeto. Crie o diretório META-INF/ se ele não existir.

2. No context.xml, adicione um Context elemento para vincular a fonte de dados a um endereço JNDI. Substitua o espaço reservado driverClassName pelo nome da classe do motorista na tabela acima.

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

3. Atualize a web.xml do seu aplicativo para usar a fonte de dados em seu aplicativo.

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

Recursos compartilhados no nível do servidor

Linux

Adicionar uma fonte de dados compartilhada no nível do servidor requer que você edite o server.xml do Tomcat. A maneira mais confiável de fazer isso é a seguinte:

1. Carregue um script de inicialização e defina o caminho para o script em Configuration>Startup Command. Você pode carregar o script de inicialização usando FTP.

Seu script de inicialização faz uma transformação xsl para o arquivo server.xml e saída do arquivo xml resultante para /usr/local/tomcat/conf/server.xml. O script de inicialização deve instalar libxslt via apk. Seu arquivo xsl e script de inicialização podem ser carregados via FTP. Abaixo está um exemplo de script de inicialização.

# 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

O arquivo XSL de exemplo a seguir adiciona um novo nó de conector ao server.xml Tomcat.

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

Finalizar a configuração

Por fim, coloque os JARs do driver no classpath do Tomcat e reinicie o Serviço de Aplicativo.

1. Certifique-se de que os arquivos do driver JDBC estejam disponíveis para o carregador de classes Tomcat colocando-os no diretório /home/site/lib . No Cloud Shell, execute az webapp deploy --type=lib para cada JAR de driver:

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

Se você criou uma fonte de dados no nível do servidor, reinicie o aplicativo Linux do Serviço de Aplicativo. O Tomcat redefine CATALINA_BASE e /home/tomcat usa a configuração atualizada.

Windows

Não é possível modificar diretamente uma instalação do Tomcat para configuração em todo o servidor porque o local de instalação é somente leitura. Para fazer alterações de configuração no nível do servidor na instalação do Windows Tomcat, a maneira mais simples é fazer o seguinte no início do aplicativo:

1. Copie o Tomcat para um diretório local (%LOCAL_EXPANDED%) e use-o como CATALINA_BASE (consulte a documentação do Tomcat sobre essa variável).
2. Adicione suas fontes de dados compartilhadas ao uso da %LOCAL_EXPANDED%\tomcat\conf\server.xml transformação XSL.

Adicionar um ficheiro de arranque

Crie um arquivo chamado startup.cmd %HOME%\site\wwwroot diretório. Esse arquivo é executado automaticamente antes que o servidor Tomcat seja iniciado. O ficheiro deve ter o seguinte conteúdo:

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

Adicionar o script de configuração do PowerShell

Em seguida, adicione o script de configuração chamado configure.ps1 ao diretório %HOME%_\site com o seguinte código:

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

Este PowerShell conclui as seguintes etapas:

1. Verifique se já existe uma cópia personalizada do Tomcat. Se isso acontecer, o script de inicialização pode terminar aqui.
2. Copie o Tomcat localmente.
3. Adicione fontes de dados compartilhadas à configuração personalizada do Tomcat usando a transformação XSL.
4. Indique que a configuração foi concluída com êxito.

Adicionar arquivo de transformação XSL

Um caso de uso comum para personalizar a instalação integrada do Tomcat é modificar os arquivos de server.xmlconfiguração do , context.xmlou web.xml do Tomcat. O Serviço de Aplicativo já modifica esses arquivos para fornecer recursos da plataforma. Para continuar a usar esses recursos, é importante preservar o conteúdo desses arquivos quando você fizer alterações neles. Para fazer isso, use uma transformação XSL (XSLT).

Adicione um arquivo de transformação XSL chamado configure.ps1 ao diretório %HOME%_\site . Você pode usar o seguinte código de transformação XSL para adicionar um novo nó de conector ao server.xml. A transformação de identidade no início preserva o conteúdo original do arquivo de configuração.

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

Definir CATALINA_BASE configuração do aplicativo

A plataforma também precisa saber onde sua versão personalizada do Tomcat está instalada. Você pode definir o local da instalação na configuração do CATALINA_BASE aplicativo.

Você pode usar a CLI do Azure para alterar essa configuração:

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

Ou, você pode alterar manualmente a configuração no portal do Azure:

1. Vá para Configurações>Configuração>Definições Definições do aplicativo.
2. Selecione Nova Definição de Aplicação.
3. Use estes valores para criar a configuração:
   1. Designação: CATALINA_BASE
   2. Valor: "%LOCAL_EXPANDED%\tomcat"

Finalizar a configuração

Por fim, coloque os JARs do driver no classpath do Tomcat e reinicie o Serviço de Aplicativo. Certifique-se de que os arquivos do driver JDBC estejam disponíveis para o carregador de classes Tomcat colocando-os no diretório /home/site/lib . No Cloud Shell, execute az webapp deploy --type=lib para cada JAR de driver:

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

Há três etapas principais ao registrar uma fonte de dados com o JBoss EAP: carregar o driver JDBC, adicionar o driver JDBC como um módulo e registrar o módulo. O Serviço de Aplicativo é um serviço de hospedagem sem monitoração de estado, portanto, os comandos de configuração para adicionar e registrar o módulo de fonte de dados devem ser roteirizados e aplicados à medida que o contêiner é iniciado.

1. Obtenha o driver JDBC do seu banco de dados.

2. Crie um arquivo de definição de módulo XML para o driver JDBC. O exemplo a seguir mostra uma definição de módulo para 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. Coloque os comandos da CLI do JBoss em um arquivo chamado jboss-cli-commands.cli. Os comandos do JBoss devem adicionar o módulo e registrá-lo como fonte de dados. O exemplo a seguir mostra os comandos JBoss CLI para 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. Crie um script de inicialização, startup_script.sh que chame os comandos da CLI do JBoss. O exemplo a seguir mostra como chamar seu jboss-cli-commands.cliarquivo . Mais tarde, você configurará o Serviço de Aplicativo para executar esse script quando o contêiner for iniciado.

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

5. Usando um cliente FTP de sua escolha, carregue seu driver JDBC, jboss-cli-commands.cli, startup_script.she a definição do módulo para /site/deployments/tools/.

6. Configure seu site para ser executado startup_script.sh quando o contêiner for iniciado. No portal do Azure, navegue até Comando de Inicialização de Configurações>Gerais de Configuração.> Defina o campo de comando de inicialização como /home/site/deployments/tools/startup_script.sh. Salve suas alterações.

Para confirmar que a fonte de dados foi adicionada ao servidor JBoss, SSH em seu webapp e execute $JBOSS_HOME/bin/jboss-cli.sh --connect. Quando estiver conectado ao JBoss, execute o /subsystem=datasources:read-resource para imprimir uma lista das fontes de dados.

Próximos passos

Visite o Centro de Desenvolvedores do Azure para Java para encontrar inícios rápidos, tutoriais e documentação de referência Java do Azure.

• FAQ do Serviço de Aplicações no Linux
• Referência de variáveis de ambiente e configurações de aplicativo