你的位置:首页 > ASP.net教程

[ASP.net教程]UWP 开发: 妙用自定义 Action 以简化并重用代码


    相信每一个 App 开发者,在开发过程中,都会有一些代码被反复用到,比如:复制文本,打电话,发短信,发邮件,给应用添加评论等等。在项目之间复制这些代码段,实在不是一个好办法,所以大家可能会把这些代码放到一个类似 Utility 类中,或者一个库(Class Library)中。本文也是帮你完成同样的事情,不过本文是通过 Action 来完成。这两种方法的目的相同,区别是前者尽管实现了代码段封装,还是需要写代码(通常在 ViewModel 中)来调用,而后者,则只要在 XAML 上添加几行代码即可。相比而言,后者要更为方便一些。

    这里的 Action 是来自 Behaviors SDK 里的概念,其实就是一个实现了 IAction 接口的类。我在本文不会介绍关于 Behaviors SDK 的基本知识,如果你对于它还不够了解,可以在园子里搜索一下相关文章,加以学习(在本文最后的参考文章处,我已经列了一篇比较不错的文章)。

    本质上, Action 与 Behavior 有着相同的目的,它们都是可以重用的一段代码。在它所实现的 IAction 接口中,定义了一个 Execute 方法,这个方法会在满足条件时被执行,条件可能是控件的事件被触发,或者属性发生改变等等。在 Execute 方法中,我们可以调用那些能完成我们想要的任务的方法。

    为了完成前面所述的需求,我们首先新建一个 UWP 项目并为其添加 Behavior SDK 引用(这个项目主要是为测试后面创建的 Action)。

    新建一个名为 CommonTaskAction 的类,此类实现了 IAction 接口,并且我们使它继承自 DependencyObject 类,这样我们可以为它定义依赖属性,以实现在 XAML 中可通过 Binding 向其赋值。如下:

public class CommonTaskAction : DependencyObject, IAction{
        public object Execute(object sender, object parameter)
        {
}}

    然后,定义一个枚举,用来表达常见任务类型,如下:

  public enum CommonTaskType  {    /// <summary>    /// 复制文本    /// </summary>    CopyText,    /// <summary>    /// 打电话    /// </summary>    MakePhoneCall,  }

    接着,为 CommonTaskAction 类添加几个依赖属性:TaskType(任务类型),TextToBeCopied(待复制的文本),PhoneNO(电话号码),PhoneDisplayName(打电话时的显示名称),如下:

    public static readonly DependencyProperty PhoneDisplayNameProperty =      DependencyProperty.Register("PhoneDisplayName", typeof(string), typeof(CommonTaskAction), new PropertyMetadata(string.Empty));        public static readonly DependencyProperty PhoneNOProperty =      DependencyProperty.Register("PhoneNO", typeof(string), typeof(CommonTaskAction), new PropertyMetadata(string.Empty));        public static readonly DependencyProperty TaskTypeProperty =      DependencyProperty.Register("TaskType", typeof(CommonTaskType), typeof(CommonTaskAction), new PropertyMetadata(0));        public static readonly DependencyProperty TextToBeCopiedProperty =      DependencyProperty.Register("TextToBeCopied", typeof(string), typeof(CommonTaskAction), new PropertyMetadata(string.Empty));    public string PhoneDisplayName    {      get { return (string)GetValue(PhoneDisplayNameProperty); }      set { SetValue(PhoneDisplayNameProperty, value); }    }    public string PhoneNO    {      get { return (string)GetValue(PhoneNOProperty); }      set { SetValue(PhoneNOProperty, value); }    }    public CommonTaskType TaskType    {      get { return (CommonTaskType)GetValue(TaskTypeProperty); }      set { SetValue(TaskTypeProperty, value); }    }    public string TextToBeCopied    {      get { return (string)GetValue(TextToBeCopiedProperty); }      set { SetValue(TextToBeCopiedProperty, value); }    }

    这时,在 Execute 方法中来完成主要逻辑,添加如下代码:

    public object Execute(object sender, object parameter)    {      switch (TaskType)      {        case CommonTaskType.CopyText:          if (!string.IsNullOrWhiteSpace(TextToBeCopied))          {            // 复制文本            DataPackage dataPackage = new DataPackage            {              RequestedOperation = DataPackageOperation.Copy,            };            dataPackage.SetText(TextToBeCopied);            Clipboard.SetContent(dataPackage);          }          break;        case CommonTaskType.MakePhoneCall:          if (!string.IsNullOrWhiteSpace(PhoneNO))          {            // 打电话            Windows.ApplicationModel.Calls.PhoneCallManager.ShowPhoneCallUI(PhoneNO, PhoneDisplayName);          }          break;      }      return true;    }

     这样,一个自定义的 Action 就完成了,它目前只添加复制文本、打电话的逻辑,你可以根据自己的需求来添加其它的逻辑。
    接下来,我们来看如何使用它。在 MainPage.xaml 中添加如下代码,即可:

<Page ...   ="using:Microsoft.Xaml.Interactions.Core"   ="using:Microsoft.Xaml.Interactivity"   ="using:CustomActionTest.Actions"

 

 <Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">    <Grid Margin="12">      <Grid.RowDefinitions>        <RowDefinition Height="Auto" />        <RowDefinition Height="Auto" />      </Grid.RowDefinitions>      <TextBlock Style="{ThemeResource TitleTextBlockStyle}" Text="CommonTaskAction 测试" />      <StackPanel Grid.Row="1" Orientation="Horizontal">        <TextBox x:Name="txtName"             Width="400"             Text="这里是测试文本" />        <Button Content="复制">          <Interactivity:Interaction.Behaviors>            <Core:EventTriggerBehavior EventName="Tapped">              <MyAction:CommonTaskAction TaskType="CopyText" TextToBeCopied="{Binding Text, ElementName=txtName}" />            </Core:EventTriggerBehavior>          </Interactivity:Interaction.Behaviors>        </Button>      </StackPanel>      <!-- 另外一个 MakePhoneCall 就不在这里测试了,可自行测试,用法如下: -->      <!--<MyAction:CommonTaskAction TaskType="MakePhoneCall" PhoneNO="13800XXXXXX" PhoneDisplayName="联系人姓名" />-->    </Grid>  </Grid>

    注意其中的 TaskType,值表达复制文本, TextToBeCopied,通过绑定,它获取到文本框的值。因而,这个 Action 就可以完成指定的任务。

    理解了本文的思路,现在,你就可以把它改造成适合你的 CommonTaskAction。

    如果你有更好的建议或意见,请留言互相交流。

源码下载

 

参考文章:

Windows通用应用开发手记-Behavior SDK概述

Behaviors SDK