Introduzione a JDBC

Java Top

Ho appena annunciato il nuovo corso Learn Spring , incentrato sui fondamenti di Spring 5 e Spring Boot 2:

>> SCOPRI IL CORSO

1. Panoramica

In questo articolo, daremo un'occhiata a JDBC (Java Database Connectivity) che è un'API per la connessione e l'esecuzione di query su un database.

JDBC può funzionare con qualsiasi database purché vengano forniti i driver appropriati.

2. Driver JDBC

Un driver JDBC è un'implementazione dell'API JDBC utilizzata per la connessione a un particolare tipo di database. Esistono diversi tipi di driver JDBC:

  • Tipo 1: contiene una mappatura a un'altra API di accesso ai dati; un esempio di ciò è il driver JDBC-ODBC
  • Tipo 2: è un'implementazione che utilizza le librerie lato client del database di destinazione; chiamato anche driver API nativo
  • Tipo 3: utilizza il middleware per convertire le chiamate JDBC in chiamate specifiche del database; noto anche come driver del protocollo di rete
  • Tipo 4: connettersi direttamente a un database convertendo le chiamate JDBC in chiamate specifiche del database; noti come driver di protocollo del database o driver sottili,

Il tipo più comunemente usato è il tipo 4, in quanto ha il vantaggio di essere indipendente dalla piattaforma . La connessione diretta a un server di database fornisce prestazioni migliori rispetto ad altri tipi. Lo svantaggio di questo tipo di driver è che è specifico del database, dato che ogni database ha il proprio protocollo specifico.

3. Connessione a un database

Per connettersi a un database, dobbiamo semplicemente inizializzare il driver e aprire una connessione al database.

3.1. Registrazione del driver

Per il nostro esempio, utilizzeremo un driver di protocollo del database di tipo 4.

Dato che stiamo usando un database MySQL, abbiamo bisogno della dipendenza mysql-connector-java :

 mysql mysql-connector-java 6.0.6 

Successivamente, registriamo il driver utilizzando il metodo Class.forName () , che carica dinamicamente la classe del driver:

Class.forName("com.mysql.cj.jdbc.Driver");

Nelle versioni precedenti di JDBC, prima di ottenere una connessione, dovevamo inizializzare il driver JDBC chiamando il metodo Class.forName . A partire da JDBC 4.0, tutti i driver che si trovano nel classpath vengono caricati automaticamente . Pertanto, non avremo bisogno di questa parte Class.forName negli ambienti moderni.

3.2. Creazione della connessione

Per aprire una connessione, possiamo utilizzare il metodo getConnection () della classe DriverManager . Questo metodo richiede un parametro String URL di connessione :

try (Connection con = DriverManager .getConnection("jdbc:mysql://localhost:3306/myDb", "user1", "pass")) { // use con here }

Poiché la connessione è una risorsa chiudibile automaticamente , dovremmo usarla all'interno di un blocco try-with-resources .

La sintassi dell'URL di connessione dipende dal tipo di database utilizzato. Diamo un'occhiata ad alcuni esempi:

jdbc:mysql://localhost:3306/myDb?user=user1&password=pass
jdbc:postgresql://localhost/myDb
jdbc:hsqldb:mem:myDb

Per connettersi al database myDb specificato , dovremo creare il database e un utente e aggiungere la concessione dell'accesso necessario:

CREATE DATABASE myDb; CREATE USER 'user1' IDENTIFIED BY 'pass'; GRANT ALL on myDb.* TO 'user1';

4. Esecuzione di istruzioni SQL

Per inviare istruzioni SQL al database, possiamo utilizzare istanze di tipo Statement , PreparedStatement o CallableStatement, che possiamo ottenere utilizzando l' oggetto Connection .

4.1. Dichiarazione

L' interfaccia Statement contiene le funzioni essenziali per l'esecuzione dei comandi SQL.

Per prima cosa, creiamo un oggetto Statement :

try (Statement stmt = con.createStatement()) { // use stmt here }

Ancora una volta, dovremmo lavorare con Statement s all'interno di un blocco try-with-resources per la gestione automatica delle risorse.

Ad ogni modo, l'esecuzione di istruzioni SQL può essere eseguita utilizzando tre metodi:

  • executeQuery () per le istruzioni SELECT
  • executeUpdate () per aggiornare i dati o la struttura del database
  • execute () può essere utilizzato per entrambi i casi sopra quando il risultato è sconosciuto

Usiamo il metodo execute () per aggiungere una tabella di studenti al nostro database:

String tableSql = "CREATE TABLE IF NOT EXISTS employees" + "(emp_id int PRIMARY KEY AUTO_INCREMENT, name varchar(30)," + "position varchar(30), salary double)"; stmt.execute(tableSql);

Quando si utilizza il metodo execute () per aggiornare i dati, il metodo stmt.getUpdateCount () restituisce il numero di righe interessate.

Se il risultato è 0, nessuna riga è stata interessata oppure è stato un comando di aggiornamento della struttura del database.

Se il valore è -1, il comando era una query SELECT; possiamo quindi ottenere il risultato usando stmt.getResultSet () .

Successivamente, aggiungiamo un record alla nostra tabella utilizzando il metodo executeUpdate () :

String insertSql = "INSERT INTO employees(name, position, salary)" + " VALUES('john', 'developer', 2000)"; stmt.executeUpdate(insertSql);

The method returns the number of affected rows for a command that updates rows or 0 for a command that updates the database structure.

We can retrieve the records from the table using the executeQuery() method which returns an object of type ResultSet:

String selectSql = "SELECT * FROM employees"; try (ResultSet resultSet = stmt.executeQuery(selectSql)) { // use resultSet here }

We should make sure to close the ResultSet instances after use. Otherwise, we may keep the underlying cursor open for a much longer period than expected. To do that, it's recommended to use a try-with-resources block, as in our example above.

4.2. PreparedStatement

PreparedStatement objects contain precompiled SQL sequences. They can have one or more parameters denoted by a question mark.

Let's create a PreparedStatement which updates records in the employees table based on given parameters:

String updatePositionSql = "UPDATE employees SET position=? WHERE emp_id=?"; try (PreparedStatement pstmt = con.prepareStatement(updatePositionSql)) { // use pstmt here }

To add parameters to the PreparedStatement, we can use simple setters – setX() – where X is the type of the parameter, and the method arguments are the order and value of the parameter:

pstmt.setString(1, "lead developer"); pstmt.setInt(2, 1);

The statement is executed with one of the same three methods described before: executeQuery(), executeUpdate(), execute() without the SQL String parameter:

int rowsAffected = pstmt.executeUpdate();

4.3. CallableStatement

The CallableStatement interface allows calling stored procedures.

To create a CallableStatement object, we can use the prepareCall() method of Connection:

String preparedSql = "{call insertEmployee(?,?,?,?)}"; try (CallableStatement cstmt = con.prepareCall(preparedSql)) { // use cstmt here }

Setting input parameter values for the stored procedure is done like in the PreparedStatement interface, using setX() methods:

cstmt.setString(2, "ana"); cstmt.setString(3, "tester"); cstmt.setDouble(4, 2000);

If the stored procedure has output parameters, we need to add them using the registerOutParameter() method:

cstmt.registerOutParameter(1, Types.INTEGER);

Then let's execute the statement and retrieve the returned value using a corresponding getX() method:

cstmt.execute(); int new_id = cstmt.getInt(1);

For example to work, we need to create the stored procedure in our MySql database:

delimiter // CREATE PROCEDURE insertEmployee(OUT emp_id int, IN emp_name varchar(30), IN position varchar(30), IN salary double) BEGIN INSERT INTO employees(name, position,salary) VALUES (emp_name,position,salary); SET emp_id = LAST_INSERT_ID(); END // delimiter ;

The insertEmployee procedure above will insert a new record into the employees table using the given parameters and return the id of the new record in the emp_id out parameter.

To be able to run a stored procedure from Java, the connection user needs to have access to the stored procedure's metadata. This can be achieved by granting rights to the user on all stored procedures in all databases:

GRANT ALL ON mysql.proc TO 'user1';

Alternatively, we can open the connection with the property noAccessToProcedureBodies set to true:

con = DriverManager.getConnection( "jdbc:mysql://localhost:3306/myDb?noAccessToProcedureBodies=true", "user1", "pass");

This will inform the JDBC API that the user does not have the rights to read the procedure metadata so that it will create all parameters as INOUT String parameters.

5. Parsing Query Results

After executing a query, the result is represented by a ResultSet object, which has a structure similar to a table, with lines and columns.

5.1. ResultSet Interface

The ResultSet uses the next() method to move to the next line.

Let's first create an Employee class to store our retrieved records:

public class Employee { private int id; private String name; private String position; private double salary; // standard constructor, getters, setters }

Next, let's traverse the ResultSet and create an Employee object for each record:

String selectSql = "SELECT * FROM employees"; try (ResultSet resultSet = stmt.executeQuery(selectSql)) { List employees = new ArrayList(); while (resultSet.next()) { Employee emp = new Employee(); emp.setId(resultSet.getInt("emp_id")); emp.setName(resultSet.getString("name")); emp.setPosition(resultSet.getString("position")); emp.setSalary(resultSet.getDouble("salary")); employees.add(emp); } }

Retrieving the value for each table cell can be done using methods of type getX() where X represents the type of the cell data.

The getX() methods can be used with an int parameter representing the order of the cell, or a String parameter representing the name of the column. The latter option is preferable in case we change the order of the columns in the query.

5.2. Updatable ResultSet

Implicitly, a ResultSet object can only be traversed forward and cannot be modified.

If we want to use the ResultSet to update data and traverse it in both directions, we need to create the Statement object with additional parameters:

stmt = con.createStatement( ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_UPDATABLE );

To navigate this type of ResultSet, we can use one of the methods:

  • first(), last(), beforeFirst(), beforeLast() – to move to the first or last line of a ResultSet or to the line before these
  • next(), previous() – to navigate forward and backward in the ResultSet
  • getRow() – to obtain the current row number
  • moveToInsertRow(), moveToCurrentRow() – to move to a new empty row to insert and back to the current one if on a new row
  • absolute(int row) – to move to the specified row
  • relative(int nrRows) – to move the cursor the given number of rows

Updating the ResultSet can be done using methods with the format updateX() where X is the type of cell data. These methods only update the ResultSet object and not the database tables.

To persist the ResultSet changes to the database, we must further use one of the methods:

  • updateRow() – to persist the changes to the current row to the database
  • insertRow(), deleteRow() – to add a new row or delete the current one from the database
  • refreshRow() – to refresh the ResultSet with any changes in the database
  • cancelRowUpdates() – to cancel changes made to the current row

Let's take a look at an example of using some of these methods by updating data in the employee's table:

try (Statement updatableStmt = con.createStatement( ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_UPDATABLE)) { try (ResultSet updatableResultSet = updatableStmt.executeQuery(selectSql)) { updatableResultSet.moveToInsertRow(); updatableResultSet.updateString("name", "mark"); updatableResultSet.updateString("position", "analyst"); updatableResultSet.updateDouble("salary", 2000); updatableResultSet.insertRow(); } }

6. Parsing Metadata

The JDBC API allows looking up information about the database, called metadata.

6.1. DatabaseMetadata

The DatabaseMetadata interface can be used to obtain general information about the database such as the tables, stored procedures, or SQL dialect.

Let's have a quick look at how we can retrieve information on the database tables:

DatabaseMetaData dbmd = con.getMetaData(); ResultSet tablesResultSet = dbmd.getTables(null, null, "%", null); while (tablesResultSet.next()) { LOG.info(tablesResultSet.getString("TABLE_NAME")); }

6.2. ResultSetMetadata

This interface can be used to find information about a certain ResultSet, such as the number and name of its columns:

ResultSetMetaData rsmd = rs.getMetaData(); int nrColumns = rsmd.getColumnCount(); IntStream.range(1, nrColumns).forEach(i -> { try { LOG.info(rsmd.getColumnName(i)); } catch (SQLException e) { e.printStackTrace(); } });

7. Handling Transactions

By default, each SQL statement is committed right after it is completed. However, it's also possible to control transactions programmatically.

This may be necessary in cases when we want to preserve data consistency, for example when we only want to commit a transaction if a previous one has completed successfully.

First, we need to set the autoCommit property of Connection to false, then use the commit() and rollback() methods to control the transaction.

Let's add a second update statement for the salary column after the employee position column update and wrap them both in a transaction. This way, the salary will be updated only if the position was successfully updated:

String updatePositionSql = "UPDATE employees SET position=? WHERE emp_id=?"; PreparedStatement pstmt = con.prepareStatement(updatePositionSql); pstmt.setString(1, "lead developer"); pstmt.setInt(2, 1); String updateSalarySql = "UPDATE employees SET salary=? WHERE emp_id=?"; PreparedStatement pstmt2 = con.prepareStatement(updateSalarySql); pstmt.setDouble(1, 3000); pstmt.setInt(2, 1); boolean autoCommit = con.getAutoCommit(); try { con.setAutoCommit(false); pstmt.executeUpdate(); pstmt2.executeUpdate(); con.commit(); } catch (SQLException exc) { con.rollback(); } finally { con.setAutoCommit(autoCommit); }

For the sake of brevity, we omit the try-with-resources blocks here.

8. Closing the Resources

When we're no longer using it, we need to close the connection to release database resources.

We can do this using the close() API:

con.close();

Tuttavia, se stiamo usando la risorsa in un blocco try-with-resources , non abbiamo bisogno di chiamare esplicitamente il metodo close () , poiché il blocco try-with-resources lo fa automaticamente.

Lo stesso vale per le istruzioni , PreparedStatement , CallableStatement e ResultSet .

9. Conclusione

In questo tutorial, abbiamo esaminato le basi del lavoro con l'API JDBC.

Come sempre, il codice sorgente completo degli esempi può essere trovato su GitHub.

Fondo Java

Ho appena annunciato il nuovo corso Learn Spring , incentrato sui fondamenti di Spring 5 e Spring Boot 2:

>> SCOPRI IL CORSO