ASP.NET基础之HttpHandler学习

迈不过友情╰ 2022-09-16 13:29 146阅读 0赞

# **一、HttpHandler理论知识** #

①**IHttpHandler定义了如果要实现一个HTTP请求的处理所必需实现的一些系统约定**。HttpHandler与HttpModule不同，**一旦定义了自己的HttpHandler类，那么它对系统的HttpHandler的关系将是“覆盖”关系**。

②**当一个HTTP请求经同HttpModule容器传递到HttpHandler容器中时，ASP.NET Framework会调用HttpHandler的ProcessRequest成员方法来对这个HTTP请求进行真正的处理。**以一个ASPX页面为例，正是在这里一个ASPX页面才被系统处理解析，并将处理完成的结果继续经由HttpModule传递下去，直至到达客户端。**对于ASPX页面，ASP.NET Framework在默认情况下是交给System.Web.UI.PageHandlerFactory这个HttpHandlerFactory来处理的。**HttpHandlerFactory，是指当一个HTTP请求到达这个HttpHandler Factory时，HttpHandlerFactory会提供出一个HttpHandler容器，交由这个HttpHandler容器来处理这个HTTP请求。针对.aspx在machine.config中是这样定义的：

③**一个HTTP请求都是最终交给一个HttpHandler容器中的ProcessRequest方法来处理的。**

④**可以自定义HttpHandler来处理某些特殊文件的请求或者逻辑的实现；自定义HttpHandler必须实现接口IHttpHandler；其中属性IsReusable表示获取一个值，该值指示其他请求是否可以使用 IHttpHandler 实例**。而方法ProcessRequest则是以一个HttpContext的上下文为参数；这些我们就可以操作HttpContext里封装的Request,Response,Server等。

![3dcfdd38c592044e10ed15ebee2ed6ff.png][]

# **二、HttpHandler之一般程序处理类(Handler.aspx)** #

在我们讲解自定义HttpHandler时，我们首先看下VS里的一般程序处理类（Handler.aspx），在我们平常开发过程中其实已经有应用到一些HttpHandler，比如我们新建一个一般程序处理类时。

public class Handler : IHttpHandler
        {
            public bool IsReusable { get { return false; } } 
    
            public void ProcessRequest(HttpContext context)
            {
                context.Response.ContentType = "text/plain";
                context.Response.Write("Hello world");
            }
    
        }//Class_end

若是使用到一般处理程序时有个地方要注意，就是它对Session值的读起时；运用上面的Handler.aspx是读不到Session值；实例如下:

①我们定义一个NotSessionHandler.ashx用来读取Session的值：

public partial class NoSessionHandler : System.Web.UI.Page,IHttpHandler
        {
            protected void Page_Load(object sender, EventArgs e)
            {
    
            }
    
            public new bool IsReusable { get { return false; } }
    
            public new void ProcessRequest(HttpContext context)
            {
                object sessionValue = context.Session["NoSessionHandler"];
                string result = string.Empty;
                if (sessionValue != null)
                {
                    result = sessionValue.ToString();
                }
                else
                {
                    result = "没有实现接口，Session的值无法读到！";
                }
                context.Response.ContentType = "text/plain";
                context.Response.Write(result);
            }
    
    
        }//Class_end

②然后再Default.aspx页面进行写入Session值，并让NotSessionHandler.aspx显示：

protected void Button2_Click(object sender, EventArgs e)
            {
                Session["NoSessionHandler"] = "Coffee";
                Response.Redirect("NoSessionHandler.aspx");
            }

运行结果：

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAeGlhb2NoZW5YSUhVQQ_size_14_color_FFFFFF_t_70_g_se_x_16][]

注意：如果出现以下错误

![84385139839bfd0e2d2bb19c0ba10c0f.png][]

为什么NotSessionHandler.ashx读取不到Session 的值？它不是已经有当前HttpContext上下文？其实NotSessionHandler.ashx还必须实现Session的一个重要接口IRequiresSessionState；其实接口IRequiresSessionState里并没有什么内容，只是一个简单的标识而已；它是存在于System.Web.SessionState内。

接着我们实现对上面的NotSessionHandler.aspx进行修改，让它实现接口IRequiresSessionState;

using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    using System.Web.SessionState;
    using System.Web.UI;
    using System.Web.UI.WebControls;
    
    namespace TestModule2.View
    {
        public partial class NoSessionHandler : System.Web.UI.Page,IHttpHandler, IRequiresSessionState
        {
            protected void Page_Load(object sender, EventArgs e)
            {
    
            }
    
            public new bool IsReusable { get { return false; } }
    
            public new void ProcessRequest(HttpContext context)
            {
                object sessionValue = context.Session["NoSessionHandler"];
                string result = string.Empty;
                if (sessionValue != null)
                {
                    result = sessionValue.ToString();
                }
                else
                {
                    result = "没有实现接口，Session的值无法读到！";
                }
                context.Response.ContentType = "text/plain";
                context.Response.Write(result);
            }
    
    
        }//Class_end
    }

# **三、自定义HttpHandler** #

自定义一个HttpHandler处理程序只要两步就可以实现了：

①第一是让类实现接口IHttpHandler；

②第二就是增加Web.config配置文件；

## 3.1、自定义后缀类型访问示例 ##

①先建一个类MyHttpHandler类并实现接口IHttpHandler,此处只是显示内容

namespace TestModule2.App_Code
    {
        public class MyHttpHandler : IHttpHandler
        {
            public bool IsReusable { get { return true; } }
    
    
            public void ProcessRequest(HttpContext context)
            {
                HttpRequest request = context.Request;
                HttpResponse response = context.Response;
    
                response.Write("这个是自定义的HttpHandler </br>");
                response.Write("访问URL地址：" + request.Url.Segments[2] + "</br>");
                string FileStr = request.PhysicalPath;
                if (File.Exists(FileStr))
                {
                    response.Write("以下是文件Test.Coffee的内容 <br/>");
                    FileInfo fileInfo = new FileInfo(FileStr);
                    StreamReader reader = new StreamReader(FileStr, Encoding.Default);
                    string StrLine = string.Empty;
                    while (!string.IsNullOrEmpty(StrLine = reader.ReadLine()))
                    {
                        response.Write(StrLine + "</br>");
                    }
                    reader.Close();
                }
                else
                {
                    response.Write("文件不存在");
                }
            }
        }//Class_end
    }

②在View文件夹下新建一个自定义后缀为.Coffee的文件Test.Coffee

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAeGlhb2NoZW5YSUhVQQ_size_10_color_FFFFFF_t_70_g_se_x_16][]

③修改web.config配置

<?xml version="1.0" encoding="utf-8"?>
    
    <configuration>
    
    	<system.webServer>
    		<handlers>
    			<add name="MyHttpHandler" path="*.Coffee" verb="*" type="TestModule2.App_Code.MyHttpHandler,App_Code"/>
    		</handlers>
    	</system.webServer>
    
    </configuration>

④运行效果如下（直接在VS运行时的情况）：

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAeGlhb2NoZW5YSUhVQQ_size_13_color_FFFFFF_t_70_g_se_x_16][]

我们部署在IIS要进行设置，不然在IIS里访问Cnblogs.wujy就会报下面的错误：

![f71e7f03a266b7eb8f8375dbd7b966e9.png][]

由于我本地的IIS为版7.0所以设置如下（若是IIS5或II6可以在应用程序扩展映射增加后缀）：

![9dca6a12ca1952d068915984f2f09502.png][]

## 3.2、实现一个对站点里的图片进行打水印 ##

实现图片上传后在访问图片时打水印，它其实并不有把水印打在图片上只是访问时才显示出水印，保持图片的原来模样；

①新建一个实现接口IHttpHandler的类WaterMarkHandler

using System;
    using System.Collections.Generic;
    using System.Drawing;
    using System.Drawing.Imaging;
    using System.IO;
    using System.Linq;
    using System.Web;
    
    namespace TestModule2.App_Code
    {
        public class WaterMarkHandler: IHttpHandler
        {
            public WaterMarkHandler()
            {
    
            }
    
            #region IHttpHandler 成员
            /// <summary>
            /// 指示其它请求是否可以使用这个实例，如果是true，则放入池中接受其它请求以提高请求
            /// </summary>
            public bool IsReusable
            {
                get { return true; }
            }
    
            /// <summary>
            /// 处理请求
            /// </summary>
            /// <param name="context">当前HTTP请求的上下文</param>
            public void ProcessRequest(HttpContext context)
            {
                //获取请求的物理图片路径
                string imagePath = context.Request.PhysicalPath;
    
                Image image = null;
                if (File.Exists(imagePath))
                {
                    //定义水印文字
                    string text = "给图片增加水印[Coffee]";
                    //定义水印文字字体大小
                    int fontSize = 8;
                    //水印文字字体
                    Font font = new Font("宋体", fontSize);
                    //根据图片物理地址加载图片
                    image = Image.FromFile(imagePath);
                    Graphics g = Graphics.FromImage(image);
                    //获取要绘制水印文字所需要的显示区域大小
                    SizeF size = g.MeasureString(text, font);
                    if (size.Width > image.Width || size.Height > image.Height)
                    {
                        //如果要显示的图片的尺寸都不足以显示按照指定字体来添加水印
                        //可以减小字体大小或者不添加水印（太小了没办法添加嘛）
                    }
                    else//添加水印文字
                    {
                        Brush brush = Brushes.SkyBlue;
                        //在图片上添加水印,绘制水印文字在图片的右下角
                        g.DrawString(text, font, brush, image.Width - size.Width, image.Height - size.Height);
                        g.Dispose();
                    }
                }
                else//如果不存在，指定一个默认图片进行显示
                {
                    imagePath = context.Server.MapPath("~/Images/6.png");
                    image = Image.FromFile(imagePath);
                }
                image.Save(context.Response.OutputStream, ImageFormat.Jpeg);//将添加水印的图片输入到当前流中
            }
    
            #endregion
    
        }//Class_end
    }

②修改配置文件web.config（说明针对本站的图片都用上面的处理程序类处理）

<?xml version="1.0" encoding="utf-8"?>
    
    <configuration>
    
    	<system.webServer>
    			<add name="WaterMarkHandler" path="*.png" verb="*" type="TestModule2.App_Code.WaterMarkHandler,App_Code"/>
    		</handlers>
    	</system.webServer>
    	
    </configuration>

③我们新建一个页面用来显示图片

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="ShowImages.aspx.cs" Inherits="TestModule2.View.ShowImages" %>
    
    <!DOCTYPE html>
    
    <html xmlns="http://www.w3.org/1999/xhtml">
    <head runat="server">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
        <title></title>
    </head>
    <body>
        <form id="form1" runat="server">
            <div>
                <br />
                <br />
                <br />
                <asp:Image ID="Image1" runat="server" Height="525px" ImageUrl="~/Images/4.png" style="margin-left: 148px; margin-right: 0px" Width="510px" />
            </div>
        </form>
    </body>
    </html>

④运行效果

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAeGlhb2NoZW5YSUhVQQ_size_16_color_FFFFFF_t_70_g_se_x_16][]

[3dcfdd38c592044e10ed15ebee2ed6ff.png]: /images/20220828/0b0cd0941ca543f3955e542a4c7cb70b.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAeGlhb2NoZW5YSUhVQQ_size_14_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/7f085ad3324d4d57bf5e0b098af1a668.png
[84385139839bfd0e2d2bb19c0ba10c0f.png]: /images/20220828/8884e2479d97474580d5997524472c83.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAeGlhb2NoZW5YSUhVQQ_size_10_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/334905b66c4040239e8e9c3ffc92032d.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAeGlhb2NoZW5YSUhVQQ_size_13_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/64fb96f5c0ef4aea9e28acd67f602c77.png
[f71e7f03a266b7eb8f8375dbd7b966e9.png]: /images/20220828/8b8550da896b4408bfa0aa49c61b4fcd.png
[9dca6a12ca1952d068915984f2f09502.png]: /images/20220828/c6415b90d6e54a93a4e9efb579a77474.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAeGlhb2NoZW5YSUhVQQ_size_16_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/acd29a12c75c4cc5b940e3d83d57b73b.png