C#如何優雅的對WinForm表單應用程式進行許可權控制

2022-11-27 14:00:49

前言

特別複雜特別高大上的系統我還沒有機會接觸，就我瞭解的來看，普通的功能許可權控制的流程都差不多隻有兩個過程：

獲取當前使用者擁有的許可權
在介面上對功能入庫的可用性或者可見性進行控制

這裡說一種在WinForm表單應用開發時進行許可權控制的辦法，文章中主要針對上述兩個過程的第二步。不過為了說清楚，我先簡單說一下我的資料庫功能表設計。

資料庫

大家的許可權資料庫好像都差不多，我比較習慣Code First，所以就直接貼資料庫對應的物件。記錄下功能名稱，所屬模組，表單名稱，控制元件名稱。許可權表裡面主要就是記錄了使用者(角色)ID和功能的對應了，有記錄就表示該使用者(角色)擁有該功能許可權，沒有記錄就是沒有許可權。

/// <summary>
/// 系統功能
/// </summary>
[SugarTable("X_FUNCTION", "系統功能")]
public class FUNCTION
{
    [SugarColumn(IsPrimaryKey = true, ColumnDescription = "主鍵", Length = 50)]
    public string GUID { get; set; }

    /// <summary>
    /// 功能名稱
    /// </summary>
    [SugarColumn(ColumnDataType = "NVARCHAR2(30)", ColumnDescription = "功能名稱")]
    public string NAME
    {
        get;
        set;
    }

    /// <summary>
    /// 模組ID
    /// </summary>
    [SugarColumn(ColumnDescription = "模組ID", Length = 50)]
    public string MODULEID
    {
        get;
        set;
    }

    /// <summary>
    /// 表單名稱
    /// </summary>
    [SugarColumn(ColumnDescription = "表單名稱", Length = 50)]
    public string FORMNAME
    {
        get;
        set;
    }

    /// <summary>
    /// 控制元件名稱
    /// </summary>
    [SugarColumn(ColumnDescription = "控制元件名稱", Length = 50)]
    public string CONTROLNAME
    {
        get;
        set;
    }
}

如何控制

最簡單的方法，就是自己在程式碼裡面把每個功能入口的控制元件都手動判斷一遍，他們的name在不在有許可權的功能列表的控制元件名稱裡。當然簡單很有可能就代表麻煩，有的視窗可能要控制的上百控制元件，得寫上百if-esle，這實在是太不優雅了，如果還有多個視窗的許可權需要控制，那就真是災難了。這個時候反射就可以起到比較好的作用。我們可以建立一個繼承自Form的類，在這個類裡面檢查許可權並設定控制元件是否可用。我使用了DevExpress控制元件，所以繼承自XtraForm。然後只要視窗繼承CheckPowerXtraForm，就可以進行許可權控制了。

程式碼中有兩個地方需要注意，第一是要等待建立視窗控制程式碼再設定視窗控制元件的可用性。因為要等待，以及讀資料庫，所以不能放在主執行緒裡面(寫到這裡，忽然覺得這個檢查許可權應該放在FormLoad事件裡比較好，不用Thread.Sleep，不過要讀資料庫，還是不適合放在主執行緒)。

/// <summary>
/// 檢查許可權
/// </summary>
public class CheckPowerXtraForm : XtraForm
{
    public CheckPowerXtraForm()
    {
        //不要再主執行緒執行
        Task.Run(() =>
        {
            CheckPower();
        });
    }
    
    /// <summary>
    /// 檢查許可權
    /// </summary>
    private async void CheckPower()
    {
        var powerDal = new PowerDAL();
        var functions = await powerDal.GetPowerFunctionsByUserAsync(Global.User.GUID);
        //獲取值屬於本表單的許可權控制元件名稱
        var formControls = functions.Where(f => f.FORMNAME == this.GetType().Name).Select(f => f.CONTROLNAME).ToList();
        //等待建立視窗控制程式碼
        while (!this.Visible)
        {
            Thread.Sleep(100);
        }
        this.BeginInvoke(new Action(()=>{
            var type = this.GetType();
            var fields = this.GetType().GetFields(BindingFlags.NonPublic|BindingFlags.Instance);
            foreach (var field in fields)
            {
                var value = field.GetValue(this);
                if (value is Control)
                {
                    var control = value as Control;
                    if (!formControls.Contains(control.Name))
                    {
                        control.Enabled = false;
                    }
                }
                else if (value is BarItem)
                {
                    var item = value as BarItem;
                    if (!formControls.Contains(item.Name))
                    {
                        item.Enabled = false;
                    }
                }
                else if (value is ToolStripMenuItem)
                {
                    var item = value as ToolStripMenuItem;
                    if (!formControls.Contains(item.Name))
                    {
                        item.Enabled = false;
                    }
                }
            }
        }));
    }
}

問題

上面的做法有一個問題，視窗裡面不是所有控制元件都需要許可權控制的，有的是一些容器性的控制元件比如Groupbox，有的是一些是個使用者就有的功能比如退出登入。按上面程式碼的做法，只要沒有記錄的，全部都會設定成不可用。所以我們需要對需要許可權控制的做一個標記。有兩個辦法：

把所有需要控制許可權的控制元件Enabled都事先設定成false，然後有許可權的就設定成true。
給需要控制的控制元件設定一個特性。

下面說說第二種做法。首先定義一個特性，裡面什麼都不需要寫。

/// <summary>
/// 檢查許可權的特性
/// </summary>
[AttributeUsage(AttributeTargets.Field)]
public class CheckPowerAttribute : Attribute
{
}

然後給需要控制的控制元件賦予這個特性。

[CheckPowerAttribute]
private DevExpress.XtraBars.BarButtonItem mbbi_exportexcel;
[CheckPowerAttribute]
private DevExpress.XtraBars.BarButtonItem mbbi_exportcad;
[CheckPowerAttribute]
private DevExpress.XtraBars.BarButtonItem mbbi_exportshp;

然後在許可權控制程式碼裡只處理具有這個特性的控制元件。

//~~~
foreach (var field in fields)
{
    var cattributes = field.GetCustomAttributes(typeof(CheckPowerAttribute), false);
    if (cattributes.Length != 0)
    {
        var value = field.GetValue(this);
        if (value is Control)
        {
            var control = value as Control;
            if (!formControls.Contains(control.Name))
            {
                control.Enabled = false;
            }
        }
        else if (value is BarItem)
        {
            var item = value as BarItem;
            if (!formControls.Contains(item.Name))
            {
                item.Enabled = false;
            }
        }
        else if (value is ToolStripMenuItem)
        {
            var item = value as ToolStripMenuItem;
            if (!formControls.Contains(item.Name))
            {
                item.Enabled = false;
            }
        }
    }
}
//~~~

總結

說是優雅，其實自己一邊寫一邊都覺得有不少改進的地方，比如CheckPower()執行的位置，還有設定Enable的時候用反射設定也會簡潔很多，如果有更好的改進方案歡迎評論討論。

到此這篇關於C#如何優雅的對WinForm表單應用程式進行許可權控制的文章就介紹到這了,更多相關C# WinForm表單應用許可權控制內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

C#如何優雅的對WinForm表單應用程式進行許可權控制

目錄

前言

資料庫

如何控制

問題

總結

熱門文章