Document Querydsl annotation processor usage #4814
Closed
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
Comment on lines
+360
to
+437
| The following example shows how to set up annotation processing by mentioning dependencies and compiler config changes in Maven and Gradle: | ||
|
|
||
| [tabs] | ||
| ====== | ||
| Maven:: | ||
| + | ||
| [source,xml,indent=0,subs="verbatim,quotes",role="primary"] | ||
| ---- | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>com.querydsl</groupId> | ||
| <artifactId>querydsl-mongodb</artifactId> | ||
| <version>${querydslVersion}</version> | ||
|
|
||
| <!-- Recommended: Exclude the mongo-java-driver to avoid version conflicts --> | ||
| <exclusions> | ||
| <exclusion> | ||
| <groupId>org.mongodb</groupId> | ||
| <artifactId>mongo-java-driver</artifactId> | ||
| </exclusion> | ||
| </exclusions> | ||
| </dependency> | ||
|
|
||
| <dependency> | ||
| <groupId>com.querydsl</groupId> | ||
| <artifactId>querydsl-apt</artifactId> | ||
| <version>${querydslVersion}</version> | ||
| <scope>provided</scope> | ||
| </dependency> | ||
| </dependencies> | ||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-compiler-plugin</artifactId> | ||
| <configuration> | ||
| <annotationProcessors> | ||
| <annotationProcessor> | ||
| org.springframework.data.mongodb.repository.support.MongoAnnotationProcessor | ||
| </annotationProcessor> | ||
| </annotationProcessors> | ||
|
|
||
| <!-- Recommended: Some IDE's might require this configuration to include generated sources for IDE usage --> | ||
| <generatedTestSourcesDirectory>target/generated-test-sources</generatedTestSourcesDirectory> | ||
| <generatedSourcesDirectory>target/generated-sources</generatedSourcesDirectory> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| ---- | ||
|
|
||
| Gradle:: | ||
| + | ||
| ==== | ||
| [source,groovy,indent=0,subs="verbatim,quotes",role="secondary"] | ||
| ---- | ||
| dependencies { | ||
| implementation 'com.querydsl:querydsl-mongodb:${querydslVersion}' | ||
|
|
||
| annotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}' | ||
| annotationProcessor 'org.springframework.data:spring-data-mongodb' | ||
|
|
||
| testAnnotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}' | ||
| testAnnotationProcessor 'org.springframework.data:spring-data-mongodb' | ||
| } | ||
|
|
||
| tasks.withType(JavaCompile).configureEach { | ||
| options.compilerArgs += [ | ||
| "-processor", | ||
| "org.springframework.data.mongodb.repository.support.MongoAnnotationProcessor"] | ||
| } | ||
| ---- | ||
|
|
||
| ==== | ||
| ====== | ||
|
|
||
| Note that the setup above shows the simplest usage omitting any other options or dependencies that your project might require. |
There was a problem hiding this comment.
do we really need to include the maven/gradle setup?
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.
Closes #4811