NHibernate3.0剖析:Query篇之NHibernate.Linq自定義擴展
系列引入
NHibernate3.0剖析系列分別從Configuration篇、Mapping篇、Query篇、Session策略篇、應用篇等方面全面揭示NHibernate3.0新特性和應用及其各種應用程序的集成,基于NHibernte3.0版本。如果你還不熟悉NHibernate,可以快速閱讀NHibernate之旅系列文章導航系列入門,如果你已經在用NHibernate了,那么請跟上NHibernate3.0剖析系列吧。
- NHibernate專題:http://kb.cnblogs.com/zt/nhibernate/
- NHibernate官方站點:http://nhforge.org/
- NHibernate參考文檔:http://nhforge.org/doc/nh/en/
- 獲取NHibernate地址:http://sourceforge.net/projects/nhibernate/
概述
NHibernate.Linq除了本身提供了標準查詢運算符和NHibernate特有的兩個強查詢立即抓取(EagerFetching)和查詢緩存(QueryCacheable),我們也可以自己定義Linq provider擴展。
Linq provider自定義擴展機制
在NHibernate中,幾乎所有的面向對象查詢語言(HQL、Criteria、QueryOver)都是可擴展的,Linq也不例外。我們可以擴展自定義LINQ-provider并將LINQ擴展方法轉換為SQL。下面看看NHibernate對外提供的Linq provider擴展機制。
ILinqToHqlGeneratorsRegistry接口
為Hql-Generators提供統一注冊接口,在Build SessionFactory的時候,NHibernate注冊提供的Hql-Generators。
LinqToHqlGeneratorsRegistryFactory注冊工廠
提供Hql-Generators注冊工廠,默認注冊NHibernate內置支持的NHibernate.Linq查詢,譬如DateTime類型提供的屬性和方法、String類型提供的屬性和方法、Queryable和Enumerable提供的方法。
可以通過Configuration的"linqtohql.generatorsregistry"配置節或者Configuration類提供的LinqToHqlGeneratorsRegistry擴展方法注冊實現ILinqToHqlGeneratorsRegistry接口自定義Linq provider擴展。
DefaultLinqToHqlGeneratorsRegistry注冊類
默認NHibernate內置支持的NHibernate.Linq查詢注冊類,繼承ILinqToHqlGeneratorsRegistry接口。
三種Hql-Generators接口:
IRuntimeMethodHqlGenerator
對運行時方法注冊,ICollection<T>集合的Contains方法,帶LinqExtensionMethodAttribute的擴展方法。
IHqlGeneratorForMethod
對方法Hql生成,譬如Queryable和Enumerable類的Any、All、Min、Max、Contains方法;string類型的StartsWith、EndsWith、Contains、Equals、ToLower、ToLowerInvariant、ToUpper、ToUpperInvariant、Substring、IndexOf、Replace方法和帶LinqExtensionMethodAttribute的擴展方法,NHibernate內部用于識別和轉換Visitors類的方法。
IHqlGeneratorForProperty
對屬性Hql生成,譬如DateTime類型的Year、Month、Day、Hour、Minute、Second、Date屬性;string類型的Length屬性。NHibernate內部用于識別和轉換Visitors類的屬性。
兩種Hql-Generators抽象類:
BaseHqlGeneratorForMethod
BaseHqlGeneratorForMethod抽象類實現IHqlGeneratorForMethod接口。用于定義方法的Hql-Generators。例如NHibernate內置提供string類型StartWith()方法的Hql-Generators實現:
BaseHqlGeneratorForProperty抽象類實現IHqlGeneratorForProperty接口。用于定義屬性的Hql-Generators。例如NHibernate內置提供string類型Length屬性的Hql-Generators實現:
知道了上面的內容,相信你可以自定義一個Linq provider擴展了。
Linq provider自定義擴展實現
我們以String類型為例,使用IsLike擴展方法對String類型擴展,模仿SQL中的LIKE從句。
1.Linq擴展方法
使用IsLike擴展方法對String類型擴展,代碼如下:
//Code Snippets Copyright http://lyj.cnblogs.com/
public static class MyLinqExtensions
{
public static bool IsLike(this string source, string pattern)
{
pattern = Regex.Escape(pattern);
pattern = pattern.Replace("%", ".*?").Replace("_", ".");
pattern = pattern.Replace(@"\[", "[").Replace(@"\]","]").Replace(@"\^", "^");
return Regex.IsMatch(source, pattern);
}
}
2.IsLike擴展方法的Hql-Generators實現
創建完擴展方法之后,就可以在內存中使用這個擴展了。但是我們需要NHibernate把他翻譯成持久化查詢(persistence-queries),即需要轉換為SQL。像NHibernate內置的實現類似,我們需要創建一個Generators:
//Code Snippets Copyright http://lyj.cnblogs.com/
public class IsLikeGenerator : BaseHqlGeneratorForMethod
{
public IsLikeGenerator()
{
SupportedMethods = new[]
{ReflectionHelper.GetMethodDefinition(() => MyLinqExtensions.IsLike(null, null))};
}
public override HqlTreeNode BuildHql(MethodInfo method, Expression targetObject,
ReadOnlyCollection<Expression> arguments, HqlTreeBuilder treeBuilder, IHqlExpressionVisitor visitor)
{
return treeBuilder.Like(visitor.Visit(arguments[0]).AsExpression(),
visitor.Visit(arguments[1]).AsExpression());
}
}
3.注冊IsLike擴展方法Hql-Generators
我們繼承默認NHibernate內置支持的NHibernate.Linq查詢注冊類,這樣可以把我們自定義的Hql-Generators附加進去。
//Code Snippets Copyright http://lyj.cnblogs.com/
public class MyLinqToHqlGeneratorsRegistry: DefaultLinqToHqlGeneratorsRegistry
{
public MyLinqToHqlGeneratorsRegistry()
{
RegisterGenerator(ReflectionHelper.GetMethodDefinition(
() => MyLinqExtensions.IsLike(null, null)),new IsLikeGenerator());
}
}
4.配置自定義Linq provider擴展
使用IsLike擴展方法去查詢DB數據,我們需要配置我們自定義的LinqToHQLGeneratorsRegistry,如果使用配置文件配置,則需要使用linqtohql.generatorsregistry:
如果使用Loquacious-configuration就是這樣:
//Code Snippets Copyright http://lyj.cnblogs.com/
configuration.LinqToHqlGeneratorsRegistry<MyLinqToHqlGeneratorsRegistry>();
5.使用IsLike擴展方法
//Code Snippets Copyright http://lyj.cnblogs.com/
var users = session.Query<User>().Where(o => o.Name.IsLike("%永京%")).ToList();
6.執行結果
通過這篇文章學習了Linq provider自定義擴展機制和實現。
參考資料
Fabio Maulo:NHibernate LINQ provider extension
NHibernate Jira: Add support for user-provided extensions to the Linq provider
希望本文對你有所幫助。