SQL-Verbindungen mit JDBC-DataSourcePool
Verbindungen zu SQL-Datenbanken (und anderen Nicht-HTTP/HTTPS-Diensten) müssen von AEM aus bereitgestellt werden, einschließlich derjenigen, die mit dem DataSourcePool-OSGi-Dienst von AEM zur Verwaltung der Verbindungen hergestellt werden.
Erweiterte Netzwerkunterstützung
Das folgende Code-Beispiel wird von den folgenden erweiterten Netzwerkoptionen unterstützt.
Stellen Sie sicher, dass vor diesem Tutorial die geeignete erweiterte Netzwerkkonfiguration eingerichtet wurde.
OSGi-Konfiguration
Die Verbindungszeichenfolge der OSGi-Konfiguration verwendet Folgendes:
AEM_PROXY_HOST
-Wert über die OSGi-Konfigurationsumgebungsvariable$[env:AEM_PROXY_HOST;default=proxy.tunnel]
als Host der Verbindung30001
– stellt denportOrig
-Wert für die Cloud Manager-Anschlussvorschau-Zuordnung30001
→mysql.example.com:3306
dar
Da Geheimnisse nicht im Code gespeichert werden dürfen, sollten Benutzername und Kennwort der SQL-Verbindung am besten über OSGi-Konfigurationsvariablen bereitgestellt werden, die mithilfe von AIO CLI- oder Cloud Manager-APIs festgelegt werden.
ui.config/src/jcr_root/apps/wknd-examples/osgiconfig/config/com.day.commons.datasource.jdbcpool.JdbcPoolService~wknd-examples-mysql.cfg.json
{
"datasource.name": "wknd-examples-mysql",
"jdbc.driver.class": "com.mysql.jdbc.Driver",
"jdbc.connection.uri": "jdbc:mysql://$[env:AEM_PROXY_HOST;default=proxy.tunnel]:30001/wknd-examples",
"jdbc.username": "$[env:MYSQL_USERNAME;default=mysql-user]",
"jdbc.password": "$[secret:MYSQL_PASSWORD]"
}
Der folgende aio CLI
-Befehl kann verwendet werden, um die OSGi-Geheimnisse für die einzelnen Umgebungen festzulegen:
$ aio cloudmanager:set-environment-variables --programId=<PROGRAM_ID> <ENVIRONMENT_ID> --secret MYSQL_USERNAME "mysql-user" --secret MYSQL_PASSWORD "password123"
Code-Beispiel
Dieses Java™-Code-Beispiel betrifft einen OSGi-Dienst, der über den DataSourcePool-OSGi-Dienst von AEM eine Verbindung zu einer externen MySQL-Datenbank herstellt.
Die DataSourcePool-OSGi-Werkskonfiguration gibt wiederum einen Port (30001
) an, der über die Regel portForwards
im Betrieb mit der enableEnvironmentAdvancedNetworkingConfiguration zum externen Host und Port mysql.example.com:3306
zugeordnet wird.
...
"portForwards": [{
"name": "mysql.example.com",
"portDest": 3306,
"portOrig": 30001
}]
...
core/src/com/adobe/aem/wknd/examples/connections/impl/JdbcExternalServiceImpl.java
package com.adobe.aem.wknd.examples.core.connections.impl;
import com.adobe.aem.wknd.examples.core.connections.ExternalService;
import com.day.commons.datasource.poolservice.DataSourceNotFoundException;
import com.day.commons.datasource.poolservice.DataSourcePool;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;
@Component
public class JdbcExternalServiceImpl implements ExternalService {
private static final Logger log = LoggerFactory.getLogger(JdbcExternalServiceImpl.class);
@Reference
private DataSourcePool dataSourcePool;
// The datasource.name value of the OSGi configuration containing the connection this OSGi component will use.
private static final String DATA_SOURCE_NAME = "wknd-examples-mysql";
@Override
public boolean isAccessible() {
try {
// Get the JDBC data source based on the named OSGi configuration
DataSource dataSource = (DataSource) dataSourcePool.getDataSource(DATA_SOURCE_NAME);
// Establish a connection with the external JDBC service
// Per the OSGi configuration, this will use the injected $[env:AEM_PROXY_HOST] value as the host
// and the port (30001) mapped via Cloud Manager API call
try (Connection connection = dataSource.getConnection()) {
// Validate the connection
connection.isValid(1000);
// Close the connection, since this is just a simple connectivity check
connection.close();
// Return true if AEM could reach the external JDBC service
return true;
} catch (SQLException e) {
log.error("Unable to validate SQL connection for [ {} ]", DATA_SOURCE_NAME, e);
}
} catch (DataSourceNotFoundException e) {
log.error("Unable to establish an connection with the JDBC data source [ {} ]", DATA_SOURCE_NAME, e);
}
return false;
}
}
Abhängigkeiten von MySQL-Treibern
Bei AEM as a Cloud Service müssen Sie oft Java™-Datenbanktreiber zur Unterstützung der Verbindungen bereitstellen. Die Bereitstellung der Treiber wird in der Regel am besten dadurch erreicht, dass die OSGi-Bundle-Artefakte, die diese Treiber enthalten, über das all
-Paket in das AEM-Projekt eingebettet werden.
Reactor pom.xml
Schließen Sie die Datenbanktreiber-Abhängigkeiten in den Reaktor pom.xml
ein und referenzieren Sie sie dann in den all
-Unterprojekten.
pom.xml
...
<dependencies>
...
<!-- MySQL Driver dependencies -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>[8.0.27,)</version>
<scope>provided</scope>
</dependency>
...
</dependencies>
...
All pom.xml
Betten Sie die Abhängigkeitsartefakte des Datenbanktreibers in das all
-Paket ein, damit sie bereitgestellt werden und in AEM as a Cloud Service verfügbar sind. Diese Artefakte müssen OSGi-Bundles sein, mit denen die Datenbanktreiber-Java™-Klasse exportiert wird.
all/pom.xml
...
<embededs>
...
<!-- Include the MySQL Driver OSGi bundles for deployment to the project -->
<embedded>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<target>/apps/wknd-examples-vendor-packages/application/install</target>
</embedded>
...
</embededs>
...
<dependencies>
...
<!-- Add MySQL OSGi bundle artifacts so the <embeddeds> can add them to the project -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>provided</scope>
</dependency>
...
</dependencies>
...