Class AcrossJVMSerializationFeature
- All Implemented Interfaces:
Serializable
Serializable
.
The way it works is to enable serialization via the enableSerializationAcrossJVM(MockCreationSettings)
,
if the mock settings is set to be serializable it will add the AcrossJVMSerializationFeature.AcrossJVMMockitoMockSerializable
interface.
This interface defines a the AcrossJVMSerializationFeature.AcrossJVMMockitoMockSerializable.writeReplace()
whose signature match the one that is looked by the standard Java serialization.
Then in the MethodInterceptorFilter
of mockito, if the writeReplace
method is called,
it will use the custom implementation of this class writeReplace(Object)
. This method has a specific
knowledge on how to serialize a mockito mock that is based on CGLIB.
Only one instance per mock! See MethodInterceptorFilter
- Since:
- 1.10.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
Simple interface that hold a correctwriteReplace
signature that can be seen by anObjectOutputStream
.static class
This is the serialization proxy that will encapsulate the real mock data as a byte array.static class
Special Mockito awareObjectInputStream
that will resolve the Mockito proxy class.private static class
Special Mockito awareObjectOutputStream
. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription<T> void
enableSerializationAcrossJVM
(org.mockito.mock.MockCreationSettings<T> settings) Enable serialization serialization that will work across classloaders / and JVM.boolean
isWriteReplace
(Method method) private boolean
private void
private void
writeReplace
(Object mockitoMock) Custom implementation of thewriteReplace
method for serialization.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
MOCKITO_PROXY_MARKER
- See Also:
-
instanceLocalCurrentlySerializingFlag
private boolean instanceLocalCurrentlySerializingFlag -
mutex
-
-
Constructor Details
-
AcrossJVMSerializationFeature
AcrossJVMSerializationFeature()
-
-
Method Details
-
isWriteReplace
-
writeReplace
Custom implementation of thewriteReplace
method for serialization. Here's how it's working and why :-
When first entering in this method, it's because some is serializing the mock, with some code like :
So,objectOutputStream.writeObject(mock);
ObjectOutputStream
will track thewriteReplace
method in the instance and execute it, which is wanted to replace the mock by another type that will encapsulate the actual mock. At this point, the code will return anAcrossJVMSerializationFeature.AcrossJVMMockSerializationProxy
. -
Now, in the constructor
AcrossJVMMockSerializationProxy(Object)
the mock is being serialized in a custom way (usingAcrossJVMSerializationFeature.MockitoMockObjectOutputStream
) to a byte array. So basically it means the code is performing double nested serialization of the passedmockitoMock
.However the
ObjectOutputStream
will still detect the customwriteReplace
and execute it. (For that matter disabling replacement viaObjectOutputStream.enableReplaceObject(boolean)
doesn't disable thewriteReplace
call, but just just toggle replacement in the written stream,writeReplace
is always called byObjectOutputStream
.)In order to avoid this recursion, obviously leading to a
StackOverflowError
, this method is using a flag that marks the mock as already being replaced, and then shouldn't replace itself again. This flag is local to this class, which means the flag of this class unfortunately needs to be protected against concurrent access, hence the reentrant lock.
- Parameters:
mockitoMock
- The Mockito mock to be serialized.- Returns:
- A wrapper (
AcrossJVMSerializationFeature.AcrossJVMMockSerializationProxy
) to be serialized by the calling ObjectOutputStream. - Throws:
ObjectStreamException
-
-
mockReplacementCompleted
private void mockReplacementCompleted() -
mockReplacementStarted
private void mockReplacementStarted() -
mockIsCurrentlyBeingReplaced
private boolean mockIsCurrentlyBeingReplaced() -
enableSerializationAcrossJVM
public <T> void enableSerializationAcrossJVM(org.mockito.mock.MockCreationSettings<T> settings) Enable serialization serialization that will work across classloaders / and JVM.Only enable if settings says the mock should be serializable. In this case add the
AcrossJVMSerializationFeature.AcrossJVMMockitoMockSerializable
to the extra interface list.- Type Parameters:
T
- Type param to not be bothered by the generics- Parameters:
settings
- Mock creation settings.
-