Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-15522 Implement a LazyInitializable interface that PersistentCollection and Envers collections extend or implement. Improve related tests.

This commit is contained in:
Fabricio Gregorio 2022-09-17 18:55:26 -03:00 committed by Yoann Rodière
parent c3f1762f3b
commit 4ac2054784
9 changed files with 110 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
hibernate-core/src/main/java/org/hibernate/Hibernate.java
View File

@ -34,6 +34,7 @@ import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.persister.entity.EntityPersister;
import org.hibernate.proxy.HibernateProxy;
import org.hibernate.proxy.LazyInitializer;
import org.hibernate.collection.spi.LazyInitializable;
/**
* Various utility functions for working with proxies and lazy collection references.
@ -85,8 +86,8 @@ public final class Hibernate {
if ( proxy instanceof HibernateProxy ) {
( (HibernateProxy) proxy ).getHibernateLazyInitializer().initialize();
}
else if ( proxy instanceof PersistentCollection ) {
( (PersistentCollection<?>) proxy ).forceInitialization();
else if ( proxy instanceof LazyInitializable ) {
( (LazyInitializable) proxy ).forceInitialization();
}
else if ( proxy instanceof PersistentAttributeInterceptable ) {
final PersistentAttributeInterceptable interceptable = (PersistentAttributeInterceptable) proxy;
@ -111,8 +112,8 @@ public final class Hibernate {
final PersistentAttributeInterceptor interceptor = ( (PersistentAttributeInterceptable) proxy ).$$_hibernate_getInterceptor();
return !(interceptor instanceof EnhancementAsProxyLazinessInterceptor);
}
else if ( proxy instanceof PersistentCollection ) {
return ( (PersistentCollection<?>) proxy ).wasInitialized();
else if ( proxy instanceof LazyInitializable ) {
return ( (LazyInitializable) proxy ).wasInitialized();
}
else {
return true;

33
hibernate-core/src/main/java/org/hibernate/collection/spi/LazyInitializable.java Normal file
View File

@ -0,0 +1,33 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.collection.spi;
import org.hibernate.Incubating;
/**
* Hibernate "wraps" a java collection in an instance of PersistentCollection. Envers uses custom collection
* wrappers (ListProxy, SetProxy, etc). All of them need to extend LazyInitializable, so the
* Hibernate.isInitialized method can check if the collection is initialized or not.
*
* @author Fabricio Gregorio
*/
@Incubating
public interface LazyInitializable {
/**
* Is this instance initialized?
*
* @return Was this collection initialized? Or is its data still not (fully) loaded?
*/
boolean wasInitialized();
/**
* To be called internally by the session, forcing immediate initialization.
*/
void forceInitialization();
}

14
hibernate-core/src/main/java/org/hibernate/collection/spi/PersistentCollection.java
View File

@ -48,7 +48,7 @@ import org.hibernate.type.Type;
* @author Gavin King
*/
@Incubating
public interface PersistentCollection<E> {
public interface PersistentCollection<E> extends LazyInitializable {
/**
* Get the owning entity. Note that the owner is only
* set during the flush cycle, and when a new collection
@ -211,11 +211,6 @@ public interface PersistentCollection<E> {
*/
Serializable getSnapshot(CollectionPersister persister);
/**
* To be called internally by the session, forcing immediate initialization.
*/
void forceInitialization();
/**
* Does the given element/entry exist in the collection?
*
@ -280,13 +275,6 @@ public interface PersistentCollection<E> {
*/
boolean isInitializing();
/**
* Is this instance initialized?
*
* @return Was this collection initialized? Or is its data still not (fully) loaded?
*/
boolean wasInitialized();
/**
* Called prior to the initialization of this yet-uninitialized collection. Pairs
* with {@link #afterInitialize}

16
hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/relation/lazy/proxy/CollectionProxy.java
View File

@ -9,13 +9,15 @@ package org.hibernate.envers.internal.entities.mapper.relation.lazy.proxy;
import java.io.Serializable;
import java.util.Collection;
import java.util.Iterator;
import org.hibernate.collection.spi.LazyInitializable;
import org.hibernate.envers.internal.entities.mapper.relation.lazy.initializor.Initializor;
/**
* @author Adam Warski (adam at warski dot org)
*/
public abstract class CollectionProxy<U, T extends Collection<U>> implements Collection<U>, Serializable {
public abstract class CollectionProxy<U, T extends Collection<U>> implements Collection<U>, LazyInitializable, Serializable {
private static final long serialVersionUID = 8698249863871832402L;
private transient Initializor<T> initializor;
@ -34,6 +36,16 @@ public abstract class CollectionProxy<U, T extends Collection<U>> implements Col
}
}
@Override
public final boolean wasInitialized() {
return delegate != null;
}
@Override
public final void forceInitialization() {
checkInit();
}
@Override
public int size() {
checkInit();
@ -118,7 +130,7 @@ public abstract class CollectionProxy<U, T extends Collection<U>> implements Col
return delegate.toString();
}
@SuppressWarnings({"EqualsWhichDoesntCheckParameterClass"})
@SuppressWarnings({ "EqualsWhichDoesntCheckParameterClass" })
@Override
public boolean equals(Object obj) {
checkInit();

17
hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/relation/lazy/proxy/MapProxy.java
View File

@ -10,13 +10,14 @@ import java.io.Serializable;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
import org.hibernate.collection.spi.LazyInitializable;
import org.hibernate.envers.internal.entities.mapper.relation.lazy.initializor.Initializor;
/**
* @author Adam Warski (adam at warski dot org)
*/
public class MapProxy<K, V> implements Map<K, V>, Serializable {
public class MapProxy<K, V> implements Map<K, V>, LazyInitializable, Serializable {
private static final long serialVersionUID = 8418037541773074646L;
private transient Initializor<Map<K, V>> initializor;
@ -35,6 +36,16 @@ public class MapProxy<K, V> implements Map<K, V>, Serializable {
}
}
@Override
public final boolean wasInitialized() {
return delegate != null;
}
@Override
public final void forceInitialization() {
checkInit();
}
@Override
public int size() {
checkInit();
@ -114,7 +125,7 @@ public class MapProxy<K, V> implements Map<K, V>, Serializable {
}
@Override
@SuppressWarnings({"EqualsWhichDoesntCheckParameterClass"})
@SuppressWarnings({ "EqualsWhichDoesntCheckParameterClass" })
public boolean equals(Object obj) {
checkInit();
return delegate.equals( obj );

17
hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/relation/lazy/proxy/SortedMapProxy.java
View File

@ -12,13 +12,14 @@ import java.util.Comparator;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import org.hibernate.collection.spi.LazyInitializable;
import org.hibernate.envers.internal.entities.mapper.relation.lazy.initializor.Initializor;
/**
* @author Adam Warski (adam at warski dot org)
*/
public class SortedMapProxy<K, V> implements SortedMap<K, V>, Serializable {
public class SortedMapProxy<K, V> implements SortedMap<K, V>, LazyInitializable, Serializable {
private static final long serialVersionUID = 2645817952901452375L;
private transient Initializor<SortedMap<K, V>> initializor;
@ -37,6 +38,16 @@ public class SortedMapProxy<K, V> implements SortedMap<K, V>, Serializable {
}
}
@Override
public final boolean wasInitialized() {
return delegate != null;
}
@Override
public final void forceInitialization() {
checkInit();
}
@Override
public int size() {
checkInit();
@ -146,7 +157,7 @@ public class SortedMapProxy<K, V> implements SortedMap<K, V>, Serializable {
}
@Override
@SuppressWarnings({"EqualsWhichDoesntCheckParameterClass"})
@SuppressWarnings({ "EqualsWhichDoesntCheckParameterClass" })
public boolean equals(Object o) {
checkInit();
return delegate.equals( o );

45
hibernate-envers/src/test/java/org/hibernate/orm/test/envers/entities/collection/MultipleCollectionEntity.java
View File

@ -9,6 +9,8 @@ package org.hibernate.orm.test.envers.entities.collection;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import jakarta.persistence.CascadeType;
import jakarta.persistence.Column;
import jakarta.persistence.Entity;
@ -26,6 +28,7 @@ import org.hibernate.envers.Audited;
@Entity
@Audited
public class MultipleCollectionEntity {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "ID", length = 10)
@ -65,7 +68,7 @@ public class MultipleCollectionEntity {
}
public List<MultipleCollectionRefEntity1> getRefEntities1() {
return Collections.unmodifiableList( refEntities1 );
return refEntities1;
}
public void addRefEntity1(MultipleCollectionRefEntity1 refEntity1) {
@ -77,7 +80,7 @@ public class MultipleCollectionEntity {
}
public List<MultipleCollectionRefEntity2> getRefEntities2() {
return Collections.unmodifiableList( refEntities2 );
return refEntities2;
}
public void addRefEntity2(MultipleCollectionRefEntity2 refEntity2) {
@ -110,34 +113,20 @@ public class MultipleCollectionEntity {
}
@Override
public boolean equals(Object o) {
if ( this == o ) {
return true;
}
if ( !(o instanceof MultipleCollectionEntity) ) {
return false;
}
MultipleCollectionEntity that = (MultipleCollectionEntity) o;
if ( refEntities1 != null ? !refEntities1.equals( that.refEntities1 ) : that.refEntities1 != null ) {
return false;
}
if ( refEntities2 != null ? !refEntities2.equals( that.refEntities2 ) : that.refEntities2 != null ) {
return false;
}
if ( text != null ? !text.equals( that.text ) : that.text != null ) {
return false;
}
return true;
public int hashCode() {
return Objects.hash( id );
}
@Override
public int hashCode() {
int result = text != null ? text.hashCode() : 0;
result = 31 * result + (refEntities1 != null ? refEntities1.hashCode() : 0);
result = 31 * result + (refEntities2 != null ? refEntities2.hashCode() : 0);
return result;
public boolean equals(Object obj) {
if ( this == obj )
return true;
if ( obj == null )
return false;
if ( getClass() != obj.getClass() )
return false;
MultipleCollectionEntity other = (MultipleCollectionEntity) obj;
return Objects.equals( id, other.id );
}
}

7
hibernate-envers/src/test/java/org/hibernate/orm/test/envers/integration/lazy/IsCollectionInitializedBytecodeEnhancementTest.java
View File

@ -77,6 +77,7 @@ public class IsCollectionInitializedBytecodeEnhancementTest extends BaseEnversJP
}
@Test
@SuppressWarnings("unchecked")
public void testIsInitialized() {
EntityManager em = getEntityManager();
@ -88,6 +89,10 @@ public class IsCollectionInitializedBytecodeEnhancementTest extends BaseEnversJP
MultipleCollectionEntity ret = res.get( 0 );
assertEquals( Hibernate.isInitialized( ret.getRefEntities1() ), false );
Hibernate.initialize(ret.getRefEntities1());
assertEquals( Hibernate.isInitialized( ret.getRefEntities1() ), true );
}
}

7
hibernate-envers/src/test/java/org/hibernate/orm/test/envers/integration/lazy/IsCollectionInitializedTest.java
View File

@ -72,6 +72,7 @@ public class IsCollectionInitializedTest extends BaseEnversJPAFunctionalTestCase
}
@Test
@SuppressWarnings("unchecked")
public void testIsInitialized() {
EntityManager em = getEntityManager();
@ -81,8 +82,12 @@ public class IsCollectionInitializedTest extends BaseEnversJPAFunctionalTestCase
.getResultList();
MultipleCollectionEntity ret = res.get( 0 );
assertEquals( Hibernate.isInitialized( ret.getRefEntities1() ), false );
Hibernate.initialize(ret.getRefEntities1());
assertEquals( Hibernate.isInitialized( ret.getRefEntities1() ), true );
}
}