Programando para a web com Scala e VRaptor

Na Caelum temos experimentado a combinação de Java com Scala para projetos em produção, onde seu poder funcional e a desburocratização da sintaxe nos permite escrever um código mais elegante e reduzido. Exemplos disso são encontrados no post escrito pelo Rafael Ferreira em Scala realmente pode ser a sua próxima linguagem e, no mais recente escrito pelo Thadeu Russo, Modelando as classes do FJ-16 em Scala.

Além das vantagens citadas acima, um outro ponto bastante interessante das linguagens escritas sobre a JVM, é a possibilidade de usar tudo que já está pronto no Java de dentro da nova linguagem. Por exemplo, podemos usar qualquer classe previamente criada no Java dentro de um projeto usando Scala. Para exemplificar a mistura das linguagens, escolhemos migrar uma parte do projeto exemplo do VRaptor, o Mydvds.

Em primeiro lugar, alteramos um pouco os controllers responsáveis por administrar os usuários, nesse caso aproveitando apenas a sintaxe mais enxuta do Scala para conseguirmos ter as mesmas funcionalidades, porém escrevendo menos código. Segue um trecho da classe:

@Resource
class UsersController(dao:UserDao, userInfo:UserInfo, result:Result, validator:Validator) {
  @Path(Array("/users/{user.login}"))
  def view(user:User) = dao.find(user.getLogin)

  @Path(Array("/users"))
  def list = {
    result include("users",dao.listAll)
  }
}

Já fazendo uso da sintaxe mais reduzida, a declaração do construtor ficou bem mais enxuta, com os parâmetros automaticamente sendo disponibilizados como atributos do objeto. A mesma redução acontece na declaração do método view, onde o tipo de retorno é inferido automaticamente e, como o método só tem uma linha, podemos omitir a abertura das chaves. Sempre é válido lembrar que Scala é estaticamente tipado da mesma maneira que Java. Programando em alguma IDE com suporte a linguagem, podemos ver em tempo de compilação que esse método retornará um objeto do tipo User.

Depois que a lógica é executada, o VRaptor, seguindo a convenção, vai direcionar para o jsp responsável por exibir a  listagem. Poderiamos até usar os JSPs como camada de visualização para nossa aplicação, mas o problema seria ficar preso às restrições impostas pela Expression Language (EL) e ao uso das taglibs padrões do Java. Por exemplo, para exibir a listagem seria necessário uma java.util.Collection ou de um Array para que a tag foreach da JSTL funcione. Aqui há uma incompatibilidade pois as coleções do Scala foram implementadas do zero, sem nenhum vínculo com as coleções do Java. Outra incompatibilidade é em relação as classes de dominio, se estas forem criadas em Scala, por default não são criados getters no estilo Java e com isso não conseguimos chamar os métodos a partir dos JSPs.

Para explorar o poder do Scala na view, foi usado o Scalate, um projeto para camada de visualização focado em tirar proveito do melhor que a linguagem tem para oferecer. Abaixo segue a página de listagem dos usuarios implementada com Scalate:

<%@val users:Buffer[User]%>
<% render("/header.ssp") %>

<h1>${"list_users".i18n}</h1>
<table>
#for(user <- users)
  <tr>
  <td><a href="${"users".url}/${user.getLogin}">${"view".i18n}</a></td>
  <td>${user.getName}</td>
  </tr>
#end

</table>
<% render("/footer.ssp") %>

O primeiro detalhe diferente para quem está acostumado com os JSPs é a necessidade de declarar as variáveis que estão disponíveis no request para serem usadas dentro da página. O Scalate transforma isso numa classe em Scala para que depois possa compilar o código para ser otimizado pela JVM, evitando o uso de reflection.

Outro ponto interessante é a sintaxe utilizada para executar os trechos dinâmicos. O Scalate vem com suporte a diversas engines de renderização. No exemplo, estamos utilizando a chamada SSP (Scala Server Pages), que tem sintaxe similar ao Velocity. Um exemplo foi o for realizado no código acima. Outro ponto interessante de ser notado é o seguinte trecho de código:

${"users".url}

Para conseguir pegar a url relativa ao contexto nas páginas dentro de uma JSP, faríamos uso da tag <c:url>. Mas no SSP estamos chamando o método url a partir de uma String. O problema é que na String não existe o método url, e mesmo assim o código funciona: a idéia foi usar o poder de implicit methods para adicionar comportamentos em classes que já existem sem que necessariamente seja preciso alterá-las, como é o caso da classe String.

Para que o método url possa ser invocado através de uma String, seria necessário a importação da classe que contém essa extensão de comportamento. Mas, como declarar váriaveis não é algo comumente feito por programadores que utilizam JSP, o Scalate disponibiliza uma maneira de importar classes e disponibilizar helpers para as views, sem que seja preciso de fato declarar a importação na SSP. Para isso, o programador simplesmente cria uma classe chamada Boot em um pacote chamado scalate e a engine a carrega automaticamente. Abaixo o código:

package scalate

// imports omitidos

class Boot(engine: TemplateEngine,context:ServletContext){
  def run: Unit = {
    engine.importStatements  ::= "import scalate.VraptorHelper._"
    engine.importStatements  ::= "import scalate.PimpedJSTLCore"
    engine.importStatements  ::= "import br.com.caelum.vraptor.mydvds.model._"
    engine.importStatements  ::= "import scala.collection.mutable.Buffer"
  }
}

object VraptorHelper{
  implicit def string2PimpedJSTLCore(str:String) = new PimpedJSTLCore(str)
}

class PimpedJSTLCore(str:String){
  def url = request.getServletContext.getContextPath +"/"+ str
}

Repare que, através do método importStatements, disponibilizamos classes para serem utilizadas em qualquer página que for ser escrita, sem a necessidade dos imports. No exemplo acima, disponibilizamos as classes do pacote model para todas SSPs, já que é bem comum fazermos uso dessas classes nas views.

Além disso, o  método string2PimpedJSTLCore responsável pela mágica do método url na classe String.  Aqui é definido um método que consegue instanciar um objeto do tipo PimpedJSTLCore para qualquer String que chame o método url. Dessa maneira é possível simular uma adição de comportamento numa classe previamente escrita sem que precisemos promover alguma alteração na original.

Para quem quer aventurar-se na mistura das linguagens, como pregado pelos programadores poliglotas, o VRaptor já conta com um plugin que contorna alguns detalhes dessa integração. Para quem pensa em fazer uma migração, todos os SSPs devem ser colocados dentro da pasta ssp, seguindo a mesma estrutura da pasta jsp convencionada pelo VRaptor.

9 Comentários

  1. Sérgio Lopes 18/01/2011 at 14:49 #

    Ótimo artigo!

    Algumas dúvidas:

    1) O que é a anotação “@Public”?

    2) Seria possível tirar as anotações (“@Get” é default e “@Path” daria lugar a convenção), certo? E fazer um código mega enxuto

    3) Essa classe Boot para o scalate não poderia vir pronta no VRaptor (pelo menos a parte que é comum a todo mundo)? Não seria possível fazer um plugin pro VRaptor onde só jogamos um .jar e tudo funciona?

  2. Alberto Souza 18/01/2011 at 15:21 #

    Oi Sergio,

    1) Já foi retirada :). Essa era um anotação especifica do mydvds para controle de autenticação.

    2) Sem problemas, e ficaria bem enxuto mesmo :).

    3) Poderia vir no plugin sim. O único detalhe é que a classe tem que ter esse nome. Então, caso queira customizá-la para adicionar um helper seu ou algo parecido, ficaria impossibilitado. Uma outra alternativa seria criar uma trait do vraptor e a pessoa simplesmente usaria ela para ganhar os comportamentos default.

  3. Roberto Nogueira 18/01/2011 at 15:24 #

    Olá,

    O código do controller em vraptor já é tão simples que não consegui enxergar tantos ganhos assim 🙂
    Acredito que a parte de testes de unidade seria bem interessante com uma linguagem mais fácil. Porém o mais verboso mesmo é o teste de integração, acho que teria bastante ganho o uso de escala nesse ponto.
    Quanto a parte da view, facilitaram bastante a montagem do html, em vez de geração de html, mais um ponto positivo.

  4. Bruno Laturner 18/01/2011 at 19:15 #

    Poderia colocar este exemplos num GitHub?

  5. Paulo Silveira 18/01/2011 at 19:17 #

    Boa ideia do @Bruno. Alberto, posta no github? Acho que até ja ta la o projeto todo, nao?

  6. Alberto Souza 18/01/2011 at 21:08 #

    Opa, publicado :). https://github.com/caelum/vraptor-scala-mydvds

  7. Paulo Grito 19/01/2011 at 20:40 #

    Olá, Alberto

    Estou abaixando os arquivos do GitHub, todavia nas configurações do Eclipse só tenho que importar o vraptor-scala-mydvds.rar ? já tem todas as features configuradas ? Usei o scala-2.8.1.final-installer.jar na tentativa de rodar o aplicativo.

    Obrigado..

  8. Alberto Souza 20/01/2011 at 11:01 #

    Oi Paulo, agora tem um zip lá no repostiorio com o projeto. Basta descompactar e importar para o eclipse.

  9. Paulo Grito 20/01/2011 at 21:43 #

    Olá, Aberto o arquivo está com erro na descompactação, pode verificar por favor..

    Abraçoss…