[项目详解][boost搜索引擎#1] 概述 | 去标签 | 数据清洗 | scp

目录

一、前言

二、项目的相关背景

三、搜索引擎的宏观原理

四、搜索引擎技术栈和项目环境

五、正排索引 VS 倒排索引--原理

正排索引

分词

倒排索引

六、编写数据去除标签和数据清洗模块 Parser

1.数据准备

parser

编码

1.枚举文件 EnumFile

2.去标签ParseHtml()

测试

使用SCP命令在两台Linux服务器之间传输文件

适用场景

命令格式

示例

将scp任务放入后台执行

---

Boost搜索引擎项目的九个步骤~

1. 项目的相关背景
2. 搜索引擎的相关宏观原理
3. 搜索引擎技术栈和项目环境
4. 正排索引 vs 倒排索引 - 搜索引擎具体原理
5. 编写数据去标签与数据清洗的模块Parser
6. 编写建立索引的模块 Index
7. 编写搜索引擎模块 Searcher
8. 编写http server模块
9. 编写前端模块

准备分几篇文章讲解，持续更新中(●'◡'●)，会在最后一篇文章中放上项目的gitee~本篇文章先从这几个部分进行实现

一、前言

在日常使用浏览器搜索时，服务器返回的是与搜索关键字相关的网站信息，包括网站标题、内容简述和URL。点击标题后会跳转到对应的网页。常见的搜索引擎如百度、谷歌等覆盖全网信息，而我们的项目是一个小范围的站内搜索引擎，用 boost库 实现的 boost站内搜索

二、项目的相关背景

什么是Boost库？

• Boost库是C++的准标准库，提供许多高级功能。
• 许多Boost组件已被纳入C++11标准。如：哈希、智能指针
• 更多详情可访问Boost官网。

什么是搜索引擎？

• 搜索引擎如百度、360、搜狗展示的信息通常 包括网页标题、摘要和URL。
• 我们设计的搜索引擎将 不包含图片、视频或广告等扩展内容。
• 搜出来的结果展示都是以，标题+内容摘要+url 组成

为什么要做Boost搜索引擎？

• Boost库缺乏站内搜索功能。
• 实现一个类似cplusplus官网的站内搜索功能是有意义的

• 实现目标：搜索一个关键字，就能够跳转到指定的网页，并显示出来
• 站内搜索的数据量相对较小且更垂直化。

三、搜索引擎的宏观原理

通过以下步骤实现：

1. 数据准备：获取并存储Boost文档数据。我们可以直接将 boost库 对应版本的数据直接解压到我们对应文件里。
2. 去标签 & 数据清洗：提取所需信息（标题、摘要、URL）。我们从boost库拿的数据其实就是对应文档html网页，但是我们需要的只是每个网页的标题+网页内容摘要+跳转的网址，所以才有了去标签和数据清洗（只拿我们想要的）
3. 构建索引：对清洗后的数据建立索引（方便客户端快速查找）；
4. 用户请求处理：解析搜索关键词，检索索引，返回结果。

流程模拟：

• 当服务器所以的工作都完成之后，客户端就发起http请求，
• 通过GET方法，上传搜索关键，
• 服务器收到了会进行解析，通过客户端发来的关键字 去检索已经构建好的索引，找到了相关的html后
• 将逐个的将每个网页的标题、摘要和网址拼接起来，构建出一个新的网页，响应给客户端
• 至此，客户就看到了相应的内容，点击网址就可以跳转到boost库相应的文档位置。

网页概述：

• tltle
• 内容摘要
• url

盈利方式：

• 推送广告，竞价排名收费

四、搜索引擎技术栈和项目环境

技术栈：

• C/C++/C++11, STL,
• 相关库

• Web 前端（ HTML5, CSS, JavaScript）, jQuery, Ajax。

相关库

• Boost库（文件遍历）
• Jsoncpp（json 处理）
• cppjieba（分词）
• cpp-httplib（网络库-http 服务）

项目环境

• Ubuntu 云服务器,
• vim/gcc/g++/Makefile
• VS2022 或 VSCode

五、正排索引 VS 倒排索引--原理

• 正排索引：文档ID-->文档关键词/ 内容。
• 倒排索引：文档的关键词-->文档ID。

分词

目标文档进行分词：目的：方便建立倒排索引和查找
停止词：了，吗，的，the，a，一般情况我们在分词的时候可以不考虑

正排索引

文档 1	我以后要养一只小猫
文档 2	我以后还要养一只小狗

分词

1：我 /以后 /要养/ 一只/ 小猫

2：我 /以后 /还要养 /一只 /小狗

倒排索引

我	文档 1，文档 2
以后	文档 1，文档 2
小猫	文档 1
小狗	文档 2

⭕模拟一次查找的过程：

用户输入：关键词->倒排索引中查找->提取出文档ID(1,2)->通过倒排数据找到正排ID->找到文档的内容->title+conent（desc）+url 文档结果进行摘要->通过 json字符串响应回去-->然后在用户的浏览器显示出一个个网页信息

代码实现逻辑：

下载Boost库 -> 解析HTML -> 数据清洗 -> 构建索引 -> 提供搜索接口 -> 显示结果。

1. 数据准备：从Boost官网下载 boost 库，并解压至Linux目录。
2. 选择所需文件：写一个解析程序从一个个html文件的源码中提取标题、内容和url，将他们保存到硬盘的一个data.txt文件中。
3. 读取：读取data.txt文件，建立正排和倒排索引，提供索引的接口来获取正排和倒排数据
4. 数据拷贝：写一个html页面，提供给用户一个搜索功能。然后模拟上述查找过程

六、编写数据去除标签和数据清洗模块 Parser

1.数据准备

• boost 官⽹： https://www.boost.org/

下载：

之后 rz -E，再解压

⽬前只需要boost_1_86_0/doc/html⽬录下的html⽂件，⽤它来进⾏建⽴索引

将我们所需要的数据源 拷贝到 data目录下的intput目录下--清洗数据完成

parser

这里我是在 vscode 下进行代码编写的，但是需要连接一下云服务器，与 Linux进行同步。 你也可以选择 vim。

基本框架：

• 将 data/input/ 所有后缀为 html 的文件筛选出来 ---- 清洗数据
• 然后对筛选好的html文件进行解析（去标签），拆分出标题、内容、网址 ---- 去标签
• 最后将去标签后的所有html文件的标题、内容、网址处理后，写入到 data/raw_html/raw.txt 下

什么是去标签呢？

举例 nano process.html 查看一下

对数据清洗之后，拿到的全都是 html 文件，此时还需要对 html 文件进行去标签处理，我们这里随便看一个html文件

• 退出 nano 的方法： Ctrl + X 。做了修改并且想要保存，输入 Y（是），不保存，直接按 N（否）然后回车

• 我们在 data目录 下的 raw_html目录下 创建有一个 raw.txt文件，用来存储干净的数据文档
• <> : html的标签，这个标签对我们进行搜索是没有价值的，需要去掉这些标签，一般标签都是成对出现的！但是也有单独出现的，我们也是不需要的。

采用下面的方案：

• 写入文件中，一定要考虑下一次在读取的时候，也要方便操作!
• 类似：title\3content\3url \n title\3content\3url \n title\3content\3url \n ...
• 方便我们getline(ifsream, line)，直接获取文档的全部内容：title\3content\3url
• 文件内按照 \3 作为分割符，每个文件再按照 \n 进行区分

note: vim 下的中文注释：ctrl+space

编码

在 Boost_Searcher 目录下创建 parser.cpp 文件开始编写框架

三步走：

• 第⼀步EnumFile(src_path, &files_list): 递归式的把每个html⽂件名带路径，保存到文件 files_list中，⽅便后期进⾏⼀个⼀个的 ⽂件进⾏读取（预处理
• 第⼆步ParseHtml(files_list, &results): 按照files_list读取每个⽂件，并进⾏解析
• 第三步SaveHtml(results, output): 把解析完毕的各个⽂件内容，写⼊到output,按照\3作为每个⽂档的分割符

#include 
#include 
#include 
 
// 首先我们肯定会读取文件，所以先将文件的路径名 罗列出来
// 将 数据源的路径 和 清理后干净文档的路径 定义好
 
 
const std::string src_path = "data/input";          // 数据源的路径
const std::string output = "data/raw_html/raw.txt"; // 清理后干净文档的路径
 
//DocInfo --- 文件信息结构体
typedef struct DocInfo
{
    std::string title;   //文档的标题
    std::string content; //文档的内容
    std::string url;     //该文档在官网当中的url
}DocInfo_t;
 
// 命名规则
// const & ---> 输入
// * ---> 输出
// & ---> 输入输出
 
 
//把每个html文件名带路径，保存到files_list中
bool EnumFile(const std::string &src_path, std::vector *files_list);
 
//按照files_list读取每个文件的内容，并进行解析
bool ParseHtml(const std::vector &files_list, std::vector *results);
 
//把解析完毕的各个文件的内容写入到output
bool SaveHtml(const std::vector &results, const std::string &output);
 
 
 
int main()
{
    std::vector files_list; // 将所有的 html文件名保存在 files_list 中
 
    // 第一步：递归式的把每个html文件名带路径，保存到files_list中，方便后期进行一个一个的文件读取
 
    // 从 src_path 这个路径中提取 html文件，将提取出来的文件存放在 string 类型的 files_list 中
    if(!EnumFile(src_path, &files_list)) //EnumFile--枚举文件
    {
        std::cerr << "enum file name error! " << std::endl;
        return 1;
    }
    return 0;
 
    // 第二步：从 files_list 文件中读取每个.html的内容，并进行解析
 
     std::vector results;
     // 从 file_list 中进行解析，将解析出来的内容存放在 DocInfo 类型的 results 中
    if(!ParseHtml(files_list, &results))//ParseHtml--解析html
    {
        std::cerr << "parse html error! " << std::endl;
        return 2;
    }
 
 
    // 第三部：把解析完毕的各个文件的内容写入到output，按照 \3 作为每个文档的分隔符
 
    // 将 results 解析好的内容，直接放入 output 路径下
    if(!SaveHtml(results, output))//SaveHtml--保存html
    {
        std::cerr << "save html error! " << std::endl;
        return 3;
    }
 
    return 0;
}

主要实现：枚举文件、解析html文件、保存html文件三个工作。

这三个工作完成是需要我们使用boost库当中的方法的，我们需要安装一下boost的开发库：

通过如上命令，我是已经安装过啦~

下图就是我们接下来编写代码需要用到的 boost库 当中的 filesystem方法。

1.枚举文件 EnumFile

• 使用 boost 枚举文件名

//在原有的基础上添加这个头文件
#include 
 
//把每个html文件名带路径，保存到files_list中
bool EnumFile(const std::string &src_path, std::vector *files_list)
{
    // 简化作用域的书写
    namespace fs = boost::filesystem;
    fs::path root_path(src_path); // 定义一个path对象，枚举文件就从这个路径下开始
    // 判断路径是否存在
    if(!fs::exists(root_path))
    {
        std::cerr << src_path << " not exists" << std::endl;
        return false;
    }
    // 对文件进行递归遍历
    fs::recursive_directory_iterator end; // 定义了一个空的迭代器，用来进行判断递归结束  -- 相当于 NULL
    for(fs::recursive_directory_iterator iter(root_path); iter != end; iter++)
    {
        // 判断指定路径是不是常规文件，如果指定路径是目录或图片直接跳过
        if(!fs::is_regular_file(*iter))
        {
            continue;
        }
 
        // 如果满足了是普通文件，还需满足是.html结尾的
        // 如果不满足也是需要跳过的
        // ---通过iter这个迭代器（理解为指针）的一个path方法（提取出这个路径）
        // ---然后通过extension()函数获取到路径的后缀
        if(iter->path().extension() != ".html")
        {
            continue;
        }
 
        //std::cout << "debug: " << iter->path().string() << std::endl; // 测试代码
      
        // 走到这里一定是一个合法的路径，以.html结尾的普通网页文件
        files_list->push_back(iter->path().string()); // 将所有带路径的html保存在files_list中，方便后续进行文本分析
    }
    return true;
}

• makefile 中连接 boost 库

查看对外部库的连接：

运行：

• 成功提取出了 html 文件~
• 测试成功后，将测试代码注释掉哦！
• 运行测试成功，继续编写下一个模块

---

2.去标签ParseHtml()

解析html文件

1. 读取刚刚枚举好的文件
2. 解析html文件中的title
3. 解析html文件中的content
4. 解析html文件中的路径，构建url

• 函数建构

bool ParseHtml(const std::vector &files_list, std::vector *results)
{
    for(const std::string &file : files_list)
    {
        // 1.读取文件，Read()
        std::string result;
        if(!ns_util::FileUtil::ReadFile(file, &result))
        {
            continue;
        }
        // 2.解析指定的文件，提取title
        DocInfo_t doc;
        if(!ParseTitle(result, &doc.title))
        {
            continue;
        }
        // 3.解析指定的文件，提取content
        if(!ParseContent(result, &doc.content))
        {
            continue;
        }
        // 4.解析指定的文件路径，构建url
        if(!ParseUrl(file, &doc.url))
        {
            continue;        
        }
 
        // 到这里，一定是完成了解析任务，当前文档的相关结果都保存在了doc里面
        results->push_back(std::move(doc)); // 本质会发生拷贝，效率肯能会比较低，这里我们使用move后的左值变成了右值，去调用push_back的右值引用版本
    }
    return true;                                                                                                                                                                                                                                                    
}

主要完成 4件事：

①根据路径名依次读取文件内容，②提取title，③提取content，④构建url。

---

2.1读取文件ReadFile()

• 遍历 files_list 中存储的文件名，从中读取文件内容到 result 中，由函数 ReadFile() 完成该功能。该函数定义于头文件 util.hpp的类 FileUtil中。

#pragma once
#include 
#include 
#include 
#include 
 
namespace ns_util
{
    class FileUtil
    {                                                                                                                                                                                                                                                                                                                                                                        
    public:
        static bool ReadFile(const std::string &file_path, std::string *out)
        {
            std::ifstream in(file_path, std::ios::in);
            if(!in.is_open())
            {
                std::cerr << "open file " << file_path << " error" << std::endl;
                return false;
            }
            std::string line;
            while(std::getline(in, line)) 
//如何理解getline读取到文件结束呢？？getline的返回值是一个&，while(bool), 本质是因为重载了强制类型转化
            {
                *out += line;
            }
            in.close();
            return true;
        }
    };
}

⭕ 重点理解：C++的流读取 && getline 的使用

2.2 提取title —— ParseTitle()

• 可以发现 构成的
• find（的左尖括号，最后截取子串；

这里需要依赖函数 —— bool ParseTitle(const std::string& file,&doc.title)，

//解析title
static bool ParseTitle(const std::string& file,std::string* title)
{
    // 查找  位置
    std::size_t end = file.find("");
    if(end == std::string::npos)
    {
        return false;
    }
    
    // 计算中间的距离，截取中间的内容
    begin += std::string("