NHibernate系列文章十：NHibernate对象二级缓存下

摘要

上一节对NHibernate二级缓存做了简单介绍，NHibernate二级缓存是由SessionFactory管理的，所有Session共享。这一节介绍二级缓存其他两个方面：二级缓存查询和二级缓存管理。

1. NHibernate二级缓存查询

NHibernate二级缓存查询是指NHibernate将查询记录的集合放到二级缓存中，之后每次查询都可以从二级缓存中拿查询记录信息。

二级缓存使用步骤：

1）在hibernate.cfg.xml文件中，使用cache.use_query_cache定义使用二级缓存查询：<property name="cache.use_query_cache">true</property>

2）在代码中显示地使用IQuery.SetCacheable(true)方法，第一次使用这个方法时，将查询条件和查询结果组成一个字典对象放入二级缓存中，字典的键是查询条件，值是查询结果记录集合。在第二次使用同样查询条件查询时再次调用这个方法，NHibernate直接从二级缓存中读取。如果查询结果记录集合在第一次调用SetCacheable后有变化（添加、修改、删除），则会清空二级缓存中的字典对象，第二次查询从数据库查询。

二级缓存查询有多种定义方式：

1）显示启用缓存查询

只使用IQuery.SetCacheable(true)方法。

程序演示

修改hibernate.cfg.xml文件，添加<property name="cache.use_query_cache">true</property>

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
  <session-factory>
    <property name="connection.connection_string_name">default</property>
    <property name="connection.driver_class">NHibernate.Driver.SqlClientDriver</property>
    <property name="dialect">NHibernate.Dialect.MsSql2008Dialect</property>
    <property name="cache.provider_class">NHibernate.Cache.HashtableCacheProvider</property>
    <property name="cache.use_second_level_cache">true</property>
    <property name="cache.use_query_cache">true</property>
    <mapping assembly="NHibernateDemoApp"/>
    <class-cache class="NHibernateDemoApp.Customer,NHibernateDemoApp" usage="read-write"/>
  </session-factory>
</hibernate-configuration>

修改Main函数

        static void Main(string[] args)
        {
            HibernatingRhinos.Profiler.Appender.NHibernate.NHibernateProfiler.Initialize();

            using (var session = SessionFactory.OpenSession())
            {
                IList<Customer> customers = session.CreateQuery("from Customer c where c.Id > 1")
                    .SetCacheable(true) 
                    .List<Customer>();
                Console.WriteLine("list count: {0}", customers.Count);
            }

            using (var session = SessionFactory.OpenSession())
            {
                IList<Customer> customers = session.CreateQuery("from Customer c where c.Id > 1")
                    .SetCacheable(true)
                    .List<Customer>();
                Console.WriteLine("list count: {0}", customers.Count);
            }

            Console.WriteLine("Completed");
            Console.ReadLine();
        }

打开NHibernateProfile，执行程序，监控结果：

第一次查询后将结果存入二级缓存，第二次查询直接从二级缓存中读取。

2）指定命名缓存区域

在代码中显示调用session.SetCacheRegion方法给二级缓存结果一个强命名。

程序演示

修改Main函数

        static void Main(string[] args)
        {
            HibernatingRhinos.Profiler.Appender.NHibernate.NHibernateProfiler.Initialize();

            using (var session = SessionFactory.OpenSession())
            {
                IList<Customer> customers = session.CreateQuery("from Customer c where c.Id > 1")
                    .SetCacheable(true)
                    .SetCacheRegion("customer_chache")
                    .List<Customer>();
                Console.WriteLine("list count: {0}", customers.Count);
            }

            using (var session = SessionFactory.OpenSession())
            {
                IList<Customer> customers = session.CreateQuery("from Customer c where c.Id > 1")
                    .SetCacheable(true)
                    .SetCacheRegion("customer_chache")
                    .List<Customer>();
                Console.WriteLine("list count: {0}", customers.Count);
            }

            Console.WriteLine("Completed");
            Console.ReadLine();
        }

清空NHibernateProfile监控记录，执行程序，得到结果

3）命名查询

在实体关系映射配置文件hibernate.cfg.xml中，定义二级缓存的命名查询。

<query cacheable="true" cache-mode="normal" name="自定义名称">
　　Hibernate Query Language查询字符串
</query>

cache-mode一般使用normal（默认方式），从二级缓存中读写。

cache-mode有五个枚举值

• Ignore：不使用二级缓存
• Put：只向二级缓存写数据
• Get：只向二级缓存读数据
• Normal：向二级缓存读和写数据
• Refresh：每次强制刷新二级缓存

程序演示

修改Customer.hbm.xml文件

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" assembly="NHibernateDemoApp" namespace="NHibernateDemoApp">
  <class name="Customer" table="Customer">
    <id name="Id">
      <generator class="native"/>
    </id>
    <property name="FirstName" not-null="true"/>
    <property name="LastName" not-null ="true"/>
    <property name="AverageRating"/>
    <property name="Points"/>
    <property name="HasGoldStatus"/>
    <property name="MemberSince"/>
    <property name="CreditRating" type="CustomerCreditRating"/>
    <property name="Street"/>
    <property name="City"/>
    <property name="Province"/>
    <property name="Country"/>
  </class>
  <query cacheable="true" cache-mode="normal" name="select_customer">
    from Customer
  </query>
</hibernate-mapping>

修改Main函数

        static void Main(string[] args)
        {
            HibernatingRhinos.Profiler.Appender.NHibernate.NHibernateProfiler.Initialize();

            using (var session = SessionFactory.OpenSession())
            {
                IList<Customer> customers = session.GetNamedQuery("select_customer")
                    .List<Customer>();
                Console.WriteLine("list count: {0}", customers.Count);
            }

            using (var session = SessionFactory.OpenSession())
            {
                IList<Customer> customers = session.GetNamedQuery("select_customer")
                    .List<Customer>();
                Console.WriteLine("list count: {0}", customers.Count);
            }

            Console.WriteLine("Completed");
            Console.ReadLine();
        }

清空Profile，执行程序得到结果

2. NHibernate二级缓存管理

NHibernate二级缓存由SessionFactory管理，SessionFactory提供了多个删除二级缓存内容的方法。

• Evict：从二级缓存中删除类实例
• EvictEntity：从二级缓存中删除指定实例
• EvictCollection：从二级缓存中删除集合
• EvictQueries：从二级缓存中删除查询

程序演示

修改Main函数

        static void Main(string[] args)
        {
            HibernatingRhinos.Profiler.Appender.NHibernate.NHibernateProfiler.Initialize();

            using (var session = SessionFactory.OpenSession())
            {
                var customer = session.Get<Customer>(1);
            }
            SessionFactory.Evict(typeof(Customer));
            using (var session = SessionFactory.OpenSession())
            {
                var customer = session.Get<Customer>(1);
            }

            Console.WriteLine("Completed");
            Console.ReadLine();
        }

清空NHibernateProfile的Session，执行程序得到结果

也可以强制调用session.SetCacheMode(CacheMode.Refresh)，刷新二级缓存内容，第二个session查询时，session重新查询数据库。

程序演示

修改Main函数

        static void Main(string[] args)
        {
            HibernatingRhinos.Profiler.Appender.NHibernate.NHibernateProfiler.Initialize();

            using (var session = SessionFactory.OpenSession())
            {
                IList<Customer> customers = session.CreateQuery("from Customer c where c.Id > 1")
                     .SetCacheable(true)
                     .SetCacheRegion("customer_chache")
                    .List<Customer>();
                Console.WriteLine("list count: {0}", customers.Count);
            }
            
            using (var session = SessionFactory.OpenSession())
            {
                IList<Customer> customers = session.CreateQuery("from Customer c where c.Id > 1")
                     .SetCacheable(true)
                     .SetCacheRegion("customer_chache")
                     .SetCacheMode(CacheMode.Refresh)
                    .List<Customer>();
                Console.WriteLine("list count: {0}", customers.Count);
            }

            Console.WriteLine("Completed");
            Console.ReadLine();
        }

执行结果，第二次强制查询数据库