Vessel 开源项目使用教程

Vessel 开源项目使用教程

vesselFast high-level web crawling Ruby framework项目地址:https://gitcode.com/gh_mirrors/ves/vessel

1. 项目的目录结构及介绍

vessel/
├── bin/
│   └── vessel
├── config/
│   ├── database.yml
│   ├── environment.rb
│   └── settings.yml
├── lib/
│   ├── vessel.rb
│   └── vessel/
│       ├── core.rb
│       ├── utils.rb
│       └── ...
├── spec/
│   ├── vessel_spec.rb
│   └── ...
├── Gemfile
├── Gemfile.lock
├── README.md
└── vessel.gemspec

目录结构介绍

• bin/: 存放可执行文件，如 vessel 启动脚本。
• config/: 存放项目的配置文件，如数据库配置 database.yml、环境配置 environment.rb 和通用设置 settings.yml。
• lib/: 存放项目的核心代码，包括主文件 vessel.rb 和子模块文件。
• spec/: 存放项目的测试文件，如 vessel_spec.rb。
• Gemfile: 定义项目所需的 RubyGems 依赖。
• Gemfile.lock: 锁定 Gem 版本。
• README.md: 项目的基本介绍和使用说明。
• vessel.gemspec: 项目的 gem 规范文件。

2. 项目的启动文件介绍

bin/vessel

bin/vessel 是项目的启动脚本，用于启动 Vessel 项目。该脚本通常会加载项目的核心代码并初始化环境。

#!/usr/bin/env ruby

require 'vessel'

Vessel::Core.run

启动流程

1. 加载核心代码: 通过 require 'vessel' 加载项目的核心代码。
2. 运行核心模块: 调用 Vessel::Core.run 方法启动项目。

3. 项目的配置文件介绍

config/database.yml

config/database.yml 是数据库配置文件，用于定义数据库连接信息。

default: &default
  adapter: postgresql
  encoding: unicode
  pool: 5

development:
  <<: *default
  database: vessel_development
  username: vessel
  password: password

test:
  <<: *default
  database: vessel_test
  username: vessel
  password: password

production:
  <<: *default
  database: vessel_production
  username: vessel
  password: <%= ENV['VESSEL_DATABASE_PASSWORD'] %>

config/environment.rb

config/environment.rb 是环境配置文件，用于加载项目的依赖和初始化环境。

require 'bundler/setup'
Bundler.require(:default, ENV['RACK_ENV'] || 'development')

require_relative '../lib/vessel'

config/settings.yml

config/settings.yml 是通用设置文件，用于定义项目的全局配置。

default: &default
  log_level: info
  cache_enabled: true

development:
  <<: *default
  log_level: debug

test:
  <<: *default
  cache_enabled: false

production:
  <<: *default
  log_level: warn

通过以上配置文件，可以灵活地调整项目的运行环境和行为。

vesselFast high-level web crawling Ruby framework项目地址:https://gitcode.com/gh_mirrors/ves/vessel