Häufige Ausnahmen im Ruhezustand

1. Einleitung

In diesem Tutorial werden einige häufige Ausnahmen erläutert, die bei der Arbeit mit Hibernate auftreten können.

Wir werden ihren Zweck und einige häufige Ursachen überprüfen. Zusätzlich werden wir ihre Lösungen untersuchen.

2. Übersicht über die Ausnahmezustände im Ruhezustand

Viele Bedingungen können dazu führen, dass bei Verwendung von Hibernate Ausnahmen ausgelöst werden. Dies können Zuordnungsfehler, Infrastrukturprobleme, SQL-Fehler, Verstöße gegen die Datenintegrität, Sitzungsprobleme und Transaktionsfehler sein.

Diese Ausnahmen erstrecken sich hauptsächlich auf HibernateException . Wenn wir jedoch Hibernate als JPA-Persistenzanbieter verwenden, werden diese Ausnahmen möglicherweise in PersistenceException eingeschlossen .

Beide Basisklassen erstrecken sich von RuntimeException . Daher sind sie alle deaktiviert. Daher müssen wir sie nicht an jedem Ort, an dem sie verwendet werden, fangen oder deklarieren.

Darüber hinaus sind die meisten davon nicht wiederherstellbar. Infolgedessen würde ein erneuter Versuch des Vorgangs nicht helfen. Dies bedeutet, dass wir die aktuelle Sitzung abbrechen müssen, wenn wir ihnen begegnen.

Schauen wir uns nun jedes einzeln an.

3. Zuordnungsfehler

Die objektrelationale Zuordnung ist ein Hauptvorteil von Hibernate. Insbesondere befreit es uns vom manuellen Schreiben von SQL-Anweisungen.

Gleichzeitig müssen wir die Zuordnung zwischen Java-Objekten und Datenbanktabellen angeben. Dementsprechend spezifizieren wir sie mithilfe von Anmerkungen oder durch Zuordnungsdokumente. Diese Zuordnungen können manuell codiert werden. Alternativ können wir Tools verwenden, um sie zu generieren.

Bei der Angabe dieser Zuordnungen können Fehler auftreten. Diese können in der Mapping-Spezifikation enthalten sein. Oder es kann eine Nichtübereinstimmung zwischen einem Java-Objekt und der entsprechenden Datenbanktabelle geben.

Solche Zuordnungsfehler erzeugen Ausnahmen. Wir stoßen bei der ersten Entwicklung häufig auf sie. Darüber hinaus können sie bei der Migration von Änderungen in verschiedenen Umgebungen auftreten.

Schauen wir uns diese Fehler anhand einiger Beispiele an.

3.1. MappingException

Ein Problem mit der objektrelationalen Zuordnung führt dazu, dass eine MappingException ausgelöst wird :

public void whenQueryExecutedWithUnmappedEntity_thenMappingException() { thrown.expectCause(isA(MappingException.class)); thrown.expectMessage("Unknown entity: java.lang.String"); Session session = sessionFactory.getCurrentSession(); NativeQuery query = session .createNativeQuery("select name from PRODUCT", String.class); query.getResultList(); }

Im obigen Code versucht die Methode createNativeQuery , das Abfrageergebnis dem angegebenen Java-Typ String zuzuordnen . Für die Zuordnung wird die implizite Zuordnung der String- Klasse aus Metamodel verwendet.

Für die String- Klasse ist jedoch keine Zuordnung angegeben. Daher wird Hibernate nicht wissen , wie die zur Karte Name Spalte String und wirft die Ausnahme.

Eine detaillierte Analyse möglicher Ursachen und Lösungen finden Sie unter Hibernate Mapping-Ausnahme - Unbekannte Entität.

In ähnlicher Weise können auch andere Fehler diese Ausnahme verursachen:

  • Mischen von Anmerkungen zu Feldern und Methoden
  • Die @JoinTable für eine @ MorganToMany- Zuordnung kann nicht angegeben werden
  • Der Standardkonstruktor der zugeordneten Klasse löst während der Zuordnungsverarbeitung eine Ausnahme aus

Darüber hinaus verfügt MappingException über einige Unterklassen, die auf bestimmte Zuordnungsprobleme hinweisen können:

  • AnnotationException - ein Problem mit einer Annotation
  • DuplicateMappingException - Doppelte Zuordnung für einen Klassen-, Tabellen- oder Eigenschaftsnamen
  • InvalidMappingException - Zuordnung ist ungültig
  • MappingNotFoundException - Zuordnungsressource wurde nicht gefunden
  • PropertyNotFoundException - Eine erwartete Getter- oder Setter-Methode konnte für eine Klasse nicht gefunden werden

Deshalb , wenn wir über diese Ausnahme kommen, sollten wir zuerst unsere Zuordnungen überprüfen .

3.2. AnnotationException

Um die AnnotationException zu verstehen , erstellen wir eine Entität ohne Bezeichneranmerkung für ein Feld oder eine Eigenschaft:

@Entity public class EntityWithNoId { private int id; public int getId() { return id; } // standard setter }

Da Hibernate erwartet, dass jede Entität einen Bezeichner hat , erhalten wir eine AnnotationException, wenn wir die Entität verwenden:

public void givenEntityWithoutId_whenSessionFactoryCreated_thenAnnotationException() { thrown.expect(AnnotationException.class); thrown.expectMessage("No identifier specified for entity"); Configuration cfg = getConfiguration(); cfg.addAnnotatedClass(EntityWithNoId.class); cfg.buildSessionFactory(); }

Darüber hinaus sind einige andere wahrscheinliche Ursachen:

  • Unbekannter Sequenzgenerator, der in der Annotation @GeneratedValue verwendet wird
  • @Temporal Annotation mit einem Java 8 Datum / Zeit - Klasse
  • Zielentität fehlt oder ist für @ManyToOne oder @OneToMany nicht vorhanden
  • Rohe Sammlungsklassen, die mit Beziehungsanmerkungen @OneToMany oder @ManyToMany verwendet werden
  • Konkrete Klassen, die mit den Sammlungsanmerkungen @OneToMany , @ManyToMany oder @ElementCollection verwendet werden, da Hibernate die Sammlungsschnittstellen erwartet

Um diese Ausnahme zu beheben, sollten Sie zuerst die in der Fehlermeldung erwähnte spezifische Anmerkung überprüfen.

4. Schemaverwaltungsfehler

Die automatische Verwaltung von Datenbankschemata ist ein weiterer Vorteil von Hibernate. Beispielsweise können DDL-Anweisungen generiert werden, um Datenbankobjekte zu erstellen oder zu validieren.

Um diese Funktion nutzen zu können, müssen Sie die Eigenschaft hibernate.hbm2ddl.auto entsprechend festlegen .

Wenn beim Ausführen der Schemaverwaltung Probleme auftreten, wird eine Ausnahme angezeigt. Lassen Sie uns diese Fehler untersuchen.

4.1. SchemaManagementException

Jedes infrastrukturbezogene Problem bei der Durchführung der Schemaverwaltung führt zu einer SchemaManagementException .

Lassen Sie uns zur Demonstration Hibernate anweisen, das Datenbankschema zu validieren:

public void givenMissingTable_whenSchemaValidated_thenSchemaManagementException() { thrown.expect(SchemaManagementException.class); thrown.expectMessage("Schema-validation: missing table"); Configuration cfg = getConfiguration(); cfg.setProperty(AvailableSettings.HBM2DDL_AUTO, "validate"); cfg.addAnnotatedClass(Product.class); cfg.buildSessionFactory(); }

Da die dem Produkt entsprechende Tabelle nicht in der Datenbank vorhanden ist, wird beim Erstellen der S essionFactory die Ausnahme für die Schemaüberprüfung angezeigt .

Darüber hinaus gibt es andere mögliche Szenarien für diese Ausnahme:

  • Es kann keine Verbindung zur Datenbank hergestellt werden, um Schemaverwaltungsaufgaben auszuführen
  • the schema is not present in the database

4.2. CommandAcceptanceException

Any problem executing a DDL corresponding to a specific schema management command can cause a CommandAcceptanceException.

As an example, let's specify the wrong dialect while setting up the SessionFactory:

public void whenWrongDialectSpecified_thenCommandAcceptanceException() { thrown.expect(SchemaManagementException.class); thrown.expectCause(isA(CommandAcceptanceException.class)); thrown.expectMessage("Halting on error : Error executing DDL"); Configuration cfg = getConfiguration(); cfg.setProperty(AvailableSettings.DIALECT, "org.hibernate.dialect.MySQLDialect"); cfg.setProperty(AvailableSettings.HBM2DDL_AUTO, "update"); cfg.setProperty(AvailableSettings.HBM2DDL_HALT_ON_ERROR,"true"); cfg.getProperties() .put(AvailableSettings.HBM2DDL_HALT_ON_ERROR, true); cfg.addAnnotatedClass(Product.class); cfg.buildSessionFactory(); }

Here, we've specified the wrong dialect: MySQLDialect. Also, we're instructing Hibernate to update the schema objects. Consequently, the DDL statements executed by Hibernate to update the H2 database will fail and we'll get an exception.

By default, Hibernate silently logs this exception and moves on. When we later use the SessionFactory, we get the exception.

To ensure that an exception is thrown on this error, we've set the property HBM2DDL_HALT_ON_ERROR to true.

Similarly, these are some other common causes for this error:

  • There is a mismatch in column names between mapping and the database
  • Two classes are mapped to the same table
  • The name used for a class or table is a reserved word in the database, like USER, for example
  • The user used to connect to the database does not have the required privilege

5. SQL Execution Errors

When we insert, update, delete or query data using Hibernate, it executes DML statements against the database using JDBC. This API raises an SQLException if the operation results in errors or warnings.

Hibernate converts this exception into JDBCException or one of its suitable subclasses:

  • ConstraintViolationException
  • DataException
  • JDBCConnectionException
  • LockAcquisitionException
  • PessimisticLockException
  • QueryTimeoutException
  • SQLGrammarException
  • GenericJDBCException

Let's discuss common errors.

5.1. JDBCException

JDBCException is always caused by a particular SQL statement. We can call the getSQL method to get the offending SQL statement.

Furthermore, we can retrieve the underlying SQLException with the getSQLException method.

5.2. SQLGrammarException

SQLGrammarException indicates that the SQL sent to the database was invalid. It could be due to a syntax error or an invalid object reference.

For example, a missing table can result in this error while querying data:

public void givenMissingTable_whenQueryExecuted_thenSQLGrammarException() { thrown.expect(isA(PersistenceException.class)); thrown.expectCause(isA(SQLGrammarException.class)); thrown.expectMessage("SQLGrammarException: could not prepare statement"); Session session = sessionFactory.getCurrentSession(); NativeQuery query = session.createNativeQuery( "select * from NON_EXISTING_TABLE", Product.class); query.getResultList(); }

Also, we can get this error while saving data if the table is missing:

public void givenMissingTable_whenEntitySaved_thenSQLGrammarException() { thrown.expect(isA(PersistenceException.class)); thrown.expectCause(isA(SQLGrammarException.class)); thrown .expectMessage("SQLGrammarException: could not prepare statement"); Configuration cfg = getConfiguration(); cfg.addAnnotatedClass(Product.class); SessionFactory sessionFactory = cfg.buildSessionFactory(); Session session = null; Transaction transaction = null; try { session = sessionFactory.openSession(); transaction = session.beginTransaction(); Product product = new Product(); product.setId(1); product.setName("Product 1"); session.save(product); transaction.commit(); } catch (Exception e) { rollbackTransactionQuietly(transaction); throw (e); } finally { closeSessionQuietly(session); closeSessionFactoryQuietly(sessionFactory); } }

Some other possible causes are:

  • The naming strategy used doesn't map the classes to the correct tables
  • The column specified in @JoinColumn doesn't exist

5.3. ConstraintViolationException

A ConstraintViolationException indicates that the requested DML operation caused an integrity constraint to be violated. We can get the name of this constraint by calling the getConstraintName method.

A common cause of this exception is trying to save duplicate records:

public void whenDuplicateIdSaved_thenConstraintViolationException() { thrown.expect(isA(PersistenceException.class)); thrown.expectCause(isA(ConstraintViolationException.class)); thrown.expectMessage( "ConstraintViolationException: could not execute statement"); Session session = null; Transaction transaction = null; for (int i = 1; i <= 2; i++) { try { session = sessionFactory.openSession(); transaction = session.beginTransaction(); Product product = new Product(); product.setId(1); product.setName("Product " + i); session.save(product); transaction.commit(); } catch (Exception e) { rollbackTransactionQuietly(transaction); throw (e); } finally { closeSessionQuietly(session); } } }

Also, saving a null value to a NOT NULL column in the database can raise this error.

In order to resolve this error, we should perform all validations in the business layer. Furthermore, database constraints should not be used to do application validations.

5.4. DataException

DataException indicates that the evaluation of an SQL statement resulted in some illegal operation, type mismatch or incorrect cardinality.

For instance, using character data against a numeric column can cause this error:

public void givenQueryWithDataTypeMismatch_WhenQueryExecuted_thenDataException() { thrown.expectCause(isA(DataException.class)); thrown.expectMessage( "org.hibernate.exception.DataException: could not prepare statement"); Session session = sessionFactory.getCurrentSession(); NativeQuery query = session.createNativeQuery( "select * from PRODUCT where", Product.class); query.getResultList(); }

To fix this error, we should ensure that the data types and length match between the application code and the database.

5.5. JDBCConnectionException

A JDBCConectionException indicates problems communicating with the database.

For example, a database or network going down can cause this exception to be thrown.

Additionally, an incorrect database setup can cause this exception. One such case is the database connection being closed by the server because it was idle for a long time. This can happen if we're using connection pooling and the idle timeout setting on the pool is more than the connection timeout value in the database.

To solve this problem, we should first ensure that the database host is present and that it's up. Then, we should verify that the correct authentication is used for the database connection. Finally, we should check that the timeout value is correctly set on the connection pool.

5.6. QueryTimeoutException

When a database query times out, we get this exception. We can also see it due to other errors, such as the tablespace becoming full.

This is one of the few recoverable errors, which means that we can retry the statement in the same transaction.

To fix this issue, we can increase the query timeout for long-running queries in multiple ways:

  • Set the timeout element in a @NamedQuery or @NamedNativeQuery annotation
  • Invoke the setHint method of the Query interface
  • Call the setTimeout method of the Transaction interface
  • Invoke the setTimeout method of the Query interface

6. Session-State-Related Errors

Let's now look into errors due to Hibernate session usage errors.

6.1. NonUniqueObjectException

Hibernate doesn't allow two objects with the same identifier in a single session.

If we try to associate two instances of the same Java class with the same identifier in a single session, we get a NonUniqueObjectException. We can get the name and identifier of the entity by calling the getEntityName() and getIdentifier() methods.

To reproduce this error, let's try to save two instances of Product with the same id with a session:

public void givenSessionContainingAnId_whenIdAssociatedAgain_thenNonUniqueObjectException() { thrown.expect(isA(NonUniqueObjectException.class)); thrown.expectMessage( "A different object with the same identifier value was already associated with the session"); Session session = null; Transaction transaction = null; try { session = sessionFactory.openSession(); transaction = session.beginTransaction(); Product product = new Product(); product.setId(1); product.setName("Product 1"); session.save(product); product = new Product(); product.setId(1); product.setName("Product 2"); session.save(product); transaction.commit(); } catch (Exception e) { rollbackTransactionQuietly(transaction); throw (e); } finally { closeSessionQuietly(session); } }

We'll get a NonUniqueObjectException, as expected.

This exception occurs frequently while reattaching a detached object with a session by calling the update method. If the session has another instance with the same identifier loaded, then we get this error. In order to fix this, we can use the merge method to reattach the detached object.

6.2. StaleStateException

Hibernate throws StaleStateExceptions when the version number or timestamp check fails. It indicates that the session contained stale data.

Sometimes this gets wrapped into an OptimisticLockException.

This error usually happens while using long-running transactions with versioning.

In addition, it can also happen while trying to update or delete an entity if the corresponding database row doesn't exist:

public void whenUpdatingNonExistingObject_thenStaleStateException() { thrown.expect(isA(OptimisticLockException.class)); thrown.expectMessage( "Batch update returned unexpected row count from update"); thrown.expectCause(isA(StaleStateException.class)); Session session = null; Transaction transaction = null; try { session = sessionFactory.openSession(); transaction = session.beginTransaction(); Product product = new Product(); product.setId(15); product.setName("Product1"); session.update(product); transaction.commit(); } catch (Exception e) { rollbackTransactionQuietly(transaction); throw (e); } finally { closeSessionQuietly(session); } }

Some other possible scenarios are:

  • we did not specify a proper unsaved-value strategy for the entity
  • two users tried to delete the same row at almost the same time
  • we manually set a value in the autogenerated ID or version field

7. Lazy Initialization Errors

We usually configure associations to be loaded lazily in order to improve application performance. The associations are fetched only when they're first used.

However, Hibernate requires an active session to fetch data. If the session is already closed when we try to access an uninitialized association, we get an exception.

Let's look into this exception and the various ways to fix it.

7.1. LazyInitializationException

LazyInitializationException indicates an attempt to load uninitialized data outside an active session. We can get this error in many scenarios.

First, we can get this exception while accessing a lazy relationship in the presentation layer. The reason is that the entity was partially loaded in the business layer and the session was closed.

Secondly, we can get this error with Spring Data if we use the getOne method. This method lazily fetches the instance.

There are many ways to solve this exception.

First of all, we can make all relationships eagerly loaded. But, this would impact the application performance because we'll be loading data that won't be used.

Secondly, we can keep the session open until the view is rendered. This is known as the “Open Session in View” and it's an anti-pattern. We should avoid this as it has several disadvantages.

Thirdly, we can open another session and reattach the entity in order to fetch the relationships. We can do so by using the merge method on the session.

Finally, we can initialize the required associations in the business layers. We'll discuss this in the next section.

7.2. Initializing Relevant Lazy Relationships in the Business Layer

There are many ways to initialize lazy relationships.

One option is to initialize them by invoking the corresponding methods on the entity. In this case, Hibernate will issue multiple database queries causing degraded performance. We refer to it as the “N+1 SELECT” problem.

Secondly, we can use Fetch Join to get the data in a single query. However, we need to write custom code to achieve this.

Finally, we can use entity graphs to define all the attributes to be fetched. We can use the annotations @NamedEntityGraph, @NamedAttributeNode, and @NamedEntitySubgraph to declaratively define the entity graph. We can also define them programmatically with the JPA API. Then, we retrieve the entire graph in a single call by specifying it in the fetch operation.

8. Transaction Issues

Transactions define units of work and isolation between concurrent activities. We can demarcate them in two different ways. First, we can define them declaratively using annotations. Second, we can manage them programmatically using the Hibernate Transaction API.

Furthermore, Hibernate delegates the transaction management to a transaction manager. If a transaction could not be started, committed or rolled back due to any reason, Hibernate throws an exception.

We usually get a TransactionException or an IllegalArgumentException depending on the transaction manager.

As an illustration, let's try to commit a transaction which has been marked for rollback:

public void givenTxnMarkedRollbackOnly_whenCommitted_thenTransactionException() { thrown.expect(isA(TransactionException.class)); thrown.expectMessage( "Transaction was marked for rollback only; cannot commit"); Session session = null; Transaction transaction = null; try { session = sessionFactory.openSession(); transaction = session.beginTransaction(); Product product = new Product(); product.setId(15); product.setName("Product1"); session.save(product); transaction.setRollbackOnly(); transaction.commit(); } catch (Exception e) { rollbackTransactionQuietly(transaction); throw (e); } finally { closeSessionQuietly(session); } }

Similarly, other errors can also cause an exception:

  • Mixing declarative and programmatic transactions
  • Attempting to start a transaction when another one is already active in the session
  • Trying to commit or rollback without starting a transaction
  • Trying to commit or rollback a transaction multiple times

9. Concurrency Issues

Hibernate supports two locking strategies to prevent database inconsistency due to concurrent transactions – optimistic and pessimistic. Both of them raise an exception in case of a locking conflict.

To support high concurrency and high scalability, we typically use optimistic concurrency control with version checking. This uses version numbers or timestamps to detect conflicting updates.

OptimisticLockingException is thrown to indicate an optimistic locking conflict. For instance, we get this error if we perform two updates or deletes of the same entity without refreshing it after the first operation:

public void whenDeletingADeletedObject_thenOptimisticLockException() { thrown.expect(isA(OptimisticLockException.class)); thrown.expectMessage( "Batch update returned unexpected row count from update"); thrown.expectCause(isA(StaleStateException.class)); Session session = null; Transaction transaction = null; try { session = sessionFactory.openSession(); transaction = session.beginTransaction(); Product product = new Product(); product.setId(12); product.setName("Product 12"); session.save(product1); transaction.commit(); session.close(); session = sessionFactory.openSession(); transaction = session.beginTransaction(); product = session.get(Product.class, 12); session.createNativeQuery("delete from Product where id=12") .executeUpdate(); // We need to refresh to fix the error. // session.refresh(product); session.delete(product); transaction.commit(); } catch (Exception e) { rollbackTransactionQuietly(transaction); throw (e); } finally { closeSessionQuietly(session); } }

Ebenso kann dieser Fehler auch auftreten, wenn zwei Benutzer versuchen, dieselbe Entität fast gleichzeitig zu aktualisieren. In diesem Fall kann der erste erfolgreich sein und der zweite löst diesen Fehler aus.

Daher können wir diesen Fehler nicht vollständig vermeiden, ohne eine pessimistische Sperrung einzuführen . Wir können jedoch die Wahrscheinlichkeit seines Auftretens minimieren, indem wir Folgendes tun:

  • Halten Sie die Aktualisierungsvorgänge so kurz wie möglich
  • Aktualisieren Sie Entitätsdarstellungen im Client so oft wie möglich
  • Zwischenspeichern Sie die Entität oder ein Wertobjekt, das sie darstellt, nicht
  • Aktualisieren Sie die Entitätsdarstellung auf dem Client nach der Aktualisierung immer

10. Schlussfolgerung

In diesem Artikel haben wir einige häufige Ausnahmen untersucht, die bei der Verwendung von Hibernate auftreten. Darüber hinaus untersuchten wir ihre wahrscheinlichen Ursachen und Lösungen.

Wie immer finden Sie den vollständigen Quellcode auf GitHub.