1 Star 0 Fork 0

fushaofei / vertx-examples

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Vert.x examples

Build Status

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

Maven users

Start with the simplest Maven example to show you how 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, Ruby and JavaScript verticles.

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

Open workspace in Eclipse Che

Gradle users

Start with the simplest Gradle example to show you how 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).

Some examples need examples-utils

You may find examples that need examples-utils. You need to build it from link:examples-utils:

git clone https://github.com/vert-x3/vertx-examples.git
cd vertx-examples
cd examples-utils
mvn clean install

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 to embed, the exact same code in the verticles can also be run embedded if you prefer. It’s really up to you. Verticles are entirely optional in Vert.x.

Different languages

Most of the examples are available in all the languages that Vert.x supports.

You’ll find the examples for the relevant language in a directory src/main/${lang} where lang is an identifier for the language, e.g. java, js, ruby etc.

For example you’ll find the Vert.x core Java examples in core-examples/src/main/java and you’ll find the Vert.x core JavaScript examples in core-examples/src/main/js

Note
All the non-Java examples are automatically generated from the Java examples using our magic code translator.

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.

  1. Download a Vert.x 3 distribution

  2. Unzip it somewhere on your disk (e.g. in your home directory)

  3. Set your PATH environment variable to include the installation directory

  4. 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 allows testing Vert.x asynchronous operations with JUnit 5.

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 / Vert.x RxJava 1 examples contains a wide range of examples using Vert.x for RxJava

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.

Maven Service Factory examples

The Vert.x Maven service factory examples shows how to package a verticle that can be deployed using the Maven Service Factory. Such a deployment is also demonstrated using either the command line or the api.

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.

OSGi Examples

The Vert.x OSGi examples contains a few examples using Vert.x in an OSGi context.

Cloud Foundry examples

The Vert.x Cloud Foundry example shows how to deploy Vert.x application to a Cloud Foundry service or platform of your choice.

Docker examples

The Vert.x Docker examples shows how to deploy Vert.x application in Docker containers. It also contains an example of application that can be deployed on Fabric8.

Openshift & Kubernetes examples

The Vert.x OpenShift 3 examples shows how to deploy Vert.x applications on Openshift 3 and Kubernetes. It also demonstrates clustering and service discovery.

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.

JDBC example

The Vert.x JDBC Examples shows how you can interact JDBC Databases using the vert.x JDBC 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.

AMQP Bridge examples

The Vert.x AMQP Bridge Examples show how you can interact with AMQP 1.0 servers using the Vert.x AMQP Bridge.

Java 9 examples

This Java 9 examples shows how a simple Java 9 modular application using Vert.x as anonymous 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.

JCA example

The Vert.x JCA Example project provides a JEE compliant application that enables to you deploy the application into a Wildfly application server. While simple in implementation, the JCA examples provides a good point of departure for your own development.

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.

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} 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.

简介

暂无描述 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/myblack/vertx-examples.git
git@gitee.com:myblack/vertx-examples.git
myblack
vertx-examples
vertx-examples
master

搜索帮助