Solr 部署與使用踩坑全記錄

Charles Zhang發表於2019-06-21
Solr

前言

Solr 是一種可供企業使用的、基於 Lucene 的搜尋伺服器，它支援層面搜尋、命中醒目顯示和多種輸出格式。在這篇文章中，將介紹 Solr 並展示如何輕鬆地將其表現優異的全文字搜尋功能加入到 Web 應用程式中。

下載地址：https://lucene.apache.org/solr/downloads.html

本文中使用的Solr 版本：7.7.2，因為我是用的是 Windows 系統，所以主要介紹的是 Windows 下的部署方法。

安裝

Solr 內建了 Jetty，所以不需要任何安裝任何 Web 容器即可執行。直接通過命令列就可以啟動。

啟動 Solr：

 .\solr.cmd start

停止 Solr：

 .\solr.cmd stop -all

建立 Core

首先在 server\solr 資料夾中建立一個新的目錄，然後將 server\solr\configsets\_default 下的 conf 目錄複製到剛剛建立的資料夾。

在瀏覽器中開啟 http://localhost:8983/solr/ 點選左側的 Core Admin 新增 Core。

Solr 部署與使用踩坑全記錄

name 和 instanceDir 都改成剛剛建立的目錄名稱。

建立好之後即可在左側的 Core Selector 中找到這個 Core。

現在一個 Core 就建立好了，在 Core 的皮膚裡可以對其進行一些基本操作。

Solr 的 Api 是支援通過呼叫介面新增資料的，但是在實際使用中我們都是從資料庫中同步資料，所以我們需要為 Solr 配置資料來源。

Solr 部署與使用踩坑全記錄

在 solrconfig.xml 檔案中找到如下內容：

  <!-- Request Handlers
       http://wiki.apache.org/solr/SolrRequestHandler

       Incoming queries will be dispatched to a specific handler by name
       based on the path specified in the request.

       If a Request Handler is declared with startup="lazy", then it will
       not be initialized until the first request that uses it.
    -->

新增一個 requestHandler 節點：

  <requestHandler name="/dataimport" class="solr.DataImportHandler">
    <lst name="defaults">
      <str name="config">data-config.xml</str>
    </lst>
  </requestHandler>

data-config.xml 檔案的大致結構如下：

Solr 部署與使用踩坑全記錄

稍後會對 data-config.xml 檔案進行詳細介紹。

配置資料來源

使用 SQL Server 資料來源

從微軟官網下載 SQL Server 的 Microsoft SQL Server JDBC 驅動程式 4.1 驅動，複製到 server\solr-webapp\webapp\WEB-INF\lib 目錄下。

這裡需要注意的是把在下載的檔案重新命名為 sqljdbc4.jar，我之前沒有改名死活載入不上。

使用 com.microsoft.sqlserver.jdbc.SQLServerDriver 驅動配置資料來源：

<dataSource name="postData" driver="com.microsoft.sqlserver.jdbc.SQLServerDriver" url="jdbc:sqlserver://127.0.0.1:1433;SelectMethod=Cursor;DatabaseName=post;useLOBs=false;loginTimeout=60" user="charlestest" password="12345678" />
使用 MySQL 資料來源

下載：mysql-connector-java-6.0.6.jar 複製到 server\solr-webapp\webapp\WEB-INF\lib 目錄下。

從 dist 目錄複製 solr-dataimporthandler-7.7.2.jar 到 server/solr-webapp/webapp/WEB-INF/lib 中。
配置 data-config.xml：

<dataConfig>
    <dataSource name="postsData"  type="JdbcDataSource" driver="com.mysql.jdbc.Driver" url="jdbc:mysql://localhost:3306/posts?useUnicode=true&amp;useJDBCCompliantTimezoneShift=true&amp;useLegacyDatetimeCode=false&amp;serverTimezone=UTC" user="root" password="12345678" batchSize="-1" />
    <document name="posts">
        <entity name="Post" dataSource="postData" pk="Id" transformer="DateFormatTransformer,HTMLStripTransformer" rootEntity="true" query="SELECT Id, post_author, post_date, post_date_gmt, post_content, post_title, post_excerpt, post_status, comment_status, ping_status, post_password, post_name, to_ping, pinged, post_modified, post_modified_gmt, post_content_filtered, post_parent, guid, menu_order, post_type, post_mime_type, comment_count
        FROM wp_posts"
        deltaQuery="SELECT Id, post_author, post_date, post_date_gmt, post_content, post_title, post_excerpt, post_status, comment_status, ping_status, post_password, post_name, to_ping, pinged, post_modified, post_modified_gmt, post_content_filtered, post_parent, guid, menu_order, post_type, post_mime_type, comment_count
        FROM wp_posts post_modified &gt;'${dataimporter.last_index_time}' " 
        >
            <field column="Id" />
            <field column="post_author" />
            <field column="post_date" dateTimeFormat='yyyy-MM-dd HH:mm:ss'/>
            <field column="post_date_gmt" dateTimeFormat='yyyy-MM-dd HH:mm:ss'/>
            <field column="post_content" />
            <field column="post_title" />
            <field column="post_excerpt" />
            <field column="post_status" />
            <field column="comment_status" />
            <field column="ping_status" />
            <field column="post_password" />
            <field column="post_name" />
            <field column="to_ping" />
            <field column="pinged" />
            <field column="post_modified" dateTimeFormat='yyyy-MM-dd HH:mm:ss'/>
            <field column="post_modified_gmt" dateTimeFormat='yyyy-MM-dd HH:mm:ss'/>
            <field column="post_content_filtered" />
            <field column="post_parent" />
            <field column="guid" />
            <field column="menu_order" />
            <field column="post_type" />
            <field column="post_mime_type" />
            <field column="comment_count" />
            <entity name="PostAuthor" dataSource="authordata" pk="Id" query="SELECT Id, user_login, user_pass, user_nicename, user_email, user_url, user_registered, user_activation_key, user_status, display_name
            FROM wp_users where id=${Post.post_author}">
                <field column="Id" />
                <field column="user_login"/>
                <field column="user_pass"/>
                <field column="user_nicename"/>
                <field column="user_email"/>
                <field column="user_url"/>
                <field column="user_registered"/>
                <field column="user_activation_key"/>
                <field column="user_status"/>
                <field column="display_name"/>
            </entity>
        </entity>
    </document>
</dataConfig>

entity 中的一些常用屬性：

  • query：查詢只對第一次全量匯入有作用，對增量同步不起作用。
  • deltaQuery：的意思是，查詢出所有經過修改的記錄的 Id 可能是修改操作，新增操作，刪除操作產生的（此查詢只對增量匯入起作用，而且只能返回 Id 值）
  • deletedPkQuery：此操作值查詢那些資料庫裡偽刪除的資料的 Id、solr 通過它來刪除索引裡面對應的資料（此查詢只對增量匯入起作用，而且只能返回 Id 值）。
  • deltaImportQuery：是獲取以上兩步的 Id，然後把其全部資料獲取，根據獲取的資料對索引庫進行更新操作，可能是刪除，新增，修改（此查詢只對增量匯入起作用，可以返回多個欄位的值，一般情況下，都是返回所有欄位的列）。
  • parentDeltaQuery：從本 entity 中的 deltaquery 中取得引數。

dataSource 中 batchSize 屬性的作用是可以在批量匯入的時候限制連線數量。

配置完成後重新載入一下 Core。

中文分詞

將 contrib\analysis-extras\lucene-libs 目錄中的 lucene-analyzers-smartcn-7.7.2.jar 複製到 server\solr-webapp\webapp\WEB-INF\lib 目錄下，否則會報錯。
在 managed-shchema 中新增如下程式碼：

  <!-- 配置中文分詞器 -->
  <fieldType name="text_cn" class="solr.TextField">
    <analyzer type="index">
      <tokenizer class="org.apache.lucene.analysis.cn.smart.HMMChineseTokenizerFactory" />
    </analyzer>
    <analyzer type="query">
      <tokenizer class="org.apache.lucene.analysis.cn.smart.HMMChineseTokenizerFactory" />
    </analyzer>
  </fieldType>

把需要使用中文分詞的欄位型別設定成 text_cn：

<field name="Remark" type="text_cn" indexed="true" stored="true" multiValued="false"/>

主從部署

Solr 複製模式，是一種在分散式環境下用於同步主從伺服器的一種實現方式，因之前提到的基於 rsync 的 SOLR 不同方式部署成本過高，被 Solr 1.4 版本所替換，取而代之的就是基於 HTTP 協議的索引檔案傳輸機制，該方式部署簡單，只需配置一個檔案即可。Solr 索引同步的是 Core 對 Core，以 Core 為基本同步單元。

主伺服器 solrconfig.xml 配置：

<requestHandler name="/replication" class="solr.ReplicationHandler">
    <lst name="master">
        <!-- 執行 commit 操作後進行 replicate 操作同樣的設定'startup', 'commit', 'optimize'-->
        <str name="replicateAfter">commit</str>
        <!-- 執行 startup 操作後進行 replicate 操作 -->
        <str name="replicateAfter">startup</str>
        <!-- 複製索引時也同步以下配置檔案 -->
        <str name="confFiles">schema.xml,stopwords.txt</str>
        <!-- 每次 commit 之後，保留增量索引的週期時間，這裡設定為 5 分鐘。 -->
        <str name="commitReserveDuration">00:05:00</str>  
        <!-- 驗證資訊，由使用者自定義使用者名稱-->
        <!-- <str name="httpBasicAuthUser">root</str> -->
        <!-- 驗證資訊，由使用者自定義密碼 -->
        <!-- <str name="httpBasicAuthPassword">password</str> -->
    </lst>
    <!--
       <lst name="slave">
         <str name="masterUrl">http://your-master-hostname:8983/solr</str>
         <str name="pollInterval">00:00:60</str>
       </lst>
    -->
</requestHandler>

從伺服器 solrconfig.xml 配置：

<requestHandler name="/replication" class="solr.ReplicationHandler">
    <lst name="slave">
        <!-- 主伺服器的同步地址 -->
        <str name="masterUrl">http://192.168.1.135/solr/posts</str>
        <!-- 從伺服器同步間隔，即每隔多長時間同步一次主伺服器 -->
        <str name="pollInterval">00:00:60</str>
        <!-- 壓縮機制，來傳輸索引，可選 internal|external，internal：內網，external：外網 -->
        <str name="compression">internal</str>
        <!-- 設定連線超時（單位：毫秒） -->
        <str name="httpConnTimeout">50000</str>
        <!-- 如果設定同步索引檔案過大，則應適當提高此值。（單位：毫秒） -->
        <str name="httpReadTimeout">500000</str>
        <!-- 驗證使用者名稱，需要和 master 伺服器一致 -->
        <!-- <str name="httpBasicAuthUser">root</str> -->
        <!-- 驗證密碼，需要和 master 伺服器一致 -->
        <!-- <str name="httpBasicAuthPassword">password</str> -->
    </lst>
</requestHandler>

Solr 主從同步是通過 Slave 週期性輪詢來檢查 Master 的版本，如果 Master 有新版本的索引檔案，Slave 就開始同步複製。

  • 1、Slave 發出一個 filelist 命令來收集檔案列表。這個命令將返回一系列後設資料（size、lastmodified、alias 等資訊）。
  • 2、Slave 檢視它本地是否有這些檔案，然後它會開始下載缺失的檔案（使用命令 filecontent）。如果與 Master 連線失敗，就會重新連線，如果重試 5 次還是沒有成功，就會 Slave 停止同步。
  • 3、檔案被同步到了一個臨時目錄（index.時間戳 格式的資料夾名稱，例如：index.20190614133600008）。舊的索引檔案還存放在原來的資料夾中，同步過程中出錯不會影響到 Slave，如果同步過程中有請求訪問，Slave 會使用舊的索引。
  • 4、當同步結束後，Slave 就會刪除舊的索引檔案使用最新的索引。

我們專案中 6.7G 的索引檔案（279 萬條記錄），大概只用了 12 分鐘左右就同步完成了，平均每秒的同步速度大約在 10M 左右。

Solr 部署與使用踩坑全記錄

Solr 部署與使用踩坑全記錄

注意事項： 如果主從的資料來源配置的不一致，很可能導致從伺服器無法同步索引資料。

在專案中使用 Solr

在 Java 專案中使用 Solr

SolrJ 是 Solr 的官方客戶端，文件地址：https://lucene.apache.org/solr/7_7_2/solr-solrj/。
使用 maven 新增：

<!-- https://mvnrepository.com/artifact/org.apache.solr/solr-solrj -->
<dependency>
    <groupId>org.apache.solr</groupId>
    <artifactId>solr-solrj</artifactId>
    <version>7.7.2</version>
</dependency>

查詢索引文件：

    String keyword = "蘋果";
    Map<String, String> queryParamMap = new HashMap<String, String>();
    queryParamMap.put("q", "*:*");
    queryParamMap.put("fq", keyword);
    MapSolrParams queryParams = new MapSolrParams(queryParamMap);
    QueryResponse queryResponse = client.query("posts", queryParams);
    SolrDocumentList results = queryResponse.getResults();

新增和更新索引文件：

    // 通過 屬性 新增到索引中
    SolrInputDocument doc = new SolrInputDocument();
    doc.addField("id", "10000");
    doc.addField("post_title", "test-title");
    doc.addField("post_name", "test-name");
    doc.addField("post_excerpt", "test-excerpt");
    doc.addField("post_content", "test-content");
    doc.addField("post_date", "2019-06-18 14:56:55");
    client.add("posts", doc);

    // 通過 Bean 新增到索引中
    Post post = new Post();
    post.setId(10001);
    post.setPost_title("test-title-10001");
    post.setPost_name("test-name");
    post.setPost_excerpt("test-excerpt");
    post.setPost_content("test-content");
    post.setPost_date(new Date());
    client.addBean("posts", post);

    client.commit("posts");

具體程式碼可以參考我 GitHub 中的示例，這裡就不詳細列出了。

在 DotNet 專案中使用 Solr

SolrNet：https://github.com/mausch/SolrNet

通過 Nuget 新增 SolrNet：

Install-Package SolrNet

首先定義一個索引物件 PostDoc：

    /// <summary>
    /// 文章 doc。
    /// </summary>
    [Serializable]
    public class PostDoc
    {
        [SolrUniqueKey("id")]
        public int Id { get; set; }

        [SolrField("post_title")]
        public string Title { get; set; }

        [SolrField("post_name")]
        public string Name { get; set; }

        [SolrField("post_excerpt")]
        public string Excerpt { get; set; }

        [SolrField("post_content")]
        public string Content { get; set; }

        [SolrField("post_date")]
        public DateTime PostDate { get; set; }
    }

在專案的 Startup 類中初始化 SolrNet：

  SolrNet.Startup.Init<PostDoc>("http://localhost:8983/solr/posts");

新增或更新文件操作：

    // 同步新增文件
    solr.Add(
        new PostDoc()
        {
            Id = 30001,
            Name = "This SolrNet Name",
            Title = "This SolrNet Title",
            Excerpt = "This SolrNet Excerpt",
            Content = "This SolrNet Content 30001",
            PostDate = DateTime.Now
        }
    );
    // 非同步新增文件（更新）
    await solr.AddAsync(
        new PostDoc()
        {
            Id = 30001,
            Name = "This SolrNet Name",
            Title = "This SolrNet Title",
            Excerpt = "This SolrNet Excerpt",
            Content = "This SolrNet Content Updated 30001",
            PostDate = DateTime.Now
        }
    );
    // 提交
    ResponseHeader responseHeader = await solr.CommitAsync();

刪除文件操作：

    // 使用文件 Id 刪除
    await solr.DeleteAsync("300001");
    // 直接刪除文件
    await solr.DeleteAsync(new PostDoc()
    {
        Id = 30002,
        Name = "This SolrNet Name",
        Title = "This SolrNet Title",
        Excerpt = "This SolrNet Excerpt",
        Content = "This SolrNet Content 30002",
        PostDate = DateTime.Now
    });
    // 提交
    ResponseHeader responseHeader = await solr.CommitAsync();

搜尋並對結果進行排序，在不傳入分頁引數的情況下 SolrNet 會返回所有滿足條件的結果。

    // 排序
    ICollection<SortOrder> sortOrders = new List<SortOrder>() {
        new SortOrder("id", Order.DESC)
    };
    // 使用查詢條件並排序
    SolrQueryResults<PostDoc> docs = await solr.QueryAsync("post_title:索尼", sortOrders);

使用欄位篩選的另一種方式：

    // 使用條件查詢
    SolrQueryResults<PostDoc> posts = solr.Query(new SolrQueryByField("id", "30000"));

分頁查詢並對高亮關鍵字：

    SolrQuery solrQuery = new SolrQuery("蘋果");
    QueryOptions queryOptions = new QueryOptions
    {
        // 高亮關鍵字
        Highlight = new HighlightingParameters
        {
            Fields = new List<string> { "post_title" },
            BeforeTerm = "<font color='red'><b>",
            AfterTerm = "</b></font>"
        },
        // 分頁
        StartOrCursor = new StartOrCursor.Start(pageIndex * pageSize),
        Rows = pageSize
    };
    SolrQueryResults<PostDoc> docs = await solr.QueryAsync(solrQuery, queryOptions);
    var highlights = docs.Highlights;

高亮關鍵字需要在返回結果中單獨獲取，docs.Highlights 是一個 IDictionary<string, HighlightedSnippets> 物件，每個 key 對應文件的 id，HighlightedSnippets 中也是一個 Dictionary，儲存高亮處理後的欄位和內容。

在 Python 專案中使用 Solr

PySolr：https://github.com/django-haystack/pysolr
使用 pip 安裝 pysolr：

pip install pysolr

簡單的操作：

# -*- coding: utf-8 -*-
import pysolr

SOLR_URL = 'http://localhost:8983/solr/posts'

def add():
    """
    新增
    """
    result = solr.add([
        {
            'id': '20000',
            'post_title': 'test-title-20000',
            'post_name': 'test-name-20000',
            'post_excerpt': 'test-excerpt-20000',
            'post_content': 'test-content-20000',
            'post_date': '2019-06-18 14:56:55',
        },
        {
            'id': '20001',
            'post_title': 'test-title-20001',
            'post_name': 'test-name-20001',
            'post_excerpt': 'test-excerpt-20001',
            'post_content': 'test-content-20001',
            'post_date': '2019-06-18 14:56:55',
        }
    ])
    solr.commit()
    results = solr.search(q='id: 20001')
    print(results.docs)

def delete():
    """
    刪除
    """
    solr.delete(q='id: 20001')
    solr.commit()
    results = solr.search(q='id: 20001')
    print(results.docs)

def update():
    """
    更新
    """
    solr.add([
        {
            'id': '20000',
            'post_title': 'test-title-updated',
            'post_name': 'test-name-updated',
            'post_excerpt': 'test-excerpt-updated',
            'post_content': 'test-content-updated',
            'post_date': '2019-06-18 15:00:00',
        }
    ])
    solr.commit()   
    results = solr.search(q='id: 20000')
    print(results.docs)

def query():
    """
    查詢
    """
    results = solr.search('蘋果')
    print(results.docs)

if __name__ == "__main__":
    solr = pysolr.Solr(SOLR_URL)
    add()
    delete()
    update()
    query()

需要注意的是在使用 solr.add() 和 solr.delete 方法以後需要執行一下 solr.commit() 方法，否則文件的變更不會提交。
如果想獲取新增或更新是否成功可以通過判斷 solr.commit() 方法返回結果，solr.commit() 方法的返回結果是一個 xml 字串：

<?xml version="1.0" encoding="UTF-8"?>
    <response>
        <lst name="responseHeader">
        <int name="status">0</int>
        <int name="QTime">44</int>
    </lst>
</response>

status 的值如果是 0 就表示提交成功了。

總結

通過簡單使用和測試，就會發現搜尋結果並不是很精準，比如搜尋“微軟”這個關鍵字，搜尋出來的資料中有完全不包含這個關鍵字的內容，所以要想讓搜尋結果更加準確就必須對 Sorl 進行調優，Solr 中還有很多高階的用法，例如設定欄位的權重、自定義中文分詞詞庫等等，有機會我會專門寫一篇這樣的文章來介紹這些功能。
我在 sql 目錄裡提供了資料庫指令碼，方便大家建立測試資料，資料是以前做的一個小站從網上抓取過來的科技新聞。

相關文章