ExSearch - 為Typecho帶來實時搜索體驗的插件

Type-cho 中沒有單獨的搜索頁，絕大多數主題的所謂「搜索頁」只是為搜索框單獨寫了一個樣式，具體的搜索還是靠頁面跳轉。我對 Type-cho 的搜索從來沒有滿意過，因此這次我想辦法將其增強。

• 插件介紹：詳情
• 插件下載：WordPress

我需要為 Type-cho 添加搜索實時響應、高亮與預覽功能。澤澤的搜索插件通過 hack Type-cho 的內部方法實現了高亮與過濾功能，但是仍然不能實現實時響應。其實也能理解，如果跟隨輸入實時響應的話，數據庫的壓力大大增加，而且網絡壓力也大大增加。必須另辟蹊徑。

Hexo 這樣無后端的博客為我提供了新的思路：將內容靜態化，使搜索在前端進行。這樣不僅降低了數據庫壓力，節省了網絡請求數，同時也不用與 Type-cho 的內部方法作斗爭。唯一的缺點是對內容過多的站點來說需要傳輸一定數量的內容到前端，但這通過緩存靜態化與前端長緩存也能緩解。

使用

• 下載頁底提供的文件
• 解壓文件夾，并將文件夾重命名為 ExSearch。
• 上傳至插件目錄，在后臺啟用
• 保存一次插件設置，并點擊重建索引。

在主題中，在任何可點擊的元素上加上?class="search-form-input"，點擊即可喚起搜索框。

自定義 hook

默認的，點擊搜索結果時會直接跳轉至對應的頁面，但是若你的主題使用了 AJAX 或者 PJAX 技術，你可能需要使用自定義的鉤子來處理點擊事件（例如發起一次 PJAX 操作）。在頁面中插入一個函數如下：

<script>
function ExSearchCall(item){
    // your code
}
</script>

其中，item?是一個 JQuery 對象。舉例：

function ExSearchCall(item){
    if (item && item.length) {
        $('.ins-close').click(); // 關閉搜索框
        let url = item.attr('data-url'); // 獲取目標頁面 URL
        $.pjax({url: url, 
            container: '#pjax-container',
            fragment: '#pjax-container',
            timeout: 8000, }); // 發起一次 PJAX 請求
    }
}

可能的問題

如果你的站點內容過多導致建立索引失敗，請在 Plugin.php 第 136 行左右的位置，取消下面兩行的注釋：

$sql = 'SET GLOBAL max_allowed_packet=4294967295;';
$db->query($sql);

注意，這需要高級權限。你也可以手動對數據庫執行：

mysql > SET GLOBAL max_allowed_packet=4294967295;

Credit

本項目靈感來源于?Wikitten?與?PPOffice，感謝。

補充：

• 文本來源：詳情

插件具體的實現原理是：

1. 插件中生成整個數據庫文章的json數據（并使用typecho的鉤子可以保證在發表新文章、修改文章中時候同步更新數據），這個數據有兩種方式存儲（文件形式，數據庫）
2. 博客打開的時候就會加載到這個json數據到前端
3. 搜索的時候直接拿這個json數據進行匹配就可以了

但我把代碼用到我的博客上的時候，出現了一些問題。

當文章數目很多的時候（我的博客目前是217篇文章），生成的json數據大小是很大的，我生成之后是1.9M的大小，使用jquery的 getjson方法很耗時（我測試是19s，和服務器有關，雖然不阻礙頁面渲染）

于是產生兩個問題：

1. 在json數據在請求的這個過程中，搜索功能是沒辦法用的
2. json數據過大造成的流量問題

（熊貓小A是一打開博客就開始請求這個json文件，我個人覺得搜索其實并不是一個常用功能，所以我是點擊搜索框才開始請求這個json數據）

當然上面兩個問題不是特別大的問題。

但是如果你的博客的文章非常之多！這個json數據會很大，導致的請求讀取時間就可能非常長了，而且造成不必要的流量加載。

我的解決方法是：前端不要一次性加載整個文章的json數據，而是通過php使用SEESION變量存儲讀取緩存的json數據。

if ($_SESSION['search_cache'] === false){
            $object['status'] = false;
            //這部分如果數據是存儲在數據庫中，就從數據庫中讀取，我這里是從緩存文件中讀取
            $filePath = __TYPECHO_ROOT_DIR__ . __TYPECHO_PLUGIN_DIR__ . DIRECTORY_SEPARATOR.'Handsome'.DIRECTORY_SEPARATOR.'cache'.DIRECTORY_SEPARATOR.'search.json';
            $file = file_get_contents($filePath);
            if ($file === false){
                $fail = "{}";
                $_SESSION['search_cache'] = $fail;
                echo $fail;
            }else{
                $_SESSION['search_cache'] = $file;
            }
        }else{
            $object['status'] = true;
        }
        
        //處理搜索數據，返回結果
        ...

通過監控輸入框的值，不斷發起ajax請求，后端直接使用SEESION變量的值進行返回結果就可以。

優點： 多次搜索，只需要一次讀取文件的消耗（之后使用SEESION變量）
缺點： 多次搜索會有多次ajax請求（但這個ajax請求不會讀數據庫，也不會讀文件，總體來說消耗是非常小的，所以速度也是很快的）

（之前實現也是監控輸入值發起ajax請求，只不過每次ajax請求都會操作數據庫，這個速度很慢）

當然這種方法也只是一種權衡罷了，畢竟ajax請求再快也會受服務器是否阻塞和網絡原因影響，而一開始就加載好全部的json數據則真正達到“即時搜索”。

關于搜索的問題，也許這個Typecho插件能夠幫助到您：

Soso - 搜索增強Typecho插件

Muze

• 20年2月17日
• 喜歡：0
• 瀏覽：1.1k