C#編程模式之擴展命令

C#編程模式之擴展命令

前言

根據上一篇的命令模式和在工作中遇到的一些實際情況，有了本篇文章，時時都是學習的一個過程，會在這個過程中發現許多好的模式或者是一種開發方式，今天寫出來的就是我工作中常用到的，自己感覺這種方式很優雅很漂亮，就自己試着實現了一下，可能原框架中不是這樣的，有許多不足之處還請大家指點。

 

需求

我還不清楚這種方式是模式還是框架開發中用到的技術，我暫且叫它為命令控制器吧。

命令控制器的主要功能就是獲取用戶提供的命令，然后來執行命令。 在這里我把要執行的“命令”設計成一個函數，會對應着一個String類型的命令字符串，並且命令控制器是允許擴展的。

 

實現
首先我定義了一個屬性類，用於在擴展的命令類、或者命令函數上，只有一個CommandName屬性，作用於命令函數上的話，則代表命令名稱，如果是作用於類上面的話就代表命令類別的名稱，只是考慮可以作為一個分類，這部分在后面有講到，可以自定義實現。

    /// <summary>
    /// 命令所用代碼屬性類
    /// </summary>
    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
    public class CommandAttribute : Attribute
    {
        private string commandName = null;

        public string CommandName
        {
            get { return commandName; }
            set { commandName = value; }
        }

        public CommandAttribute(string CommandName)
        {
            commandName = CommandName;
        }
    }

有了這個屬性類了，我們就要把它用起來，定義一些后面要用到的命令示例類，

    /// <summary>
    /// 示例:命令類以及命令函數，亦可當作為擴展
    /// </summary>
    [Command("Test")]
    public class CommandTest : CommandMethod
    {
        [Command("MyCommandone")]
        public object test(ICommandParameter commandparameter)
        {
            return null;
        }

        [Command("MyCommandone1")]
        public object test1(ICommandParameter commandparameter)
        {
            return null;
        }

        [Command("MyCommandone2")]
        public object test2(ICommandParameter commandparameter)
        {
            return null;
        }


        [Command("MyCommandone3")]
        public object test3(ICommandParameter commandparameter)
        {
            return null;
        }

        [Command("MyCommandone4")]
        public object test4(ICommandParameter commandparameter)
        {
            return null;
        }
    }

上面的示例代碼中可以看到CommandTest類繼承自CommandMethod類，而類里面的一些函數的簽名也是一樣的，函數參數都為ICommandParameter接口類型，這就是擴展命令方法時要遵循的一些規范，定義的規范：

    /// <summary>
    /// 擴展命令函數的參數規范
    /// </summary>
    public interface ICommandParameter
    {

    }

    /// <summary>
    /// 擴展命令方法類基類
    /// </summary>
    public class CommandMethod
    {

    }

需要實現什么都是可以自定義，比如說可以在ICommandParameter接口中定義個object類型的名稱為ContainerObject的屬性，意思就是容器屬性，可以在后面調用命令時，傳入實例參數時設置容器屬性的值，可以設置為任何你想設置的值到里面，然后再在命令函數里使用它，也可以根據抽象定義實現一個參數上下文對象專門用於處理擴展命令的，看需要自定義吧。

然后就是書寫一個命令控制器的代碼了，它呢主要負責把客戶端注冊進來的類型做一些處理，比如說 判斷類型、反射類型獲取函數命令以及函數信息、把命令函數轉換成委托、維護命令列表等等一些簡單的功能,還用到了一個CommandMethodActionDelegate類型的委托：

    public delegate object CommandMethodActionDelegate(ICommandParameter commandParameter);
    
    public class CommandController
    {
        private static CommandController _Instance = null;

        public static CommandController Instance
        {
            get
            {
                if (_Instance == null)
                {
                    _Instance = new CommandController(HostDevelopment.Instance);
                }
                return _Instance;
            }
        }

        private HostDevelopment _CommandDevelopment = HostDevelopment.Instance;

        public CommandController(HostDevelopment commandDevelopment)
        {
            _CommandDevelopment = commandDevelopment;
        }

        private Dictionary<string, CommandMethodActionDelegate> commandlist = new Dictionary<string, CommandMethodActionDelegate>();


        private List<string> _commandNames = null;
        /// <summary>
        /// 命令名稱集合
        /// </summary>
        public List<string> CommandNames
        {
            get
            {
                if (_commandNames == null)
                {
                    GetCommandNames();
                }
                return _commandNames;
            }
        }

        private void GetCommandNames()
        {

            if (commandlist.Count > 0)
            {
                if (_commandNames == null)
                {
                    _commandNames = new List<string>();
                }
                foreach (string name in commandlist.Keys)
                {
                    _commandNames.Add(name);
                }
            }
        }

        public bool RegisterCommand(object instance)
        {
            Type t = instance.GetType();
            CommandAttribute cmdatt = (CommandAttribute)Attribute.GetCustomAttribute(t, typeof(CommandAttribute), false);
            if (cmdatt != null)
            {
                AddCommandToModel(instance);
                return true;
            }
            else { return false; }
        }

        private void AddCommandToModel(object instance)
        {
            Type t = instance.GetType();
            MethodInfo[] methods = t.GetMethods();
            foreach (MethodInfo methodinfo in methods)
            {
                CommandAttribute cmdatt = (CommandAttribute)Attribute.GetCustomAttribute(methodinfo, typeof(CommandAttribute), false);
                if (cmdatt != null)
                {

                    CommandMethodActionDelegate commanddelegate = (CommandMethodActionDelegate)Delegate.CreateDelegate(typeof(CommandMethodActionDelegate), instance, methodinfo.Name);
                    commandlist.Add(cmdatt.CommandName, commanddelegate);
                }

            }
        }


        internal object Execute(string commandName, ICommandParameter commandParameter)
        {
            if (commandName == null)
            {
                throw new ArgumentNullException("commandName");
            }
            if (!commandlist.ContainsKey(commandName))
            {
                return new ArgumentNullException("不包含的命令，命令無效");
            }
            CommandMethodActionDelegate cmdaction = commandlist[commandName];
            return cmdaction.Invoke(commandParameter);
        }
    }

在CommandController類型中，RegisterCommand()方法為注冊擴展命令到命令控制器，示例中的注冊方式為手動的傳入類型實例來注冊的，也可以把實現方式修改為在命令控制器啟動的時候獲取當前系統所有依賴項的程序集，獲取到所有符合類型規范的擴展命令類型，並且注冊到控制器中。

上面代碼中有說到的HostDevelopment類型，是我定義的一個宿主容器對象，用它來承載命令控制器，以及在這個系列的文章中，都是使用HostDevelopment來進行對控制器的承載，這是后話。現在來看一下HostDevelopment暫時的定義：

    public class HostDevelopment
    {
        private static HostDevelopment _commandDevelopment = null;

        public static HostDevelopment Instance
        {
            get
            {
                if (_commandDevelopment == null)
                {
                    _commandDevelopment = new HostDevelopment();
                }
                return _commandDevelopment;
            }
        }

        private static ServiceContainer _serviceContainer = new ServiceContainer();
         
        private void SetServiceContainer(Type t,object instance)
        { 
            if (instance == null)
            {
                throw new ArgumentNullException("instance");
            }
            _serviceContainer.AddService(t, instance);
        }

        private object GetServiceContainer(Type t)
        {
            return _serviceContainer.GetService(t);
        }

        public CommandController CommandController
        {
            get
            {
                return (CommandController)GetServiceContainer(typeof(CommandController));
            }
        }

        public void Start()
        {
            SetServiceContainer(typeof(CommandController), new CommandController(this));
        }

        public object Execute(string commandName, ICommandParameter commandParameter)
        {
           return  CommandController.Execute(commandName, commandParameter);
        }
    }

看了這些了，應該就大致的明白了，不過現在這樣的代碼還是測試不了的，因為缺少一些實體。定義一個默認實現的命令參數規范：

    public class CommandParameterCase:ICommandParameter
    {
        private string _StrText;

        public string StrText
        {
            get { return _StrText; }
            set { _StrText = value; }
        }
    }

然后再修改一下CommandTest類型中的第一個叫test的函數（對應的命令名稱為MyCommandone），函數名稱有點隨意，大家不要介意這些。

        [Command("MyCommandone")]
        public object test(ICommandParameter commandparameter)
        {
            if (commandparameter != null)
            {
                CommandParameterCase commandparametercase = commandparameter as CommandParameterCase;
                return commandparametercase.StrText;
            }
            else { return null; }
        }

這樣所需的都定義齊了。
我們再看一下調用代碼：

HostDevelopment.Instance.Start();
HostDevelopment.Instance.CommandController.RegisterCommand(new CommandTest());
var strtext = HostDevelopment.Instance.Execute("MyCommandone", new CommandParameterCase() { StrText = "test" });

對了隨便是打個斷點或者是輸出strtext都可以看到它的值。這里不作多的解釋了。

最后加上對象關系圖解吧，並不是什么標准的畫法，有助於理解就行了。

 END

 

 

作者：金源

出處：http://www.cnblogs.com/jin-yuan/

本文版權歸作者和博客園共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面