Devise-Async 项目使用教程

Devise-Async 项目使用教程

devise-asyncSend Devise's emails in background. Supports Resque, Sidekiq, Delayed::Job and QueueClassic.项目地址:https://gitcode.com/gh_mirrors/de/devise-async

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

Devise-Async 项目的目录结构如下：

devise-async/
├── lib/
│   ├── devise/
│   │   ├── async/
│   │   │   ├── backend.rb
│   │   │   ├── model.rb
│   │   │   ├── proxy.rb
│   │   │   └── version.rb
│   │   └── async.rb
│   └── devise-async.rb
├── spec/
│   ├── devise/
│   │   ├── async/
│   │   │   ├── backend_spec.rb
│   │   │   ├── model_spec.rb
│   │   │   └── proxy_spec.rb
│   │   └── async_spec.rb
│   └── spec_helper.rb
├── .gitignore
├── .rspec
├── .travis.yml
├── CHANGELOG.md
├── Gemfile
├── LICENSE
├── README.md
├── Rakefile
└── devise-async.gemspec

目录结构介绍

• lib/: 包含项目的核心代码。
  • devise/async/: 包含与 Devise 异步邮件发送相关的后端、模型和代理文件。
  • devise-async.rb: 项目的主文件。
• spec/: 包含项目的测试代码。
  • devise/async/: 包含与 lib/devise/async/ 对应的测试文件。
  • spec_helper.rb: 测试辅助文件。
• .gitignore: Git 忽略文件配置。
• .rspec: RSpec 配置文件。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目更新日志。
• Gemfile: 项目依赖管理文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• Rakefile: Rake 任务文件。
• devise-async.gemspec: 项目 gem 规范文件。

2. 项目的启动文件介绍

Devise-Async 项目的启动文件主要是 lib/devise-async.rb，该文件负责加载项目所需的所有模块和配置。

require 'devise'
require 'devise/async/version'
require 'devise/async/model'
require 'devise/async/backend'
require 'devise/async/proxy'

module Devise
  module Async
    # 项目启动逻辑
  end
end

启动文件介绍

• require 'devise': 引入 Devise gem。
• require 'devise/async/version': 引入版本信息。
• require 'devise/async/model': 引入模型模块。
• require 'devise/async/backend': 引入后端模块。
• require 'devise/async/proxy': 引入代理模块。
• module Devise::Async: 定义 Devise 异步模块，包含项目的启动逻辑。

3. 项目的配置文件介绍

Devise-Async 项目的配置文件主要是 config/initializers/devise_async.rb，该文件用于配置 Devise 异步邮件发送的相关参数。

# config/initializers/devise_async.rb
Devise::Async.setup do |config|
  config.enabled = true
  config.backend = :resque
  config.queue = :my_custom_queue
  config.mailer = "MyCustomMailer"
end

配置文件介绍

• config.enabled: 启用或禁用 Devise 异步功能。
• config.backend: 设置使用的后台队列系统，如 :resque、:sidekiq 等。
• config.queue: 设置自定义队列名称。
• config.mailer: 设置自定义邮件发送类。

通过以上配置，可以灵活地调整 Devise 异步邮件发送的行为，以适应不同的应用场景和需求。

devise-asyncSend Devise's emails in background. Supports Resque, Sidekiq, Delayed::Job and QueueClassic.项目地址:https://gitcode.com/gh_mirrors/de/devise-async