解析大型.NET ERP系统核心组件 查询设计器 报表设计器 窗体设计器 工作流设计器 任务计划设计器

企业管理软件包含一些公共的组件，这些基础的组件在每个新项目立项阶段就必须考虑。核心的稳定不变功能，方便系统开发与维护，也为系统二次开发提供了诸多便利。比如通用权限管理系统，通用附件管理，通用查询等组件，若是在项目开发前就准备好了这些组件，为项目如期交付提供了保证。

• 查询设计器 Query Designer  支持选择一个或多个数据库表，通过左右连接的方式构建查询结果，支持直接手写SQL语句设计查询，支持调用存储过程查询，支持用代码设计查询。
• 报表设计器 Report Designer 支持配置的方式生成报表参数对话框，支持报表多语言，支持报表参数设置与打印
• 窗体设计器 Form Designer 支持用户自定义界面控件的布局(Layout)和外观(Appearance)，支持用户修改界面控件的查找条件
• 工作流设计器 Workflow Designer 支持自定义流程，支持自定义消息通知，支持自定义事件，支持计划任务
• 任务计划设计器 Schedule Designer 支持计划任务

查询设计器 Query Designer

在系统维护过程中，不停的增加新的字段，一般不会立即重写系统现有的查询，但需要一种方式可以立即看到系统的更改，或者是系统现有的查询不能满足客户的需求，查询设计器就是为了解决系统查询功能的不足开发的。

我考虑到了以下几种查询的方式，简单介绍它们的实现方式供参考。

1 SQL语句  SQL Statements

假设客户的系统维护人员懂SQL语句，经过多年客户积累的系统，软件公司也有许多常用的查询语句，将这些查询语句放到一个查询功能中执行一下，即可获取数据。

参考下面的SqlDbx程序的例子，在系统中可以对这个界面进行简化，只保留输入SQL语句和显示查询结果的地方。

为了方便最终用户分析结果数据，系统需要提供对查询结果数据的导出(Microsoft Excel)，过滤，排序，分组等功能。

ERP系统将每个查询保存起来，下次用户只需要敲查询编号即可看到查询结果，并对结果数据进行操作。

2  图形化查询设计 GUI Query Design

如果用户不懂SQL语句，系统考虑提供一种图形化的方式供用户设计查询。记得10年前自己在学习SQL语句的时候，是非常期待有一个智能化的工具，可以让我选择要查询的数据表和字段，再设置数据表之间关联，最后就得到我需用的查询语句。系统参考了Access 的查询设计器，参考一下经典的Access的查询设计界面：

微软Office套件中Access的查询设计器经过多年的发展，应该是有足够的理由相信这个界面是最容易让非IT人士接受的查询设计界面。只需要用鼠标选一下要查询的表，再选择要显示的字段，系统自动产生相应的SQL语句。

图纸化查询设计这种功能会经常出现在报表设计器中，报表设计器一般都会附加一个图形化的查询设计工具，我们可以在那里找到它的界面原型，经过简化后变成ERP系统的查询设计工具。

3  存储过程查询 Query By Stored Procedure

如果SQL语句或是表关联也不能满足数据的查询要求，系统可以考虑增加存储过程支持，以满足更复杂的查询需求。在ERP的财务报表中，各种财务统计报表的确相当的繁琐，非用存储过程不可。我们需要考虑好，如何将参数传递到存储过程中，显示存储过程的返回结果就可满足这种需求。为此，设计如下的查询语句：

EXEC  spRpt_OrderAmtTotal  %1, %2   

存储过程的后面两个参数是占位符号，表示需要给此存储过程传递参数。于是，还需要设计一种参数映射，设定参数的类型，长度，运行此查询时，将用户输入的值替换到上面的两个占位置符中，传递到存储过程中。

存储过程的定义已经定义它的参数类型，系统运行查询时，系统需要将上面的%1的值所代表的值转换成存储过程需要的参数类型，比如上图中的%1 所代表的Date From，系统需要用户的输入值进行强制类型转换为日期时间类型，再传递到存储过程中获取返回结果。

4 程序查询 Query By Program

用程序代码写查询可以分为二种情况，单据查询，列表查询。单据查询只需要继承原有的单据编辑窗体，设置窗体不可编辑，这样就完成了单据查询。列表查询是指需要用户输入一种或几种过滤条件，根据过滤条件得到查询结果。

单据查询的代码非常简单，只是重设几个属性即可，参考下面的代码例子。

public partial class SalesContractEnquiry : Foundation.Sales.Entry.SalesContractEntry
{
        public CostSheetEnquiry()
        {
              InitializeComponent();

              this.SupportAdd = false;
              this.SupportDelete = false;
              this.SupportEdit = false;
        }

程序代码中禁用了单据的新增，删除，编辑操作，这样单据窗体变也了查询窗体。

列表查询的界面参考如下，界面中上方是过滤条件输入控件，下面显示查询结果。对查询结果可以导出Excel，过滤，分组，或是以图表的方式呈现查询结果。

报表设计器 Report Designer

报表设计器分二个组件，一个是报表设计，另一个是报表显示，前者是design，后者是render。市面上有许多报表设计工具，我比较熟悉是的水晶报表(Crystal Report)和报表服务(SQL Server Reporting Services)。刚毕业那时还接触到开源的报表设计器RDLC Designer，是微软报表服务的一个开源实现。工作中接触水晶报表的时间比较多，我的技术总监写的一个水晶报表查看器，全是反射调用做成的报表查看器，不依赖于水晶报表的版本，发现水晶报表对.NET的支持相当稳定，从Crystal Report for Visual Studio 2008 runtime到现在的Crystal Report 13.10，几乎没有改动代码就可以完美的运行技术总监的代码，水晶报表是.NET报表制作的工业标准。

能力有限，实在没有精力去维护一份报表设计器代码，报表设计选用SAP的水晶报表设计器，这个工具有很多年没有更新，目前能找到的最新版本是Crystal Report 200 SP2。

所以这一部分的内容测重于报表呈现(Render)，力求设计一个完美的报表阅读器。作为核心功能，列出如下需求：

• 报表设计完成后，不需要.NET编程即可调用报表，主要的困难在于参数传递。
• 报表支持多语言，也就是支持英语，简体，繁体三种语言显示报表。
• 报表部署方便，只需要安装一个Crystal Report runtime就可以运行报表。
• 报表定制容易，用户既可以用系统提供的标准报表，也可用定制修改报表。

1  参数传递 Dynamic Parameter

水晶报表分三种类型的参数，通过调节这三个数值来改变水晶报表的数据。定义以下枚举：

public enum ReportFieldType
{
        [DisplayText("Selection Formula"), StringValue("0")]
        SelectionFormula = 0,

        [DisplayText("Formula Field"), StringValue("1") ]
        FormulaField = 1,

        [DisplayText("Parameter"), StringValue("2")]
        Parameter = 2
}

以上三种种方式的定义，与下面的水晶报表截图可以更清楚的了解它们的含义：

0 表示表记录选择条件，1 表示公式，2表示参数。 通过这三种方式，可以定义如下表结构：

运行报表时，先根据上面的参数表生成控件，获取控件的值，传递到水晶报表中，即完成了参数传递。

这样开发的好处是技术支持人员可独立制作和开发报表，不需要开发部专门为每个界面开发参数选择界面。

2 多语言 Localization

如何只设计一份报表，却可以让它同时以三种本地化语言显示报表。经历了以下几种方案演化。

1)  定义一个LanguageCode的公式或参数，运行时由系统传入到报表中来，表示当前要显示的语言。水晶报表中每个文字标签都用公式表示，公式Ccy的例子参考如下：

if  LanguageCode=1 then "Currency"
else if LanguageCode=2 then “貨幣”
else   "货币"

从公式中可以看到，1表示英语，2表示繁体中文，其它的数字表示简体中文。这样根据传入的LanguageCode的值，来显示文本标签的值，实现了报表多语言显示。

2) 使用.NET Localization方案，定义三种资源文件，分别是Resource.en-us.resx,Resource.zh-cn.resx,Resource.zh-tw.resx，编译这个程序集后会生成三个带语言标识的子程序集，.NET运行时会根据语言查找相应的资源文件，调用语言配对的资源。关键的代码调用如下所示：

System.Threading.Thread.CurrentThread.CurrentUICulture = CultureInfo.CreateSpecificCulture(cultureName);
System.Threading.Thread.CurrentThread.CurrentCulture = new CultureInfo(cultureName);

3)  翻译水晶报表控件TextObject

这个方法是借助于水晶报表.NET API，找到水晶报表中需要翻译的对象，一般是TextObject，将它翻译成对应的本地化语言再显示，这种方案深受报表开发人员喜爱，开发报表时只需要按照标准英文版的做法，当需要显示为其它语言时，自动转化为本地化语言。可参考下面的代码片段以加深了解。

IEnumerator reportObjectEnumerator = (IEnumerator)ReflectionHelper.InvokeMethod(reportObjects, "GetEnumerator");

                while (reportObjectEnumerator.MoveNext())
                {
                    try
                    {
                        object reportObject = reportObjectEnumerator.Current;
                        object objectKind = ReflectionHelper.GetPropertyValue(reportObject, "Kind");
                        string objectKindName = Enum.GetName(objectKind.GetType(), objectKind);

                        if (string.CompareOrdinal(objectKindName, "TextObject") == 0 || string.CompareOrdinal(objectKindName, "FieldHeadingObject") == 0)
                        {
                            string text = (string)ReflectionHelper.GetPropertyValue(reportObject, "Text");
                            if (!string.IsNullOrEmpty(text))
                            {
                                string translatedText = ComponentCommon.TranslateText(text, false);
                                if (string.CompareOrdinal(text, translatedText) != 0)
                                    ReflectionHelper.SetPropertyValue(reportObject, "Text", translatedText);
                            }
                        }
                    }
                    catch
                    {
                    }
                }

反射调用一个对象要实现foreach的效果，需要调用GetEnumerator方法。

3 部署 Deployment

写一个水晶报表运行库的检测程序，它可以检测安装的水晶报表的版本。水晶报表控件全部用反射方法调用，参考下面的代码例子，这样就实现了编译时不依赖于水晶报表版本的效果，部署时更加灵活方便。

 ReflectionHelper.SetPropertyValue(this._crystalReportViewer, "ReportSource", this._report);
 ReflectionHelper.InvokeMethod(this._crystalReportViewer, "Update");
 ReflectionHelper.InvokeMethod(this._crystalReportViewer, "Zoom", new System.Type[] { typeof(int) }, new object[] { 1 });
 ReflectionHelper.InvokeMethod(this._crystalReportViewer, "Zoom", new System.Type[] { typeof(int) }, new object[] { this._zoomFactor });
              

4  报表定制

引入一个替代报表(Alternate report)的概念，将标准报表嵌入到程序集或放置在标准报表目录中，系统也支持一个替代报表的路径选项，系统读取报表时优先查找替代报表路径中的报表文件，找到则用替代报表显示，否则继续在标准报表路径中查找报表。因为两种报表放置在不同的路径中，所以相同的报表文件也不会相互影响和覆盖，解决了客户定制报表与系统报表取舍的难题。替代(Alternate)的概念还用在物料清单的替代物料中，生产发料时当物料不够发料，可以去查找替代物料发料，好比我们口渴了可以喝汽水，也可以选择喝凉茶。

窗体设计器 Form Designer

窗体设计器在ERP/MIS领域应用的相当广泛，Visual Studio本身就是一个设计精良的窗体设计器。金蝶ERP的BOS系统全部依赖于它的窗体设计器，在此基础上做数据绑定和插件开发。微软的InfoPath也是一个自定义表单工作，常用来做OA系统的自定义表单。刚毕业那会也非常喜欢研究form designer re-host技术，可惜一直没有找到技术突破点，也不知道这样的设计是否合理。曾经接触过《像搭积木一样做软件》这本书，全书讲解的就是以窗体设计器为基础，做表达式求值，做事件绑定和属性绑定，不需要编码而开发企业管理软件。

然而这种美好的技术终究是一种幻觉，Visual Studio 仍旧是最流行的开发工具，窗体开发仍旧是企业管理软件开发的重点。窗体设计器所产生的代码，只有一小部分间接的用途。我没有深入接触这个主题，但就我所知道的知识点列举如下。

1 窗体设计器可以生成CS/VB/Xml 三种代码格式。NET动态编译技术已经很成熟，直接调用.NET API就可以将CS/VB代码编译为程序集，在这里我选择第三种格式，我并不需要用窗体设计器完全开发一个新功能，那样涉及到数据绑定，主从数据等一系列难题，我只需要设计器产生Xml格式，运行时我可以优先加载这个自定义布局，所以Xml格式足矣。

2 要设计的窗体对象是现有的系统功能。用户可能要修改界面控件的布局或是外观。实施过程中，看到很多客户喜欢将控件标成红色或蓝色以加快阅读速度，然而当满屏幕都是花花绿绿的控件，反而会降低阅读理解的速度。另一个就是控件的布局，一些用户不需要的选项卡，控件可以通过窗体设计器隐藏。

3 窗体设计器最重要的地方是可以修改界面控件的查找。参考下图。

窗体设计器可以修改Customer No中查找按钮的过滤条件，这一重要的功能大大减轻了开发人员的负担。

4  窗体设计器不可以用来完全重新开发一个新功能，从界面设计到数据绑定，再到数据验证，以及数据之间的勾稽

引用，这些功能的实现不可能通过鼠标拖放控件就完成。即使通过大量的二次开发，像金蝶那样做成BOS，它的可扩展性和灵活性仍那以控制。比如单价 * 数量=金额，要做到输入单价或数量时，自动计算金额。BOS要考虑的内容项太多，我终究是彻底放弃这种开发模式，只用到窗体设计器的一小部分功能：控件外观与布局修改，控件查找定制。

工作流设计器  Workflow Designer

工作流实现的四大基础功能：通知提醒，批核，计划任务，调用自定义代码。

为了实现这个目标，基于微软的.NET WF，做了以下工作以达到上述目的。

1  定义活动库 Activities

活动是工作流中的代码执行单元，一个工作流定义本身也是一个活动。根据业务需要，定义了如下活动库：

文档批核活动，发送消息活动，发送邮件活动，调用.NET 代码活动，执行数据库查询活动，报表生成活动。

2 定义工作流类型 Workflow

根据业务的需要，定义以下几种业务类型：

单据类：单据保存，单据更新，单据删除，单据新建。

业务类：文档送审，文档批核，业务过帐，业务完成，业务取消。

任务计划：在预定时间执行工作流

3 工作流设计器 Workflow Designer Rehost

MSDN 中提供了rehost工作流设计器的例子，直接把它拿来参考，添加自定义活动组件和自定义工作流类型，再将工作流设计器输出格式保存为XOML，即可完成工作流设计器的绝大部分功能。

这里比较复杂的一点是自定义条件表达式，需要一个与对象表达式求值工具。Code Project中有许多条件表达式的例子，难点在于如何将业务单据的状态与工作流挂接。

4 工作流监控器 Workflow Monitor

系统需要一个可视化的工具查看每个流程当前正在运行的结点，MSDN中有例子可参考。

5 工作流持久化 Workfllow Persistence

.NET提供的基础服务，创建一个工作流状态保存数据库和一个工作流跟踪数据库。

6  工作流服务器 Workflow Server

工作流与系统业务部分的交互，专门开一个独立的端口用于数据的读写。

任务计划设计器 Schedule Designer

企业应用中的作业调度，常见的操作如下：邮件提醒和告警，执行文件传输操作，创建复杂报表。

系统分为两种计划任务调度器，一种是基于SQL Server Agent实现，定时执行SQL语句，另一种是基于Quartz框架库实现，用.NET代码开发任务调度程序。

1 基于SQL Server Agent

SQL Server Job是一个定期执行脚本的对象，给它加一个时间选项即可完成基于SQL Server Agent的计划调度程序。

这个界面会依据控件值的不同，生成不同参数的SQL Server Job，参考下面的程序代码片段：

 private void btnOk_Click(object sender, EventArgs e)
        {
            if (Schedule == null)
                Schedule = new SQLschedule();

            Schedule.name = txtName.Text.Trim();
            if (chkEnabled.Checked)
                Schedule.enabled = 1;
            else
                Schedule.enabled = 0;

            if (cmbScheduleType.SelectedIndex == 1)
            {
                Schedule.freq_type = 1; // One-time
                Schedule.active_start_date = dtOneTimeOccurDate.Value;
                Schedule.active_end_date = new DateTime(9999, 12, 31);
                Schedule.active_start_time = dtOneTimeOccurTime.Value;
                Schedule.active_end_time = new DateTime(2000, 1, 1, 23, 59, 59);
            }
            else
            {
                if (cmbFrequencyOccurs.SelectedIndex == 0)
                {
                    Schedule.freq_type = 4; // Daily
                    Schedule.freq_interval = (int) numFrequencyRecurs.Value;
                }

                if (cmbFrequencyOccurs.SelectedIndex == 1)
                {
                    Schedule.freq_type = 8; // Weekly
                    int freq_interval = 0;
                    if (chkFrequencyRecursSun.Checked)
                        freq_interval += 1;
                    if (chkFrequencyRecursMon.Checked)
                        freq_interval += 2;
                    if (chkFrequencyRecursTue.Checked)
                        freq_interval += 4;
  

这个工具来源于Code Project上的一篇文章，可以用SQL Agent Job Editor尝试找到它。

2  Quartz.NET 任务调度框架

这是由Java项目转化过来的著名项目，用.NET代码重定了它的逻辑。看一个最简单的任务计划的源代码。

public class HelloJob : IJob
{

        private static ILog _log = LogManager.GetLogger(typeof(HelloJob));

        public HelloJob()
        {
        }

        public virtual void  Execute(IJobExecutionContext context)
        {
            // Say Hello to the World and display the date/time
            _log.Info(string.Format("Hello World! - {0}", System.DateTime.Now.ToString("r")));
        }

}

Quartz.NET处理好了关于任务计划调度方面的各个细节，很容易上手，官方提供的例子也相当丰富。