Hace poco empecé a trabajar con Ratpack y me gusta bastante. Principalmente he hecho proyectos rápidos desde cero. Pero me gustaría usarlo en una aplicación Spring Boot existente para reemplazar la parte MVC tradicional. Esto es realmente fácil de hacer ya que todo ha sido pensado ya gracias a su Módulo de primavera.
Si sigues este blog quizás recuerdes un antiguo post sobre almacenamiento, indexación y búsqueda archivos con Couchbase y Spring Boot. Utilizaré el código relacionado como ejemplo. La idea es sustituir Spring MVC por Ratpack, y hacer que mis servicios heredados, síncronos y bloqueantes, sean asíncronos y no bloqueantes. El código resultante está disponible en github también.
Añadir las dependencias adecuadas
Estoy usando Gradle. Ratpack está muy bien integrado con él. Todo lo que necesitas hacer para añadir un módulo es añadir la dependencia correcta llamando a ratpack.dependency("miModuloFavorito"). Así que en nuestro caso, para añadir soporte para Spring Boot, es necesario añadir ratpack.dependency("spring-boot"). Desafortunadamente la versión gestionada automáticamente por Ratpack es inferior a 1.4.0.M3, que es la versión que trae la configuración automática de Couchbase. Así que esta vez tendré que añadir las dependencias manualmente.
|
1 2 3 4 5 6 7 8 9 10 11 12 |
dependencies { compile ratpack.dependency("guice"), ratpack.dependency("rx"), ratpack.dependency("handlebars"), "com.couchbase.client:java-client:2.3.1", "org.springframework.boot:spring-boot-autoconfigure:1.4.0.M3", "io.ratpack:ratpack-spring-boot:1.3.3", "org.slf4j:slf4j-simple:1.7.12", "org.codehaus.plexus:plexus-utils:3.0.21", "commons-codec:commons-codec:1.10" } |
Lo que se puede ver aquí es que ratpack.dependency("spring-boot") es un atajo para añadir org.springframework.boot:spring-boot-autoconfigure:1.4.0.M3 y io.ratpack:ratpack-spring-boot:1.3.3. Lo que este módulo te da es la capacidad de integrar un servidor Ratpack a tu aplicación Spring. Podrás recuperar @Beans de Spring desde el contexto de Ratpack y declarar manejadores como configuración de Spring.
Declarar la configuración de Ratpack
Una cosa que te tiene que encantar de Spring Boot es la autoconfiguración. Sólo necesitas asegurarte de que el SDK de Couchbase está en el classpath, y que la propiedad spring.couchbase.bootstrap-hosts se declara. En ese momento se instanciarán beans de Spring para un Bucket por defecto. Y esta instancia de bucket estará disponible como bean o en el contexto de Ratpack. Así que no tienes que declarar ningún binding para Couchbase en la capa de Ratpack.
Lo primero que se hace tradicionalmente con Ratpack es iniciar un servidor y definir la configuración y los manejadores. Aquí ya tenemos una aplicación Spring Boot ejecutándose. Todas las clases anotadas con @Configuration serán recogidas automáticamente y añadidas a la configuración de la aplicación. El primer paso para declarar esa configuración es crear una Clase que implemente RatpackServerCustomizer y anótelo con @Confguration. Te permite definir una lista de handlers, bindings y configuración del servidor. En el siguiente ejemplo estoy registrando algunas propiedades del servidor y vinculando varias clases al contexto de Ratpack. La propiedad 'server.maxContentLength' es el tamaño máximo de archivo que puedes subir.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
package org.couchbase.devex; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Map; import org.couchbase.devex.domain.StoredFileRenderer; import org.couchbase.devex.service.SearchService; import org.springframework.context.annotation.Configuration; import com.google.common.collect.ImmutableMap; import ratpack.form.Form; import ratpack.func.Action; import ratpack.guice.BindingsSpec; import ratpack.handlebars.HandlebarsModule; import ratpack.handlebars.Template; import ratpack.handling.Chain; import ratpack.rx.RxRatpack; import ratpack.server.BaseDir; import ratpack.server.ServerConfigBuilder; import ratpack.spring.config.RatpackServerCustomizer; import rx.Observable; @Configuration public class RatpackConfiguration implements RatpackServerCustomizer { @Override public List<action> getHandlers() { List<action> handlers = new ArrayList<action>(); handlers.add(fileApi()); return handlers; } @Override public Action getServerConfig() { return config -> config.baseDir(BaseDir.find()) .props(ImmutableMap.of("server.maxContentLength", "100000000", "app.name", "Search Store File")); } @Override public Action getBindings() { return bindingConfig -> bindingConfig.module(HandlebarsModule.class).bind(FileHandler.class) .bind(StoredFileRenderer.class).bind(ErrorHandlerImpl.class).bind(ClientHandlerImpl.class); } private Action fileApi() { return chain -> chain.prefix("file", FileHandler.class).post("fulltext", ctx -> { ctx.parse(Form.class).then(form -> { String queryString = form.get("queryString"); SearchService searchService = ctx.get(SearchService.class); Observable<map<string, object="">> files = searchService.searchFulltextFiles(queryString); RxRatpack.promise(files).then(response -> ctx .render(Template.handlebarsTemplate("uploadForm", "text/html", m -> m.put("files", response)))); }); }).post("n1ql", ctx -> { ctx.parse(Form.class).then(form -> { String queryString = form.get("queryString"); SearchService searchService = ctx.get(SearchService.class); Observable<map<string, object="">> files = searchService.searchN1QLFiles(queryString); RxRatpack.promise(files).then(response -> ctx .render(Template.handlebarsTemplate("uploadForm", "text/html", m -> m.put("files", response)))); }); }); } } </map<string,></map<string,></action</action</action |
El sistema de plantillas de la aplicación se basa en Handlebars, por lo que necesitas el HandlebarsModule. FileHandler se encargará de todas las llamadas a la API '/file' y StoredFileRenderer se asegurará de que StoredFile se muestre correctamente. Los dos últimos bindings son para la gestión de errores.
Lo más importante que ocurre aquí es la fileAPI que declara mi manejador. Un manejador define lo que sucede cuando un usuario accede a una URL en particular. Aquí asociamos cada llamada a '/file/*' a la clase FileHandler. También definimos el comportamiento para POST en '/fulltext' y '/n1ql'.
Ratpack utiliza promesas. Así que cuando analices un formulario procedente de una petición POST, obtendrás una promesa. Lo que puedes ver en cada uno de esos POST es que el SearchService se obtiene del contexto de Ratpack. Aunque nunca se haya vinculado en la configuración. Esto se debe a que los beans de Spring están disponibles en el contexto como parte de la integración.
El siguiente paso es llamar a ese servicio de búsqueda que devuelve un Observable. Podemos utilizar el módulo rx-java de Ratpack que proporciona un envoltorio para Observables. Envolverá esto como una promesa. Entonces puedes simplemente renderizar la respuesta.
En este punto nos deshicimos de todo el Spring MVC controladores. Como puedes ver mi servicio devuelve un Observable. Que no es el caso en mi aplicación anterior.
Migración de servicios para Ratpack
La mayoría de mis servicios se basan en Couchbase. El SDK está basado en RxJava por lo que es muy fácil convertir la mayoría de ellos a un modo asíncrono, no bloqueante y hacer que devuelvan Observable.
Uso de RxJava
Este es un ejemplo muy simple. Es una consulta N1QL que mapea los resultados a una Lista de Mapa. Las dos primeras líneas no cambian en absoluto, ya que son en su mayoría la definición de la consulta. Puedes ver que el mapeo se siente más natural cuando se utiliza el cubo síncrono en la segunda versión.
|
1 2 3 4 5 6 7 8 9 10 |
public List<map<string, object="">> searchN1QLFiles(String whereClause) { N1qlQuery query = N1qlQuery.simple( "SELECT binaryStoreLocation, binaryStoreDigest FROM `default` WHERE type= 'file' " + whereClause); query.params().consistency(ScanConsistency.STATEMENT_PLUS); N1qlQueryResult res = bucket.query(query); List<map<string, object="">> filenames = res.allRows().stream().map(row -> row.value().toMap()) .collect(Collectors.toList()); return filenames; } </map<string,></map<string,> |
Se convierte en
|
1 2 3 4 5 6 7 |
public Observable<map<string, object="">> searchN1QLFiles(String whereClause) { N1qlQuery query = N1qlQuery.simple( "SELECT binaryStoreLocation, binaryStoreDigest FROM `default` WHERE type= 'file' " + whereClause); query.params().consistency(ScanConsistency.STATEMENT_PLUS); return bucket.async().query(query).flatMap(AsyncN1qlQueryResult::rows).map(r -> r.value().toMap()); } </map<string,> |
¿Y el bloqueo del código heredado?
Algunos de mis servicios se basan en código antiguo y bloqueante. Aunque no hay una forma mágica de hacerlos no bloqueantes, podemos envolverlos fácilmente en una Promesa. Esto nos permitirá utilizarlos fácilmente en los Handlers. Envolver una llamada bloqueante es super fácil, todo lo que necesitas hacer es envolver tu función con 'Blocking.get()'. Aquí tienes un ejemplo muy sencillo:
|
1 2 3 4 |
public String getSha1Digest(InputStream is) { return DigestUtils.sha1Hex(is); } |
se convierte en
|
1 2 3 4 |
public Promise getSha1Digest(InputStream is) { return Blocking.get(() -> DigestUtils.sha1Hex(is)); } |
Conclusión
Ahora ya sabes casi todo lo que necesitas saber para darle un poco de Ratpack Love a tu aplicación Spring Boot. Si sientes que falta algo, por favor ponte en contacto conmigo en twitter o en los comentarios a continuación.
