【C#】【WinForm】【DevExpress】XAF自定义登录参数和身份验证

　　在使用XAF框架是，默认身份验证是使用用户名和密码的。Win和Web页面如下所示。

　　现在要（公司、员工、密码）登录来替代（用户名、密码）登录。效果如下：

  原理

　　是如何实现自定义传参验证的呢？最关键的步骤在于登录使用自定义的认证标准（能够实现登录）而不是默认的Authentication Standard。

　　我们可以先了解在生成项目时，有无登录页面的区别。分别打开生成简单的无自动登录和有自动登录的默认Win应用配置（Web应用配置类似）文件WinApplication.cs。

 

　　因此，默认登录需要两个XAF控件Security Strategy Complex 和 Authentication Standard,字面意思是复杂安全策略和认证标准。

　　Security Strategy Complex，复杂安全策略。对其功能简单的理解就是定义登录的角色类型、用户类型等信息。查看Security Strategy Complex的属性。实现登录控件是角色类型（RoleType）和用户类型（UserType）来实现自定义的用户登录。

 　　Authentication Standard, 认证标准。简单的理解，就是根据复杂安全策略提供的参数，有了这个控件，就能实现登录。它的方法本身定义了登录页面需要登录的参数。要想实现登录页面，就需要自己写一个控件，然后替换Authentication Standard控件。

 　　注：记得将自定义的控件替换为Authentication Standard（开始时依据官方步骤，不理解原理，遗漏此步骤，因此百思不得其解）。

　　如何自定义控件呢？Authentication Standard控件对应的类为AuthenticationStandard，我们可以自定义类，官方的方法是继承AuthenticationBase、或者IAuthenticationStandard接口。下图是登录类的继承关系图，蓝色部分为登录控件，可以查看官方文件（https://documentation.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Security.AuthenticationStandard.class）根据需求，实现和集成。接下来的方法会按照官方的方法来做。

步骤

要实现自定义登录（公司、员工、密码）登录。依据以下步骤：

实现员工公司类，并生成演示数据

• 创建参数类
• 创建自定义登录认证类
• 让登录窗口下拉能显示数据
  • 为登录窗口提供对象空间
  • 让登录窗口能够访问外部数据
• 将自定义类传递给安全系统

实现员工公司类，并生成演示数据

　　为了实现登录，员工（Employee）需要继承PermissionPolicyUser类。公司（Company）与员工需要创建关联（association）。

　　员工（Employee）具体代码如下：

using DevExpress.Xpo;
using DevExpress.ExpressApp.DC;
using DevExpress.Persistent.Base;
using DevExpress.Persistent.BaseImpl.PermissionPolicy;
//……
    [DefaultClassOptions]
    [XafDefaultProperty("UserName"),XafDisplayName("员工")]
    public class Employee : PermissionPolicyUser
    {
        public Employee(Session session) : base(session) { }
        private Company company;
        [Association("Company-Employees")]
        [XafDisplayName("公司")]
        public Company Company
        {
            get { return company; }
            set { SetPropertyValue("Company", ref company, value); }
        }
}
//……

　　公司（Company）类具体代码：

using DevExpress.Xpo;
using DevExpress.ExpressApp.DC;
using DevExpress.Persistent.Base;
using DevExpress.Persistent.BaseImpl;
//……
    [DefaultClassOptions]
    [XafDisplayName("公司"),XafDefaultProperty("Name")]
    public class Company : BaseObject
    {
        public Company(Session session) : base(session) { }
        private string name;
        
        [XafDisplayName("名称")]
        public string Name
        {
            get { return name; }
            set { SetPropertyValue("Name", ref name, value); }
        }
        [Association("Company-Employees")]
        public XPCollection<Employee> Employees
        {
            get { return GetCollection<Employee>("Employees"); }
        }
    }
//……

　　接下来调用项目的模型编辑器，展开Views | CustomLogonParametersExample.Module.BusinessObjects节点，并找到员工（Employee）和公司（Company）的列表视图（ListView视图），将属性AllowNew设置为false。为了防止在这两个视图中创建新对象。

 　　为了方便验证，打开 BatabaseUpdate→Update.cs文件，添加验证数据。

using DevExpress.ExpressApp.Security;
using DevExpress.ExpressApp.Security.Strategy;
// ... 
public class Updater : ModuleUpdater {
    public Updater(IObjectSpace objectSpace, Version currentDBVersion) : base(objectSpace, currentDBVersion) { }
    public override void UpdateDatabaseAfterUpdateSchema() {
        base.UpdateDatabaseAfterUpdateSchema();
        PermissionPolicyRole administrativeRole = ObjectSpace.FindObject<PermissionPolicyRole>(
            new BinaryOperator("Name", SecurityStrategy.AdministratorRoleName));
        if (administrativeRole == null) {
            administrativeRole = ObjectSpace.CreateObject<PermissionPolicyRole>();
            administrativeRole.Name = SecurityStrategy.AdministratorRoleName;
            administrativeRole.IsAdministrative = true;
        }
        const string adminName = "Administrator";
        Employee administratorUser = ObjectSpace.FindObject<Employee>(
            new BinaryOperator("UserName", adminName));
        if (administratorUser == null) {
            administratorUser = ObjectSpace.CreateObject<Employee>();
            administratorUser.UserName = adminName;
            administratorUser.IsActive = true;
            administratorUser.SetPassword("");
            administratorUser.Roles.Add(administrativeRole);
        }
        PermissionPolicyRole userRole = ObjectSpace.FindObject<PermissionPolicyRole>(
            new BinaryOperator("Name", "User"));
        if (userRole == null) {
            userRole = ObjectSpace.CreateObject<PermissionPolicyRole>();
            userRole.Name = "User";
            userRole.AddTypePermission<Employee>(
                SecurityOperations.ReadOnlyAccess, SecurityPermissionState.Allow);
            userRole.AddTypePermission<Company>(
                SecurityOperations.ReadOnlyAccess, SecurityPermissionState.Allow);
        }
        if (ObjectSpace.FindObject<Company>(null) == null) {
            Company company1 = ObjectSpace.CreateObject<Company>();
            company1.Name = "Company 1";
            company1.Employees.Add(administratorUser);
            Employee user1 = ObjectSpace.CreateObject<Employee>();
            user1.UserName = "Sam";
            user1.SetPassword("");
            user1.Roles.Add(userRole);
            Employee user2 = ObjectSpace.CreateObject<Employee>();
            user2.UserName = "John";
            user2.SetPassword("");
            user2.Roles.Add(userRole);
            Company company2 = ObjectSpace.CreateObject<Company>();
            company2.Name = "Company 2";
            company2.Employees.Add(user1);
            company2.Employees.Add(user2);
        }
        ObjectSpace.CommitChanges();
    }
}

 创建参数类

　　在项目*.Modeule下添加参数类CustomLogonParameters。代码如下。

using System;
using System.ComponentModel;
using System.Runtime.Serialization;
using DevExpress.ExpressApp.DC;
using DevExpress.Persistent.Base;
using UserTest.Module.BusinessObjects;

//……
　　 [DomainComponent, Serializable]
    [System.ComponentModel.DisplayName("登录")]                       //登录标题
    public class CustomLogonParameters : INotifyPropertyChanged, ISerializable
    {
        #region 构造方法
        public CustomLogonParameters() { }

        //ISerializable,序列化
        public CustomLogonParameters(SerializationInfo info, StreamingContext context)
        {
            if (info.MemberCount > 0)
            {
                UserName = info.GetString("UserName");
                Password = info.GetString("Password");
            }
        }
        #endregion
        
        private Company company;                //公司
        private Employee employee;              //员工
        private string password;                //密码

        [ImmediatePostData]   //值应该尽快传递给绑定对象，但用户更改值时，允许强制更新
        [XafDisplayName("公司")]
        public Company Company
        {
            get { return company; }
            set
            {
                if (value == company) return;
                company = value;
                Employee = null;
                OnPropertyChanged("Company");
            }
        }
        [DataSourceProperty("Company.Employees")]
        [ImmediatePostData] //值应该尽快传递给绑定对象，但用户更改值时，允许强制更新
        [XafDisplayName("员工")]
        public Employee Employee
        {
            get { return employee; }
            set
            {
                if (Company == null) return;
                employee = value;
                if (employee != null)
                {
                    UserName = employee.UserName;
                }
                OnPropertyChanged("Employee");
            }
        }
        [Browsable(false)]                  //用户名在登录页面不显示    
        [XafDisplayName("用户名")]                 
        public String UserName { get; set; }
        [PasswordPropertyText(true)]  
        [XafDisplayName("密码")]
        public string Password
        {
            get { return password; }
            set
            {
                if (password == value){ return; }
                password = value;
            }
        }

        public event PropertyChangedEventHandler PropertyChanged;
        //属性更改时引发事件页面上能快速更改事件）
        private void OnPropertyChanged(string propertyName)
        {
            if (PropertyChanged != null)
            {
                PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
            }
        }       

        [System.Security.SecurityCritical]
        public void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            info.AddValue("UserName", UserName);
            info.AddValue("Password", Password);
        }
}
//……

　　注：在登录验证的时候，不能使用引用属性验证。因此，在方法中，根据公司、员工获取用户名（UserName），登录验证的时候使用用户名+密码验证。这就是为什么参数中需要加一个因此用户名的原因。

创建自定义登录认证类

　　创建类CustomAuthentication。为了实现自定义身份认证，需要继承AuthenticationBase。具体代码如下：

using System;
using DevExpress.ExpressApp;
using DevExpress.Data.Filtering;
using System.Collections.Generic;
using DevExpress.ExpressApp.Security;
using UserTest.Module.BusinessObjects;
//……

/// <summary>
    /// 自定义登录参数类
    /// </summary>
    public class CustomAuthentication : AuthenticationBase, IAuthenticationStandard
    {
        private CustomLogonParameters customLogonParameters;            //登录参数
        public CustomAuthentication()
        {
            customLogonParameters = new CustomLogonParameters();
        }
        /// <summary>
        /// 注销
        /// </summary>
        public override void Logoff()
        {
            base.Logoff();
            customLogonParameters = new CustomLogonParameters();
        }
        /// <summary>
        /// 重置登录参数
        /// </summary>
        public override void ClearSecuredLogonParameters()
        {
            customLogonParameters.Password = "";
            base.ClearSecuredLogonParameters();
        }
        /// <summary>
        /// 通过比较登录参数与数据库中用户对象的值，进行验证。
        /// 
        /// </summary>
        /// <param name="objectSpace">用户数据操作对象空间</param>
        /// <returns>经身份验证的用户</returns>
        public override object Authenticate(IObjectSpace objectSpace)
        {

            Employee employee = objectSpace.FindObject<Employee>(new BinaryOperator("UserName", customLogonParameters.UserName));
            if (employee == null)
            {
                throw new ArgumentNullException("Employee");
            }
            if (!employee.ComparePassword(customLogonParameters.Password))
            {
                throw new AuthenticationException(employee.UserName, "密码错误.");
            }
            return employee;
        }

        /// <summary>
        /// 初始化登录参数
        /// </summary>
        /// <param name="logonParameters">登录参数</param>
        public override void SetLogonParameters(object logonParameters)
        {
            this.customLogonParameters = (CustomLogonParameters)logonParameters;
        }

        /// <summary>
        /// 返回到要添加程序的应用列表
        /// </summary>
        /// <returns></returns>
        public override IList<Type> GetBusinessClasses()
        {
            return new Type[] { typeof(CustomLogonParameters) };
        }
        /// <summary>
        /// 指示登录过程是否是交互式的(通过登录对话框请求登录参数)
        /// </summary>
        public override bool AskLogonParametersViaUI
        {
            get { return true; }
        }

        /// <summary>
        /// 返回登录参数
        /// </summary>
        public override object LogonParameters
        {
            get { return customLogonParameters; }
        }
        /// <summary>
        /// 是否启用注销方法，继承AuthenticationBase
        /// </summary>
        public override bool IsLogoffEnabled
        {
            get { return true; }
        }
}

//……

 　　注：记得初始化方法LogonParameters。

让登录窗口下拉能显示数据

　　完成参数类和自定义登录认证类后，直接将自定义类传递给安全系统（后一步会介绍）。会发现下拉框无法获取到数据。

　　要使得下拉框能够获取到这些外部数据。我们需要为登录窗口提供对象空间和让登录窗口访问外部数据。

　　以Win版本为例，提供对象空间后，下拉时能够获取到数据，数据处于数据保护。

 　　让窗口访问外部数据（公司类型）以后，下拉时能够读取数据。

为登录窗口提供对象空间

Win版

　　打开Program.cs ,修改代码如下：

using CustomLogonParametersExample.Module;
using CustomLogonParametersExample.Module.BusinessObjects;
using DevExpress.ExpressApp;
// ... 
static class Program {
    // ... 
    static void Main() {
        // ... 
        winApplication.CreateCustomLogonWindowObjectSpace += 
        application_CreateCustomLogonWindowObjectSpace;
        winApplication.Setup();
        // ... 
    }
    private static void application_CreateCustomLogonWindowObjectSpace(object sender, 
    CreateCustomLogonWindowObjectSpaceEventArgs e) {
        e.ObjectSpace = ((XafApplication)sender).CreateObjectSpace(typeof(CustomLogonParameters));
        if (e.ObjectSpace is NonPersistentObjectSpace) {
            IObjectSpace objectSpaceCompany = ((XafApplication)sender).CreateObjectSpace(typeof(Company));
            ((NonPersistentObjectSpace)e.ObjectSpace).AdditionalObjectSpaces.Add(objectSpaceCompany);
        }
    }
}

 　　打开WinApplication.cs,修改代码如下：

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Win;
using DevExpress.ExpressApp.Xpo;
// ... 
public partial class CustomLogonParametersExampleWindowsFormsApplication : WinApplication {
    // ... 
    protected override void CreateDefaultObjectSpaceProvider(CreateCustomObjectSpaceProviderEventArgs args) {
        args.ObjectSpaceProviders.Add(new XPObjectSpaceProvider(args.ConnectionString, args.Connection, false));
        args.ObjectSpaceProviders.Add(new NonPersistentObjectSpaceProvider(TypesInfo, null));
    }
}

 Web版

　　Web代码如下：

using CustomLogonParametersExample.Module;
using CustomLogonParametersExample.Module.BusinessObjects;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Web;
// ... 
public class Global : System.Web.HttpApplication {
    // ... 
    protected void Session_Start(Object sender, EventArgs e) {
        // ... 
        WebApplication.Instance.CreateCustomLogonWindowObjectSpace += 
        application_CreateCustomLogonWindowObjectSpace;
        WebApplication.Instance.Setup();
        // ... 
    }
    private static void application_CreateCustomLogonWindowObjectSpace(object sender, 
    CreateCustomLogonWindowObjectSpaceEventArgs e) {
        e.ObjectSpace = ((XafApplication)sender).CreateObjectSpace(typeof(CustomLogonParameters));
        if (e.ObjectSpace is NonPersistentObjectSpace) {
            IObjectSpace objectSpaceCompany = ((XafApplication)sender).CreateObjectSpace(typeof(Company));
            ((NonPersistentObjectSpace)e.ObjectSpace).AdditionalObjectSpaces.Add(objectSpaceCompany);
        }
    }
}

using System;
using System.Collections.Generic;
using CustomLogonParametersExample.Module;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.DC;
using DevExpress.ExpressApp.Xpo;
using DevExpress.ExpressApp.Web;
// ... 
public partial class CustomLogonParametersExampleAspNetApplication : WebApplication {
    private static NonPersistentTypeInfoSource nonPersistentTypeInfoSource;
    // ... 
    protected override void CreateDefaultObjectSpaceProvider(CreateCustomObjectSpaceProviderEventArgs args) {
        args.ObjectSpaceProvider = 
        new XPObjectSpaceProvider(GetDataStoreProvider(args.ConnectionString, args.Connection), true);
        if (nonPersistentTypeInfoSource == null) {
            nonPersistentTypeInfoSource = new NonPersistentTypeInfoSource(TypesInfo, new List<Type>() 
               { typeof(CustomLogonParameters) });
        }
        args.ObjectSpaceProviders.Add(new NonPersistentObjectSpaceProvider(TypesInfo, 
        nonPersistentTypeInfoSource));
    }
}

 让登录窗口能够访问外部数据

　　为了能够让下拉框读取公司、员工数据。

　　Win版本，打开WinApplication.cs，代码如下。

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Win;
using DevExpress.ExpressApp.Security;
//……
public partial class UserTestWindowsFormsApplication : WinApplication {
//……
public UserTestWindowsFormsApplication() {
//……
//允许在登录窗口中访问公司、员工数据
            ((SecurityStrategy)Security).AnonymousAllowedTypes.Add(typeof(Company)); 
          ((SecurityStrategy)Security).AnonymousAllowedTypes.Add(typeof(Employee));
}
//……
}
//……

　　Web版本，打开WebApplication.cs，代码如下。

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Security;
using DevExpress.ExpressApp.Web;
// ... 
public partial class UserTestAspNetApplication: WebApplication {
    // ... 
    public UserTestAspNetApplication () {
        // ... 
//允许登录串口查看公司、员工数据
            ((SecurityStrategy)Security).AnonymousAllowedTypes.Add(typeof(Company));
            ((SecurityStrategy)Security).AnonymousAllowedTypes.Add(typeof(Employee));
    }
    // ... 
}

 将自定义类传递给安全系统

　　调用应用程序设计器。将SecurityStrategyComplex组件从工具箱拖到设计器的安全窗格上。然后，将您在与平台无关的模块中实现的CustomAuthentication组件放在同一个窗格中。

　　关注SecurityStrategyComplex组件。在Properties窗口中，设置SecurityStrategy。UserType员工。

 个人源码地址

　　百度网盘链接: https://pan.baidu.com/s/1atleFNZeqYqoiNtKfeErIA 提取码: 9fkf

参考网址

　　[1]https://documentation.devexpress.com/eXpressAppFramework/112982/Task-Based-Help/Security/How-to-Use-Custom-Logon-Parameters-and-Authentication