Desenvolvendo um Website de Gerenciamento Financeiro #5

Aperfeiçoando nossas Entidades

Vamos falar sobre o Finder. É um recurso do Ebean que permite que melhoremos nossas entidades com métodos que ajudaram na pesquisa ao banco de dados. Com Kotlin, podemos usá-lo como um companion object para tornar tudo mais fácil. Deixe-me mostrá-lo:

	@Entity
	class Script(
	@Id
	@GeneratedValue(strategy = GenerationType.AUTO)
	var id: Long? = null,
	var name: String = "",
	var source: String = "",
	var description: String = "",
	@Version
	var version: Long = 0L,
	) {
	companion object : Finder<Long, Script>(Script::class.java)
	}
	fun someExamples() {
	// lists all scripts
	val list = Script.all()
	// find a single script by it's name
	val script1 = Script.query().where().eq("name", "name of the script").findOne()
	// finds the script with id = 1
	val script2 = Script.byId(1)
	// delete the script with id = 1
	Script.deleteById(1)
	}

view raw Script.kt hosted with ❤ by GitHub

Agora minha entidade Script tem métodos como all(), query(), byId(), update() e outros. Veja a função someExamples no Gist acima, fácil não é?

Você pode, inclusive, criar uma classe ScriptFinder que extende Finder com suas próprias consultas. No meu caso, prefiro deixar isto em uma camada de serviços.

---

De volta ao nosso projeto

Para ilustrar estes métodos em uso, alterarei nossas entidades e testes. Aqui está o nosso BaseEntitiesRelated.kt atual:

	package com.marcelustrojahn.models
	import io.ebean.Finder
	import java.time.LocalDate
	import javax.persistence.*
	@Entity
	@Inheritance
	abstract class BaseEntity(
	@Id
	@GeneratedValue(strategy = GenerationType.AUTO)
	var id: Long? = null,
	var name: String = "",
	var enabled: Boolean = true,
	var addressStreet: String = "",
	var addressNumber: Int = 0,
	var addressDistrict: String = "",
	var addressCity: String = "",
	var addressState: String = "",
	var addressZip: String = "",
	var birth: LocalDate = LocalDate.MIN,
	@Version
	var version: Long = 0
	) {
	companion object: Finder<Long, BaseEntity>(BaseEntity::class.java)
	override fun toString() = "BaseEntity(id: $id, name: $name)"
	}
	@Entity
	class Person(
	var cpf: String? = "",
	var rg: String? = ""
	) : BaseEntity() {
	companion object: Finder<Long, BaseEntity>(BaseEntity::class.java)
	override fun toString() = "Person(id: $id, name: $name)"
	}
	}
	@Entity
	class Company(
	var officialName: String? = "",
	var cnpj: String? = "",
	var ie: String? = "",
	var im: String? = ""
	) : BaseEntity() {
	companion object: Finder<Long, BaseEntity>(BaseEntity::class.java)
	override fun toString() = "Company(id: $id, name: $name)"
	}
	}

view raw BaseEntityRelated.kt hosted with ❤ by GitHub

Note que não estou usando data classes (que expliquei há 2 posts atrás) e que também criei o método toString() em todas as entidades para algum debug mais tarde.

Agora alterarei nossos testes para refletir as alterações nas entidades. Por favor, lembre-se que estamos ainda no início deste projeto e você não verá grande vantagem nisto ainda. De fato, eu só queria explicar sobre isto logo porque mais tarde é bem provável que removeremos toda esta funcionalidade em favor de usar uma camada de serviços.

Aqui está o código para as classes de teste:

	package com.marcelustrojahn.models
	import io.ebean.Ebean
	import io.kotlintest.matchers.shouldBe
	import io.kotlintest.matchers.shouldNotBe
	import io.kotlintest.specs.FreeSpec
	class BaseEntityTests: FreeSpec() {
	init {
	// remember the database will always be empty in the beggining of tests
	// so the id will be 1
	"should be able to save a Person" {
	val person = Person().apply { name = "John" }
	Ebean.save(person)
	person.id shouldNotBe null // id is filled on save
	}
	"should be able to select the Person from the database" {
	val person = Person.byId(1)
	person shouldNotBe null
	}
	"should be able to update the Person" {
	val person = Person.byId(1)
	person?.name = "Jack"
	Ebean.save(person)
	Ebean.find(Person::class.java).where().idEq(1).findOne()?.name shouldBe "Jack"
	}
	"should be able to delete the Person" {
	Person.deleteById(1)
	Person.byId(1) shouldBe null
	}
	}
	}

view raw BaseEntityTests.kt hosted with ❤ by GitHub

E aqui vemos a diferença entre as duas versões para refrescar sua memória ou para aqueles que estão me encontrando agora.

Um pouco mais simples, certo?

Te vejo no próximo post!