讓 Net core 3.1 的 PageModel 可以 Properties Autowired

會考慮使用 Properties Autowired 是經過考慮跟評估的，畢竟 Properties Autowired 會造成負面的影響，就是 class 所相依的 class 會不清楚，很難像 Constructor 那樣清楚明白，但一般正常不會自己去建構 Controller 跟 PageModel，要建構的成本太大了，所以 Controller 跟 PageModel 很適合用 Properties Autowired。

為了做到 Properties Autowired 可以用 IPageFilter 進行處理:

原始碼

1. using System; 
2. using System.Collections.Concurrent; 
3. using System.Linq; 
4. using System.Reflection; 
5. using Microsoft.AspNetCore.Components; 
6. using Microsoft.AspNetCore.Mvc.Filters; 
7. using Microsoft.AspNetCore.Mvc.RazorPages; 
8. using Microsoft.Extensions.DependencyInjection; 
9.  
10. namespace XXXXX.Api.Filters 
11. { 
12.    public class PageModelInjectFilter : IPageFilter 
13.    { 
14.        /// <summary>注入器的快取</summary> 
15.        private readonly ConcurrentDictionary<Type, Action<PageModel, IServiceProvider>> _injecterCache = 
16.            new ConcurrentDictionary<Type, Action<PageModel, IServiceProvider>>(); 
17.  
18.  
19.        /// <summary>建構注入器</summary> 
20.        private Action<PageModel, IServiceProvider> buildInjecter(Type type) 
21.        { 
22.            /* delegate 具有疊加的能力，先建構一個空的 delegate */ 
23.            Action<PageModel, IServiceProvider> action = (page, provider) => { }; 
24.  
25.            /* 取得 Properties 且是可以寫入，並具有 [Inject] Attribute */ 
26.            var props = type.GetProperties() 
27.                .Where(p => p.CanWrite) 
28.                .Where(p => p.IsDefined(typeof(InjectAttribute))); 
29.  
30.            foreach (var prop in props) 
31.            { 
32.                action += (page, provider) => 
33.                { 
34.                    /* 如果 Property 是已經有 Value 的就不要進行注入 */ 
35.                    if (prop.GetValue(page) != null) { return; } 
36.  
37.                    /* 從 provider 取得依賴的物件 */ 
38.                    object value = provider.GetRequiredService(prop.PropertyType); 
39.                    prop.SetValue(page, value); 
40.                }; 
41.            } 
42.  
43.            return action; 
44.        } 
45.  
46.  
47.        /// <summary>在選取處理常式方法之後，但在進行模型系結之前呼叫。</summary> 
48.        public void OnPageHandlerSelected(PageHandlerSelectedContext context) 
49.        { 
50.            /* 判斷是否是 PageModel */ 
51.            var page = context.HandlerInstance as PageModel; 
52.            if (page == null) { return; } 
53.  
54.            /* 取得或建構注入器 */ 
55.            Action<PageModel, IServiceProvider> injecter =  
56.               _injecterCache.GetOrAdd(page.GetType(), buildInjecter); 
57.  
58.            /* 進行注入 */ 
59.            injecter(page, context.HttpContext.RequestServices); 
60.        } 
61.  
62.  
63.        /// <summary>在完成模型系結之後，于處理常式方法執行之前呼叫。</summary> 
64.        public void OnPageHandlerExecuting(PageHandlerExecutingContext context) { } 
65.  
66.        /// <summary>在處理常式方法執行之後，在動作結果執行之前呼叫。</summary> 
67.        public void OnPageHandlerExecuted(PageHandlerExecutedContext context) { } 
68.    } 
69. } 

using System;
using System.Collections.Concurrent;
using System.Linq;
using System.Reflection;
using Microsoft.AspNetCore.Components;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.Extensions.DependencyInjection;

namespace XXXXX.Api.Filters
{
    public class PageModelInjectFilter : IPageFilter
    {
        /// <summary>注入器的快取</summary>
        private readonly ConcurrentDictionary<Type, Action<PageModel, IServiceProvider>> _injecterCache =
            new ConcurrentDictionary<Type, Action<PageModel, IServiceProvider>>();


        /// <summary>建構注入器</summary>
        private Action<PageModel, IServiceProvider> buildInjecter(Type type)
        {
            /* delegate 具有疊加的能力，先建構一個空的 delegate */
            Action<PageModel, IServiceProvider> action = (page, provider) => { };

            /* 取得 Properties 且是可以寫入，並具有 [Inject] Attribute */
            var props = type.GetProperties()
                .Where(p => p.CanWrite)
                .Where(p => p.IsDefined(typeof(InjectAttribute)));

            foreach (var prop in props)
            {
                action += (page, provider) =>
                {
                    /* 如果 Property 是已經有 Value 的就不要進行注入 */
                    if (prop.GetValue(page) != null) { return; }

                    /* 從 provider 取得依賴的物件 */
                    object value = provider.GetRequiredService(prop.PropertyType);
                    prop.SetValue(page, value);
                };
            }

            return action;
        }


        /// <summary>在選取處理常式方法之後，但在進行模型系結之前呼叫。</summary>
        public void OnPageHandlerSelected(PageHandlerSelectedContext context)
        {
            /* 判斷是否是 PageModel */
            var page = context.HandlerInstance as PageModel;
            if (page == null) { return; }

            /* 取得或建構注入器 */
            Action<PageModel, IServiceProvider> injecter = 
               _injecterCache.GetOrAdd(page.GetType(), buildInjecter);

            /* 進行注入 */
            injecter(page, context.HttpContext.RequestServices);
        }


        /// <summary>在完成模型系結之後，于處理常式方法執行之前呼叫。</summary>
        public void OnPageHandlerExecuting(PageHandlerExecutingContext context) { }

        /// <summary>在處理常式方法執行之後，在動作結果執行之前呼叫。</summary>
        public void OnPageHandlerExecuted(PageHandlerExecutedContext context) { }
    }
}

接著在 Startup.cs 進行過濾器配置

原始碼

1. public void ConfigureServices(IServiceCollection services) 
2. { 
3.    //... 
4.  
5.    IMvcBuilder mvcBuilder = services 
6.        .AddRazorPages(options => 
7.        { 
8.            //... 
9.        }) 
10.        .AddMvcOptions(options => 
11.        { 
12.            //... 
13.            options.Filters.Add(new PageModelInjectFilter()); 
14.        }) 
15.        ; 
16.  
17.    //... 
18. } 

public void ConfigureServices(IServiceCollection services)
{
    //...

    IMvcBuilder mvcBuilder = services
        .AddRazorPages(options =>
        {
            //...
        })
        .AddMvcOptions(options =>
        {
            //...
            options.Filters.Add(new PageModelInjectFilter());
        })
        ;

    //...
}

然後在 PageModel 就可以用下面的方式撰寫:

原始碼

1. public class IndexModel : PageModel 
2. { 
3.    [Inject] public IMenuProvider MenuProvider { private get; set; } 
4.  
5.    public IActionResult OnGet() 
6.    { 
7.        return Page(); 
8.    } 
9. } 

public class IndexModel : PageModel
{
    [Inject] public IMenuProvider MenuProvider { private get; set; }

    public IActionResult OnGet()
    {
        return Page();
    }
}