XAF框架学习方法

XAF框架概述

XAF（eXpressApp Framework）是DevExpress提供的一个企业级应用开发框架，专注于快速构建业务应用程序。它支持WinForms、ASP.NET Core Blazor和MAUI平台，通过模块化设计简化开发流程。XAF的核心优势在于自动生成UI、内置ORM（XPO）、权限管理等功能。

环境搭建与项目创建

安装DevExpress组件后，在Visual Studio中创建XAF项目：

# 使用DevExpress模板创建解决方案
dotnet new devexpress.xaf -n XAFDemo -f net6.0

配置连接字符串示例：

<!-- App.config -->
<connectionStrings>
  <add name="ConnectionString" connectionString="Integrated Security=SSPI;Pooling=false;Data Source=(localdb)\mssqllocaldb;Initial Catalog=XAFDemo" />
</connectionStrings>

业务对象建模

定义一个简单的客户模型：

[DefaultClassOptions]
public class Customer : BaseObject {
    public Customer(Session session) : base(session) { }
    
    private string _Name;
    public string Name {
        get { return _Name; }
        set { SetPropertyValue(nameof(Name), ref _Name, value); }
    }

    [Association("Customer-Orders")]
    public XPCollection<Order> Orders {
        get { return GetCollection<Order>(nameof(Orders)); }
    }
}

配套的订单模型：

public class Order : BaseObject {
    public Order(Session session) : base(session) { }
    
    private DateTime _OrderDate;
    public DateTime OrderDate {
        get { return _OrderDate; }
        set { SetPropertyValue(nameof(OrderDate), ref _OrderDate, value); }
    }

    private Customer _Customer;
    [Association("Customer-Orders")]
    public Customer Customer {
        get { return _Customer; }
        set { SetPropertyValue(nameof(Customer), ref _Customer, value); }
    }
}

UI定制技巧

列表视图列自定义：

[ListViewFindPanel(true)]
[ListViewAutoFilterRow(true)]
public class CustomerListViewAdapter : ViewController {
    protected override void OnViewControlsCreated() {
        base.OnViewControlsCreated();
        var listView = View as ListView;
        if(listView != null) {
            listView.Columns["Name"].Caption = "客户名称";
            listView.Columns["Name"].SortOrder = ColumnSortOrder.Ascending;
        }
    }
}

明细视图布局定制：

<!-- Model.DesignedDiffs.xafml -->
<Application UI="WinForms">
  <Views>
    <DetailView Id="Customer_DetailView">
      <Items>
        <PropertyEditor PropertyName="Name">
          <Caption Location="Top"/>
          <ControlSize Width="200"/>
        </PropertyEditor>
        <ListPropertyEditor PropertyName="Orders">
          <DataSourceCriteriaOperator>[OrderDate] >= LocalDateTimeToday()</DataSourceCriteriaOperator>
        </ListPropertyEditor>
      </Items>
    </DetailView>
  </Views>
</Application>

业务逻辑扩展

添加验证规则示例：

[RuleCriteria("CustomerNameRequired", DefaultContexts.Save, 
    "NOT IsNullOrEmpty([Name])", 
    "Name is required")]
public class Customer : BaseObject {
    // 原有代码...
}

自定义动作实现：

public class ExportCustomerAction : SimpleAction {
    public ExportCustomerAction() : base("Export", PredefinedCategory.Edit) { }
    
    protected override void OnExecute(ActionExecuteEventArgs e) {
        var objectSpace = Application.CreateObjectSpace(typeof(Customer));
        var customers = objectSpace.GetObjects<Customer>();
        
        using(var stream = new MemoryStream()) {
            new XlsxExportOptions().ExportToXlsx(stream, customers);
            // 保存处理...
        }
    }
}

模块开发实践

创建自定义模块：

[Tooltip("Custom reporting module")]
public sealed class ReportingModule : ModuleBase {
    public override void Setup(XafApplication application) {
        base.Setup(application);
        application.CreateCustomObjectSpaceProvider += (s, e) => {
            if(e.ObjectSpaceProvider == null)
                e.ObjectSpaceProvider = new XPObjectSpaceProvider(new ConnectionStringDataStoreProvider());
        };
    }
}

模块注册方法：

// Module.cs
protected override ModuleTypeList GetRequiredModuleTypesCore() {
    return new ModuleTypeList(
        typeof(DevExpress.ExpressApp.SystemModule.SystemModule),
        typeof(ReportingModule)
    );
}

部署与调试

WebAPI配置示例：

public class Startup {
    public void ConfigureServices(IServiceCollection services) {
        services.AddXafWebApi(Configuration, options => {
            options.BusinessObject<Customer>();
            options.EnableSwagger = true;
        });
    }
}

调试技巧：

// 在控制器中输出调试信息
protected override void OnActivated() {
    Debug.WriteLine($"Current View: {View.Id}");
    foreach(var item in View.Items) {
        Debug.WriteLine($"Control: {item.Id}");
    }
}

性能优化

数据加载优化示例：

using(var objectSpace = Application.CreateObjectSpace()) {
    var customers = objectSpace.GetObjects<Customer>(
        CriteriaOperator.Parse("Orders[OrderDate >= ?]", DateTime.Today),
        new CollectionCriteriaPatcher(),
        new InPlaceObjectSerializer()
    );
}

缓存策略设置：

<!-- Web.config -->
<caching>
  <outputCacheSettings>
    <outputCacheProfiles>
      <add name="XAFCache" duration="3600" varyByParam="*"/>
    </outputCacheProfiles>
  </outputCacheSettings>
</caching>

高级主题

动态权限控制实现：

public class CustomSecurityStrategy : SecurityStrategy {
    protected override bool CanExecuteOperation(
        object target, string operation, object[] parameters) {
        if(operation == "Delete" && target is Customer c) {
            return c.Orders.Count == 0;
        }
        return base.CExecuteOperation(target, operation, parameters);
    }
}

多语言支持配置：

protected override void SetupMultiLanguage() {
    base.SetupMultiLanguage();
    ResourceManager.RegisterResources(
        Assembly.GetExecutingAssembly(), 
        "XAFDemo.Resources"
    );
    Localization.Culture = new CultureInfo("zh-CN");
}

通过系统化的实践方法结合具体代码示例，开发者可以快速掌握XAF框架的核心功能。建议从基础业务对象建模开始，逐步扩展到UI定制和复杂业务逻辑的实现，最终掌握模块化开发和性能优化等高级技巧。