ArcObjects SDK开发 021 开发框架搭建-FrameWork包设计

1、框架引擎部分

引擎模块其实就是之前我们说的App-Command-Tool模块，通过这个模块，把系统的主干框架搭建起来。

其中大部分出现在菜单以及工具条上的按钮都会继承这个框架定义ICommand和ITool。整个系统也是通过整合一些列Comand和Tool的方式，把整个系统搭建出来，这点也可以通过我们系统的主窗体代码中看到。

2、常用Command和Tool

一些常用的工具，例如地图放大、缩小、平移等。这些工具要求定义能够被框架引擎识别，并且符合当前使用的UI风格。定义如下。

使用的时候，只需要一行代码即可。

this.UI_Tool_Bar.Items.Add(new BarCheckItemCommandUI(new FrameworkUI.MapTools.MapZoomInTool(this._MapApplication)));
this.UI_Tool_Bar.Items.Add(new BarCheckItemCommandUI(new FrameworkUI.MapTools.MapZoomOutTool(this._MapApplication)));
FrameworkUI.MapTools.MapPanTool myMapPanTool = new FrameworkUI.MapTools.MapPanTool(this._MapApplication);
this.UI_Tool_Bar.Items.Add(new BarCheckItemCommandUI(myMapPanTool));
this._MapApplication.MapPanTool = myMapPanTool;
this._MapApplication.CrruteTool = myMapPanTool;
this.UI_Tool_Bar.Items.Add(new BarButtonItemCommandUI(new FrameworkUI.MapTools.MapFullExtentCommand(this._MapApplication)));
this.UI_Tool_Bar.Items.Add(new BarButtonItemCommandUI(new FrameworkUI.MapTools.MapZoomInFixedCommand(this._MapApplication)));
this.UI_Tool_Bar.Items.Add(new BarButtonItemCommandUI(new FrameworkUI.MapTools.MapZoomOutFixedCommand(this._MapApplication)));
this.UI_Tool_Bar.Items.Add(new BarButtonItemCommandUI(new FrameworkUI.MapTools.MapZoomBackCommand(this._MapApplication)));
this.UI_Tool_Bar.Items.Add(new BarButtonItemCommandUI(new FrameworkUI.MapTools.MapZoomForwardCommand(this._MapApplication)));

3、通用模块部分

通用模块设计主要包括一些比较通用且核心的模块定义。目前我开发的GeoChem系统定义了三个模块。进度信息模块，Geoprocessor扩展模块和多语言支持模块。

能在Core里面出现的模块，要满足通用性以及核心性两点。我们以最简单的ProcessInfo为例，来说明这样的模块的特性。

配合这个ProcessInfo的是FrameworkUI里面定义的ProcessInfoDialog对话框，定义如下。

设计一，在ProcessInfoDialogHelper使用了一个新线程弹出进度对话框，在主线程进行运算的时候，进度条可以很顺畅的响应进度变化不会卡。

设计二，ProcessInfo定义了SubProcessInfo的概念，可以很好的和子函数衔接。例如一个模型计算，有5个步骤,A（10）、B（30）、C（60）、D（90）、E（100）。其中两个步骤比较复杂，其中B包含3个步骤，B1（20）、B2（80）、B3（100）。D包含了5个步骤，分别是和D1（20）、D2（40）、D3（60）、D4（80）、D5（100）。如何把B和D的计算进度反馈更方便的反馈给计算模型呢？

版本1，不关注B和D的细节了，进度到了A之后，进度条不在动了，只是更新上面的计算信息，等B计算完，一下跳到B该有的进度。D同理。

版本2，加入B是一个专门为本模型定义的一个函数，那么可以把ProcessInfo传入进去，直接设置B1的计算完值为14%，B2计算完之后，设置为26%，B3计算完设置为30%。假如D是一个通用的函数，除了该模块调用，其他模块也会调用，那么可以传ProcessInfo进入，然后再传起始进度值和结束进度值进度。例如调用D，传入ProcessInfo和60、90。计算完D1，设置进度之为60+（90-60）*20%，依次类推。

版本3，设计了SubProcess的概念。当模型调用B的时候，会调用主ProcessInfo，创建一个子ProcessInfo，并设置这个子ProcessInfo应该进度到何值。当子ProcessInfo进度值发生变化的时候，反馈给其父ProcessInfo，由父ProcessInfo计算自己应该前进多少进度。二接收子ProcessInfo的函数，还是设置进度从0-100即可。

调用代码如下。

使用子进度对象的函数定义如下。

public void Exe(ProcessInfo pProcessInfo)
{
    //获取栅格CellSize
    pProcessInfo.SetProcess(5, "Get cell size...");
    double myCellSize = GetRasterCellSize();

    //提取栅格数据的范围
    pProcessInfo.SetProcess(10, "Data Extent...");
    string myRasterDomainFile = this.GetRasterDomain();

    //平滑数据
    pProcessInfo.SetProcess(12, "Smooth Data...");
    string myRasterFilePath = this.SmoothData(this.RasterFilePath);

    //生成等值线
    pProcessInfo.SetProcess(20, "ContourList...");
    string myContourLineFile = this.CreateContourLine(myRasterFilePath);

    //调整等值线值的数据精度
    pProcessInfo.SetProcess(25, "Calculate CONTOUR field...");
    this.AdjustAccuracy(myContourLineFile);

    //平滑等值线
    pProcessInfo.SetProcess(30, "SmoothLine...");
    myContourLineFile = this.SmoothContourLine(myContourLineFile, myCellSize);

    //用栅格数据的范围裁切等值线
    pProcessInfo.SetProcess(35, "Clip Contour Line...");
    myContourLineFile = this.ClipContourLineByRasterDomain(myContourLineFile, myRasterDomainFile);

    //根据等值线，生成等值面
    pProcessInfo.SetProcess(40, "Create Contour Polygon");
    pProcessInfo.StartSubProcess(70);
    string myContourPolygonFile = this.GetContourPolygonFile(pProcessInfo.SubProcessInfo, myContourLineFile, myRasterDomainFile);
    pProcessInfo.EndSubProcess();

    //得到切割时使用的 Shape文件
    pProcessInfo.SetProcess(75, "Clip data...");
    this.ClipContourLineAndPolygon(myRasterDomainFile, ref myContourLineFile, ref myContourPolygonFile);

    //删除面积较为小的面
    pProcessInfo.SetProcess(88, "Eliminate Small Area...");
    this.ContourEliminate(ref myContourLineFile, ref myContourPolygonFile);

    //计算极值标注
    pProcessInfo.SetProcess(90, "Create Limite Value Point...");
    this.UpdateThresholdLabel(myContourPolygonFile);

    pProcessInfo.SetProcess(95, "Save Map Document...");
    this.SaveAsMxdFile(myContourLineFile, myContourPolygonFile);
    pProcessInfo.SetProcess(100, "Complete!");
}
使用子进度对象的函数定义如下。
private string GetContourPolygonFile(ProcessInfo pProcessInfo, string pContourLineFile, string pRasterDomainFile)
{
    var myContourPolygonCal = new ContourPCreator
    {
        ContourLineFilePath = pContourLineFile,
        ExtentFilePath = pRasterDomainFile,
        ResultPolygonFilePath = FilePathHelper.GetTempShapeFilePath()
    };
    myContourPolygonCal.Exe(pProcessInfo);
    return myContourPolygonCal.ResultPolygonFilePath;
}
ContourPCreator类的Exe函数定义如下。
public void Exe(ProcessInfo pProcessInfo)
{
    this._PolygonList.Clear();
    this._PolylineList.Clear();

    //把线转换成面
    pProcessInfo.SetProcess(0, "Feature To Polygon...");
    var myPolygonFilePath = FilePathHelper.GetTempShapeFilePath();
    var myFeatureToPolygon = new FeatureToPolygon()
    {
        in_features = this.ContourLineFilePath + ";" + this.ExtentFilePath,
        out_feature_class = myPolygonFilePath,
        cluster_tolerance = "0.001 Meters"
    };
    GPEx myGPEx = new GPEx();
    myGPEx.Execute(myFeatureToPolygon);

    //用栅格范围裁切面
    string myClipOutFilePath = FilePathHelper.GetTempShapeFilePath();
    pProcessInfo.SetProcess(10, "Clip...");
    var myClip = new ESRI.ArcGIS.AnalysisTools.Clip()
    {
        in_features = myPolygonFilePath,
        clip_features = this.ExtentFilePath,
        out_feature_class = myClipOutFilePath
    };
    myGPEx.Execute(myClip);

    //添加字段
    pProcessInfo.SetProcess(20, "Add Field...");
    var myAddField = new AddField
    {
        in_table = myClipOutFilePath,
        field_name = "Value",
        field_type = "DOUBLE"
    };
    myGPEx.ExecuteByGP(myAddField);

    //拷贝结果数据
    ShapeFileHelper.Copy(myClipOutFilePath, this.ResultPolygonFilePath);

    //读取面信息
    pProcessInfo.SetProcess(30, "Init ContourPolygon ...");
    this.LoadContourPolygonList();

    //分析面与面之间的临近关系
    pProcessInfo.SetProcess(40, "Polygon Neighbors ...");
    this.LoadContourPolygonRels();

    //读取等值线的值列表
    pProcessInfo.SetProcess(50, "Read Line Value ...");
    this.LoadContourPolylineList();

    //面与线 临近分析
    pProcessInfo.SetProcess(60, "Load Contour Polygon Line Rels ...");
    this.LoadContourPolygonLineRels();

    //计算等值面值,在此循环，主要是为了避免特殊情况，导致死循环
    pProcessInfo.SetProcess(70, "Cal Contour Polygon Value...");
    for (int i = 0; i < 100; i++)
    {
        int myUnCalCount = this.CalContourPolygonValue();
        if (myUnCalCount == 0)
        {
            break;
        }
    }

    //把计算的值写入该文件中
    pProcessInfo.SetProcess(90, "Write Value To Contour Polygon File...");
    this.WritePolygonValueToFeatureClass();

    //计算完成
    pProcessInfo.SetProcess(100, "Contour Polygon Cal Complete...");
}

因为ProcessInfo是非常核心一个类，使用范围非常广泛，如果把这个定义好了，会让系统非常清晰。这样的话，每个需要暴露进度的函数，值需要定义一个ProcessInfo参数传入进来即可，在函数内部进度从0开始，100结束，其他的都不需要关心了。

4、常用函数库

常用函数库，我一般会定义到Framework程序集的Helper目录下。如果是字段相关的会定义成FieldHelper，空间参考相关的会定义成SpatialReferenceHepler。并且里面大部分都是静态函数，方便直接调用。

在这些里面用的最多的就是FolderPathHelper、ShapeFileHelper、SpatialReferenceHepler以及FeatureClassHelper等。