代码要恰如其分——记一次代码审查

代码要恰如其分，说的是只实现当前需要的功能，保留一定的可扩展性，但不要为了在很长一段时间内都不会发生的事情实现可扩展性。
不要预测将来，将来的新需求可以通过不断的重构来保持代码的健康和可扩展性。

下面是一个在WCF内部服务中实现的类，这个前提很重要，这是一个服务的内部实现，不是契约，是不需要对外发布的组件（不含服务契约，契约通过另外的组件发布）。

public static class PictureRecognizerFactory
    {
        private static PictureRecognizer[] m_Recognizers;
        private static object _oSync = new object();

        private static PictureRecognizer[] m_AllRecognizers
        {
            get
            {
                if (m_Recognizers == null)
                {
                    lock (_oSync)
                    {
                        if (m_Recognizers == null)
                        {
                            m_Recognizers = FindAllPictureRecognizer();
                        }
                    }
                }
                return m_Recognizers;
            }
        }

        /// <summary>
        /// 获取图片的类别
        /// </summary>
        /// <param name="picture"></param>
        /// <returns></returns>
        public static PictureType GetPictureType(Picture picture)
        {
            foreach (PictureRecognizer item in m_AllRecognizers)
            {
                PictureType type = item.Reconize(picture);
                if (type != PictureType.Unknown)
                    return type;
            }
            return PictureType.Unknown;

        }

        /// <summary>
        /// 寻找所有被标识了PictureRecognizerAttribute的类
        /// </summary>
        /// <returns></returns>
        private static PictureRecognizer[] FindAllPictureRecognizer()
        {
            Type[] typesWithRecognizer = GetTypesWithRecognizers();

            List<PictureRecognizer> list = new List<PictureRecognizer>();
            foreach (Type type in typesWithRecognizer)
            {
                list.Add((PictureRecognizer)type.Assembly.CreateInstance(type.FullName));
            }

            return list.ToArray();
        }

        /// <summary>
        /// 获取所有标记为RecognizerAttribute的类型
        /// </summary>
        /// <returns></returns>
        private static Type[] GetTypesWithRecognizers()
        {
            List<Type> typesRecognizers = new List<Type>();
            Assembly[] assemblies = AppDomain.CurrentDomain.GetAssemblies();
            foreach (Assembly ass in assemblies)
            {
                try
                {
                    Type[] types = ass.GetTypes();
                    foreach (Type type in types)
                    {
                        if (type.GetCustomAttributes(typeof(PictureRecognizerAttribute), true).Length > 0)
                        {
                            typesRecognizers.Add(type);
                        }

                    }
                }
                catch { }//如果在某个Assembly中加载不到类型，则不予理会，不处理异常
            }
            if (typesRecognizers.Count == 0)
                throw new Exception("找不到任何图像识别器");
            return typesRecognizers.ToArray();
        }
    }

这段代码有几个问题：

1、它通过AppDomain.CurrentDomain.GetAssemblies()来获取当前加载的所有程序集，也就是作者认为会有很多类被标记了PictureRecognizerAttribute。实际上，正如我们前提条件所说，PictureRecognizerAttribute是一个在非公开发布的服务组件中定义的类，它是属于服务的内部实现机制，在可以预见的将来都不需要发布给服务外部的类使用。因此，所有定义了PictureRecognizerAttribute的类都和PictureRecognizerAttribute在同一个程序集中。这点非常重要。

2、基于第一个前提，也就是说所有被标记为PictureRecognizerAttribute的类对PictureRecognizerFactory都是可见的，并且可能被标记为PictureRecognizerAttribute类数量非常少，因此通过New来实现是最简单、高效的。

3、实际上程序需要获取的是继承至PictureRecognizer的实现类，因此应该直接判断类型是否继承至PictureRecognizer，无需通过判断PictureRecognizerAttribute，引入一个无用的类。

重构以后的代码：

public static class PictureRecognizerFactory
    {
        static readonly PictureRecognizer[] _Recognizers = new PictureRecognizer[] 
        { 
            new PictureRecognizerImpl1(),
            new PictureRecognizerImpl2(),
        };

        /// <summary>
        /// 获取图片的类别
        /// </summary>
        /// <param name="picture"></param>
        /// <returns></returns>
        public static PictureType GetPictureType(Picture picture)
        {
            foreach (PictureRecognizer item in _Recognizers)
            {
                PictureType type = item.Reconize(picture);
                if (type != PictureType.Unknown)
                    return type;
            }
            return PictureType.Unknown;

        }
    }

 如果将来需要一定的开放程度，可以通过暴露内部集合来增加一定的扩展性，参考 Asp.Net MVC ViewEngines 类的实现。

不要对未来做过多（不是不要）的设想，保持代码的精简，增加代码的可读性、可维护性是软件开发过程中非常重要的一点。代码的行数越少，可能发生的Bug就越少，将来的维护（重构、扩展）难度就越低。

本篇文章不讨论类的命名，代码规范等问题，如有此类问题请忽略。: )