Usando Traits para não peder código ao (re)importar modelo XMI

Fechado

Wemerson Couto Guimarães 29/10/2014 (há 9 anos)

Quem usa o Adianti Studio tem à sua disposição uma excelente ferramenta de importação e geração de classes derivadas diretamente do diagrama de classes UML (salvas em formato XMI). E isso é uma mão na roda para acelerar o desenvolvimento. Porém torna-se um pesadelo quando inadvertidamente o desenvolvedor esquece de fazer um backup do código inserido após a importação e vez ou outra perde horas de trabalho sobrescrevendo suas classes.

Com o PHP 5.4 surgiram novos conceitos e um deles é a Trait (traço), onde temos herança horizontal. Digamos que uma trait é como um traço adquirido no decorrer da vida de um objeto, e não propriamente uma característica herdada de seus pais. Quando herda dizemos ter herança vertical (ao estender de outra classe). Já na herança horizontal, não estende ou deriva de outra; simplesmente usa as características quando necessário. A ideia que em vez de ir empilhando várias classes derivadas gerando vários clones e adicionando novas características, simplesmente criamos uma combinação de traços com novos atributos e métodos.

Não vou entrar em mais detalhes sobre trais senão esse texto ficará muito extenso. Quem quiser saber mais Traits, veja um excelente material publicado pelo Flávio Gomes Lisboa no slideshare, nesse link: pt.slideshare.net/flaviogomesdasilvalisboa/traits-no-php-54-muito-al

Como um exemplo básico de utilização desse recurso, vejamos o diagrama de classes com uma única classe no link da figura abaixo:

i.imgur.com/ZZvz0cA.png

Código gerado pelo Adianti Studio com base diagrama:

<?php
/**
* Pessoa Active Record
* @author <your-name-here>
*/
class Pessoa extends TRecord
{
const TABLENAME = 'pessoa';
const PRIMARYKEY= 'id';
const IDPOLICY = 'serial'; // {max, serial}
/**
* Constructor method
*/
public function __construct($id = NULL, $callObjectLoad = TRUE)
{
parent::__construct($id, $callObjectLoad);
parent::addAttribute('nome');
parent::addAttribute('cor');
parent::addAttribute('sexo');
parent::addAttribute('nascimento');
}
/**
* Method getAniversariantes
* @param $inicio, $fim
*/
public function getAniversariantes( $inicio, $fim )
{
}
}
?>

Em vez de codificarmos o método getAniversariantes() na classe, excluímos o mesmo e o recriamos numa trait. Abaixo o código da trait já com o método:

<?php
trait PessoaTrait
{
private $aniversariantes;
public function getAniversariantes( $inicio, $fim )
{
$repository = new TRepository('Pessoa');
$criteria = new TCriteria;
$criteria->add( new TFilter('nascimento' , 'BETWEEN', $inicio, $fim) );
$this->aniversariantes = $repository->load($criteria);
return $this->aniversariantes;
}
}
?>

Agora na classe basta incluirmos a trait dentro da classe. Abaixo o código completo da classe já com os ajustes:

<?php
/**
* Pessoa Active Record
* @author <your-name-here>
*/
class Pessoa extends TRecord
{
use PessoaTrait; // Pensem... (Usar) vários traços, é melhor que se inflar para herdar (Ter) esses traços
const TABLENAME = 'pessoa';
const PRIMARYKEY= 'id';
const IDPOLICY = 'serial'; // {max, serial}
/**
* Constructor method
*/
public function __construct($id = NULL, $callObjectLoad = TRUE)
{
parent::__construct($id, $callObjectLoad);
parent::addAttribute('nome');
parent::addAttribute('cor');
parent::addAttribute('sexo');
parent::addAttribute('nascimento');
}
// método getAniversariantes foi movido para a trait
}
?>

Bem à primeira vista pode parecer pouco, mas pense numa aplicação de porte pelo menos razoável com várias classes extensas e com muitos métodos que você precisa codificar manualmente. Seguindo essa ideia, fará apenas uma vez e não terá mais problemas caso precise importar novamente alguma classe do XML.

Coloque na trait apenas os métodos e atributos que você precisou adicionar ou codificar manualmente na classe, mantendo na classe os métodos completos gerados pela importação.

Comentários (8)