Vert.x 4 examples

This repository contains a range of examples so you can get up and running easily with Vert.x. 4

Vert.x 3 examples can be found here https://github.com/vert-x3/vertx-examples/tree/3.x

Maven users

Start with the simplest Maven example to show you how to setup a simple Vert.x project that uses Maven. You need to have Java 8 installed and set the JAVA_HOME environment variable to point to your Java 8 installation.

Use that as a template for setting up a Maven project with Vert.x.

Progress to the simple Maven verticle example to show you how to deploy your code as verticles in a Maven project. Also check Maven verticles examples to show how you can use Maven with Groovy verticle.

Want to start right away, open the first example in Eclipse Che:

Gradle users

Start with the simplest Gradle example to show you how to setup a simple Vert.x project that uses Gradle.

Use that as a template for setting up a Gradle project with Vert.x.

Progress to the simple Gradle verticle example to show you how to deploy your code as verticles in a Gradle project

Neither Maven nor Gradle users

That’s fine too :)

You can run most of the examples at the command line using vertx run if you have Vert.x installed (see below).

The examples

The examples demonstrate how to use all different bits of Vert.x including Vert.x core, Vert.x-Web and various other services and features.

Most of the examples have been written as verticles. For more information on verticles please consult the Vert.x core manual.

Using verticles allows you to scale and run your code from the command line more easily, but if you prefer the same code in the verticles can also be run embedded. It’s really up to you. Verticles are entirely optional in Vert.x.

Running the examples

Running in your IDE

Most of the Java examples can be run directly in your IDE (if you have one!).

We provide a main() method in most of the example classes which allows you to conveniently run them directly in your IDE.

Just right click the main method or class in your IDE and run as… application (supported by all major IDEs).

Running at the command line

If vertx is installed you can also run any verticle directly on the command line. This way of working may be of interest to you, if you don’t want to use Maven or Gradle or perhaps you don’t use an IDE.

Or perhaps you’re just a command line kind of person.

If you’re coming from using other platforms such as Node.js you might want to work this way. You can think of the vertx command as a bit like the node command in Node.js.

Instructions for installing Vert.x are in the next section.

Once Vert.x is installed, to run an example, just cd to the example directory and type vertx run followed by the filename of the verticle. For example

cd core-examples/src/main/java/io/vertx/example/core
vertx run EchoServer.java

cd core-examples/src/main/js/echo
vertx run echo_server.js

Yes! You can run Java source files directly using Vert.x (no compilation required).

Installing Vert.x

Note	This is only necessary if you want to run Vert.x at the command line. If you’d prefer to work with Maven or Gradle projects then you don’t need to pre-install Vert.x - you just let Maven/Gradle pull in the Vert.x dependencies into your project as you would with any dependency.

Pre-requisites: You will need to have Java 8 JDK installed.

Download a Vert.x 3 distribution
Unzip it somewhere on your disk (e.g. in your home directory)
Set your PATH environment variable to include the installation directory
Test the install by typing vertx -version.

On the download page, you will find several distributions. Each distribution has a different set of components:

Min: The min distribution contains only Vert.x Core, the support of the different languages, and the Hazelcast clustering.
Full: The full distribution contains all the components of the Vert.x stack. It includes Vert.x web and the different data access technologies.

Vert.x core examples

The Vert.x core examples contains a wide range of examples using just Vert.x Core.

Vert.x-Web examples

Vert.x-Web is a toolkit for building web applications using Vert.x

The Vert.x-Web examples contains a wide range of examples using Vert.x-Web

Vert.x Web Client examples

Vert.x Web Client that provides an easy to use web client for Vert.x.

The Vert.x Web Client examples contains a wide range of examples using the Vert.x Web Client

Vertx Unit examples

Vertx-Unit is a library for writing asynchronous tests. We include some examples of how to use this tool to test your Vert.x (or other asynchronous) applications.

The Vert.x Unit examples shows how to use Vert.x Unit.

Vert.x JUnit 5 examples

The vertx-junit5 modules allow testing Vert.x asynchronous operations with JUnit 5.

See Vert.x JUnit 5 examples.

Vert.x Opentracing examples

Vert.x Opentracing examples contains a wide range of examples using Vert.x Opentracing.

Vert.x Zipkin examples

Vert.x Zipkin examples contains a wide range of examples using Vert.x Zipkin.

RxJava examples

Vert.x for RxJava provides most of its APIs as RxJava so you can use those if you prefer.

RxJava is a great choice when you want to perform complex operations on multiple asynchronous streams of data.

The Vert.x RxJava 2 examples contains a wide range of examples using Vert.x for RxJava 2 The Vert.x RxJava 3 examples contains a wide range of examples using Vert.x for RxJava 3

gRPC examples

The Vert.x gRPC Examples show how you can implement a gRPC service and invoke a gRPC service with Vert.x.

Kotlin examples

The Vert.x Kotlin Examples shows a few examples with Kotlin such a REST application, Kotlin coroutines and usage of KotlinTest.

Mail examples

The Vert.x Mail examples contains a few examples using Vert.x Mail

The mail examples show different ways to create the mail message and send it via tls, ssl etc. The examples either use localhost:25 to send a mail or use host mail.example.com. To actually run the examples you will have to change the mail server and the user credentials in the MailLogin example.

Service Proxy Examples

The Vert.x Service Proxy examples contains an example of service proxy usage. It depicts how a service provider can be implemented and how the published service can be consumed.

Docker examples

The Vert.x Docker examples shows how to deploy Vert.x application in Docker containers.

Spring Examples

The Vert.x Spring Examples shows how vert.x application can be integrated inside a Spring ecosystem.

Redis example

The Vert.x Redis Example shows how you can interact with Redis using the vert.x Redis client.

Mongo example

The Vert.x Mongo Example shows how you can interact with MongoDB using the vert.x Mongo client.

SQL client example

The Vert.x SQL Client Examples shows how you can interact PostgreSQL or MySQL Databases using the Reactive SQL client.

Kafka example

The Vert.x Kafka Examples shows how you can interact Kafka using the vert.x Kafka client.

MQTT example

The Vert.x MQTT Examples shows how you can write MQTT servers and clients using Vert.x MQTT.

Service Proxy Examples

The Vert.x Service Proxy examples contains an example of service proxy usage. It depicts how a service provider can be implemented and how the published service can be consumed.

JPMS examples

This JPMS examples shows how a simple Java (11) modular application using Vert.x as automatic modules.

Vert.x fatjar examples

The Vert.x fatjar Examples show how you can build fatjar with Maven or Gradle.

HTTP/2 Showcase

This HTTP/2 Showcase application highlights the benefits of HTTP/2 when dealing with latency on the web.

Camel Bridge examples

The Vert.x Camel Bridge Examples show how you can use Apache Camel routes from the event bus.

Micrometer metrics examples

The Vert.x Micrometer metrics examples show how to collect Vert.x metrics with Micrometer and send them to backends such as Prometheus or InfluxDB.

GraphQL examples

The Vert.x Web GraphQL examples contain simple client/server GraphQL applications built with Vert.x Web GraphQL and the GraphQL-Java library.

123/vertx-examples

Vert.x 4 examples

Maven users

Gradle users

Neither Maven nor Gradle users

The examples

Running the examples

Running in your IDE

Running at the command line

Installing Vert.x

Vert.x core examples

Vert.x-Web examples

Vert.x Web Client examples

Vertx Unit examples

Vert.x JUnit 5 examples

Vert.x Opentracing examples

Vert.x Zipkin examples

RxJava examples

gRPC examples

Kotlin examples

Mail examples

Service Proxy Examples

Docker examples

Spring Examples

Redis example

Mongo example

SQL client example

Kafka example

MQTT example

Service Proxy Examples

JPMS examples

Vert.x fatjar examples

HTTP/2 Showcase

Camel Bridge examples

Micrometer metrics examples

GraphQL examples

简介

发行版

贡献者

近期动态