-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #618 from DavideD/vert.x-web-mutiny
Hibernate Reactive + Vert.x Web routing + Mutiny quickstart
- Loading branch information
Showing
20 changed files
with
1,567 additions
and
0 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
* | ||
!target/*-runner | ||
!target/*-runner.jar | ||
!target/lib/* |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Eclipse | ||
.project | ||
.classpath | ||
.settings/ | ||
bin/ | ||
|
||
# IntelliJ | ||
.idea | ||
*.ipr | ||
*.iml | ||
*.iws | ||
|
||
# NetBeans | ||
nb-configuration.xml | ||
|
||
# Visual Studio Code | ||
.vscode | ||
|
||
# OSX | ||
.DS_Store | ||
|
||
# Vim | ||
*.swp | ||
*.swo | ||
|
||
# patch | ||
*.orig | ||
*.rej | ||
|
||
# Maven | ||
target/ | ||
pom.xml.tag | ||
pom.xml.releaseBackup | ||
pom.xml.versionsBackup | ||
release.properties |
117 changes: 117 additions & 0 deletions
117
hibernate-reactive-routes-quickstart/.mvn/wrapper/MavenWrapperDownloader.java
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
/* | ||
* Copyright 2007-present the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
import java.net.*; | ||
import java.io.*; | ||
import java.nio.channels.*; | ||
import java.util.Properties; | ||
|
||
public class MavenWrapperDownloader { | ||
|
||
private static final String WRAPPER_VERSION = "0.5.5"; | ||
/** | ||
* Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided. | ||
*/ | ||
private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/" | ||
+ WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar"; | ||
|
||
/** | ||
* Path to the maven-wrapper.properties file, which might contain a downloadUrl property to | ||
* use instead of the default one. | ||
*/ | ||
private static final String MAVEN_WRAPPER_PROPERTIES_PATH = | ||
".mvn/wrapper/maven-wrapper.properties"; | ||
|
||
/** | ||
* Path where the maven-wrapper.jar will be saved to. | ||
*/ | ||
private static final String MAVEN_WRAPPER_JAR_PATH = | ||
".mvn/wrapper/maven-wrapper.jar"; | ||
|
||
/** | ||
* Name of the property which should be used to override the default download url for the wrapper. | ||
*/ | ||
private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl"; | ||
|
||
public static void main(String args[]) { | ||
System.out.println("- Downloader started"); | ||
File baseDirectory = new File(args[0]); | ||
System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath()); | ||
|
||
// If the maven-wrapper.properties exists, read it and check if it contains a custom | ||
// wrapperUrl parameter. | ||
File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH); | ||
String url = DEFAULT_DOWNLOAD_URL; | ||
if(mavenWrapperPropertyFile.exists()) { | ||
FileInputStream mavenWrapperPropertyFileInputStream = null; | ||
try { | ||
mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile); | ||
Properties mavenWrapperProperties = new Properties(); | ||
mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream); | ||
url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url); | ||
} catch (IOException e) { | ||
System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'"); | ||
} finally { | ||
try { | ||
if(mavenWrapperPropertyFileInputStream != null) { | ||
mavenWrapperPropertyFileInputStream.close(); | ||
} | ||
} catch (IOException e) { | ||
// Ignore ... | ||
} | ||
} | ||
} | ||
System.out.println("- Downloading from: " + url); | ||
|
||
File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH); | ||
if(!outputFile.getParentFile().exists()) { | ||
if(!outputFile.getParentFile().mkdirs()) { | ||
System.out.println( | ||
"- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'"); | ||
} | ||
} | ||
System.out.println("- Downloading to: " + outputFile.getAbsolutePath()); | ||
try { | ||
downloadFileFromURL(url, outputFile); | ||
System.out.println("Done"); | ||
System.exit(0); | ||
} catch (Throwable e) { | ||
System.out.println("- Error downloading"); | ||
e.printStackTrace(); | ||
System.exit(1); | ||
} | ||
} | ||
|
||
private static void downloadFileFromURL(String urlString, File destination) throws Exception { | ||
if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) { | ||
String username = System.getenv("MVNW_USERNAME"); | ||
char[] password = System.getenv("MVNW_PASSWORD").toCharArray(); | ||
Authenticator.setDefault(new Authenticator() { | ||
@Override | ||
protected PasswordAuthentication getPasswordAuthentication() { | ||
return new PasswordAuthentication(username, password); | ||
} | ||
}); | ||
} | ||
URL website = new URL(urlString); | ||
ReadableByteChannel rbc; | ||
rbc = Channels.newChannel(website.openStream()); | ||
FileOutputStream fos = new FileOutputStream(destination); | ||
fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE); | ||
fos.close(); | ||
rbc.close(); | ||
} | ||
|
||
} |
Binary file not shown.
2 changes: 2 additions & 0 deletions
2
hibernate-reactive-routes-quickstart/.mvn/wrapper/maven-wrapper.properties
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.2/apache-maven-3.6.2-bin.zip | ||
wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.5/maven-wrapper-0.5.5.jar |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
# Quarkus demo: Hibernate Reactive and Vert.x Web | ||
|
||
This is a minimal CRUD service exposing a couple of endpoints over REST, | ||
with a front-end based on Angular so you can play with it from your browser. | ||
|
||
While the code is surprisingly simple, under the hood this is using: | ||
- Vert.x Web routers to expose the REST endpoints | ||
- Hibernate Reactive to perform the CRUD operations on the database | ||
- A PostgreSQL database; see below to run one via Docker | ||
- ArC, the CDI inspired dependency injection tool with zero overhead | ||
|
||
## Requirements | ||
|
||
To compile and run this demo you will need: | ||
|
||
- JDK 1.8+ | ||
- GraalVM | ||
|
||
In addition, you will need either a PostgreSQL database, or Docker to run one. | ||
|
||
### Configuring GraalVM and JDK 1.8+ | ||
|
||
Make sure that both the `GRAALVM_HOME` and `JAVA_HOME` environment variables have | ||
been set, and that a JDK 1.8+ `java` command is on the path. | ||
|
||
See the [Building a Native Executable guide](https://quarkus.io/guides/building-native-image) | ||
for help setting up your environment. | ||
|
||
## Building the demo | ||
|
||
Launch the Maven build on the checked out sources of this demo: | ||
|
||
> ./mvnw install | ||
## Running the demo | ||
|
||
### Prepare a PostgreSQL instance | ||
|
||
Make sure you have a PostgreSQL instance running. To set up a PostgreSQL database with Docker: | ||
|
||
> docker run --ulimit memlock=-1:-1 -it --rm=true --memory-swappiness=0 --name quarkus_test -e POSTGRES_USER=quarkus_test -e POSTGRES_PASSWORD=quarkus_test -e POSTGRES_DB=quarkus_test -p 5432:5432 postgres:10.5 | ||
Connection properties for the Agroal datasource are defined in the standard Quarkus configuration file, | ||
`src/main/resources/application.properties`. | ||
|
||
### Live coding with Quarkus | ||
|
||
The Maven Quarkus plugin provides a development mode that supports | ||
live coding. To try this out: | ||
|
||
> ./mvnw quarkus:dev | ||
In this mode you can make changes to the code and have the changes immediately applied, by just refreshing your browser. | ||
|
||
Hot reload works even when modifying your JPA entities. | ||
Try it! Even the database schema will be updated on the fly. | ||
|
||
### Run Quarkus in JVM mode | ||
|
||
When you're done iterating in developer mode, you can run the application as a | ||
conventional jar file. | ||
|
||
First compile it: | ||
|
||
> ./mvnw install | ||
Then run it: | ||
|
||
> java -jar ./target/hibernate-reactive-routers-quickstart-1.0-SNAPSHOT-runner.jar | ||
Have a look at how fast it boots. | ||
Or measure total native memory consumption... | ||
|
||
### Run Quarkus as a native application | ||
|
||
You can also create a native executable from this application without making any | ||
source code changes. A native executable removes the dependency on the JVM: | ||
everything needed to run the application on the target platform is included in | ||
the executable, allowing the application to run with minimal resource overhead. | ||
|
||
Compiling a native executable takes a bit longer, as GraalVM performs additional | ||
steps to remove unnecessary codepaths. Use the `native` profile to compile a | ||
native executable: | ||
|
||
> ./mvnw install -Dnative | ||
After getting a cup of coffee, you'll be able to run this binary directly: | ||
|
||
> ./target/hibernate-reactive-routers-quickstart-1.0-SNAPSHOT-runner | ||
Please brace yourself: don't choke on that fresh cup of coffee you just got. | ||
|
||
Now observe the time it took to boot, and remember: that time was mostly spent to generate the tables in your database and import the initial data. | ||
|
||
Next, maybe you're ready to measure how much memory this service is consuming. | ||
|
||
N.B. This implies all dependencies have been compiled to native; | ||
that's a whole lot of stuff: from the bytecode enhancements that Hibernate ORM | ||
applies to your entities, to the lower level essential components such as the PostgreSQL JDBC driver, the Undertow webserver. | ||
|
||
## See the demo in your browser | ||
|
||
Navigate to: | ||
|
||
<http://localhost:8080/index.html> | ||
|
||
Have fun, and join the team of contributors! | ||
|
||
## Running the demo in Kubernetes | ||
|
||
This section provides extra information for running both the database and the demo on Kubernetes. | ||
As well as running the DB on Kubernetes, a service needs to be exposed for the demo to connect to the DB. | ||
|
||
Then, rebuild demo docker image with a system property that points to the DB. | ||
|
||
```bash | ||
-Dquarkus.datasource.reactive.url=jdbc:postgresql://<DB_SERVICE_NAME>/quarkus_test | ||
``` |
Oops, something went wrong.