AVRO-3441: ServiceLoader for LogicalTypeFactory #1590
Merged
Conversation
This file contains hidden or 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
Automatically register LogicalTypeFactory classes using the Java 6 service loader upon startup. This works for any LogicalTypeFactory that does not need constructor parameters.
opwvhk
commented
Mar 9, 2022
Comment on lines
+60
to
+64
| static { | ||
| for (LogicalTypeFactory logicalTypeFactory : ServiceLoader.load(LogicalTypeFactory.class)) { | ||
| register(logicalTypeFactory); | ||
| } | ||
| } |
Contributor
Author
There was a problem hiding this comment.
This is the actual magic.
opwvhk
commented
Mar 9, 2022
| */ | ||
| package org.apache.avro; | ||
|
|
||
| public class DummyLogicalTypeFactory implements LogicalTypes.LogicalTypeFactory { |
Contributor
Author
There was a problem hiding this comment.
This is part 1 of what makes it work: a public class with a public no-arg constructor (a default constructor in this case, but that's not important).
opwvhk
commented
Mar 9, 2022
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| org.apache.avro.DummyLogicalTypeFactory |
Contributor
Author
There was a problem hiding this comment.
This is part 2 of what makes it work: a file in META-INF/services named after the binary name of the interface, containing names of classes that implement the interface (one per line); comments and empty lines are ignored.
opwvhk
commented
Mar 9, 2022
Comment on lines
+291
to
+296
| @Test | ||
| public void testRegisterLogicalTypeFactoryByServiceLoader() { | ||
| MatcherAssert.assertThat(LogicalTypes.getCustomRegisteredTypes(), | ||
| IsMapContaining.hasEntry(equalTo("service-example"), instanceOf(LogicalTypes.LogicalTypeFactory.class))); | ||
| } | ||
|
|
opwvhk
commented
Mar 9, 2022
Comment on lines
+298
to
+299
| Assert.assertEquals("Should be equal (forward): " + message, o1, o2); | ||
| Assert.assertEquals("Should be equal (reverse): " + message, o2, o1); |
Contributor
Author
There was a problem hiding this comment.
Boyscout rule (plus a few more)
martin-g
approved these changes
Mar 17, 2022
RyanSkraba
approved these changes
Mar 18, 2022
RyanSkraba
pushed a commit
that referenced
this pull request
Mar 18, 2022
Automatically register LogicalTypeFactory classes using the Java 6 service loader upon startup. This works for any LogicalTypeFactory that does not need constructor parameters.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Automatically register LogicalTypeFactory classes using the Java 6
service loader upon startup. This works for any LogicalTypeFactory that
does not need constructor parameters.
Make sure you have checked all steps below.
Jira
Tests
OR does not need testing for this extremely good reason:org.apache.avro.TestLogicalType#testRegisterLogicalTypeFactoryByServiceLoaderCommits
Documentation