Integración de Play con Slick y SQLite en Scala
Contenido del curso
Antes de empezar, deberías descargar el template Play Scala Seed desde esta página: https://developer.lightbend.com/start/?group=play&project=play-scala-seed
Recuerda que para este proyecto usaremos IntelliJ IDEA como editor, así que asegúrate de tenerlo instalado junto con los plugins recomendados en una lectura anterior. Debes tener abierto el proyecto en el IntelliJ IDEA.
El proceso que seguiremos será el siguiente:
Movie.scala con el modelo y la definición de la tabla.Dependencias
Lo primero que hay que agregar son las dependencias para usar PlaySlick (el plugin que integra Play con Slick), y el driver JDBC de la base de datos que vayamos a usar, que en este caso será SQLite.
SBT buscará los paquetes de sus dependencias en Maven.
Puedes pensar en Maven como algo similar a NPM de JavaScript (un repositorio de paquetes que pueden ser descargados). Aunque la diferencia con NPM es que Maven no constituye una entidad única si no múltiples repositorios de paquetes administrados por diferentes entidades o empresas.
Por eso para encontrar nuevos paquetes existe una página que tiene indexados más de mil repositorios de Maven: https://mvnrepository.com/
Allí es fácil hacer búsquedas no solo de los paquetes que necesitemos, si no también de sus versiones disponibles.
Como ejercicio, haz tú la búsqueda de los dos paquetes que queremos instalar. En la siguiente imagen puedes ver cómo debe quedar el build.sbt:
Luego con el comando sbt update desde la consola, haremos que sbt descargue estas dependencias en nuestro proyecto para que estén disponibles.
Configuración
Lo siguiente que debes hacer, es configurar los datos de acceso a una base de datos SQLite. Esto lo haremos en el archivo application.conf que se encuentra en la carpeta conf del proyecto.
El archivo application.conf está escrito en un formato llamado HOCON. En la imagen estamos definiendo las configuraciones para la base de datos por defecto (Slick permite configurar múltiples conexiones al tiempo también). Las configuraciones mínimas son las siguientes:
$ al final de la clase SQLiteProfile. Puedes ver un listado de las bases de datos soportadas con los links a sus perfiles en la documentación de Slick, https://scala-slick.org/doc/3.3.1/supported-databases.htmlMyDataBase.db será el nombre del archivo donde se alojará la base de datos. No es necesario que exista con antelación ya que más adelante haremos que play lo cree por nosotros. En otras bases de datos como Postgres, Oracle o MySql, la URL de conexión será distinta, pero siempre siguiendo su formato para JDBC.slick.default), hace referencia al paquete de Scala donde Slick buscará las clases cuando hagamos la definición de los modelos.Modelo
En la carpeta app, crearemos un paquete que se llame models, y dentro crearemos un archivo llamado Movie.scala. Puedes crearlos con clic derecho New, o creando la carpeta y el archivo manualmente. Debe quedarte de la siguiente manera:
Case Class Movie
Lo primero será convertir la clase Movie en un case class, y agregarle los atributos correspondientes. Este case class debe quedar de la siguiente manera:
Los puntos a notar son:
() en vez de llaves {}.id y tags son opcionales, pero el primero crea por defecto un UUID (que debes de importar) cuando el objeto no tenga id.MovieTable
Teniendo ya el case class, debemos crear una clase que será el "puente" entre la información que se envíe/reciba de la base de datos, hacia el objeto de Scala.
Esta clase la llamaremos MovieTable y puede estar en el mismo archivo, junto con la case class Movie (a diferencia de Java, en Scala podemos tener distintas clases en el mismo archivo sin problema). Debe quedar de la siguiente manera:
api que está en el profile de nuestra base de datos SQLite (en Scala el guión bajo _ en una importación, es equivalente al asterisco * de Java o Python).Table[T] que recibe un tipo de dato T, que en este caso será el case class Movie. Allí también de le dice el nombre de la tabla de SQL a la que hace referencia.column, dándole el tipo de dato de Scala, y el nombre de la columna en SQL.id que tiene O.PrimaryKey, o tags que tiene O.Length(2000, varying = true) . Existen varias opciones que están dentro del objeto O de opciones de columna. Las opciones disponibles siempre depende de la base de datos que estés usando.id en la tabla es directamente un String en vez de un Option[String]. Esto es porque la clave primaria nunca puede ser nula.*. Para el atributo id.?, ese ? es necesario porque en la definición de la tabla ese atributo es obligatorio, pero en la definición del objeto es opcional, de esa manera el compilador sabe que lo debe transformar.Si quieres conocer más detalles sobre esto, puedes verlos en la documentación de Slick: https://scala-slick.org/doc/3.3.1/schemas.html
MovieRepository
La última parte en este archivo será lo que se conoce como repositorio.
En este contexto, un repositorio es el encargado de comunicar la base de datos con lo que será más adelante el controlador. Esta será la clase sobre la que vamos a trabajar en la próxima clase.
El repositorio debe quedar de la siguiente manera:
dbConfigProvider contiene lo necesario para realizar peticiones a la base de datos, usando los datos que escribiste en el application.conf.implicit para no tener que pasarle este parámetro todo el tiempo, si no que el compilador lo ponga por nosotros.movieQuery, es desde el cual vamos a estar creando las peticiones a la base de datos en la próxima clase.Funciones de ayuda para la creación de la base de datos
Esta parte no la explicaré en detalle, pero será útil para crear el esquema de la base de datos usando lo que acabamos de escribir. Es decir, que no es necesario tener las definiciones de las tablas en SQL, si no que con base en el código en Scala, podemos decirle a Slick que las cree por nosotros.
En el repositorio
Para ello, primero debes agregar el siguiente código dentro de la clase MovieRepository:
// Esto va dentro de la clase MovieRepository /** * Función de ayuda para crear la tabla si ésta * aún no existe en la base de datos. * @return */ def dbInit: Future[Unit] = { // Definición de la sentencia SQL de creación del schema val createSchema = movieQuery.schema.createIfNotExists // db.run Ejecuta una sentencia SQL, devolviendo un Future db.run(createSchema) } def getAll = ??? def getOne = ??? def create = ??? def update = ??? def delete = ???
Nota que la última parte en donde están los ???, es donde empezaremos en la próxima clase.
En el HomeController
Luego debes agregar lo siguiente en el archivo app/controllers/HomeController.scala
// Importar el repository y el contexto de ejecución global import models.MovieRepository import scala.concurrent.ExecutionContext.Implicits.global //.... // Hay que agregar el repository para que sea inyectado @Singleton class HomeController @Inject()( cc: ControllerComponents, movieRepository: MovieRepository ) extends AbstractController(cc) { // ..... /* Función de ayuda para crear la tabla si esta aún no existe. */ def dbInit() = Action.async { request => movieRepository.dbInit .map(_ => Created("Tabla creada")) .recover{ex => play.Logger.of("dbInit").debug("Error en dbInit", ex) InternalServerError(s"Hubo un error") } } }
HomeController para que sea inyectado.dbInit.En el archivo de rutas
Por último se debe agregar en el archivo conf/routes una ruta hacia la acción dbInit que acabamos de agregar:
GET /dbInit controllers.HomeController.dbInit
![07.png](https://static.platzi.com/media/user_upload/07-a0159219-ea8b-41fa-993d-3eadd97438e7.jpg
Corriendo el servidor y creando la base de datos
Usaremos en comando sbt compile para estar seguros que todo compila correctamente, y después escribimos el comando sbt run para correr el servidor en modo desarrollo.
Con el servidor de desarrollo encendido, visitaremos la dirección http://localhost:9000/dbInit, y después de unos segundos, deberías ver el mensaje de "Tabla creada".
Y si revisas la carpeta del proyecto, deberías ver el archivo de la base de datos SQLite también:
Para detener el servidor de desarrollo, usa las teclas Ctrl+D en la consola.
Conclusiones
En esta clase escrita aprendimos muchas habilidades útiles para trabajar con Play y Scala.
Aquí fuimos a lo práctico, pero por supuesto hay temas que se profundizan en la documentación de Play y que quizás te puedan interesar: https://www.playframework.com/documentation/2.7.x/PlaySlick
Estoy seguro que en el código de esta clase notaste cómo aplicamos varios de los temas que vimos en las clases pasadas. Escribe en los comentarios cuales viste que te llamaron la atención, y por qué crees que son útiles o inútiles en donde fueron aplicados.
Jesus Rodriguez
Juan Quevedo Sanchez
Rafael Lizarraga
Stid Rodríguez Barrientos
Juan Quevedo Sanchez
Martin Albarracin
Jose Alvear
J. Fernando Zuñiga Ortiz
Elias Ojeda Medina
Fabricio Orrala
Daniel Jacales
Antonio Rafael González Ferrer
Nicolás Danilo Peña Fuentes
C. Daniel Sanchez R.
Profesor
Ezequiel Aguilar Benitez
Daniel Eduardo Portugal Revilla
Miguel Contreras
C. Daniel Sanchez R.
Profesor
Alejandro Cabarcas Perdomo
Axel Alexis Montejo Lopez
Johan Nicolas Riaño Torres
Rafael Lizarraga
Manuel Eguiluz
Johan Nicolas Riaño Torres
Carlos Cabrera
Juan Quevedo Sanchez
C. Daniel Sanchez R.
ProfesorJuan Quevedo Sanchez
Manuel Eguiluz
Daniel Horfan
No me gusto este articulo, pudo haber sido explicado un poco mejor con videos porque algunos pasos se prestan a confusion y por lo menos en el articulo en vez de dejar imagenes, hubiera estado mejor dejar snippets para copiar y pegar porque muchas de estas cosas son demasiado boilerplate y esta muy facil equivocarse por un par de caracteres
x2
me hace copiar a mano una imagen omg
Me parece pésima esta clase, qué pasó íbamos bien, muy diferente ver codificar y entender cada elemento que leer un documento.
x2
Hay una serie de errores en el codigo mostrado, puede ser por la nueva versión de play, recomiendo se realicen las correcciones necesarias, dado que se invierte mucho tiempo en tratar de ejecutar el ejercicio, me tomo el atrevimiento de compartir este repositorio de Jonathan Valencia que me ayudo con la configuración de la base de datos con slick https://github.com/jonathanvalenciav/platzi-video.
Estimado buenas tardes por favor su ayuda me sale este error en el BUILD:
C:\Users\JoséLuis\Desktop\platzi-video-master\app\controllers\HomeController.scala:17:19 object index is not a member of package views.html Ok(views.html.index())
Ay que bien se siente jajaja al fin, después de la infinidad de errores
Funciono! Después de tantos errores
Creo que también es importante lo siguiente:
Gracias Jonathan Valencia y Martín Albarracín.
Para los que tienen problemas corriendo el proyecto les dejo mi repositorio, para guía , hay algunas cositas que no están explicitas en el articulo y hay que leer un poco más sobre todo de el framework para que funcione para los que tengan experiencia en spring les sera un poco mas sencillo entender.
Mi principal problema fue identificar correctamente los imports que hay que hacer así como implementar el controller lo necesario para la compilación.
Obtengo errores en todo 😑
Imágenes:
El error en navegador:
IO error while decoding C:\Users\sistemasfimtt\iCloudDrive\Platzi\Carreras\Fundamentos de Programación\ProgramacionFuncionalConScala\play-scala-seed\target\scala-2.13\routes\main\controllers\ReverseRoutes.scala with UTF-8: MALFORMED[1] Please try specifying another one using the -encoding option
Mis archivos: build.sbt
name := """platzi-video""" organization := "com.platzi" version := "1.0-SNAPSHOT" lazy val root = (project in file(".")).enablePlugins(PlayScala) scalaVersion := "2.13.1" libraryDependencies += guice libraryDependencies += "org.scalatestplus.play" %% "scalatestplus-play" % "5.0.0" % Test libraryDependencies += "com.typesafe.play" %% "play-slick" % "4.0.2" libraryDependencies += "org.xerial" % "sqlite-jdbc" % "3.28.0"
application.conf
# https://www.playframework.com/documentation/latest/Configuration slick.dbs.default.profile="slick.jdbc.SQLiteProfiles$" slick.dbs.default.db.driver="org.sqlite.JDBC" slick.dbs.default.db.url="jdbc:sqlite:MyDataBase.db" slick.dbs.default.db.user="" slick.dbs.default.db.password="" slick.default="model.*"
Movie.scala
package models import java.util.UUID /* Objeto Movie. */ case class Movie( id: Option[String] = Option(UUID.randomUUID.toString), title: String, year: Int, cover: String, description: String, duration: Int, contentRating: String, source: String, tags: Option[String] )
MovieTable.scala
package models import slick.jdbc.SQLiteProfile.api_ /* Clase que mapea el objeto a la tabla movie. https://scala-slick.org/doc/3.3.1/schemas.html */ class MovieTable(tag: Tag) extends TableMovie{ def id: Rep[String] = columnString def title: Rep[String] = columnString def year: Rep[Int] = columnInt def cover: Rep[String] = columnString def description: Rep[String] = columnString def duration: Rep[Int] = columnInt def contentRating: Rep[String] = columnString def source: Rep[String] = columnString def tags: Rep[Option[String]] = column[Option[String]]("tags", 0.Lenght(2000, varying = true)) def *: ProvenShape[Movie] = (id.?, title, year, cover, duration, contentRating, source, tags) <> (Movie.tupled, Movie.unapply) }
MovieRepository.scala
package models import javax.inject.Inject import play.api.db.slick.{DatabaseConfigProvider, HasDatabaseConfigProvider} import play.api.mvc.{AbstractController, ControllerComponents} import scala.concurrent.{ExecutionContext, Future} /* Clase repository, donde irán las consultas. */ class MovieRepository @Inject()( protected val dbConfigProvider: DatabaseConfigProvider, cc: ControllerComponents )(implicit ec: ExecutionContext) extends AbstractController(cc) with HasDatabaseConfigProvider[JdbcProfile]{ private lazy val movieQuery = TableQuery[MovieTable] } /* * Función de ayuda para crear la tabla si esta * aún no existe en la base de datos. * @return */ def dbInit: Future[Unit] = { // Definición de la sentencia SQL de creación del schema val createSchema = movieQuery.schema.createIfNotExists // db.run ejecuta una secuencia SQL, devolviendo un Future db.run(createSchema) } def getAll = ??? def getOne = ??? def create = ??? def update = ??? def delete = ???
HomeController.scala
package controllers import javax.inject._ import play.api._ import play.api.mvc._ // Importar el repository y el contexto de ejecución global import models.MovieRepository import scala.concurrent.ExecutionContext.Implicits.global /** Hay quea gregar el repository para que sea inyectado */ @Singleton class HomeController @Inject()( cc: ControllerComponents, movieRepository: MovieRepository ) extends AbstractController(cc){ // ... /* Función de ayuda para crear la tabla si esta aún no existe */ def dbInit() = Action.async{ request => movieRepository.dbInit .map(_ => Created("Tabla creada")) .recover{ex => play.Logger.of("dbInit").debug("Error en dbInit", ex) InternalServerError(s"Hubo un error") } } }
routes
# Routes # This file defines all application routes (Higher priority routes first) # https://www.playframework.com/documentation/latest/ScalaRouting # ~~~~ # An example controller showing a sample home page GET / controllers.HomeController.index # Map static resources from the /public folder to the /assets URL path GET /assets/*file controllers.Assets.versioned(path="/public", file: Asset) GET /dbInit controllers.HomeController.dbInit
¿Algún apoyo con el tema?
En la clase MovieTable tienes algunos errores de sintaxis. Revisa por ejemplo que estás llamando 0.PrimaryKey, y debería ser O.PrimaryKey (no es un cero, es la letra 'O') en el def tags colocas 0.Lenght, y es O.Length
Hola. Uno de los errores puede ser por la tilde Programación en el nombre de la carpeta.
También hay otro error en la importación del objeto api en MovieTable.scala, deberías ser slick.jdbc.SQLiteProfile.api._.
Por supuesto, el apunte de dann es correcto en que no es un cero si no una O.
Che clase toda qlera, en fin Para aquellos que no les instale las dependencias y estén usando Intellij. Cierren y abran de nuevo su proyecto. Posterior a eso también tomen de guía a quienes ya les quedo el proyecto y lo comentaron como aporte en esta sección
este es la estructura de archivos y como debe quedar. tuve que importar muchas cosas por defecto según me indicaba IntelliJ porque en el post creo que hay muchos pasos que no se menciona. estare subiendo el código a Github
Esta clase te arruina el curso, al ser todo imagenes y no poder copiar es un desastre no te queda igual, no compila, lo hace engorroso, una lastima
Hola. También lo ando haciendo y lo que hice fue copiar el código qué están en las fuentes de la siguiente clase.
Total llevo bastante tiempo intentando hacerlo funcionar y nada. Has encontrado alguna solución ?
Terrible artículo. Una explicación bastante insuficiente y pobre
si tengo el model en este caso "models" metida por alla en varios niveles de carpetas, el "slick.default" tendría que colocarle la ruta completa?
Hola Juan.
slick.default no está tomando la carpeta donde tengas los modelos, si no que está tomando la jerarquía del paquete!
Es decir, podrías tener el archivo en una/carpeta/muy/adentro/de/otras/archivo.scala, y si en la cabecera de archivo.scala tienes que el paquete al que pertenece es models (package models), eso es lo que el compilador buscará.
Esto es bastante conveniente porque puede dar flexibilidad a la hora organizar los archivos de un proyecto.
para las personas que recién lleguen como yo y no quieran ponerse a transcribir imagen por imagen tengo este hackLife: descarguen cada imagen recortenla y carguenla aquí, es un OCR para pasar de imagen a texto https://www.onlineocr.net/es/
O también pueden ir a la clase siguiente y copiar el código fuente que está en los archivos.
Buenas, alguien por favor que me hace falta. Cuando lanzo el comando sbt update muestra el siguiente error:
download error: Caught javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building fail ed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target (sun.security.validator.ValidatorExceptio n: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target) while download ing https://repo.typesafe.com
He buscado pero no se que me falta. tengo jdk1.8.0_281 de 64 bits y javac 1.8.0_281 Mi build.sbt es
name := "mi-primer-scala" organization := "com.scala" version := "1.0-SNAPSHOT" lazy val root = (project in file(".")).enablePlugins(PlayScala) scalaVersion := "2.13.3" libraryDependencies += guice libraryDependencies += "org.scalatestplus.play" %% "scalatestplus-play" % "5.0.0" % Test libraryDependencies += "com.typesafe.play" %% "play-slick" % "4.0.2" libraryDependencies += "org.xerial" %% "sqlite-jdbc" % "3.28.0" // Adds additional packages into Twirl //TwirlKeys.templateImports += "com.example.controllers._" // Adds additional packages into conf/routes // play.sbt.routes.RoutesKeys.routesImport += "com.example.binders._"``` Nota: tengo el cacerts en la ruta: C:\Program Files (x86)\Java\jre1.8.0_281\lib\security pero entonces no entiendo que me hace falta. Gracias
