Connexion à des bases de données SQL

Dernière mise à jour : 4 mai 2023

Créé pour :

  • Developer
CAUTION
AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

Accédez à une base de données SQL externe, de sorte que vos applications CQ puissent interagir avec les données :

Regroupement du pilote de base de données JDBC

Certains fournisseurs de base de données proposent des pilotes JDBC dans un lot OSGi ; MySQL, par exemple. Si le pilote JDBC correspondant à votre base de données n’est pas disponible sous la forme d’un lot OSGi, procurez-vous le fichier JAR du pilote et enveloppez-le dans un lot OSGi. Le lot doit exporter les packages nécessaires pour interagir avec le serveur de base de données. Il doit également importer les packages auxquels il fait référence.

L’exemple suivant utilise la méthode Module externe Bundle pour Maven pour encapsuler le pilote HSQLDB dans un lot OSGi. Le POM demande au module externe d’incorporer le fichier hsqldb.jar identifié comme une dépendance. Tous les packages org.hsqldb sont exportés.

Le module externe détermine automatiquement les modules à importer et les répertorie dans le fichier MANIFEST.MF du lot. Si l’un des packages n’est pas disponible sur le serveur CQ, le lot ne démarre pas lors de l’installation. Deux solutions possibles sont les suivantes :

  • Indiquez dans le POM que les packages sont facultatifs. Utilisez cette solution lorsque la connexion JDBC ne nécessite pas réellement les membres du package. Utilisez l’élément Import-Package pour indiquer les packages facultatifs comme dans l’exemple suivant :

    <Import-Package>org.jboss.*;resolution:=optional,*</Import-Package>

  • Encapsulez les fichiers JAR contenant les modules dans un lot OSGi qui exporte les modules et déployez le lot. Utilisez cette solution lorsque les membres du module sont requis pendant l’exécution du code.

La connaissance du code source vous permet de décider quelle solution utiliser. Vous pouvez également essayer l’une des solutions et effectuer des tests pour valider la solution.

POM qui regroupe hsqldb.jar 

<project xmlns="https://maven.apache.org/POM/4.0.0"
  xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.adobe.example.myapp</groupId>
  <artifactId>hsqldb-jdbc-driver-bundle</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>wrapper-bundle-hsqldb-driver</name>
  <url>www.adobe.com</url>
  <description>Exports the HSQL JDBC driver</description>
  <packaging>bundle</packaging>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.felix</groupId>
        <artifactId>maven-bundle-plugin</artifactId>
        <version>1.4.3</version>
        <extensions>true</extensions>
        <configuration>
         <instructions>
            <Embed-Dependency>*</Embed-Dependency>
            <_exportcontents>org.hsqldb.*</_exportcontents>
          </instructions>
        </configuration>
      </plugin>
    </plugins>
  </build>
  <dependencies>
    <dependency>
      <groupId>hsqldb</groupId>
      <artifactId>hsqldb</artifactId>
      <version>2.2.9</version>
    </dependency>
  </dependencies>
</project>

Les liens suivants ouvrent les pages de téléchargement de certains produits de base de données populaires :

Configuration du service Pool de connexions JDBC

Ajoutez une configuration pour le service Pool de connexions JDBC qui utilise le pilote JDBC pour créer des objets de source de données. Votre code d’application utilise ce service pour obtenir l’objet et se connecter à la base de données.

Le Pool de connexions JDBC (com.day.commons.datasource.jdbcpool.JdbcPoolService) est un service d’usine. Si vous avez besoin de connexions qui utilisent des propriétés différentes, par exemple un accès en lecture seule ou en lecture/écriture, créez plusieurs configurations.

Lorsque vous utilisez CQ, plusieurs méthodes permettent de gérer les paramètres de configuration pour ces services. see Configuration d’OSGi pour plus d’informations.

Les propriétés suivantes sont disponibles pour configurer un service de connexion en pool. Les noms des propriétés sont répertoriés tels qu’ils apparaissent dans la console web. Le nom correspondant à un nœud sling:OsgiConfig apparaît entre parenthèses. Des exemples de valeurs sont affichés pour un serveur HSQLDB et une base de données dont le pseudonyme est mydb :

  • Classe de pilotes JDBC (jdbc.driver.class) : classe Java à utiliser pour implémenter l’interface java.sql.Driver ; org.hsqldb.jdbc.JDBCDriver, par exemple. Le type de données est String.

  • URI de connexion JDBC (jdbc.connection.uri) : URL de la base de données à utiliser pour créer la connexion ; jdbc:hsqldb:hsql//10.36.79.223:9001/mydb, par exemple. Le format de l’URL doit être valide pour être utilisé avec la méthode getConnection de la classe java.sql.DriverManager. Le type de données est String.

  • Nom d’utilisateur (jdbc.username) : nom d’utilisateur à employer pour s’authentifier auprès du serveur de base de données. Le type de données est String.

  • Mot de passe (jdbc.password) : mot de passe à utiliser pour l’authentification de l’utilisateur. Le type de données est String.

  • Requête de validation (jdbc.validation.query) : instruction SQL à utiliser pour s’assurer que la connexion a bien été établie ; select 1 from INFORMATION_SCHEMA.SYSTEM_USERS, par exemple. Le type de données est String.

  • Lecture seule par défaut (default.readonly) : sélectionnez cette option si vous voulez que la connexion fournisse un accès en lecture seule. Le type de données est Boolean.

  • Validation automatique par défaut (default.autocommit) : sélectionnez cette option pour créer des transactions distinctes pour chaque commande SQL envoyée à la base de données ; chaque transaction est alors automatiquement validée. Ne sélectionnez pas cette option lorsque vous validez explicitement des transactions dans votre code. Le type de données est Boolean.

  • Taille du pool (pool.size) : nombre de connexions simultanées qui doivent être disponibles pour la base de données. Le type de données est Long.

  • Attente de pool (pool.max.wait.msec) : délai avant l’expiration de la requête de connexion. Le type de données est Long.

  • Nom de la source de données (datasource.name) : nom de cette source de données. Le type de données est String.

  • Propriétés de service supplémentaires (datasource.svc.properties) : ensemble de paires nom/valeur que vous souhaitez ajouter à l’URL de connexion. Le type de données est String[].

Le Pool de connexions JDBC est un service d’usine. Par conséquent, si vous utilisez un nœud sling:OsgiConfig pour configurer le service de connexion, le nom du nœud doit inclure le PID du service d’usine, suivi de -alias. Le pseudonyme que vous utilisez doit être unique pour tous les nœuds de configuration de ce PID. com.day.commons.datasource.jdbcpool.JdbcPoolService-myhsqldbpool est un exemple de nom de nœud.

chlimage_1-7

Connexion à la base de données

Dans votre code Java, utilisez le service DataSourcePool pour obtenir un objet javax.sql.DataSource pour la configuration que vous avez créée. Le service DataSourcePool fournit la méthode getDataSource qui renvoie un objet DataSource pour un nom de source de données spécifique. Comme argument de méthode, utilisez la valeur de la propriété Nom de la source de données (ou datasource.name) que vous avez spécifiée pour la configuration du service Pool de connexions JDBC.

L’exemple de code JSP suivant récupère une instance de la source de données hsqldbds, exécute une requête SQL simple et affiche le nombre de résultats renvoyés.

JSP qui effectue une recherche de base de données 

<%@include file="/libs/foundation/global.jsp"%><%
%><%@page session="false"%><%
%><%@ page import="com.day.commons.datasource.poolservice.DataSourcePool" %><%
%><%@ page import="javax.sql.DataSource" %><%
%><%@ page import="java.sql.Connection" %><%
%><%@ page import="java.sql.SQLException" %><%
%><%@ page import="java.sql.Statement" %><%
%><%@ page import="java.sql.ResultSet"%><%
%><html>
<cq:include script="head.jsp"/>
<body>
<%DataSourcePool dspService = sling.getService(DataSourcePool.class);
  try {
     DataSource ds = (DataSource) dspService.getDataSource("hsqldbds");
     if(ds != null) {
         %><p>Obtained the datasource!</p><%
         %><%final Connection connection = ds.getConnection();
          final Statement statement = connection.createStatement();
          final ResultSet resultSet = statement.executeQuery("SELECT * from INFORMATION_SCHEMA.SYSTEM_USERS");
          int r=0;
          while(resultSet.next()){
             r=r+1;
          }
          resultSet.close();
          %><p>Number of results: <%=r%></p><%
      }
   }catch (Exception e) {
        %><p>error! <%=e.getMessage()%></p><%
    }
%></body>
</html>
NOTE
Si la méthode getDataSource renvoie une exception car la source de données est introuvable, assurez-vous que la configuration du service Pool de connexions est correcte. Vérifiez les noms de propriété, les valeurs et les types de données.
NOTE
Pour savoir comment injecter un pool de sources de données dans un lot OSGi, voir Injection d’un service DataSourcePool dans un lot OSGi Adobe Experience Manager.
Page précédente
Page suivante

Experience Manager