Revert "remove the spring-worker-example until eclipse-vertx/vertx-codegen#131 is fixed"

This reverts commit 8ff2cc1.

Author: cescoffier

spring-examples/pom.xml

@@ -15,7 +15,7 @@
     <module>spring-example</module>
     <module>springboot-clustering</module>
     <module>spring-verticle-factory</module>
-    <!--<module>spring-worker-example</module>-->
+    <module>spring-worker-example</module>
   </modules>
 
 </project>

spring-examples/spring-worker-example/README.adoc

@@ -0,0 +1,33 @@
+= Vert.x Spring Worker example
+
+This example shows how you can embed Vert.x in Spring Boot, having:
+
+- Spring container creating the verticles
+- a standard verticle with Vert.x web for the REST API
+- Spring backend services (with declarative transaction management and JPA repositories)
+- a worker verticle exposing the Spring services over the event bus through service proxies
+
+This might be useful if you have an existing Spring codebase and want to keep your data access layer.
+
+To try the example, execute this command in a terminal:
+
+[source,shell]
+----
+mvn clean spring-boot:run
+----
+
+Then add a book to the database:
+
+[source,shell]
+----
+curl http://localhost:8080/book --data '{"name": "The Practice of System and Network Administration", "author":"Thomas A. Limoncelli, Christina J. Hn, Strata R. Chalup"}'
+----
+
+You should now be able to see your book saved:
+
+[source,shell]
+----
+curl http://localhost:8080/books
+----
+
+Notice that the `id` field is now set which means that the book as indeed been persisted in the database.

spring-examples/spring-worker-example/pom.xml

@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>io.vertx</groupId>
+    <artifactId>spring-examples</artifactId>
+    <version>3.4.2</version>
+  </parent>
+
+  <artifactId>spring-worker-example</artifactId>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+    <java.version>1.8</java.version>
+    <boot.version>1.4.3.RELEASE</boot.version>
+    <h2.version>1.4.191</h2.version>
+  </properties>
+
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <!-- Import dependency management from Spring Boot -->
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-dependencies</artifactId>
+        <version>${boot.version}</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-data-jpa</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.h2database</groupId>
+      <artifactId>h2</artifactId>
+      <version>${h2.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>io.vertx</groupId>
+      <artifactId>vertx-web</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>io.vertx</groupId>
+      <artifactId>vertx-service-proxy</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>io.vertx</groupId>
+      <artifactId>vertx-codegen</artifactId>
+      <version>${project.version}</version>
+      <scope>provided</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <pluginManagement>
+      <plugins>
+        <!-- We specify the Maven compiler plugin as we need to set it to Java 1.8 -->
+        <plugin>
+          <artifactId>maven-compiler-plugin</artifactId>
+          <version>3.1</version>
+          <configuration>
+            <source>${java.version}</source>
+            <target>${java.version}</target>
+            <annotationProcessors>
+              <annotationProcessor>io.vertx.codegen.CodeGenProcessor</annotationProcessor>
+            </annotationProcessors>
+            <compilerArgs>
+              <arg>-AoutputDirectory=${project.basedir}/src/main</arg>
+            </compilerArgs>
+          </configuration>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+    <plugins>
+      <plugin>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-maven-plugin</artifactId>
+        <version>${boot.version}</version>
+      </plugin>
+    </plugins>
+  </build>
+
+  <profiles>
+    <profile>
+      <id>staging</id>
+      <repositories>
+        <repository>
+          <id>staging</id>
+          <url>https://oss.sonatype.org/content/repositories/iovertx-3295</url>
+        </repository>
+      </repositories>
+    </profile>
+  </profiles>
+
+</project>

spring-examples/spring-worker-example/src/main/asciidoc/dataobjects.adoc

@@ -0,0 +1,19 @@
+= Cheatsheets
+
+[[Book]]
+== Book
+
+++++
+ A book JPA entity.
+++++
+'''
+
+[cols=">25%,^25%,50%"]
+[frame="topbot"]
+|===
+^|Name | Type ^| Description
+|[[author]]`author`|`String`|-
+|[[id]]`id`|`Number (Long)`|-
+|[[name]]`name`|`String`|-
+|===
+

spring-examples/spring-worker-example/src/main/java/io/vertx/example/spring/worker/Application.java

@@ -0,0 +1,111 @@
+/*
+ * Copyright 2017 Red Hat, Inc.
+ *
+ * Red Hat licenses this file to you 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.
+ */
+
+package io.vertx.example.spring.worker;
+
+import io.vertx.core.DeploymentOptions;
+import io.vertx.core.Vertx;
+import io.vertx.core.VertxOptions;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.context.event.EventListener;
+
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import static java.util.concurrent.TimeUnit.*;
+
+/**
+ * @author Thomas Segismont
+ */
+@SpringBootApplication
+public class Application {
+  private static final Logger LOG = LoggerFactory.getLogger(Application.class);
+
+  @Autowired
+  SpringVerticleFactory verticleFactory;
+
+  /**
+   * The Vert.x worker pool size, configured in the {@code application.properties} file.
+   *
+   * Make sure this is greater than {@link #springWorkerInstances}.
+   */
+  @Value("${vertx.worker.pool.size}")
+  int workerPoolSize;
+
+  /**
+   * The number of {@link SpringWorker} instances to deploy, configured in the {@code application.properties} file.
+   */
+  @Value("${vertx.springWorker.instances}")
+  int springWorkerInstances;
+
+  public static void main(String[] args) {
+    SpringApplication.run(Application.class, args);
+  }
+
+  /**
+   * Deploy verticles when the Spring application is ready.
+   */
+  @EventListener
+  public void deployVerticles(ApplicationReadyEvent event) {
+    Vertx vertx = Vertx.vertx(new VertxOptions().setWorkerPoolSize(workerPoolSize));
+
+    // The verticle factory is registered manually because it is created by the Spring container
+    vertx.registerVerticleFactory(verticleFactory);
+
+    CountDownLatch deployLatch = new CountDownLatch(2);
+    AtomicBoolean failed = new AtomicBoolean(false);
+
+    String restApiVerticleName = verticleFactory.prefix() + ":" + BookRestApi.class.getName();
+    vertx.deployVerticle(restApiVerticleName, ar -> {
+      if (ar.failed()) {
+        LOG.error("Failed to deploy verticle", ar.cause());
+        failed.compareAndSet(false, true);
+      }
+      deployLatch.countDown();
+    });
+
+    DeploymentOptions workerDeploymentOptions = new DeploymentOptions()
+      .setWorker(true)
+      // As worker verticles are never executed concurrently by Vert.x by more than one thread,
+      // deploy multiple instances to avoid serializing requests.
+      .setInstances(springWorkerInstances);
+    String workerVerticleName = verticleFactory.prefix() + ":" + SpringWorker.class.getName();
+    vertx.deployVerticle(workerVerticleName, workerDeploymentOptions, ar -> {
+      if (ar.failed()) {
+        LOG.error("Failed to deploy verticle", ar.cause());
+        failed.compareAndSet(false, true);
+      }
+      deployLatch.countDown();
+    });
+
+    try {
+      if (!deployLatch.await(5, SECONDS)) {
+        throw new RuntimeException("Timeout waiting for verticle deployments");
+      } else if (failed.get()) {
+        throw new RuntimeException("Failure while deploying verticles");
+      }
+    } catch (InterruptedException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
+}

spring-examples/spring-worker-example/src/main/java/io/vertx/example/spring/worker/Book.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2017 Red Hat, Inc.
+ *
+ * Red Hat licenses this file to you 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.
+ */
+
+package io.vertx.example.spring.worker;
+
+import io.vertx.codegen.annotations.DataObject;
+import io.vertx.core.json.JsonObject;
+
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.Id;
+
+/**
+ * A book JPA entity.
+ *
+ * @author Thomas Segismont
+ */
+@Entity
+// Book must annotated with @DataObject because it is used as a parameter type in BookAsyncService
+@DataObject(generateConverter = true)
+public class Book {
+
+  @Id
+  @GeneratedValue
+  private Long id;
+
+  private String name;
+
+  private String author;
+
+  // Mandatory for JPA entities
+  protected Book() {
+  }
+
+  public Book(String name, String author) {
+    this.name = name;
+    this.author = author;
+  }
+
+  // Mandatory for data objects
+  public Book(JsonObject jsonObject) {
+    BookConverter.fromJson(jsonObject, this);
+  }
+
+  public Long getId() {
+    return id;
+  }
+
+  public void setId(Long id) {
+    this.id = id;
+  }
+
+  public String getName() {
+    return name;
+  }
+
+  public void setName(String name) {
+    this.name = name;
+  }
+
+  public String getAuthor() {
+    return author;
+  }
+
+  public void setAuthor(String author) {
+    this.author = author;
+  }
+
+  public JsonObject toJson() {
+    JsonObject json = new JsonObject();
+    BookConverter.toJson(this, json);
+    return json;
+  }
+
+  @Override
+  public String toString() {
+    return "Book{" +
+      "id=" + id +
+      ", name='" + name + '\'' +
+      ", author='" + author + '\'' +
+      '}';
+  }
+}