如何“正确”为SharePoint字段命名

fish3129

　　当大家需要扩展一个SharePoint列表/文档库的数据结构时，就会为列表/文档库创建新的字段(栏)。不管是直接为列表/文档库新建字段，还是在网站集里面创建网站栏，作为管理员，最好使用一些“最佳实践”来为字段命名。使用正确的字段名，在未来的配置、管理、开发过程中，都可以节省很多的时间和精力。
　　每个SharePoint字段实际上有两个名称，一个是“标题”（Title，有时候也把它叫做“显示名称”），一个是“内部名称”（Internal Name）。平时用户在列表视图界面上看到的，都是字段的标题。字段的内部名称可以看作是字段的唯一标识。如果你曾经使用SharePoint对象模型，通过代码从列表中获取数据，那么对“内部名称”这个概念一定很熟悉。基本上，SharePoint对“内部名称”的格式有非常严格的要求，它只能由英文字母、数字和下划线字组成，且不能包含空格。但是“标题”则没有这么多限制，通常我们会使用中文作为字段的“标题”，而且“标题”中很可能会包含空格。当一个字段被创建之后，它的“内部名称”就被固定下来了，但是“标题”则可以在之后被随时修改。
　　var list = site.Lists["任务"];      
var titleField = list.Fields.GetFieldByInternalName("Title"); // 使用字段的内部名称来获取一个字段      
var statusField = list.Fields.GetField("状态"); // 使用字段的标题来获取一个字段，注意，GetField()会先尝试内部名称，然后再尝试使用标题进行查找
　　怎么知道一个字段的内部名称呢？最简单的方法就是对一个字段进行编辑，然后观察浏览器地址栏中的URL地址。比如，当我们编辑“状态”字段时，在地址栏就能看到一个“Field=Status”参数，这表示“状态”字段的内部名称是“Status”。

　　当我们在Visual Studio 2010中开发SharePoint应用程序时，也可以通过VS内置的SharePoint Explorer来查看一个字段的详细信息。在VS2010的“服务器资源管理器”中点击“添加SharePoint连接”，就能打开一个SharePoint网站。

　　通过展开列表节点，就能直接查看列表的所有字段，以及字段的各种属性。内部名称这个属性也能直接看到。

　　但是当管理员创建一个字段时，在页面UI上并不能分别输入新字段的标题和内部名称。在新建字段的界面上，只有一个“栏名”文本框。

　　SharePoint系统会使用管理员输入在“栏名”文本框内的内容作为新字段的标题，然后根据这个标题，调用System.Xml.XmlConvert.Encode()方法，来将标题自动转换成内部名称。这样，才能让转换后的内部名称符合SharePoint对内部名称命名的规范。
　　比如，如果管理员使用页面UI创建一个标题为“Live ID”的字段，这个字段的内部名称会被自动命名为“Live_x0020_ID”。如果管理员创建一个标题为“技术等级”的字段，它的内部名称将是“_x6280__x672f__x7b49__x7ea7_”。
　　但是这种自动转换后的内部名称的格式非常不好看，也不易记忆。实际上，管理员应该始终使用一个符合内部名称规范的名称，来创建字段，这样这个新字段的内部名称和标题都相同。然后，管理员再回过头去修改这个字段，将其标题修改为更符合用户习惯的名字。由于内部名称一旦确定就不再更改，所以字段的内部名称将始终保持为初始值。
　　比如，我们要创建一个“技术等级”字段。最好的方法，是使用“TechLevel”为名，来新建一个字段。

　　这时，这个字段的标题，和内部名称，都将是“TechLevel”。

　　然后，在界面上将这个字段名称修改为“技术等级”。这样，用户将看到这个字段的名字叫做“技术等级”，但由于字段的内部名称会始终保持原始值，所以这个字段的内部名称仍然为“TechLevel”。

　　如果我们要在代码里面创建新字段，也应该使用类似的方法。

　　为字段命名一个好记、易识别的内部名称，无论是在我们的自定义代码中，还是在SharePoint Search里面，都要或得更好的便利性。