Skip to content

Commit da5a406

Browse files
gonzalogomezgarciagonzalogomezgarcia
committed
Added sample project to show plugin configuration to use customized templates:
* graphql-maven-plugin-samples-CustomTemplates-resttemplate defines a customized template for a Query implementation based on a Srping-based QueryExecutor using RestTemplate * graphql-maven-plugin-samples-CustomTemplates-client is a client project showing plugin configuration to use customized template Update Maven site with new page ustomtemplates.apt.vm showing usage of new param "templates" Updated README with info related on how to customize code generation on Maven Plugin
1 parent e8c635b commit da5a406

File tree

15 files changed

+1044
-15
lines changed

15 files changed

+1044
-15
lines changed

‎README.md

Lines changed: 90 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
The GraphQL Java Generator makes it easy to work in Java with graphQL in a schema first approach.
44

5-
This project is an accelerator to develop __GraphQL clients__ and __GraphQL servers__ in java.
5+
This project is an accelerator to develop __GraphQL clients__ and __GraphQL servers__ in java.
66

7-
That is: graphql-java-generator generates the boilerplate code, and lets you concentrate on what's specific to your use case. Then, the running code __doesn't depend on any dependencies from graphql-java-generator__. So you can get rid of graphql-java-generator at any time: just put the generated code in your SCM, and that's it.
7+
That is: graphql-java-generator generates the boilerplate code, and lets you concentrate on what's specific to your use case. Then, the running code __doesn't depend on any dependencies from graphql-java-generator__. So you can get rid of graphql-java-generator at any time: just put the generated code in your SCM, and that's it.
88

99
* In __client mode__ : graphql-java-generator generates a class for each query and mutation type (subscriptions are not managed yet). These classes contain the methods to call the queries and mutations. That is, to call the GraphQL server, you just call one of this method.
1010
* graphql-java-generator also generates the POJOs from the GraphQL schema. The __GraphQL response is stored in these POJOs__, for easy and standard use in Java.
@@ -14,10 +14,10 @@ That is: graphql-java-generator generates the boilerplate code, and lets you con
1414
* graphql-java-generator also generates interfaces, named DataFetchersDelegate. It expects a Spring Bean to be defined.
1515
* The developer just has to implement each DataFetchersDelegate, and the GraphQL server is ready to go!
1616

17-
Please, take a look at the projects that are within the graphql-maven-plugin-samples: they show various ways to implement a GraphQL server, based on the graphql-java library.
17+
Please, take a look at the projects that are within the graphql-maven-plugin-samples: they show various ways to implement a GraphQL server, based on the graphql-java library.
1818

19-
__The interesting part is that graphql-java-generator is just an accelerator: you don't depend on any library from graphql-java-generator__. So, it just helps you to build application based on [graphql-java](https://www.graphql-java.com) .
20-
If the generated code doesn't fully suit your needs, you can take what's generated as a full sample for graphql-java usage, based on your use case. You can then update the generated code, where it's not compliant for you. And that's it. The only thing, there, is that we would like to know what was not correct for your use case, so that we can embed it into next versions. Or perhaps, if it's just a matter of documentation, to better explain how to use it...
19+
__The interesting part is that graphql-java-generator is just an accelerator: you don't depend on any library from graphql-java-generator__. So, it just helps you to build application based on [graphql-java](https://www.graphql-java.com) .
20+
If the generated code doesn't fully suit your needs, you can take what's generated as a full sample for graphql-java usage, based on your use case. You can then update the generated code, where it's not compliant for you. And that's it. The only thing, there, is that we would like to know what was not correct for your use case, so that we can embed it into next versions. Or perhaps, if it's just a matter of documentation, to better explain how to use it...
2121

2222
The generator is currently available as a maven plugin. A Gradle plugin will come soon.
2323

@@ -52,14 +52,18 @@ You'll find the following samples in the project. For all of these samples, ther
5252
* The GraphQL server exposes http
5353
* The server uses the schema personalization, to override the default code generation
5454
* The GraphQL model maps to the database model
55-
* The Forum client project shows implementation of the same queries in the XxxQueries classes.
55+
* The Forum client project shows implementation of the same queries in the XxxQueries classes.
5656
* StarWars
5757
* The server is packaged as a war
5858
* The GraphQL server exposes https
5959
* The GraphQL interfaces in this model (character, and friends relation) makes it difficult to map to native RDBMS data model. This project uses JPA native queries to overcome this.
6060
* The StarWars client project shows implementation of the same queries in the XxxQueries classes.
61+
* CustomTemplates
62+
* An example related on how to customize code templates
63+
* graphql-maven-plugin-samples-CustomTemplates-resttemplate project offers a customize template for Query/Mutation/Subscriptino client class and offer a Spring-base RestTemplate implementation for QueryExecutor template
64+
* graphql-maven-plugin-samples-CustomTemplates-resttemplate proyect defines a client project that generates code with customized template defined in previous project
6165

62-
Note: The client projects for these samples contain integration tests. They are part of the global build. These integration tests check the graphql-maven-plugin behaviour for both the client and the server for these samples.
66+
Note: The client projects for these samples contain integration tests. They are part of the global build. These integration tests check the graphql-maven-plugin behaviour for both the client and the server for these samples.
6367

6468
### Client mode
6569

@@ -91,10 +95,10 @@ When in server mode, the plugin generates:
9195
* The DataFetchersDelegate interface declarations for all the [Data Fetchers](https://www.graphql-java.com/documentation/master/data-fetching/), which is the graphql-java word for GraphQL resolvers.
9296
* The DataFetchersDelegate groups the Data Fetchers into one class per GraphQL object (including the Query and the Mutation)
9397
* It contains the proper declarations to use the [DataLoader](https://github.com/graphql-java/java-dataloader) out of the box
94-
* The POJOs to manipulate the GraphQL objects defined in the GraphQL schema.
98+
* The POJOs to manipulate the GraphQL objects defined in the GraphQL schema.
9599
* These POJOs are annotated with JPA annotations. This allows you to link them to almost any database
96100
* You can customize these annotations, with the Schema Personalization file (see below for details)
97-
* (in a near future) It will be possible to define your own code template, to generate exactly the code you want
101+
* (in a near future) It will be possible to define your own code template, to generate exactly the code you want
98102
* All the necessary runtime is actually attached as source code into your project: the generated code is stand-alone. So, your project, when it runs, doesn't depend on any external dependency from graphql-java-generator.
99103

100104
Once all this is generated, your only work is to implement the DataFetchersDelegate interfaces. They are the link between the GraphQL schema and your data storage. As such, they are specific to your use case. A DataFetchersDelegate implementation looks like this:
@@ -140,6 +144,82 @@ public class DataFetchersDelegateTopicImpl implements DataFetchersDelegateTopic
140144

141145
You'll find all the info on the [server](server.html) page.
142146

147+
148+
### Custom code templates
149+
150+
If for any reason you may need to customize the template to modify the generated code this can be donde using the parameter **tempaltes**
151+
152+
Here there's an exmaple of plugin configuration to use customized templates
153+
154+
```
155+
<project ...>
156+
...
157+
158+
<build>
159+
<plugins>
160+
...
161+
<plugin>
162+
<groupId>com.graphql-java-generator</groupId>
163+
<artifactId>graphql-maven-plugin</artifactId>
164+
<version>${lastReleasedVersion}</version>
165+
166+
<executions>
167+
<execution>
168+
<goals>
169+
<goal>graphql</goal>
170+
</goals>
171+
</execution>
172+
</executions>
173+
<configuration>
174+
<mode>client</mode>
175+
<templates>
176+
<QUERY_MUTATION_SUBSCRIPTION>classpath/entry/to/cutomtemplate.java.vm</QUERY_MUTATION_SUBSCRIPTION>
177+
</templates>
178+
</configuration>
179+
<dependencies>
180+
181+
<!-- Dependency containing your templates-->
182+
<dependency>
183+
<groupId>...</groupId>
184+
<artifactId>...</artifactId>
185+
<version>...</version>
186+
</dependency>
187+
188+
</dependencies>
189+
</plugin>
190+
</plugins>
191+
</build>
192+
...
193+
</project>
194+
```
195+
**templates** param is a map where the key is the ID of the template to customize
196+
and the value is a classpath entry to the resources containing the customized tempalte
197+
198+
Customize templates shall be provided in a depdency configured in the plugin
199+
200+
Both client and server templates can be customized.
201+
202+
The avialable template IDs that can be configured for customization are:
203+
204+
| ID | Scope | Default template |
205+
| --- | --- |
206+
| OBJECT | COMMON | [templates/object_type.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/object_type.vm.java) |
207+
| INTERFACE | COMMON | [templates/interface_type.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/interface_type.vm.java) |
208+
| ENUM | COMMON | [templates/enum_type.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/enum_type.vm.java) |
209+
| UNION | COMMON | [templates/union_type.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/union_type.vm.java) |
210+
| CUSTOM_SCALAR_REGISTRY_INITIALIZER | CLIENT | [templates/client_CustomScalarRegistryInitializer.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/client_CustomScalarRegistryInitializer.vm.java) |
211+
| QUERY_MUTATION_SUBSCRIPTION | CLIENT | [templates/client_query_mutation_subscription_type.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/client_query_mutation_subscription_type.vm.java) |
212+
| QUERY_TARGET_TYPE | CLIENT | [templates/client_query_target_type.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/client_query_target_type.vm.java) |
213+
| JACKSON_DESERIALIZER | CLIENT | [templates/client_jackson_deserialize.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/client_jackson_deserialize.vm.java) |
214+
| BATCHLOADERDELEGATE | SERVER | [templates/server_BatchLoaderDelegate.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/server_BatchLoaderDelegate.vm.java) |
215+
| BATCHLOADERDELEGATEIMPL | SERVER | [templates/server_BatchLoaderDelegateImpl.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/server_BatchLoaderDelegateImpl.vm.java) |
216+
| DATAFETCHER | SERVER | [templates/server_GraphQLDataFetchers.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/server_GraphQLDataFetchers.vm.java) |
217+
| DATAFETCHERDELEGATE | SERVER | [templates/server_GraphQLDataFetchersDelegate.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/server_GraphQLDataFetchersDelegate.vm.java) |
218+
| GRAPHQLUTIL | SERVER | [templates/server_GraphQLUtil.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/server_GraphQLUtil.vm.java) |
219+
| PROVIDER | SERVER | [templates/server_GraphQLProvider.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/server_GraphQLProvider.vm.java) |
220+
| SERVER | SERVER | [templates/server_GraphQLServerMain.vm.java](http://github.com/graphql-java-generator/graphql-maven-plugin-project/tree/master/graphql-maven-plugin-logic/src/main/resources/templates/server_GraphQLServerMain.vm.java) |
221+
222+
143223
# Main evolutions for the near future
144224

145225
You'll find below the main changes, that are planned in the near future:
@@ -157,7 +237,7 @@ The Change Log is available [here](CHANGELOG.md)
157237

158238
# Note for contributors
159239

160-
This project is a maven plugin project.
240+
This project is a maven plugin project.
161241

162242
If you want to compile it, you'll have to add the lombok.jar file in your IDE. Please see the relevant section, in the Install menu of the [https://projectlombok.org/](https://projectlombok.org/) home page. This very nice tools generates all java boiler plate code, like setters, getters, constructors from fields...
163243

‎graphql-maven-plugin-samples/graphql-maven-plugin-samples-CustomTemplates-client/downloads/tomcat-9.0.20.zip

10.9 MB
Binary file not shown.

‎graphql-maven-plugin-samples/graphql-maven-plugin-samples-CustomTemplates-client/pom.xml

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
<?xml version="1.0"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5+
<modelVersion>4.0.0</modelVersion>
6+
<parent>
7+
<groupId>com.graphql-java-generator</groupId>
8+
<artifactId>graphql-maven-plugin-samples</artifactId>
9+
<version>1.5-SNAPSHOT</version>
10+
</parent>
11+
12+
<artifactId>graphql-maven-plugin-samples-CustomTemplates-client</artifactId>
13+
14+
<build>
15+
<plugins>
16+
<plugin>
17+
<groupId>com.graphql-java-generator</groupId>
18+
<artifactId>graphql-maven-plugin</artifactId>
19+
<executions>
20+
<execution>
21+
<goals>
22+
<goal>graphql</goal>
23+
</goals>
24+
</execution>
25+
</executions>
26+
<configuration>
27+
<mode>client</mode>
28+
<templates>
29+
<QUERY_MUTATION_SUBSCRIPTION>templates/resttemplate/client_query_mutation_subscription_type.vm.java</QUERY_MUTATION_SUBSCRIPTION>
30+
</templates>
31+
</configuration>
32+
<dependencies>
33+
<!-- Dependency contains the custom template parametrized in plugin and a QueryExecutor bases on Spring Rest Template -->
34+
<dependency>
35+
<groupId>com.graphql-java-generator</groupId>
36+
<artifactId>graphql-maven-plugin-samples-CustomTemplates-resttemplate</artifactId>
37+
<version>${project.version}</version>
38+
</dependency>
39+
</dependencies>
40+
</plugin>
41+
42+
43+
<plugin>
44+
<!-- Execution of the integration tests -->
45+
<groupId>org.apache.maven.plugins</groupId>
46+
<artifactId>maven-failsafe-plugin</artifactId>
47+
<executions>
48+
<execution>
49+
<goals>
50+
<goal>integration-test</goal>
51+
<goal>verify</goal>
52+
</goals>
53+
</execution>
54+
</executions>
55+
</plugin>
56+
<plugin>
57+
<groupId>org.codehaus.cargo</groupId>
58+
<artifactId>cargo-maven2-plugin</artifactId>
59+
<version>1.7.4</version>
60+
<executions>
61+
<execution>
62+
<id>start-tomcat</id>
63+
<phase>pre-integration-test</phase>
64+
<goals>
65+
<goal>start</goal>
66+
</goals>
67+
</execution>
68+
<execution>
69+
<id>stop-tomcat</id>
70+
<phase>post-integration-test</phase>
71+
<goals>
72+
<goal>stop</goal>
73+
</goals>
74+
</execution>
75+
</executions>
76+
<configuration>
77+
<container>
78+
<containerId>tomcat9x</containerId>
79+
<zipUrlInstaller>
80+
<url>https://repo.maven.apache.org/maven2/org/apache/tomcat/tomcat/9.0.20/tomcat-9.0.20.zip</url>
81+
<downloadDir>${project.basedir}/downloads</downloadDir>
82+
</zipUrlInstaller>
83+
</container>
84+
<configuration>
85+
<properties>
86+
<cargo.logging>low</cargo.logging>
87+
<log>target/cargo.log</log>
88+
<cargo.protocol>https</cargo.protocol>
89+
<cargo.tomcat.connector.keyAlias>graphql</cargo.tomcat.connector.keyAlias>
90+
<cargo.tomcat.connector.keystoreFile>${project.basedir}/src/main/resources/keystore.jks</cargo.tomcat.connector.keystoreFile>
91+
<cargo.tomcat.connector.keystorePass>graphql</cargo.tomcat.connector.keystorePass>
92+
<cargo.tomcat.connector.keystoreType>JKS</cargo.tomcat.connector.keystoreType>
93+
<cargo.servlet.port>8443</cargo.servlet.port>
94+
<cargo.servlet.users>admin:tomcat:manager-gui</cargo.servlet.users>
95+
</properties>
96+
</configuration>
97+
<deployables>
98+
<deployable>
99+
<location>${basedir}/../graphql-maven-plugin-samples-StarWars-server/target/graphql-maven-plugin-samples-StarWars-server-${project.version}.war</location>
100+
<type>war</type>
101+
<properties>
102+
<context>/starwars</context>
103+
</properties>
104+
</deployable>
105+
</deployables>
106+
</configuration>
107+
</plugin>
108+
<plugin>
109+
<!-- We don't want to spam the repository with test/sample artefacts -->
110+
<artifactId>maven-deploy-plugin</artifactId>
111+
<configuration>
112+
<skip>true</skip>
113+
</configuration>
114+
</plugin>
115+
</plugins>
116+
117+
<extensions>
118+
<!-- Adding these extensions prevents the error below, with JDK 9 and higher: -->
119+
<!-- NoSuchMethodError: 'java.lang.String javax.annotation.Resource.lookup()' -->
120+
<extension>
121+
<groupId>javax.annotation</groupId>
122+
<artifactId>javax.annotation-api</artifactId>
123+
<version>1.3.2</version>
124+
</extension>
125+
<extension>
126+
<groupId>javax.annotation</groupId>
127+
<artifactId>jsr250-api</artifactId>
128+
<version>1.0</version>
129+
</extension>
130+
</extensions>
131+
132+
133+
</build>
134+
135+
<dependencies>
136+
<!-- Dependency contains the custom template parametrized in plugin and a QueryExecutor bases on Spring Rest Template -->
137+
<dependency>
138+
<groupId>com.graphql-java-generator</groupId>
139+
<artifactId>graphql-maven-plugin-samples-CustomTemplates-resttemplate</artifactId>
140+
<version>${project.version}</version>
141+
</dependency>
142+
143+
<!-- Dependencies for tests -->
144+
<dependency>
145+
<groupId>org.springframework.boot</groupId>
146+
<artifactId>spring-boot-starter-test</artifactId>
147+
<scope>test</scope>
148+
</dependency>
149+
<dependency>
150+
<groupId>org.junit.jupiter</groupId>
151+
<artifactId>junit-jupiter-api</artifactId>
152+
<scope>test</scope>
153+
</dependency>
154+
<dependency>
155+
<groupId>org.junit.jupiter</groupId>
156+
<artifactId>junit-jupiter-engine</artifactId>
157+
<scope>test</scope>
158+
</dependency>
159+
<dependency>
160+
<groupId>org.springframework.security</groupId>
161+
<artifactId>spring-security-web</artifactId>
162+
<scope>test</scope>
163+
</dependency>
164+
<dependency>
165+
<groupId>org.apache.httpcomponents</groupId>
166+
<artifactId>httpclient</artifactId>
167+
<scope>test</scope>
168+
</dependency>
169+
170+
<dependency>
171+
<groupId>org.apache.logging.log4j</groupId>
172+
<artifactId>log4j-slf4j-impl</artifactId>
173+
</dependency>
174+
175+
<!-- Dependencies for GraphQL -->
176+
<dependency>
177+
<groupId>com.graphql-java-generator</groupId>
178+
<artifactId>graphql-java-client-dependencies</artifactId>
179+
<type>pom</type>
180+
</dependency>
181+
</dependencies>
182+
183+
<reporting>
184+
<plugins>
185+
<plugin>
186+
<groupId>org.apache.maven.plugins</groupId>
187+
<artifactId>maven-javadoc-plugin</artifactId>
188+
<reportSets>
189+
<reportSet>
190+
<id>non-aggregate</id>
191+
<reports>
192+
<report>javadoc</report>
193+
</reports>
194+
</reportSet>
195+
</reportSets>
196+
</plugin>
197+
</plugins>
198+
</reporting>
199+
200+
</project>

‎graphql-maven-plugin-samples/graphql-maven-plugin-samples-CustomTemplates-client/src/main/resources/keystore.jks

2.23 KB
Binary file not shown.

‎graphql-maven-plugin-samples/graphql-maven-plugin-samples-CustomTemplates-client/src/main/resources/keystore.readme

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
This keystore contains the self signed key to enable https for this sample.
2+
3+
IT MUST NOT BE USED IN ANY REAL SERVER.
4+
5+
Especially as the private key is accessible to everyone.
6+
7+
8+
The Keystore password is "graphql"
9+
The alias for the key is also "graphql"
10+
11+
12+
The keystore.jks keystore has been generated by this command:
13+
keytool -genkey -keyalg RSA -alias graphql -keystore keystore.jks -storepass graphql -validity 10000 -keysize 2048
14+
Then:
15+
- Name and surname: localhost
16+
- Organization: com.graphql-java-generator
17+
- Other data: no input
18+
No password for the key

0 commit comments

Comments
 (0)