高级搜索插件solis search在umbraco中的使用

好久没有写关于umbraco的博客了，这段时间在研究solis search，感觉它太强大，好东西是需要分享的，所以写一篇简单的使用博客分享给个人umbraco爱好者。

简介

在了解solis search之前，我们需要简单的了解apache solr, Apache Solr 是一个开源的搜索服务器。Solr 使用 Java 语言开发，主要基于 HTTP 和 Apache Lucene 实现。Lucene是一套用于全文检索和搜寻的开源程式库，由Apache软件基金会支持和提供。Lucene提供了一个简单却强大的应用程式接口，能够做全文索引和搜寻。更详细的介绍请充分利用搜索引擎，这里就不做详细介绍了。

solis search就是基于apache solr开发的一个umbraco的插件。它在做了简单的配置之后，就可以检索到umbraco content里面的几乎所有的文字内容，包括上传的文档或者选择的media picker中的文档（word, pdf, excel 等等）。

下载安装

1. 安装JAVA环境

安装java环境是为了运行apache solr server.

下载地址：http://www.java.com/zh_CN/,

下载后安装，安装之后请配置环境变量，是java命令可以直接在命令行根目录运行。如何配置环境变量在这就不介绍了。

2. 安装apache solr

下载地址：http://lucene.apache.org/solr/，这里记住，一定要下载4.5.1版本的，不然使用会出现未知的错误。因为solis search是基于version 4.5开发的。

请参考官方文档进行安装：http://lucene.apache.org/solr/4_5_1/tutorial.html，

操作简要说明：

• 解压压缩包到电脑的任意位置，建议目录全是英文的
• 打开cmd，进入到目录：solr-4.5.1example
  
• 运行> java -jar start.jar启动solr server.

3. 安装 solis search package

下载：https://www.solissearch.com/download/ 

推荐下载Solis Search 1.1.15.218 Umbraco package, 下载之后再umbraco后台进行安装

安装过程一般不会出错，如果出了错，请下载手动安装包，根据文档进行安装： https://www.solissearch.com/documentation/

安装之后，找到安装包里面的schema.xml和solrconfig.xml然后 复制到solr的文件夹solr-4.5.1examplesolrcollection1conf下面，这一步很重要，然后重启solr server: java -jar start.jar

接着就是rebuild index:

当然在rebuild index之前要根据具体的需要修改配置文件。

在这里，我将我的配置贴出来，并且做简单的介绍，

<?xml version="1.0"?>
<SolisSearch>
  <SolrServer address="http://localhost:8983/solr" username="" licenseKey="" />
  <SearchSettings defaultField="text" enableLanguageSupport="true" enabledLanguages="en" highlight="true" highlightFields="text" fragmenter="regex" fragsize="300" defaultOperator="AND" />
  <Languages>
    <Language name="en" rootNode="1064" />
  </Languages>
  <DocTypes>
    <DocType name="default" addPageNameToContent="true">
      <Properties>
        <Property name="p1" property="Name" type="text" content="true" />
        <Property name="r1" property="relatedLinks" type="relatedLinks" parser="SolisSearch.Parsers.RelatedLinksParser,SolisSearch" />
      </Properties>
    </DocType>
    <DocType name="umbHomePage">
      <Properties>
        <Property name="p1" property="mainHeading" type="text" content="true" />
        <Property name="p2" property="mainContent" type="text" content="true" striphtml="true"/>
      </Properties>
    </DocType>
    <DocType name="newsGroup" addPageNameToContent="true">
      <Properties>
        <Property name="p1" property="Name" type="text" content="true" />
      </Properties>
    </DocType>
    <DocType name="newsItem" addPageNameToContent="true">
      <Properties>
        <Property name="p1" property="title" type="text" content="true" />
        <Property name="p2" property="content" type="text" content="true" striphtml="true"/>
        <Property name="p3" property="downloadFile" type="relatedLinks" parser="SolisSearch.Parsers.RelatedLinksParser,SolisSearch" />
        <Property name="p4" property="uploadDoc" type="relatedLinks" parser="SolisSearch.Parsers.RelatedLinksParser,SolisSearch" />
      </Properties>
    </DocType>
  </DocTypes>
  <Facets>
    <Facet type="value" field="doctypes" mincount="0" sort="false" />
    <Facet type="range" field="last_modified" mincount="1">
      <Ranges>
        <FacetRange name="date3" dynamic="thisday" dataType="date" />
        <FacetRange name="date4" dynamic="thisweek" dataType="date" />
        <FacetRange name="date5" dynamic="thismonth" dataType="date" />
        <FacetRange name="date6" dynamic="thisyear" dataType="date" />
        <FacetRange name="date7" dynamic="last" gap="20" dataType="date" />
      </Ranges>
    </Facet>
  </Facets>
</SolisSearch>

SolrServer：配置solr server的 地址，用户名以及license key.

SearchSettings: 配置当前search的环境，支持的语言，链接操作符，是否高亮等等

DocTypes：这个是重点，用来配置可以搜索出来的content字段

<DocType name="newsItem" addPageNameToContent="true">
      <Properties>
        <Property name="p1" property="title" type="text" content="true" />
        <Property name="p2" property="content" type="text" content="true" striphtml="true"/>
        <Property name="p3" property="downloadFile" type="relatedLinks" parser="SolisSearch.Parsers.RelatedLinksParser,SolisSearch" />
        <Property name="p4" property="uploadDoc" type="relatedLinks" parser="SolisSearch.Parsers.RelatedLinksParser,SolisSearch" />
      </Properties>
</DocType>

name="newsItem": 将名为newsItem的document type添加到可搜索列表；

addPageNameToContent="true": 表示该document type的name是可搜索的；

Properties: 指定该document type中哪些property是可以被搜索的；

Property: name - 标示符， property - 属性名， type - 搜索的类型， content - 搜索的是内容值

type="relatedLinks": 表示使用solis search的方法去搜索，一般用来搜索word文档，pdf文档中的内容， 需要添加 parser="SolisSearch.Parsers.RelatedLinksParser,SolisSearch".

这里的p3和p4表示添加了media picker类型以及upload的类型的属性是可以搜索的。

搜索view代码：

@using System.Activities.Statements
@using System.Globalization
@using SolisSearch.Helpers
@using SolisSearch.Repositories
@inherits Umbraco.Web.Macros.PartialViewMacroPage

@{
    Layout = "../Master.cshtml";
}


<h1>@ViewBag.Title</h1>
<h3>@ViewData["content"]</h3>

@{
    var query = HttpUtility.UrlDecode(Request.QueryString["q"]);
    var fq = new List<string>();


    <script type="text/javascript">
        $(document).ready(function () {

            $("#txtSearch").keydown(function (e) {
                if (e.which == "13") {
                    $("#searchform").submit();
                }
            });

            $(".facetlink").click(function () {
                var filter = $(this).attr("data-filter");
                $("#filters").append("<input name='fq' type='hidden' value='" + filter + "¤' >");
                $("#searchform").submit();

            });

            $("#filters").on("click", "a", function () {
                $(this).prev("input").remove();
                $("#searchform").submit();
            });
        });
    </script>

    <div class="searchform">
        <form id="searchform" method="GET">
            <input id="txtSearch" autocomplete="off" type="search" name="q" value="@query" />
            <button type="submit">Search</button>

            @if (!String.IsNullOrEmpty(Request["fq"]))
            {
                fq.AddRange(Request["fq"].TrimEnd(Convert.ToChar("¤")).Split(new[] { "¤," }, StringSplitOptions.RemoveEmptyEntries));
            }

            <div id="filters">
                @{
                    if (fq.Any())
                    {
                        <h6>Active filters <span>(Click to remove)</span></h6>
                        foreach (var field in fq)
                        {
                            <input name="fq" type="hidden" value="@string.Format("{0}¤", field)" />
                            <a href="#">@Html.Raw(GetFriendlyCategoryName(RangeFormatHelper.FormatRange(field)))&nbsp;<i class="fa fa-times"></i></a>
                        }

                    }
                }

            </div>
        </form>
    </div>


    if (!String.IsNullOrEmpty(query) || fq.Any())
    {
        var languageName = CultureInfo.CurrentCulture.TwoLetterISOLanguageName;

        var searchRepo = new SearchRepository();
        var searchResultItems = searchRepo.SearchIndex(query, fq.ToArray(), 1, 0, null);

        if (searchResultItems.SpellChecking.Any())
        {
            <div class="spellchecking">
                <h4>Did you mean</h4>
                @foreach (var spellitem in searchResultItems.SpellChecking)
                {

                    foreach (var suggestion in spellitem.Suggestions)
                    {
                        <p><a href="?q=@suggestion">@suggestion</a></p>
                    }

                }
            </div>
        }

        <div class="facets">
            <div>
                @if (searchResultItems.FacetFields.Any())
                {
                    var doctypesFacets = searchResultItems.FacetFields["doctypes"];
                    <h4>Category</h4>
                    <ul>
                        @{
                    foreach (var keyValuePair in doctypesFacets)
                    {
                        var friendlyname = GetFriendlyCategoryName(keyValuePair.Key);
                        if (String.IsNullOrEmpty(friendlyname))
                        {
                            continue;
                        }

                        <li>
                            <a class="facetlink" data-filter="@Html.Raw(string.Format("{0}:{1}", "doctypes", keyValuePair.Key))" href="javascript:void(0);">
                                @Html.Raw(friendlyname + " (" + keyValuePair.Value + ")")
                            </a>
                        </li>
                    }
                        }

                    </ul>


                }
            </div>
            <div>
                @if (searchResultItems.FacetQueries.Any())
                {
                    <h4>Date modified</h4>
                    <ul>
                        @foreach (var facetqueries in searchResultItems.FacetQueries)
                        {
                            <li>
                                <a class="facetlink" data-filter="@facetqueries.Key" data-value="@facetqueries.Key" href="javascript:void(0);">
                                    @Html.Raw(RangeFormatHelper.FormatRange(facetqueries.Key) + " (" + facetqueries.Value + ")")
                                </a>
                            </li>
                        }
                    </ul>
                }
            </div>

        </div>

        if (searchResultItems.Any())
        {
            <div class="searchResults">
                <p>@string.Format("Total of {0} items found", searchResultItems.NumFound)</p>
                <ol>
                    @foreach (var searchitem in searchResultItems)
                    {
                        <li>
                            <h4><a href="@Html.Raw(searchitem.LinkUrl ?? searchitem.ResourceName)">@Html.Raw(searchitem.Name ?? searchitem.DocumentTitle.FirstOrDefault() ?? Path.GetFileNameWithoutExtension(searchitem.ResourceName))</a></h4>
                            @{
                                var highlightedSnippets = searchResultItems.Highlights[searchitem.Id];
                                if (highlightedSnippets != null && highlightedSnippets.Any())
                                {
                                    foreach (var highlightItem in highlightedSnippets)
                                    {
                                        @Html.Raw(string.Join(" ", highlightItem.Value))
                                    }
                                }
                                else
                                {
                                    var contentString = string.Join(" ", searchitem.Content);
                                    @Html.Raw(contentString.Substring(0, Math.Min(contentString.Length, 175)))
                                }
                            }
                        </li>
                    }
                </ol>
            </div>

        }
        else
        {
            <p style="clear: both;">No search results</p>
        }
    }
}

@functions
{

    private string GetFriendlyCategoryName(string doctype)
    {
        if (doctype.Contains("/")) return doctype;
        switch (doctype)
        {
            case "newsItem":
                return "News Item";
            case "umbHomePage":
                return "Article";
            default:
                return "Others";

        }
    }

}

做了如上操作后，就可以开始使用solis search进行操作了。

有错误的地方，欢迎指出。

参考：

https://www.solissearch.com/

http://baike.baidu.com/view/5649738.htm?fr=aladdin

http://baike.baidu.com/view/371811.htm

尊重原创，转载请说明出处！