Fazendo cache de objetos com Hibernate

Nesse artigo vamos explicar o funcionamento do cache da Session (cache simples), e sobre o Second Level Cache (cache avançado).

Hibernate

Para rodar o exemplo deste artigo, faça o download do Hibernate 3.1.3.

Ap�s fazer o download, coloque o arquivo hibernate.jar no classpath do seu projeto, assim como todos os outros jar�s encontrados na pasta �lib�.

Criando o POJO

Para testar o cache, vamos criar uma simples classe �Not�cia�.


<?xml version="1.0"?>

<!DOCTYPE hibernate-mapping PUBLIC

      "-//Hibernate/Hibernate Mapping DTD 3.0//EN"

      "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">

 

<hibernate-mapping>

<class

    name="model.Noticia"

    table="Noticia"

    >

      <id

        name="id"

        type="java.lang.Integer"

        column="ID"

    >

        <generator class="native" />

    </id>

      <property

        name="titulo"

        type="java.lang.String"

        column="titulo"

        length="50"

        not-null="true"

    />

</class>

</hibernate-mapping>

 

public class Noticia {

      private Integer id;

      private String titulo;

//get e set �

}

Criando a Tabela Not�cia:


create table Noticia (

ID integer generated by default as identity (start with 1),

titulo varchar(50) not null,

primary key (ID))

E o arquivo hibernate.cfg.xml (Altere a URL e driver JDBC para o banco de dados de sua prefer�ncia):


<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate 
Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/
hibernate-configuration-3.0.dtd">

 

<hibernate-configuration>

  <session-factory>

 

    <!-- HSQLDB -->

    <property name="hibernate.connection.driver_class">

        org.hsqldb.jdbcDriver</property>

    <property name="hibernate.connection.url">

        jdbc:hsqldb:hsql://localhost/hello</property>

    <property name="hibernate.connection.username">sa</property>

    <property name="hibernate.connection.password" />

    <property name="hibernate.dialect">org.hibernate.dialect
    .HSQLDialect</property>

 

    <property name="hibernate.show_sql">true</property>

 

    <mapping resource="model/Noticia.hbm.xml" />

 

  </session-factory>

</hibernate-configuration>

First-Level cache - Session Cache

Sempre que o Hibernate busca um objeto utilizando os m�todos load e get, o resultado � armazenado no cache da Session, conhecido como first-level cache. Este cache � default no Hibernate e n�o pode ser desabilitado. O objeto �Session� representa uma conex�o com o banco de dados, e n�o deve �viver� por muito tempo, desta forma � uma boa pr�tica (recomendado) que a Session seja eliminada ao final de uma transaç�o/requisiç�o com o servidor. Desta forma, a conex�o com o banco � fechada (ou retornada ao pool) e o cache da Session tamb�m � apagado.

O Exemplo abaixo faz uma simples busca de uma not�cia com o ID=1. Note que a busca � feita 2 vezes para a Not�cia, mas o Hibernate vai acessar o banco de dados apenas uma vez. Entre a 1� e a 2� busca, foi inclu�do um trecho de c�digo que faz um UPDATE com JDBC, para atualizar o t�tulo da not�cia. Por�m como era esperado, o Hibernate manteve a Not�cia no cache da Session, e o t�tulo da 2� busca ainda � uma informaç�o antiga.

Ao rodar o exemplo, vamos supor que existe uma not�cia na tabela com o ID = 1.


public class Teste1 {

  public static void main(String[] args) throws Exception {

        SessionFactory sessionFactory =

                     new Configuration().configure().buildSessionFactory();

        Session session = sessionFactory.openSession();

        Transaction t = session.beginTransaction();



        //Recupera a not�cia do banco. Insere no cache da Session

        System.out.println("1 - pre session.get");

        Noticia n = (Noticia) session.get(Noticia.class, new Integer(1));

        System.out.println("1 - pos session.get");

        System.out.println(n.getTitulo());

       

        //Atualiza a tabela usando JDBC.

        Class.forName("org.hsqldb.jdbcDriver");

        Connection conn = DriverManager.getConnection

                            ("jdbc:hsqldb:hsql://localhost/hello","sa","");

        Statement stmt = conn.createStatement();

        stmt.executeUpdate("update noticia set titulo = 'novo titulo'");



//Tire o coment�rio para remover a Not�cia do cache da Session

        //session.evict(n);

       

//A segunda busca vai imprimir o t�tulo antigo da not�cia.

        System.out.println("2 - pre session.get");

        n = (Noticia) session.get(Noticia.class, new Integer(1));

        System.out.println("2 - pos session.get");

        System.out.println(n.getTitulo());



        t.commit();

        session.close();

  }

}

Sa�da:


pre session.get: Hibernate: select noticia0_.ID as ID0_0_, 
noticia0_.titulo as titulo0_0_, noticia0_.texto as texto0_0_ 
from Noticia noticia0_ where noticia0_.ID=?
   pos session.get: Titulo antigo
  pre session.get
pos session.get

Titulo antigo

O texto �T�tulo antigo� apareceu duas vezes, como era esperado.

Note que est� comentado a linha com o c�digo: session.evict(n);. O m�todo evict(object) da classe Session elimina o objeto do cache, fazendo com que o Hibernate consulte o banco de dados todas as vezes que precisar de determinada informaç�o. Faça o teste!

Entendendo o First-Lavel cache

Sempre que uma nova Session � aberta, uma nova conex�o com o servidor � realizada e um novo cache � criado. Quando a Session for fechada, o seu cache correspondente tamb�m � eliminado. O cache de uma Session n�o interfere em outra Session.

Para comprovar isto, altere o c�digo anterior, para fechar a Session atual, e abrir uma nova antes de fazer a segunda consulta.


//1� consulta�
//JDBC com update� 

t.commit();
session.close();//fecha a 1� session (fecha conex�o e elimina o cache) 

session = sessionFactory.openSession(); //cria uma nova session
t = session.beginTransaction(); 

//nesta session os dados ser�o consultados do banco de dados
//2� consulta�

O resultado da execuç�o deste c�digo pode ser visualizado abaixo:


pre session.get: Hibernate: select noticia0_.ID as ID0_0_, 
noticia0_.titulo as titulo0_0_, noticia0_.texto as texto0_0_ 
from Noticia noticia0_ where noticia0_.ID=?
pos session.get: Titulo Antigo
pre session.get: Hibernate: select noticia0_.ID as ID0_0_, 
noticia0_.titulo as titulo0_0_, noticia0_.texto as texto0_0_ 
from Noticia noticia0_ where noticia0_.ID=?
     pos session.get: Novo titulo

Note que o Hibernate fez 2 consultas no banco. E que o t�tulo da not�cia foi atualizando na segunda busca.

Lembre-se de que outra maneira de eliminar um objeto da cache (sem fechar a Session) � chamando o m�todo session.evict(obj).

Este cache � muito simples para ser utilizado em aplicaç�es Web, onde geralmente a cada requisiç�o ao servidor, uma nova Session � criada. Ent�o fica a pergunta, como utilizar cache de objetos mesmo Sessions (conex�es) diferentes?

Para isto existe o Second-Level cache, que � uma estrat�gia de cache um pouco mais agressiva e eficiente, onde alguns frameworks como o EHCache e OSCache s�o utilizados. Este cache ser� explicado mais abaixo:

EHCache

O EHCache � o framework default de cache do Hibernate. Para utiliz�-lo basta colocar o ehcache.jar no classpath da aplicaç�o. Para utilizar outro framework, como por exemplo o OSCache, � necess�rio alterar o arquivo hibernate.cfg.xml e incluir a seguinte linha:


<property name="hibernate.cache.provider_class"
>net.sf.hibernate.cache.OSCacheProvider </property>

Para este artigo, n�o � necess�rio alterar esta propriedade, pois vamos assumir o EHCacheProvider (default).

Ativando o cache para a classe Not�cia

Para utilizar o cache, � necess�rio configurar o hibernate.conf.xml, conforme visualizado abaixo.


<mapping resource="model/Noticia.hbm.xml" />
<class-cache class="model.Noticia" usage="read-write" />

Neste exemplo vamos utilizar o tipo read-write o qual permite a leitura e gravaç�o de novas informaç�es. Outro tipo que pode ser utilizado � o read-only para as informaç�es que n�o nunca ser�o atualizadas.

Second Level Cache Hibernate

Para configurar as propriedades do cache para a Not�cia, � necess�rio adicionar o arquivo ehcache.xml no classpath da aplicaç�o. Copie este arquivo da pasta de distribuiç�o do Hibernate e insira as seguintes configuraç�es:


<cache name="model.Noticia"

  maxElementsInMemory="100"

  eternal="false"

  timeToIdleSeconds="300"

  timeToLiveSeconds="600"

  overflowToDisk="false"

/>

Note que neste caso o nome do cache � o nome completo da classe �model.Noticia�. Caso o nome do cache n�o seja encontrado, o cache default ser� utilizado. Este cache tamb�m � configurado no arquivo ehcache.xml com a tag ��.

Abaixo as explicaç�es de cada propriedade que pode ser configurada:

maxElementsInMemory: n�mero m�ximo de objetos que podem ficar armazenados em mem�ria.
eternal: se configurado para true, significa que o cache nunca vai expirar.
timeToIdleSeconds: tempo em segundos que um objeto pode permanecer inutilizado no cache.
timeToLiveSeconds: tempo em segundos que um objeto pode ficar em cache.
overflowToDisk: se configurado para true e caso o limite de objetos em mem�ria seja superior ao definido pela propriedade maxElementsInMemory, as informaç�es ser�o armazenadas em disco.

Pronto, isto � tudo. Agora os objetos �Not�cia� ser�o armazenados em cache.

Testando o cache

Para testar o cache, vamos fazer o mesmo exemplo que foi utilizado no artigo anterior. Inicialmente � feita uma consulta no banco de dados com a primeira Session. Logo depois a tabela Not�cia � atualizada utilizando JDBC. Ent�o a Session atual � fechada, e uma nova � aberta. Atrav�s do Second Level Cache, a segunda Session consegue recuperar os objetos em cache, respeitando as configuraç�es de limite de objetos em mem�ria e tempo de expiraç�o definidos no arquivo ehcache.xml.


//1� consulta�

//JDBC com update� 

//fecha a 1� session (fecha conex�o e elimina o first level cache)

t.commit();

session.close(); 

//cria uma nova session

session = sessionFactory.openSession();

t = session.beginTransaction(); 

//2� consulta�

//As informaç�es retornadas aqui est�o em cache

Faça o teste, e voc� ver� que o resultado retornado pela 2� consulta � o mesmo retornado pela 1�, uma vez que o cache � utilizado, e n�o � feita uma consulta no banco de dados.

Cache para a Query

A classe Query � frequentemente utilizada para realizar consultas no banco de dados utilizando HQL, como por exemplo:


Noticia n = (Noticia) session.createQuery("from Noticia where id = 1").setCacheable(true).uniqueResult();

Note que para utilizar o cache da Query, o m�todo setCacheable(true) foi chamado para informar o Hibernate que � necess�rio fazer cache da consulta.

Por�m para o cache funcionar, � necess�rio adicionar a seguinte linha no arquivo hibernate.cfg.xml:


<property name="hibernate.cache.use_query_cache">true</property>

Por default, o nome do cache (conhecido como regi�o) utilizado � org.hibernate.cache.StandardQueryCache. Portanto, do mesmo modo que anteriormente foi configurado o cache para a classe Not�cia, � necess�rio configurar as propriedades do cache para a Query, conforme visualizado abaixo:


<cache name="org.hibernate.cache.StandardQueryCache"

    �� outras propriedades aqui

/>

Caso seja necess�rio customizar o cache a ser utilizado por cada consulta, pode-se utilizar o m�todo setCacheRegion da classe Query:


Noticia n = (Noticia) session.createQuery("from Noticia where id = 1").setCacheable(true).setCacheRegion("cacheNoticia").uniqueResult();

Desta forma uma configuraç�o de cache precisa ser criada para o nome cacheNoticia, conforme demonstrado abaixo:


<cache name="consultaNoticia"

   �� outras propriedades aqui

/>

Log4j

O log4j pode ser utilizado para debugar a execuç�o do cache. Para ativar os logs, insira a seguinte linha no arquivo log4j.properties:


log4j.logger.org.hibernate.cache=debug,stdout

Para demonstrar os logs, execute o c�digo abaixo:


public class TesteCache3 {

  public static void main(String[] args) throws Exception {

        SessionFactory sessionFactory = new Configuration()
        .configure().buildSessionFactory();

        Session session = sessionFactory.openSession();

        Transaction t = session.beginTransaction();



        //Recupera a not�cia do banco.

        System.out.println("1 - pre session.get");

        Noticia n = (Noticia) session.createQuery("from Noticia where id = 1")
        .setCacheable(true).setCacheRegion("consultaNoticia").uniqueResult();

        System.out.println("1 - pos session.get");

        System.out.println(n.getTitulo());

       

//          Fecha a 1� session

        t.commit();

        session.close();



        //    Atualiza a tabela usando JDBC.

        Class.forName("org.hsqldb.jdbcDriver");

        Connection conn = DriverManager
        .getConnection("jdbc:hsqldb:hsql://localhost/hello","sa","");

        Statement stmt = conn.createStatement();

        stmt.executeUpdate("update noticia set titulo = 'novo titulo'");

       

        session = sessionFactory.openSession();

        t = session.beginTransaction();



//Faz a busca na 2� session e utiliza o cache �consultaNoticia�

        System.out.println("2 - pre session.get");

        n = (Noticia) session.createQuery("from Noticia where id = 1")
        .setCacheable(true).setCacheRegion("consultaNoticia").uniqueResult();

        System.out.println("2 - pos session.get");

        System.out.println(n.getTitulo());



        t.commit();

        session.close();

  }

}

A sa�da do programa pode ser visualizada abaixo:


DEBUG CacheFactory:39 - instantiating cache region: 
model.Noticia usage strategy: read-write
INFO UpdateTimestampsCache:43 - starting update timestamps 
cache at region: 
org.hibernate.cache.UpdateTimestampsCache
WARN EhCacheProvider:103 - Could not find configuration 
[org.hibernate.cache.UpdateTimestampsCache]; using defaults.
DEBUG EhCacheProvider:106 - started EHCache region: 
org.hibernate.cache.UpdateTimestampsCache
INFO StandardQueryCache:51 - starting query cache at region: 
org.hibernate.cache.StandardQueryCache
pre session.get
INFO StandardQueryCache:51 - starting query cache at region: consultaNoticia
WARN EhCacheProvider:103 - Could not find configuration [consultaNoticia]; 
using defaults.
DEBUG EhCacheProvider:106 - started EHCache region: consultaNoticia
DEBUG StandardQueryCache:93 - checking cached query results in region: 
consultaNoticia
DEBUG EhCache:104 - key: sql: select noticia0_.ID as ID0_, noticia0_
.titulo as titulo0_, 
noticia0_.texto as texto0_ from Noticia noticia0_ where noticia0_.ID=1; 
parameters: ; named parameters: {}
DEBUG EhCache:113 - Element for sql: select noticia0_.ID as ID0_, 
noticia0_.titulo as titulo0_, 
noticia0_.texto as texto0_ from Noticia noticia0_ where noticia0_.ID=1; 
parameters: ; 
named parameters: {} is null
DEBUG StandardQueryCache:98 - query results were not found in cache
Hibernate: select noticia0_.ID as ID0_, noticia0_.titulo as titulo0_, 
noticia0_.texto 
as texto0_ from Noticia noticia0_ where noticia0_.ID=1
DEBUG ReadWriteCache:148 - Caching: model.Noticia#1
DEBUG EhCache:104 - key: model.Noticia#1
DEBUG EhCache:113 - Element for model.Noticia#1 is null
DEBUG ReadWriteCache:160 - Cached: model.Noticia#1
DEBUG StandardQueryCache:67 - caching query results in region: 
consultaNoticia
pos session.get
Titulo antigo
pre session.get
DEBUG StandardQueryCache:93 - checking cached query results in region: 
consultaNoticia
DEBUG EhCache:104 - key: sql: select noticia0_.ID as ID0_, 
noticia0_.titulo as titulo0_, 
noticia0_.texto as texto0_ from Noticia noticia0_ where 
noticia0_.ID=1; parameters: ; 
named parameters: {}
DEBUG StandardQueryCache:147 - Checking query spaces for 
up-to-dateness: [Noticia]
DEBUG EhCache:104 - key: Noticia
DEBUG EhCache:113 - Element for Noticia is null
DEBUG StandardQueryCache:108 - returning cached query results
DEBUG ReadWriteCache:75 - Cache lookup: model.Noticia#1
DEBUG EhCache:104 - key: model.Noticia#1
DEBUG ReadWriteCache:85 - Cache hit: model.Noticia#1
pos session.get
Titulo antigo

Conclus�o

Neste artigo foi explicado como configurar o Second Level Cache do Hibernate, e como demonstrado � uma tarefa relativamente simples.

Fazer cache de objetos pode aumentar a performance de sua aplicaç�o, mas cuidado para n�o abusar muito, porque isto pode aumentar consideravelmente a quantidade de mem�ria que sua aplicaç�o est� utilizando.

A configuraç�o ideal para cada aplicaç�o, cabe a voc� descobrir. At� a pr�xima.