[原创]通过Attribute完成中文智能提示

前言

  Attribute作为”特性”，可运用的范围是很广的，而且运用的场景也是非常的灵活。Attribute在MSDN中是这样解释的(有删减)：

Attribute 类将预定义的系统信息或用户定义的自定义信息与目标元素相关联。目标元素可以是程序集、类、构造函数、委托、枚举、事件、字段、接口、方法、可移植可执行文件模块、参数、属性 (Property)、返回值、结构或其他属性 (Attribute)。 

所有属性类型都直接或间接地从 Attribute 类派生。属性可应用于任何目标元素；多个属性可应用于同一目标元素；并且属性可由从目标元素派生的元素继承。 

 

  如果在实际场景中使用Attribute呢？可以看到，在很多的组件编写时，会在属性前面加上一些特定的Attribute，之后就可以在设计界面的属性设计器中看到。

场景

 

  在一些大型的桌面系统开发中，会重构出很多的基础控件。这些强大的基础控件，进而构造出非常复杂的画面，实际上这些画面也有很多的共性，所以又会抽出基础Form进行继承开发，减少开发业务的复杂度，提高了开发人员的开发效率。

而在一般的大型项目中，会有专门的一块业务，作为”系统管理员”操作的部分。实际上这些”系统管理员”对编程和系统一窍不通，但是他们明白式样，明白简单的逻辑。所以为了提供给他们很好的去操作画面上的控件。提供了一个功能，就是在管理画面将这些控件用中文的形式显示出来，并且属性的访问也用中文的形式，这样他们就可以写出简单的逻辑去管理和维护业务画面。在这里我们就用到了Attribute的强大功能，去完成这个操作。比如：当前台画面上有检索部分和结果显示部分，这部分需要动态进行SQL拼接=>

姓名.文字 != ‘’
{
      AND sql1
}

姓名.文字 == ‘’
{
      AND sql2
}

实例

  首先，我们需要创建一个SomeClassCNAttribute和一个SomePropertyCNAttribute类，用以对开发的控件进行说明，他们都继承于Attribute:

 

public class SomeClassCNAttribute : Attribute
    {
        private string _name;

        public string Name
        {
            get { return _name; }
            set { _name = value; }
        }
        public SomeClassCNAttribute(string strName)
        {
            _name = strName;
        }
    }

public  class SomePropertyCNAttribute : Attribute
    {
        private string _name;

        public string Name
        {
            get { return _name; }
            set { _name = value; }
        }
       public SomePropertyCNAttribute(string strName)
       {
           _name = strName;
       }
    }

这两个属性是准备用来对说明类库用途的。如：
[SomeClassCN("基本信息1")]
    public class SomePropertyCopy
    {
        private string strRealName;
        [SomePropertyCN("姓名")]
        public string StrRealName
        {
            get { return strRealName; }
            set { strRealName = value; }
        }
        private string strSex;
        [SomePropertyCN("性别")]
        public string StrSex
        {
            get { return strSex; }
            set { strSex = value; }
        }
        private string strEmail;
        [SomePropertyCN("邮件")]
        public string StrEmail
        {
            get { return strEmail; }
            set { strEmail = value; }
        }

        public SomePropertyCopy() { }

        public SomePropertyCopy(string name, string sex, string email)
        {
            strRealName = name;
            strSex = sex;
            strEmail = email;
        }
    }

  该类可以通过定义一个FCNExpression类库来读取中英文名并存入字典

 

  根据类来创建一个关于属性与方法的对应中英文的字典,每个类都看作一个树，树下有属性和方法名。

/// <summary>
    /// 单位类,读取后存入表达库
    /// </summary>
    public class FCNExpression
    {
        #region 字段定义
        private Type _type;
        #endregion

        #region 构造函数
        protected FCNExpression() { }

        public FCNExpression(object objTarget)
            : this(objTarget.GetType())
        {

        }

        public FCNExpression(Type type)
            : this()
        {
            _type = type;
        }
        #endregion

        #region 属性定义
        private List<ExpressionItem> _innerExpressions = null;
        /// <summary>
        /// 内部字典
        /// </summary>
        public List<ExpressionItem> InnerExpressions
        {
            get
            {
                if (_innerExpressions == null)
                {
                    _innerExpressions = GetSomePropertyAttributesDirecs(_type);
                }
                return _innerExpressions;
            }
        }
        /// <summary>
        /// 中文类名
        /// </summary>
        public string ClassCNName
        {
            get
            {
                if (_type.IsDefined(typeof(SomeClassCNAttribute), false))
                {
                    SomeClassCNAttribute sccna =
                        Attribute.GetCustomAttribute(_type, typeof(SomeClassCNAttribute)) as SomeClassCNAttribute;
                    return sccna.Name;
                }
                return string.Empty;
            }
        }
        #endregion

        #region 方法定义
        /// <summary>
        /// 取得定义为SomeProperty的属性
        /// </summary>
        /// <param name="objTarget"></param>
        private List<ExpressionItem> GetSomePropertyAttributesDirecs(Type objType)
        {
            if (objType == null)
            {
                return null;
            }
            List<ExpressionItem> _dicExpressions = new List<ExpressionItem>();
            //当前类型内定义的属性。
            foreach (PropertyInfo pinfo in objType.GetProperties())
            {
                //循环查找是否定义过SomePropertyCNAttribute属性。
                if (pinfo.IsDefined(typeof(SomePropertyCNAttribute), false))
                {
                    //将当前属性所定义的Attribute取得，读取定义名称，存入键值对。
                    SomePropertyCNAttribute spcna =
                        Attribute.GetCustomAttribute(pinfo, typeof(SomePropertyCNAttribute)) as SomePropertyCNAttribute;
                    ExpressionItem eiNew = new ExpressionItem();
                    eiNew.sCnName = spcna.Name;
                    eiNew.sEnName = pinfo.Name;
                    eiNew.ItemType = MemberTypes.Property;
                    if (_dicExpressions.Contains(eiNew))
                    {
                        continue;
                    }
                    //存入中文与属性名 eg.<姓名,strName>
                    _dicExpressions.Add(eiNew);
                }
            }
            foreach (MethodInfo minfo in objType.GetMethods(BindingFlags.Public))
            {
                //循环查找是否定义过SomePropertyCNAttribute属性。
                if (minfo.IsDefined(typeof(SomeClassCNAttribute), false))
                {
                    //将当前属性所定义的Attribute取得，读取定义名称，存入键值对。
                    SomeClassCNAttribute spcna =
                        Attribute.GetCustomAttribute(minfo, typeof(SomeClassCNAttribute)) as SomeClassCNAttribute;
                    ExpressionItem eiNew = new ExpressionItem();
                    eiNew.sCnName = spcna.Name;
                    eiNew.sEnName = minfo.Name;
                    eiNew.ItemType = MemberTypes.Method;
                    if (_dicExpressions.Contains(eiNew))
                    {
                        continue;
                    }
                    //存入中文与属性名 eg.<姓名,strName>
                    _dicExpressions.Add(eiNew);
                }
            }
            return _dicExpressions;
        }
        /// <summary>
        /// 获取属性的值
        /// </summary>
        /// <param name="strCNName">中文名称</param>
        /// <param name="objTarget">目标对象,获取该对象下的属性值</param>
        /// <param name="index">索引,如果是集合的情况下用索引查找</param>
        /// <returns>Value值</returns>
        public object GetPropertyValueByCNName(string strCNName, object objTarget, params object[] index)
        {
            Type objType = objTarget.GetType();

            if (objType == null)
            {
                return null;
            }

            PropertyInfo pi = objType.GetProperty(InnerExpressions.Find((x) => x.sCnName == strCNName).sEnName);

            if (pi == null)
            {
                return null;
            }
            return pi.GetValue(objTarget, index);
        }
        /// <summary>
        /// 获取属性的值
        /// </summary>
        /// <param name="strCNName">中文名称</param>
        /// <param name="objTarget">目标对象,获取该对象下的属性值</param>
        /// <returns>Value值</returns>
        public object GetPropertyValueByCNName(string strCNName, object objTarget)
        {
            return this.GetPropertyValueByCNName(strCNName, objTarget, null);
        }
        /// <summary>
        /// 类中方法定义的获取
        /// </summary>
        /// <param name="strCNName">中文名</param>
        /// <param name="objTarget">对象</param>
        /// <param name="param">参数类型</param>
        /// <returns></returns>
        public object GetMethodValueByCnName(string strCNName, object objTarget, params object[] param)
        {
            Type objType = objTarget.GetType();

            if (objType == null)
            {
                return null;
            }
            MemberInfo mi = objType.GetMethod(InnerExpressions.Find((x) => x.sCnName == strCNName).sEnName);

            if (mi == null)
            {
                return null;
            }
            return mi;
        }
        #endregion

        #region 内部定义
        public class ExpressionItem
        {
            private string _sCnName;

            public string sCnName
            {
                get { return _sCnName; }
                set { _sCnName = value; }
            }
            private string _sEnName;

            public string sEnName
            {
                get { return _sEnName; }
                set { _sEnName = value; }
            }
            public MemberTypes ItemType;
        }
        #endregion
    }

   当每次输入到文本的时候，如果是圆点符号”.”则访问方法，将该输入的文本在创建的字典中查找如果有这个类库，则取出它包含的属性，加入到ListBox中，由ListBox在文本输入区域显示出来。

private bool GetItelliInfos(RichTextBox rtb)
        {
            int startno = 1;
            string strName = string.Empty;
            while (true)
            {
                if (rtxtExpression.SelectionStart - startno < 0)
                {
                    strName = rtxtExpression.Text.Substring(0, startno - 1).Trim();

                    break;
                }
                if (rtxtExpression.Text.Substring(rtxtExpression.SelectionStart - startno, 1).ToString().Trim().Equals(string.Empty))
                {
                    strName = rtxtExpression.Text.Substring(rtxtExpression.SelectionStart - startno, startno).Trim();

                    break;
                }
                startno++;
            }
            if (strName.Equals(string.Empty))
            {
                return false;
            }
            FCNExpression f = ListFCN.Find((x) => x.ClassCNName.Equals(strName));
            if (f == null)
            {
                return false;
            }
            foreach (var item in f.InnerExpressions)
            {
                LstBoxintelli.Items.Add(item.sCnName);

            }
            return true;
        }

总结

  我们可以通过Attribute做到很多事情,这次在文中只写出了如果通过Attribute去获取类库的属性名，做出了中英文对应的字典，并在输入点的时候弹出ListBox显示这些属性。下次会写到基于这个功能完成一些基本的判断式和计算式。依然是用中文显示作为输入手段。