Dante 项目技术文档

2024-12-26 15:13:21作者：范靓好Udolf

1. 安装指南

Dante 是一个将任意 Ruby 代码转换为可通过命令行启动或停止的守护进程的简单工具。要使用 Dante，请按照以下步骤进行安装：

将 Dante 添加到您的 Gemfile 中：

# Gemfile

gem "dante"

或者，将其添加到您的 gemspec 中：

# mygem.gemspec

Gem::Specification.new do |s|
  s.add_dependency "dante"
end

然后，运行 bundle install 来安装 Dante。

2. 项目使用说明

Dante 设计用于从任何 "bin" 可执行文件中使用。以下是如何创建和使用 Dante 的示例：

创建 bin 可执行文件

在 bin/myapp 创建一个文件：

#!/usr/bin/env ruby

require File.expand_path("../../myapp.rb", __FILE__)

Dante.run('myapp') do |opts|
  # opts: host, pid_path, port, daemonize, user, group
  Thin::Server.start('0.0.0.0', opts[:port]) do
    use Rack::CommonLogger
    use Rack::ShowExceptions
    run MyApp
  end
end

确保使您的 bin 文件可执行：

chmod +x bin/myapp

命令行使用

以下是一些命令行选项：

启动应用：
```
./bin/myapp
```
启动应用并重定向输出到日志文件：
```
./bin/myapp -l /var/log/myapp.log
```

守护进程模式启动应用：

./bin/myapp -p 8080 -d -P /var/run/myapp.pid -l /var/log/myapp.log

停止守护进程：
```
./bin/myapp -k -P /var/run/myapp.pid
```
显示帮助信息：
```
./bin/myapp --help
```

高级用法

如果需要添加自定义标志或描述，可以使用 Dante::Runner：

#!/usr/bin/env ruby

require File.expand_path("../../myapp.rb", __FILE__)

runner = Dante::Runner.new('myapp', :port => 8080)
runner.description = "This is myapp"
runner.with_options do |opts|
  opts.on("-t", "--test TEST", String, "Test this thing") do |test|
    options[:test] = test
  end
end

runner.verify_options_hook = lambda { |opts|
  raise Exception.new("Must supply test parameter") if opts[:test].nil?
}

runner.execute do |opts|
  Thin::Server.start('0.0.0.0', opts[:port]) do
    puts opts[:test]
    use Rack::CommonLogger
    use Rack::ShowExceptions
    run MyApp
  end
end

现在可以这样做：

./bin/myapp -t custom

并且 opts 会包含 :test 选项供脚本使用。

3. 项目 API 使用文档

Dante 主要通过 Dante.run 和 Dante::Runner 类进行操作。以下是一些关键 API 的描述：

Dante.run(name, &block): 开始一个 Dante 守护进程。name 是进程名称，block 包含启动逻辑。
Dante::Runner.new(name, options): 创建一个 Dante::Runner 实例。name 是进程名称，options 是启动参数。
runner.description: 设置守护进程的描述。
runner.with_options: 添加自定义命令行选项。
runner.verify_options_hook: 设置一个验证钩子来检查选项。
runner.execute(&block): 执行守护进程的启动逻辑。