SQL数据缓存依赖总结

以前只听过SQL server数据缓存依赖，但一直没使用，由于项目需要，才研究了一番，发现了一个很诡异的问题，竟然是一个操作顺序问题导致的。

SQL server数据缓存依赖有两种实现模式，轮询模式，通知模式。

1 轮询模式实现步骤

此模式需要SQL SERVER 7.0/2000/2005版本以上版本都支持

主要包含以下几步：

1.1 使用aspnet_regsql命令行或SqlCacheDependencyAdmin来配置连接数据库

ALTER DATABASE <DatabaseName> SET ENABLE_BROKER; //启用 ServiceBroker，需要在数据库中执行，或者在数据库右键属性，选项中修改ENABLE BROKER为true

//注意修改时，需要关闭所有和此数据库关联的窗口，否则修改不成功。

报如下错误：

Alter failed for Database 'pu'. (Microsoft.SqlServer.Smo)
                         An exception occurred while executing a Transact-SQL statement or batch. (Microsoft.SqlServer.ConnectionInfo)
                       Database state cannot be changed while other users are using the database 'pu'
                      ALTER DATABASE statement failed. (Microsoft SQL Server, Error: 5070)

一.对数据启用缓存依赖

在visual studio command prompt中执行以下命令

aspnet_regsql -C "Data Souce=localhost;Integrated Security=True;Initial Catalog=SqlTest" -ed

注释：aspnet_regsql是命令行工具本命令表示启用SqlTest数据库缓存依赖

当执行该命令后，将会在数据库SqlTest中创建表：AspNet_SqlCacheTablesForChangeNotification，如图：

tableName：记录被缓存的表

notificationCreated：记录缓存被创建的时间

changeId：计数器，当表数据修改后，自动增加1

同事创建5个存储过程：

AspNet_SqlCachePollingStoredProcedure

AspNet_SqlCacheQueryRegisteredTablesStoredProcedure

AspNet_SqlCacheRegisterTableStoredProcedure

AspNet_SqlCacheUnRegisterTableStoredProcedure

AspNet_SqlCacheUpdateChangeIdStoredProcedure

二.对数据表启用缓存依赖

在visual studio command prompt中执行以下命令

aspnet_regsql -C "Data Souce=localhost;Integrated Security=True;Initial Catalog=Pubs" -et -t Customers

注释：对Customers表启用缓存依赖

当执行该命令后，将在数据库表AspNet_SqlCacheTablesForChangeNotification中添加一条记录，如图：

三.配置应用程序

<caching>
<sqlCacheDependency enabled="true" pollTime="1000">
<databases>
<add name="mydatabase" connectionStringName="pubsConnectionstring"/>
</databases>
</sqlCacheDependency>
</caching>

注释：pollTime设置为1000ms，意思是应用程序按照1s的频率进行轮询，如果数据库表Customers数据被修改，则缓存在1m内失效，重新加载新的数据，然后缓存，知道数据被再次修改，检测数据库表的变化，connectionStringName被设置为要对哪一个数据库进行轮询的数据库连接字符串

此时已经对sql轮询模式已经设置完毕。

注意：系统默认不能识别aspnet_regsql，.net 4.0中aspnet_regsql的默认路径为C:\Windows\Microsoft.NET\Framework\v4.0.30319，需要首先把当前目录修改为C:\Windows\Microsoft.NET\Framework\v4.0.30319，才可以执行此命令。

1.2 配置文件

<?xmlversion="1.0"?>
<configuration>
<connectionStrings>
<add name="PubsConnectionString"connectionString="Data Source=10.32.153.165; Initial Catalog=pubs;uid=sa;pwd=q1w2e31@;"providerName="System.Data.SqlClient"/>
</connectionStrings>
<system.web>
<compilationdebug="true"targetFramework="4.0"/>
<caching>
<sqlCacheDependencyenabled ="true"pollTime ="1000">
<databases>
<!--name:必需的 String 属性。要添加到配置集合中的 SqlCacheDependencyDatabase 对象的名称。
此名称用作 @ OutputCache 指令上 SqlDependency 属性的一部分。
pollTime:设置 SqlCacheDependency 轮询数据库表以查看是否发生更改的频率（以毫秒计算）。这儿是一个测试,所以设为10秒,请加大此值
connectionStringName 必选的 String 特性。为数据库设置连接字符串名称。在 connectionStrings 元素（ASP.NET 设置架构）配置节中引用连接字符串。-->
<addname="Pubs"connectionStringName = "PubsConnectionString"/>
</databases>
</sqlCacheDependency>
</caching>
</system.web>
</configuration>

<?xml version="1.0"?>
<configuration>
<connectionStrings>
<add name="PubsConnectionString" connectionString="Data Source=10.32.153.165; Initial Catalog=pubs;uid=sa;pwd=q1w2e31@;" providerName="System.Data.SqlClient" />
</connectionStrings>
<system.web>
<compilation debug="true" targetFramework="4.0" />
<caching>
<sqlCacheDependency enabled = "true" pollTime = "1000" >
<databases>
<!--name:必需的 String 属性。要添加到配置集合中的 SqlCacheDependencyDatabase 对象的名称。
此名称用作 @ OutputCache 指令上 SqlDependency 属性的一部分。
pollTime:设置 SqlCacheDependency 轮询数据库表以查看是否发生更改的频率（以毫秒计算）。这儿是一个测试,所以设为10秒,请加大此值
connectionStringName 必选的 String 特性。为数据库设置连接字符串名称。在 connectionStrings 元素（ASP.NET 设置架构）配置节中引用连接字符串。-->
<add name="Pubs" connectionStringName = "PubsConnectionString" />
</databases>
</sqlCacheDependency>
</caching>
</system.web>
</configuration>

注意：connectionStrings，和caching两节的关系，caching节的connectionStringName需要和connectionStrings中的name对应的。

1.3 SqlCacheDependencyAdmin使用

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.Caching;
using System.Configuration;
using System.Data.SqlClient;
namespace TestWebSqlCacheDependency
{
public partial class _Default : System.Web.UI.Page
{
string key = "model_type";
protected void Page_Load(object sender, EventArgs e)
{
TextBox1.Text = test();// test();
}
private string test()
{
//从缓存中取值
string model = null;
if (HttpRuntime.Cache[key] !=null)
{
model = HttpRuntime.Cache[key].ToString();
}
if (model ==null)
{
//取数据
model = getDBValue();
//启用更改通知
SqlCacheDependencyAdmin.EnableNotifications(
ConfigurationManager.ConnectionStrings["PubsConnectionString"].ConnectionString);
//连接到 SQL Server 数据库并为 SqlCacheDependency 更改通知准备数据库表
SqlCacheDependencyAdmin.EnableTableForNotifications(
ConfigurationManager.ConnectionStrings["PubsConnectionString"].ConnectionString,"TableTest");//第二个参数是要监控的表名称
//制定缓存策略
SqlCacheDependency scd = new SqlCacheDependency("Pubs","TableTest");
//注意此处的Pubs需要要配置文件的caching节下的databases节下的name对应，而不是随便写的，目前个人测试的结论就是这样。第二个参数是要监控的表名称
//插入缓存
HttpRuntime.Cache.Insert(key, model, scd);
}
return model;
}
private string getDBValue()
{
SqlConnection cn = new SqlConnection(ConfigurationManager.ConnectionStrings["PubsConnectionString"].ConnectionString);
cn.Open();
SqlCommand cd = cn.CreateCommand();
cd.CommandText = " select top 1 TableTest.col2 from TableTest ";
object o = cd.ExecuteScalar();
cn.Close();
if (o != null)
{
return o.ToString();
}
return null;
}
}
}

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.Caching;
using System.Configuration;
using System.Data.SqlClient;
namespace TestWebSqlCacheDependency
{
public partial class _Default : System.Web.UI.Page
{
string key = "model_type";
protected void Page_Load(object sender, EventArgs e)
{
TextBox1.Text = test();// test();
}
private string test()
{
//从缓存中取值
string model = null;
if (HttpRuntime.Cache[key] != null)
{
model = HttpRuntime.Cache[key].ToString();
}
if (model == null)
{
//取数据
model = getDBValue();
//启用更改通知
SqlCacheDependencyAdmin.EnableNotifications(
ConfigurationManager.ConnectionStrings["PubsConnectionString"].ConnectionString);
//连接到 SQL Server 数据库并为 SqlCacheDependency 更改通知准备数据库表
SqlCacheDependencyAdmin.EnableTableForNotifications(
ConfigurationManager.ConnectionStrings["PubsConnectionString"].ConnectionString, "TableTest");//第二个参数是要监控的表名称
//制定缓存策略
SqlCacheDependency scd = new SqlCacheDependency("Pubs", "TableTest");
//注意此处的Pubs需要要配置文件的caching节下的databases节下的name对应，而不是随便写的，目前个人测试的结论就是这样。第二个参数是要监控的表名称
//插入缓存
HttpRuntime.Cache.Insert(key, model, scd);
}
return model;
}
private string getDBValue()
{
SqlConnection cn = new SqlConnection(ConfigurationManager.ConnectionStrings["PubsConnectionString"].ConnectionString);
cn.Open();
SqlCommand cd = cn.CreateCommand();
cd.CommandText = " select top 1 TableTest.col2 from TableTest ";
object o = cd.ExecuteScalar();
cn.Close();
if (o != null)
{
return o.ToString();
}
return null;
}
}
}

轮询模式的实质，就是在数据库中多了一个表AspNet_SqlCacheTablesForChangeNotification，在需要监视改变的表也多了一个Trigger，触发器名称为：表名_AspNet_SqlCacheNotification_Trigger，在每次表中有数据时，会触发此触发器，向AspNet_SqlCacheTablesForChangeNotification表中插入数据，系统会隔一段时间查询一次，发现有改变时，就会清空相对应的cache,caching节的pollTime其实就是查询间隔，也就是说，如果此时间设置的很长，数据库中的数据修改后，需要很长时间，才能清空对应的cache，最长延时可到达pollTime对应的时间，性能并不是很好。

2 通知模式实现步骤

SQL SERVER 2005（包括SQL SERVER 2005）以上的数据库才可以使用。

2.1 启用Service Broker

Select DATABASEpRoPERTYEX('数据库名称','IsBrokerEnabled') --检测是否启用了 ServiceBroker，1 表示已经启用 0 表示没有启用

ALTER DATABASE <DatabaseName> SET ENABLE_BROKER; //启用 ServiceBroker，需要在数据库中执行，或者在数据库右键属性，选项中修改 ENABLE BROKER为true, 与轮询模式完全一致，但不要aspnet_regsql相应的脚本。

2.2 启动调用SqlDependency.Start，结束时调用SqlDependency.Stop()

最好放进Global中，例如：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Security;
using System.Web.SessionState;
using System.Data.SqlClient;
using System.Web.Caching;
namespace WebTest2
{
public class Global : System.Web.HttpApplication
{
void Application_Start(object sender, EventArgs e)
{
#region SQL2005
SqlDependency.Start(ConnectionString_SQL2005);//推荐将这段代码加到Global.asax的Application_Start方法中
#endregion
}
void Application_End(object sender, EventArgs e)
{
SqlDependency.Stop(ConnectionString_SQL2005);
}
}
}

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Security;
using System.Web.SessionState;
using System.Data.SqlClient;
using System.Web.Caching;
namespace WebTest2
{
public class Global : System.Web.HttpApplication
{
void Application_Start(object sender, EventArgs e)
{
#region SQL2005
SqlDependency.Start(ConnectionString_SQL2005);//推荐将这段代码加到Global.asax的Application_Start方法中
#endregion
}
void Application_End(object sender, EventArgs e)
{
SqlDependency.Stop(ConnectionString_SQL2005);
}
}
}

调试时注意一定要运行SqlDependency.Start()这句，否则就会出错，所以测试时不要使用预览模式。由于vs会启动WebDev.WebServer40.EXE ，导致SqlDependency.Start()可能就没有运行，所以调试时一定要把VS启动的WebDev.WebServer40.EXE的前一次模拟服务停止了，使vs重新启动WebDev.WebServer40.EXE，并运行SqlDependency.Start()。

2.3 使用

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System;
using System.Configuration;
using System.Collections.Generic;
using System.Data;
using System.Data.SqlClient;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.Caching;
namespace WebTest2
{
public partial class _Default : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
DataTable dt = HttpRuntime.Cache["dt"]as DataTable;
if (dt == null)
{
using (SqlConnection sqlCon =new SqlConnection(WebConfigHelper.ConnectionString_SQL2005))
{
sqlCon.Open();
SqlCommand sqlCmd = new SqlCommand();
sqlCmd.Connection = sqlCon;
sqlCmd.CommandText = "select col2 from dbo.TableTest";
dt = new DataTable();
SqlCacheDependency scd = new SqlCacheDependency(sqlCmd);
SqlDataAdapter sda = new SqlDataAdapter(sqlCmd);
sda.Fill(dt);
HttpRuntime.Cache.Insert("dt", dt, scd);
sqlCon.Close();
}
}
GridView1.DataSource = dt;
GridView1.DataBind();
}
}
}

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System;
using System.Configuration;
using System.Collections.Generic;
using System.Data;
using System.Data.SqlClient;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.Caching;
namespace WebTest2
{
public partial class _Default : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
DataTable dt = HttpRuntime.Cache["dt"] as DataTable;
if (dt == null)
{
using (SqlConnection sqlCon = new SqlConnection(WebConfigHelper.ConnectionString_SQL2005))
{
sqlCon.Open();
SqlCommand sqlCmd = new SqlCommand();
sqlCmd.Connection = sqlCon;
sqlCmd.CommandText = "select col2 from dbo.TableTest";
dt = new DataTable();
SqlCacheDependency scd = new SqlCacheDependency(sqlCmd);
SqlDataAdapter sda = new SqlDataAdapter(sqlCmd);
sda.Fill(dt);
HttpRuntime.Cache.Insert("dt", dt, scd);
sqlCon.Close();
}
}
GridView1.DataSource = dt;
GridView1.DataBind();
}
}
}

很明显通知模式，配置文件不需要任何特殊处理，数据库中也没有增加表AspNet_SqlCacheTablesForChangeNotification和Trigger，性能也比轮询模式好的多。只要数据库中数据有改变，cache中的对应数据就会清空，基本上是实时的，不像轮询模式由pollTime决定。

通知模式需要注意的时，一定要在创建数据库之前，把数据库配置管理中的tcp/ip的那个配置改为able，否则就会出项很诡异的错误，能发出通知，但客户端就是不能收到，无论数据库中的数据怎样改变，读取的数据始终是缓存中的数据，但把tcp/ip的那个配置改为able后，再创建的数据库就可以，而且好像只有首次配置才会出现，当再次把able改为diable时在创建数据库，再改为able时，就不会出现了，很奇怪。整整折腾了三天，才发现此问题！！

另外使用windows身份认证创建的数据库也有可能导致此问题，具体原因不明。所以应该使用SQL身份认证创建数据库，不要使用windows身份认证创建数据库。很奇怪后来在测试时，使用windows身份认证创建数据库又可以了，所以具体原因目前不知道。

原因参考

http://www.cnblogs.com/rickie/archive/2006/12/21.html

另外通知模式的查询语句也有一定的要求，这一定要注意。参考支持的 SELECT 语句

存储过程不能包含SET NOCOUNT ON，WITH(NOLOCK)，否者数据不能缓存到Cache，每次都是重新读取数据库，不管数据有没有改变。

通知模式的延时估计有几百毫秒，也就是说，在更新数据库后，立即读取Cache数据不是空的，但我测试一秒后就为空了，不会影响实际使用的，但对单元测试会有影响，一定要Thread.sleep(1000),否则单元测试不能通过。

参考文章

SQL数据缓存依赖

SQL Server2005实现数据库缓存依赖的实现步骤

Sql Server 2005/2008 SqlCacheDependency查询通知的使用总结

SqlCacheDependency 类

使用 SqlCacheDependency 类在 ASP.NET 中缓存

启用查询通知

诡异问题详细信息

数据sqlcachedependency轮询功能配置方法

caching 的 sqlCacheDependency 的 databases 元素（ASP.NET 设置架构）

caching 的 sqlCacheDependency 元素（ASP.NET 设置架构）

caching 的 database 的 add 元素（ASP.NET 设置架构

SQL Server 中的查询通知 (ADO.NET)

为通知创建查询

我在这篇文章的末尾分享一下我们最近做项目中关于通知模式中应用的一些经验：

我们有一个复杂的查询语句写在一个存储过程里，但是这是通知模式所不支持的sql语句，所以我们HardCode了一段查询两张表的简单查询语句去达到通知模式中的监控两张表，然后在注册在cache中，下面是代码：

对两张表监控的SqlCacheDependency的应用
public const string SqlDependencyCacheSql = "SELECT id FROM dbo.Products;SELECT id FROM dbo.ExpiredProducts;";
public static SqlCacheDependency GetSqlCacheDependency()
{
SqlCacheDependency sqlCacheDependency = null;
using (SqlConnection sqlCon = new SqlConnection(dbConnectionString))
{
SqlCommand sqlCmdCache = new SqlCommand(SqlDependencyCacheSql, sqlCon);
sqlCacheDependency = new SqlCacheDependency(sqlCmdCache);
try
{
sqlCon.Open();
sqlCmdCache.ExecuteNonQuery();
}
catch
{
throw;
}
}
return sqlCacheDependency;
}
public static Dictionary<string, Product> Products
{
get
{
if (HttpRuntime.Cache[CacheAllProduct] == null)
{
SqlCacheDependency sqlCacheDependency = BrandPartnerDataAccess.GetSqlCacheDependency();
DataTable dt = DataAccess.GetAllProduct();
HttpRuntime.Cache.Insert(CacheAllProduct, ConvertToProductsDictionary(dt), sqlCacheDependency);
}
return HttpRuntime.Cache[CacheAllProduct] as Dictionary<string, Product>;
}
}