Metode filter untuk Razor Pages di ASP.NET Core

Oleh Rick Anderson

Razor Halaman memfilter IPageFilter dan IAsyncPageFilter mengizinkan Razor Halaman menjalankan kode sebelum dan sesudah Razor handler Halaman dijalankan. Razor Filter halaman mirip dengan filter tindakan MVC Inti ASP.NET, kecuali filter tidak dapat diterapkan ke metode penangan halaman individual.

Razor Filter halaman:

• Jalankan kode setelah metode handler dipilih, tetapi sebelum pengikatan model terjadi.
• Jalankan kode sebelum metode handler dijalankan, setelah pengikatan model selesai.
• Jalankan kode setelah metode handler dijalankan.
• Dapat diimplementasikan pada halaman atau secara global.
• Tidak dapat diterapkan ke metode penangan halaman tertentu.
• Dapat memiliki dependensi konstruktor yang diisi oleh Injeksi Dependensi (DI). Untuk informasi selengkapnya, lihat ServiceFilterAttribute dan TypeFilterAttribute.

Meskipun konstruktor halaman dan middleware memungkinkan eksekusi kode kustom sebelum metode handler dijalankan, hanya Razor filter Halaman yang memungkinkan akses ke HttpContext dan halaman. Middleware memiliki akses ke HttpContext, tetapi tidak ke "konteks halaman". Filter memiliki FilterContext parameter turunan, yang menyediakan akses ke HttpContext. Berikut adalah sampel untuk filter halaman: Terapkan atribut filter yang menambahkan header ke respons, sesuatu yang tidak dapat dilakukan dengan konstruktor atau middleware. Akses ke konteks halaman, yang mencakup akses ke instans halaman dan modelnya, hanya tersedia saat menjalankan filter, handler, atau isi Razor Halaman.

Melihat atau mengunduh kode sampel (cara mengunduh)

Razor Filter halaman menyediakan metode berikut, yang dapat diterapkan secara global atau di tingkat halaman:

• Metode sinkron:

  • OnPageHandlerSelected : Dipanggil setelah metode handler dipilih, tetapi sebelum pengikatan model terjadi.
  • OnPageHandlerExecuting : Dipanggil sebelum metode handler dijalankan, setelah pengikatan model selesai.
  • OnPageHandlerExecuted : Dipanggil setelah metode handler dijalankan, sebelum hasil tindakan.

• Metode asinkron:

  • OnPageHandlerSelectionAsync : Dipanggil secara asinkron setelah metode handler dipilih, tetapi sebelum pengikatan model terjadi.
  • OnPageHandlerExecutionAsync : Dipanggil secara asinkron sebelum metode handler dipanggil, setelah pengikatan model selesai.

Terapkan versi sinkron atau asinkron dari antarmuka filter, bukan keduanya. Kerangka kerja memeriksa terlebih dahulu untuk melihat apakah filter mengimplementasikan antarmuka asinkron, dan jika demikian, ia memanggilnya. Jika tidak, ini memanggil metode antarmuka sinkron. Jika kedua antarmuka diimplementasikan, hanya metode asinkron yang dipanggil. Aturan yang sama berlaku untuk mengambil alih di halaman, menerapkan versi sinkron atau asinkron dari penimpaan, bukan keduanya.

Menerapkan Razor filter Halaman secara global

Kode berikut mengimplementasikan IAsyncPageFilter:

public class SampleAsyncPageFilter : IAsyncPageFilter
{
    private readonly IConfiguration _config;

    public SampleAsyncPageFilter(IConfiguration config)
    {
        _config = config;
    }

    public Task OnPageHandlerSelectionAsync(PageHandlerSelectedContext context)
    {
        var key = _config["UserAgentID"];
        context.HttpContext.Request.Headers.TryGetValue("user-agent",
                                                        out StringValues value);
        ProcessUserAgent.Write(context.ActionDescriptor.DisplayName,
                               "SampleAsyncPageFilter.OnPageHandlerSelectionAsync",
                               value, key.ToString());

        return Task.CompletedTask;
    }

    public async Task OnPageHandlerExecutionAsync(PageHandlerExecutingContext context,
                                                  PageHandlerExecutionDelegate next)
    {
        // Do post work.
        await next.Invoke();
    }
}

Dalam kode sebelumnya, ProcessUserAgent.Write adalah kode yang disediakan pengguna yang berfungsi dengan string agen pengguna.

Kode berikut mengaktifkan SampleAsyncPageFilter di Startup kelas :

public void ConfigureServices(IServiceCollection services)
{
    services.AddRazorPages()
        .AddMvcOptions(options =>
        {
            options.Filters.Add(new SampleAsyncPageFilter(Configuration));
        });
}

Kode berikut memanggil AddFolderApplicationModelConvention untuk menerapkan satu-satunya SampleAsyncPageFilter halaman di /Movies:

public void ConfigureServices(IServiceCollection services)
{
    services.AddRazorPages(options =>
    {
        options.Conventions.AddFolderApplicationModelConvention(
            "/Movies",
            model => model.Filters.Add(new SampleAsyncPageFilter(Configuration)));
    });
}

Kode berikut mengimplementasikan sinkron IPageFilter:

public class SamplePageFilter : IPageFilter
{
    private readonly IConfiguration _config;

    public SamplePageFilter(IConfiguration config)
    {
        _config = config;
    }

    public void OnPageHandlerSelected(PageHandlerSelectedContext context)
    {
        var key = _config["UserAgentID"];
        context.HttpContext.Request.Headers.TryGetValue("user-agent", out StringValues value);
        ProcessUserAgent.Write(context.ActionDescriptor.DisplayName,
                               "SamplePageFilter.OnPageHandlerSelected",
                               value, key.ToString());
    }

    public void OnPageHandlerExecuting(PageHandlerExecutingContext context)
    {
        Debug.WriteLine("Global sync OnPageHandlerExecuting called.");
    }

    public void OnPageHandlerExecuted(PageHandlerExecutedContext context)
    {
        Debug.WriteLine("Global sync OnPageHandlerExecuted called.");
    }
}

Kode berikut mengaktifkan SamplePageFilter:

public void ConfigureServices(IServiceCollection services)
{
    services.AddRazorPages()
        .AddMvcOptions(options =>
        {
            options.Filters.Add(new SamplePageFilter(Configuration));
        });
}

Menerapkan Razor filter Halaman dengan menimpa metode filter

Kode berikut mengambil alih filter Halaman asinkron Razor :

public class IndexModel : PageModel
{
    private readonly IConfiguration _config;

    public IndexModel(IConfiguration config)
    {
        _config = config;
    }

    public override Task OnPageHandlerSelectionAsync(PageHandlerSelectedContext context)
    {
        Debug.WriteLine("/IndexModel OnPageHandlerSelectionAsync");
        return Task.CompletedTask;
    }

    public async override Task OnPageHandlerExecutionAsync(PageHandlerExecutingContext context, 
                                                           PageHandlerExecutionDelegate next)
    {
        var key = _config["UserAgentID"];
        context.HttpContext.Request.Headers.TryGetValue("user-agent", out StringValues value);
        ProcessUserAgent.Write(context.ActionDescriptor.DisplayName,
                               "/IndexModel-OnPageHandlerExecutionAsync",
                                value, key.ToString());

        await next.Invoke();
    }
}

Menerapkan atribut filter

Filter filter OnResultExecutionAsync berbasis atribut bawaan dapat disubkelas. Filter berikut menambahkan header ke respons:

using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc.Filters;

namespace PageFilter.Filters
{
    public class AddHeaderAttribute  : ResultFilterAttribute
    {
        private readonly string _name;
        private readonly string _value;

        public AddHeaderAttribute (string name, string value)
        {
            _name = name;
            _value = value;
        }

        public override void OnResultExecuting(ResultExecutingContext context)
        {
            context.HttpContext.Response.Headers.Add(_name, new string[] { _value });
        }
    }
}

Kode berikut menerapkan AddHeader atribut :

using Microsoft.AspNetCore.Mvc.RazorPages;
using PageFilter.Filters;

namespace PageFilter.Movies
{
    [AddHeader("Author", "Rick")]
    public class TestModel : PageModel
    {
        public void OnGet()
        {

        }
    }
}

Gunakan alat seperti alat pengembang browser untuk memeriksa header. Di bawah Header Respons, author: Rick ditampilkan.

Lihat Mengesampingkan urutan default untuk instruksi tentang mengambil alih pesanan.

Lihat Pembatalan dan sirkuit pendek untuk instruksi untuk sirkuit pendek alur filter dari filter.

Mengotorisasi atribut filter

Atribut Otorisasi dapat diterapkan ke PageModel:

using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;

namespace PageFilter.Pages
{
    [Authorize]
    public class ModelWithAuthFilterModel : PageModel
    {
        public IActionResult OnGet() => Page();
    }
}