在 Sitecore 里使用 Solr 搜索 SortOrder 关联的 Item

在 C# 使用 Solr 搜索

sitecore 的配置信息文件可直接丢进 \App_Config 下，sitecore 会自动检测配置文件更新并加载到内存中。
通常情况下，配置信息文件是放在 \App_Config\Include\ 下， 为你项目名。

通过配置启用 SortOrder 字段并获取 SortOrder

sitecore 默认是移除了 SortOrder 字段的，不过可通过打个补丁修改配置信息，如下配置 xml 启用 SortOrder 字段。
但是这种启用 SortOrder 字段有个不好的地方，当字段值为空时，在 Solr 里是找不到此字段的，且值类型为 string 类型。

EnableSortOrder_Patch.config

1. <?xml version="1.0" encoding="utf-8"?>
2. <configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
3.   <system.web>
4.   </system.web>
5.   <sitecore>
6.       <contentSearch>
7.           <indexConfigurations>
8.               <defaultSolrIndexConfiguration type="Sitecore.ContentSearch.SolrProvider.SolrIndexConfiguration, Sitecore.ContentSearch.SolrProvider">
9.                   <documentOptions type="Sitecore.ContentSearch.SolrProvider.SolrDocumentBuilderOptions, Sitecore.ContentSearch.SolrProvider">
10.                       <exclude hint="list:AddExcludedField">
11.                           <__SortOrder>
12.                               <patch:delete />
13.                           </__SortOrder>
14.                       </exclude>
15.                   </documentOptions>
16.               </defaultSolrIndexConfiguration>
17.           </indexConfigurations>
18.       </contentSearch>
19.   </sitecore>
20. </configuration>

复制代码

C# Code

1. // ./SearchResultModel.cs
2. using Sitecore.ContentSearch;
4. public class SearchResultModel
5. {
6.     [IndexField(BuiltinFields.Name)]
7.     public virtual string ItemName { get; set; }
9.     // 注意此处需要填 SortOrder 的 Item name, 而不是 Title(通常在 sitecore 里直接看到就是 Title) 或者 Display Name
10.     // 可通过它的 ID 找出证实一下 {BA3F86A2-4A1C-4D78-B63D-91C2779C1B5E}
11.     // 或通过路径：/sitecore/templates/System/Templates/Sections/Appearance/Appearance/__Sortorder
12.     [IndexField("__Sortorder")]
13.     public virtual int SortOrder { get; set; }
15.     [IndexField(BuiltinFields.LatestVersion)]
16.     [ScriptIgnore]
17.     public virtual bool IsLatestVersion { get; set; }
18. }
20. // ----------------------------------------------
22. // ./Sample.cs
23. using Sitecore.ContentSearch;
24. using Sitecore.Globalization;
25. using Sitecore.ContentSearch.Linq.Utilities;
26.    
27. var indexName = "sitecore_web_index";
28. var language = Sitecore.Globalization.Language.Parse("en");
29. using (IProviderSearchContext context = ContentSearchManager.GetIndex(indexName)
30. {
31.     var predicate = PredicateBuilder.True<SearchResultModel>();
32.     if (!Sitecore.Context.PageMode.IsNormal)
33.         predicate = predicate.And(z => z.IsLatestVersion);
35.     predicate = predicate.And(z => z.Language.Equals(language.Name, StringComparison.OrdinalIgnoreCase));
37.     var query = context.GetQueryable<SearchResultModel>()
38.         .Filter(predicate);
40.     // sitecore 排序的规则为：先按 SortOrder 升序排序，再按 Item name 升序排序
41.     query = query
42.         .OrderBy(z => z.SortOrder)
43.         .ThenBy(z => z.ItemName);
45.     return query.Select(x => x.Item)?.GetResults().Hits.Select(z => z.Document);
46. }

复制代码

*通过使用通过使用 IComputedIndexField 的获取 SortOrder 的方法

此方法与前面不同的地方在于，当字段值为空时，在 Solr 里仍然可以搜索到此字段，且值为 100，同时值类型为 int 类型。推荐使用这种方式。

AddSortOrderField_Patch.config

1. <?xml version="1.0" encoding="utf-8"?>
2. <configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
3.   <system.web>
4.   </system.web>
5.   <sitecore>
6.     <contentSearch>
7.       <indexConfigurations>
8.         <defaultSolrIndexConfiguration type="Sitecore.ContentSearch.SolrProvider.SolrIndexConfiguration, Sitecore.ContentSearch.SolrProvider">
9.           <documentOptions>
10.             <fields hint="raw:AddComputedIndexField">
11.               <field fieldName="SortOrder" returnType="int">LinkReit.Feature.Content.ChannelCard.ComputedFields.SortOrderField, LinkReit.Feature.Content.ChannelCard</field>
12.             </fields>
13.           </documentOptions>
14.         </defaultSolrIndexConfiguration>
15.       </indexConfigurations>
16.     </contentSearch>
17.   </sitecore>
18. </configuration>

复制代码

C# Code

1. // ./SortOrderField.cs
3. using Sitecore.Data.Items;
4. using Sitecore.ContentSearch;
5. using Sitecore.ContentSearch.ComputedFields;
7. public class SortOrderField : IComputedIndexField
8. {
9.     public object ComputeFieldValue(IIndexable indexable)
10.     {
11.         var item = (Item)(indexable as SitecoreIndexableItem);
12.         if (item == null) return null;
13.         
14.         return item.Appearance.Sortorder;
15.     }
17.     public string FieldName { get; set; }
19.     public string ReturnType { get; set; }
20. }
22. // ----------------------------------------------
24. // ./SearchResultModel.cs
25. using Sitecore.ContentSearch;
27. public class SearchResultModel
28. {
29.     [IndexField(BuiltinFields.Name)]
30.     public virtual string ItemName { get; set; }
32.     // 此处 IndexFieldAttribute 构造参数需要填写的是你配置的 SortOrder 的 fieldName
33.     [IndexField("SortOrder")]
34.     public virtual int SortOrder { get; set; }
36.     [IndexField(BuiltinFields.LatestVersion)]
37.     [ScriptIgnore]
38.     public virtual bool IsLatestVersion { get; set; }
39. }
41. // ----------------------------------------------
43. // ./Sample.cs
44. using Sitecore.ContentSearch;
45. using Sitecore.Globalization;
46. using Sitecore.ContentSearch.Linq.Utilities;
47.    
48. var indexName = "sitecore_web_index";
49. var language = Sitecore.Globalization.Language.Parse("en");
50. using (IProviderSearchContext context = ContentSearchManager.GetIndex(indexName)
51. {
52.     var predicate = PredicateBuilder.True<SearchResultModel>();
53.     if (!Sitecore.Context.PageMode.IsNormal)
54.         predicate = predicate.And(z => z.IsLatestVersion);
56.     predicate = predicate.And(z => z.Language.Equals(language.Name, StringComparison.OrdinalIgnoreCase));
58.     var query = context.GetQueryable<SearchResultModel>()
59.         .Filter(predicate);
61.     // sitecore 排序的规则为：先按 SortOrder 升序排序，再按 Item name 升序排序
62.     query = query
63.         .OrderBy(z => z.SortOrder)
64.         .ThenBy(z => z.ItemName);
66.     return query.Select(x => x.Item)?.GetResults().Hits.Select(z => z.Document);
67. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！