Gerando c�digo com o FreeMarker

O FreeMarker � muito utilizado por alguns frameworks Web MVC como a principal tecnologia utilizada na camada de apresentaç�o, substituindo o JSP, que � o caso por exemplo do framework WebWork.

Embora muitos utilizem o FreeMarker no lugar do JSP, o seu principal objetivo � ser um simples e r�pido framework de templates, o qual pode ser utilizado para automatizar a geraç�o de determinado c�digo. Um exemplo de aplicaç�o que utiliza o FreeMarker com esta finalidade � o HibernateTools, ferramenta bem conhecida dos usu�rios do Hibernate..

Neste artigo ser� apresentado como escrever um simples template em FreeMarker, e separar a l�gica de neg�cios do �design� do seu template.

FreeMarker

Para rodar o exemplo deste artigo, faça o download do FreeMarker 2.3.8 clicando aqui. Ap�s fazer o download, coloque o arquivo freemarker.jar no classpath do seu projeto.

Utilizando o FreeMarker

A classe abaixo demonstra como utilizar o FreeMarker. O m�todo parseTemplate recebe um Map com os par�metros e o nome do template. O resultado � uma String (texto) com o template processado.

� recomendado que seja criado somente uma inst�ncia da classe Configuration, e para isto uma vari�vel privada e est�tica foi declarada na classe.

Note que a constante TEMPLATES_FOLDER define o local onde est�o os templates. O valor da constante est� fixa no c�digo para facilitar o exemplo.


 import java.io.File;
 import java.io.IOException;
 import java.io.StringWriter;
 import java.util.Map;
 
 import freemarker.template.Configuration;
 import freemarker.template.DefaultObjectWrapper;
 import freemarker.template.Template;
 import freemarker.template.TemplateException;
 
 public class FreemarkerUtils {
 
  private static Configuration cfg = new Configuration();
 
  private static final String TEMPLATES_FOLDER = "templates";
  
  public static final String parseTemplate(Map map,String templateName) 
  throws TemplateException, IOException {
 
  //diret�rio onde est�o templates
  cfg.setDirectoryForTemplateLoading(new File(TEMPLATES_FOLDER));
 
  cfg.setObjectWrapper(new DefaultObjectWrapper());
 
  //recupera o template
  Template t = cfg.getTemplate(templateName);
 
  StringWriter writer = new StringWriter();
 
  /** Freemarker **/
  t.process(map, writer);
 
  writer.flush();
  writer.close();
 
  return writer.toString();
  }
 }

Exemplo

Para utilizar a classe anterior, vamos criar um arquivo de template chamado teste.ftl na pasta �templates�. Se voc� estiver usando o Eclipse, a pasta �templates� pode ser criada na raiz do seu projeto:


teste.ftl
 ${data?string("dd/MM/yyyy")}
 
 Prezado $, segue a lista de produtos:
 
 <#list produtos as p>
  - ${p.nome} - R${p.preco}

O template acima demonstra como construir um �email� para enviar aos usu�rios de um sistema. No template, a data atual e o nome do usu�rio s�o exibidos, e tamb�m uma poss�vel lista de produtos selecionados para este usu�rio.

Para rodar o exemplo crie a classe Produto, conforme abaixo:


public class Produto {
  private String nome;
  private double preco;
  public Produto(String nome, double preco) {
  super();
  this.nome = nome;
  this.preco = preco;
  }
  public String getNome() {
  return nome;
  }
  public double getPreco() {
  return preco;
  }
 }

E finalmente, uma pequena classe que executa o template teste.ftl, passando os par�metros necess�rios:


  public class HelloTemplate {
  public static void main(String[] args) throws IOException,TemplateException {
 
  Map map = new HashMap();
  map.put("data", new Date());
  map.put("usuario", "Ricardo");
  
  List produtos = new ArrayList();
  produtos.add(new Produto("Produto A1",300.14));
  produtos.add(new Produto("Produto B2",401.56));
  produtos.add(new Produto("Produto C3",555.77));
  map.put("produtos", produtos);
 
  String s = FreeMarkerUtils.parseTemplate(map, "teste.ftl");
  System.out.println(s);
  }
 }

A sa�da do programa pode ser visualizada abaixo:



 13/11/2006
 
 Prezado Ricardo, segue a lista de produtos:
 
  - Produto A1 - R$300.14
  - Produto B2 - R$401.56
  - Produto C3 - R$555.77

Conclus�o

O template constru�do neste artigo, poderia ser um �email� enviado a uma lista de usu�rios de um sistema. Tente criar um template, onde a sa�da seja um arquivo HTML, e envi�-lo por email com a API Commons-email descrita neste artigo.

O FreeMarker � sem d�vida muito simples, sendo poss�vel utiliz�-lo para gerar c�digo, ou at� mesmo em aplicaç�es Web, substituindo o JSP na camada de visualizaç�o.

Refer�ncias:

Freemarker
Java World

Gerando c�digo com o FreeMarker

Neste artigo será apresentado o FreeMarker, um poderoso framework de templates, similiar ao famoso Velocity da Jakarta.

FreeMarker

Utilizando o FreeMarker

Exemplo

Conclus�o

Artigos relacionados