开源项目 go-pkg-spider 启动和配置教程

1. 项目目录结构及介绍

开源项目 go-pkg-spider 的目录结构如下：

go-pkg-spider/
├── cmd/             # 项目的主入口，通常包含 main.go 文件
│   └── spider/       # 主程序所在目录
│       └── main.go   # 项目启动文件
├── configs/         # 配置文件存放目录
│   └── config.yaml   # 项目配置文件
├── internal/        # 内部模块和包
│   ├── engine/       # 爬虫引擎相关代码
│   ├── model/        # 数据模型定义
│   ├── repository/   # 数据存储相关接口和实现
│   └── service/      # 业务逻辑相关代码
├── pkg/             # 外部可复用的包和工具
├── scripts/         # 脚本文件，如数据库迁移脚本等
├── test/            # 测试代码目录
├── go.mod            # go 的依赖管理文件
└── README.md        # 项目说明文件

• cmd/：存放项目启动入口的目录，通常包含 main.go 文件。
• configs/：存放项目的配置文件，如 yaml、json 等。
• internal/：存放项目内部使用的模块和包，包括爬虫引擎、数据模型、数据存储接口和业务逻辑等。
• pkg/：存放项目外部可复用的包和工具。
• scripts/：存放项目相关的脚本文件，如数据库迁移脚本。
• test/：存放项目的测试代码。
• go.mod：go 的依赖管理文件，用于管理项目依赖。
• README.md：项目的说明文件，通常包含项目的介绍、安装、配置和使用说明。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/spider/main.go。以下是 main.go 文件的基本结构：

package main

import (
    "log"
    "os"

    "github.com/suosi-inc/go-pkg-spider/internal/engine"
    "github.com/suosi-inc/go-pkg-spider/configs"
)

func main() {
    // 加载配置文件
    cfg, err := configs.LoadConfig("config.yaml")
    if err != nil {
        log.Fatalf("加载配置文件失败: %v", err)
    }

    // 初始化爬虫引擎
    e, err := engine.NewEngine(cfg)
    if err != nil {
        log.Fatalf("初始化爬虫引擎失败: %v", err)
    }

    // 启动爬虫引擎
    if err := e.Start(); err != nil {
        log.Fatalf("启动爬虫引擎失败: %v", err)
    }

    // 等待引擎停止
    e.Wait()

    // 程序退出时清理资源
    if err := e.Stop(); err != nil {
        log.Fatalf("停止爬虫引擎失败: %v", err)
    }
    os.Exit(0)
}

main.go 文件负责加载配置文件，初始化爬虫引擎，并启动爬虫。

3. 项目的配置文件介绍

项目的配置文件位于 configs/config.yaml。以下是配置文件的基本内容：

spider:
  concurrency: 10    # 爬虫并发数
  timeout: 30        # 爬取单个网页的超时时间（秒）
  delay: 1           # 爬取间隔时间（秒）

database:
  dialect: mysql    # 数据库类型
  host: 127.0.0.1   # 数据库地址
  port: 3306        # 数据库端口
  user: root        # 数据库用户名
  password: password # 数据库密码
  database: spider   # 数据库名

配置文件包含了爬虫的并发数、超时时间、爬取间隔时间以及数据库的连接信息等。这些配置项可以在项目启动时通过配置文件进行修改，以满足不同的需求。