ASP.net的地址重写(URLRewriter)实现原理及代码示例

ASP.net的地址重写(URLRewriter)实现原理及代码示例

吴剑 2007-01-01

原创文章，转载必需注明出处：http://www.cnblogs.com/wu-jian/

 

概述

访问者输入：http://wu-jian.cnbolgs.com/default.aspx，实际请求和响应的地址却是：http://www.cnblogs.com/wu-jian/default.aspx, 这就是UrlRewrite，除了实现二级域名功能，它在简化用户输入地址、SEO、网站版本迭代更新等多个方面发挥着重要作用。

微软曾在.net framework 1.1中提供过一个名为URLRewriter的小工具供开发人员轻松实现UrlRewrite，下载地址为：http://download.microsoft.com/download/0/4/6/0463611e-a3f9-490d-a08c-877a83b797cf/MSDNURLRewriting.msi 

本文以URLRewriter为例，在.net framework 2.0的环境下做了小部分优化调整，供大家学习和参考，能力有限，不足之处请大家及时指出。本文假设读者对URLRewriter、ASP.net的 Http管线有一定了解，否则请查阅相关资料。

 

配置

URLRewriter在web.config里通过自定义配置结合正则表达式来实现URL重写。

自定义节点的声明：

<configSections>
    <section name="RewriterConfig" 
        type="PaoTiao.PTRewriter.Config.RewriterConfigSerializerSectionHandler, PaoTiao.PTRewriter"/>
</configSections>

 

自定义节点配置项：

<RewriterConfig>
    <Rules>
      <RewriterRule>
        <LookFor>^http://([a-zA-Z0-9]{4,16}).cnblogs.com/default.aspx$</LookFor>
        <SendTo>/$1/default.aspx</SendTo>
      </RewriterRule>

      <RewriterRule>
        <LookFor>^http://www.cnblogs.com/([a-zA-Z0-9]{4,16})/$</LookFor>
        <SendTo>/test/url.aspx?p=$1</SendTo>
      </RewriterRule>
    </Rules>
  </RewriterConfig>

 

如上我配置了两个规则，以实例说明，第一个可将：http://wu-jian.cnblogs.com 重写到：/wu-jian/default.aspx

第二个可将：http://www.cnblogs.com/wu-jian 重写到：/test/url.aspx?p=wu-jian

但微软的URLRewriter LookFor并不支持到域名位置，它只能在根目录之后做文章，截选了它源码DEMO中的一段：

<RewriterRule>
    <LookFor>~/(\d{4})/(\d{2})/(\d{2})\.aspx</LookFor>
    <SendTo>~/ShowBlogContent.aspx?year=$1&amp;month=$2&amp;day=$3</SendTo>
</RewriterRule>

 

可以发现，当需要使用二级域名或自定义级别更高的rewrite时，URLRewriter是不支持的，所以在此我将源代码作了一小部分优化，匹配与重写都使用LookFor和SendTo中的原始表达式，不做任何智能替换与修改。其实很多时候，在微软的产品中都能发现这种“画蛇添足”的影子。

关于匹配与替换， 其实就是应用了正则表达式中的“反向引用”原理，在我的博客里有代码示例，不熟悉正则的朋友可去了解，此处不作详叙。

 

源代码分析

对自定义配置进行访问的类：

using System;
using System.Configuration;
using System.Xml;
using System.Xml.Serialization;
using System.Xml.XPath;

namespace PaoTiao.PTRewriter.Config
{
    ///<summary>
    /// 实现IConfigurationSectionHandler接口，以对自定义节点进行访问
    ///</summary>
publicclass RewriterConfigSerializerSectionHandler : IConfigurationSectionHandler
    {
        ///<summary>
        /// 该方法无需主动调用
        /// 它在ConfigurationManager.GetSection()被调用时根据改配置节声明中所定义的类名和路径自动实例化配置节处理类
        ///</summary>
publicobject Create(object parent, object configContext, System.Xml.XmlNode section)
        {
            XmlSerializer ser =new XmlSerializer(typeof(RewriterConfiguration));
            return ser.Deserialize(new XmlNodeReader(section));
        }

    }//end class
}

 

之前一直写WEB程序，很少用到自定义节点，直到一次写Windows Service用到了app.config，发现要读取自定义节点，就需要实现IConfigurationSectionHandler接口。

using System;
using System.Web;
using System.Web.Caching;
using System.Configuration;
using System.Xml.Serialization;

namespace PaoTiao.PTRewriter.Config
{
    [Serializable()]
    [XmlRoot("RewriterConfig")]
    publicclass RewriterConfiguration
    {
        private RewriterRuleCollection rules;

        ///<summary>
        /// 该方法从web.config中读取规则集合，并使用了Cache以避免频繁IO操作
        ///</summary>
        ///<returns></returns>
publicstatic RewriterConfiguration GetConfig()
        {
            //使用缓存
if (HttpContext.Current.Cache["RewriterConfig"] ==null)
                HttpContext.Current.Cache.Insert("RewriterConfig", ConfigurationManager.GetSection("RewriterConfig"));

            return (RewriterConfiguration)HttpContext.Current.Cache["RewriterConfig"];
        }

        public RewriterRuleCollection Rules
        {
            get { return rules; }
            set { rules = value; }
        }

    }//end class
}  

我想使用UrlRewrite的站点绝大部分都是面向公众用户的，面向公众用户就面临着大的流量和并发，谁也不愿意为每个请求去读取一次web.config吧，那么在此处使用Cache是明智之举。另外更换了已过期的ConfigurationSettings.GetConfig()方法为ConfigurationManager.GetSection()方法。

 

如下两个类完成类似的Model功能。

using System;
using System.Collections;

namespace PaoTiao.PTRewriter.Config
{
    ///<summary>
    /// 规则集合
    ///</summary>
    [Serializable()]
    publicclass RewriterRuleCollection : CollectionBase
    {
        ///<summary>
        /// 向集合中添加新规则
        ///</summary>
        ///<param name="r">RewriterRule对象</param>
publicvirtualvoid Add(RewriterRule r)
        {
            this.InnerList.Add(r);
        }

        ///<summary>
        /// 获取或设置项
        ///</summary>
public RewriterRule this[int index]
        {
            get { return (RewriterRule)this.InnerList[index]; }
            set { this.InnerList[index] = value; }
        }

    }//end class
}  

  

using System;

namespace PaoTiao.PTRewriter.Config
{
    ///<summary>
    /// 重写规则的数据对象
    ///</summary>
    [Serializable()]
    publicclass RewriterRule
    {
        privatestring mLookFor;
        privatestring mSendTo;

        ///<summary>
        /// 查找规则
        ///</summary>
publicstring LookFor{
            get { returnthis.mLookFor; }
            set { this.mLookFor = value; }
        }

        ///<summary>
        /// 重写规则
        ///</summary>
publicstring SendTo{
            get { returnthis.mSendTo; }
            set { this.mSendTo = value; }
        }

    }//end class
}//end namespace

  

使用HttpModule实现地址重写 

using System;
using System.Web;

namespace PaoTiao.PTRewriter
{
    ///<summary>
    /// 实现IHttpModule的抽象类
    ///</summary>
publicabstractclass BaseModuleRewriter : IHttpModule
    {
        publicvirtualvoid Dispose() { }

        publicvirtualvoid Init(HttpApplication app)
        {
            app.BeginRequest +=new EventHandler(this.BaseModuleRewriter_BeginRequest);
        }

        protectedvirtualvoid BaseModuleRewriter_BeginRequest(object sender, EventArgs e)
        {
            HttpApplication app = (HttpApplication)sender;
            Rewrite(app);
        }

        ///<summary>
        /// 地址重写抽象函数
        ///</summary>
        ///<param name="app"></param>
protectedabstractvoid Rewrite(HttpApplication app);

    }//end class
}

在Http模块中进行核心逻辑处理，源代码是在AuthorizeRequest事件中，此处我使用了BeginRequest事件。

  

对抽象方法Rewrite的实现。大家可以发现URL重写其实就一个核心方法：HttpContext.RewritePath

看看MSDN中对该方法的描述：指定内部重写路径，并允许请求的 URL 与资源的内部路径不同。 

using System;
using System.Text.RegularExpressions;
using System.Configuration;

using System.IO;

namespace PaoTiao.PTRewriter
{
    publicclass ModuleRewriter : BaseModuleRewriter
    {
        ///<summary>
        /// 地址重写函数
        ///</summary>
        ///<param name="app"></param>
protectedoverridevoid Rewrite(System.Web.HttpApplication app)
        {
            //开始跟踪日志
            app.Context.Trace.Write("ModuleRewriter", "Entering ModuleRewriter");

            //获取规则集合
            Config.RewriterRuleCollection rules = Config.RewriterConfiguration.GetConfig().Rules;

            for (int i =0; i < rules.Count; i++)
            {
                string lookFor = rules[i].LookFor;
                Regex reg =new Regex(lookFor, RegexOptions.IgnoreCase);

                if (reg.IsMatch(app.Request.Url.ToString()))
                {
                    //获取目的URL
string sendToUrl = reg.Replace(app.Request.Url.ToString(), rules[i].SendTo);

                    //跟踪日志
                    app.Context.Trace.Write("ModuleRewriter", "Rewriting URL to "+ sendToUrl);
                    //地址重写
                    app.Context.RewritePath(sendToUrl);

                    //Temp code for debug
                    //using (StreamWriter sw = new StreamWriter(@"c:\test\rr.txt", true, System.Text.Encoding.UTF8))
                    //{
                    //    sw.WriteLine(app.Request.Url.ToString());
                    //    sw.WriteLine("--------------------------------------");
                    //    sw.Close();
                    //}

                    //退出for循环
break;
                }
            }

            //结束跟踪日志
            app.Context.Trace.Write("ModuleRewriter", "Exiting ModuleRewriter");
        }

    }//end class
}

  

最后在web.config中注册自定义的Http模块：

<httpModules>
      <add name="ModuleRewriter" type="PaoTiao.PTRewriter.ModuleRewriter, PaoTiao.PTRewriter"/>
</httpModules>

 

应用

回到前面的示例， http://wu-jian.cnblogs.com --> /wu-jian/default.aspx

wu-jian所在的位置为域名前缀，或叫二级域名，这就需要在DNS上做一个 *.cnblogs.com 的泛解析。

 

第二个示例是将目录解析到某一地址：http://www.cnblogs.com/wu-jian --> /test/url.aspx?p=wu-jian

很明显，这里的关键点在于怎样让IIS把这种格式的请求交由.net进程来处理，一旦进入.net framwork，我们就能随心所欲了。OK，通过如下的操作过程即可：

IIS管理-->站点-->属性-->主目录标签-->配置-->通配符应用程序映射-->插入

1、选择 C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\aspnet_isapi.dll

2、不勾选“确认文件是否存在”

 

总结

关于Url Rewrite的介绍很多，第三方组件也很多，比如isapi rewrite、比如iirf，他们通过IIS底层接口实现所以效率更高，Url Rewriter在.Net进程内实现，也是微软在Framework1.1时代提供的解决方案，其实这篇文章也是多年前写的，只是最近准备换用IIRF，看着那些在.Net Framework4.0中提示已过期的方法，不得不感叹时光流水，对以前曾花了时间和精力的东西做个整理和备忘吧，同时希望给有需要的人带来帮助。

 

<全文完>

 

作者：吴剑
出处：http://www.cnblogs.com/wu-jian/
本文版权归作者和博客园共有，欢迎转载，但必需注明出处，并且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。