Add package-to-scan feature #786
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Context Some applications can have thousands of classes. When JPA is configured to scan classes (`exclude-unlisted-classes` is `false` in `persistence.xml`), the time used to scan all classes can be quite long. With reasonable application size, class scanning can take only ten's of milliseconds but for heavy application it can take a few seconds. In order to help reducing startup time, we can restrict class scanning to a pre-configured list of known packages to avoid loading unnecessary classes metadata. # What was done - Introduced a new property `PersistenceUnitProperties.PACKAGES_TO_SCAN`: `eclipselink.packages-to-scan` - Modified `PersistenceUnitProcessor.getClassNamesFromURL` to only return eligible classes This new property takes as a value a list of packages as a string: `com.foo.bar, some.other.packages` # Performance result I've tested this feature with 2 applications, one with ~1000 classes and another with more than 30k classes. `MetadataProcessor.initPersistenceUnitClasses` was faster by ~25% for the small application and ~45% for the big one. Signed-off-by: Alexandre Jacob <alexandref.jacob@gmail.com>
ajacob
force-pushed
the
add-packages-to-scan-feature
branch
from
519a95b
to
6a6dabf
Compare
t-beckmann
approved these changes
Aug 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Some applications can have thousands of classes.
When JPA is configured to scan classes (
exclude-unlisted-classesisfalseinpersistence.xml), the time used to scan all classes can be quite long.With reasonable application size, class scanning can take only ten's of milliseconds but for heavy application it can take a few seconds.
In order to help reducing startup time, we can restrict class scanning to a pre-configured list of known packages to avoid loading unnecessary classes metadata.
What was done
PersistenceUnitProperties.PACKAGES_TO_SCAN:eclipselink.packages-to-scanPersistenceUnitProcessor.getClassNamesFromURLto only return eligible classesThis new property takes as a value a list of packages as a string:
com.foo.bar, some.other.packagesPerformance result
I've tested this feature with 2 applications, one with ~1000 classes and another with more than 30k classes.
MetadataProcessor.initPersistenceUnitClasseswas faster by ~25% for the small application and ~45% for the big one.NOTE: This is a port from a
2.7.4patched version running in production