• Cmdlet开发与学习(三)


          5.流程或诊断信息输出,错误以及异常处理

          在使用PowerShell的过程中,如果cmdlet执行有输出结果,我们会在PS界面看到结果输出信息。如果cmdlet执行出现异常,那我们就会看到异常信息。接着我们就开始学习这些输出信息的实现。

          Cmdlet基类给我们提供了几种输出方法:WriteDebug, WriteError, WriteObject, WriteProcess, WriteVerbose, WriteWarning。

          WriteDebug:该方法是为cmdlet开发人员输出Debug信息的,用来诊断问题,问题排除的。

          WriteError:在cmdlet执行的过程中,可能会出现某些不影响整个命令执行的错误,比如删除指定文件夹里面的所有文件,一个文件的删除失败,是不会对整个cmdlet的执行结果产生影响的,但是既然是有错误,就需要输出出来,告知使用者错误信息。这个时候,就使用WriteError。

          WriteObject:cmdlet的执行需要输出,比如,查询指定文件夹里面所有的txt文件,使用WriteObject方法输出。

          WriteProcess:有时候一条cmdlet的执行是需要很长时间的,如果界面什么都没有,总会给使用者一种错误,命令hang住了。WriteProcess可以生成进度记录,类似进度条的效果,告知使用者当前命令正在执行。

          WriteVerbose:如果需要生成一般用户级别的信息,比如,告知使用者当前命令已经执行到哪一步,整个流程是怎样的,使用WriteVerbose。

          WriteWarning:生成Warning警告信息,但是默认情况下,警告信息输出是被抛弃了的。

          注意:以上输出仅能在方法BeginProcessing,ProcessRecord,EndProcessing中使用。如果在这3个方法之外使用,会抛出InvalidOperationException异常。

          下面我们使用WriteObject生成管道输出。

     1     [Cmdlet(VerbsCommon.Get,"SQLServerBackupFile")]
     2     public class GetSQLServerBackup : PSCmdlet
     3     {
     4         private string path;
     5 
     6         [Parameter]
     7         public string Path
     8         {
     9             get { return path; }
    10             set { path = value; }
    11         }
    12 
    13         protected override void ProcessRecord()
    14         {
    15             if (Directory.Exists(path))
    16             {
    17                 string[] files = Directory.GetFiles(path);
    18                 foreach (string itemFile in files)
    19                 {
    20                     FileInfo tempInfo = new FileInfo(itemFile);
    21                     if (tempInfo.Extension.Equals(".bak", StringComparison.OrdinalIgnoreCase))
    22                     {
    23                         WriteObject(tempInfo);
    24                     }
    25                 }
    26             }
    27         }
    28     }

          6.cmdlet帮助文档

          cmdlet开发最后一步,也是最重要的一步,就是编写帮助文档,这样客户可以通过get-help cmdlet很好地了解其用法。

          PowerShell已经提供了标准的帮助文档模板,因此,cmdlet开发人员只需要关注内容。

          7.PSSnapIn和Module

          PSSnapIn是PowerShell 1.0的产物,而Module是PowerShell 2.0才有的。当然,你也可以在PS 2.0中使用PSSnapIn。

          目前看来,Module应该是更受MS青睐,在之后的PS版本中,Module的功能越来越丰富。

          关于SnapIn和Module的使用,参考:http://technet.microsoft.com/en-us/library/dd745031(v=VS.85).aspx

          既然我们已经写好了Cmdlet命令,那么接着就是看看具体的效果了。

          简单的方法,是将我们的cmdlet dll导入进PS中。

          

  • 相关阅读:
    QEMU内存分析(四):ept页表构建
    virtio简介(二) —— virtioballoon guest侧驱动
    将数据库所有的表的字符集改为utf8
    windows 10 mysql 安装
    Windows10 安装MySQL详细教程2020版 亲测亲写
    发现了一个可以免费下载jar包的网站,所有jar包都有
    我的新书《Flink大数据分析实战》出版啦
    2022最新 Navicat Premium 16中文软件激活安装永久使用正版(支持MAC+win)
    Adobe全家桶PS、PR、AU等2022正版永久有效,无需破解直接安装就能用
    虚拟机问题:VMware Workstation 与 Device/Credential Guard 不兼容。在禁用 Device/Credential Guard 后,可以运行
  • 原文地址:https://www.cnblogs.com/ByronsHome/p/3721421.html
Copyright © 2020-2023  润新知