Jim Framework 使用教程
1. 项目的目录结构及介绍
jim-framework/
├── README.md
├── app/
│ ├── controllers/
│ ├── models/
│ ├── views/
│ └── helpers/
├── config/
│ ├── database.yml
│ ├── routes.rb
│ └── application.rb
├── db/
│ ├── migrate/
│ └── seeds.rb
├── lib/
│ ├── tasks/
│ └── helpers/
├── public/
│ ├── images/
│ ├── javascripts/
│ └── stylesheets/
├── spec/
│ ├── controllers/
│ ├── models/
│ └── views/
└── Gemfile
目录结构介绍
- app/: 包含应用程序的主要代码,包括控制器、模型、视图和辅助函数。
- controllers/: 存放控制器文件。
- models/: 存放模型文件。
- views/: 存放视图文件。
- helpers/: 存放辅助函数文件。
- config/: 包含应用程序的配置文件。
- database.yml: 数据库配置文件。
- routes.rb: 路由配置文件。
- application.rb: 应用程序配置文件。
- db/: 包含数据库相关的文件。
- migrate/: 存放数据库迁移文件。
- seeds.rb: 数据库种子文件。
- lib/: 包含库文件和任务。
- tasks/: 存放Rake任务文件。
- helpers/: 存放辅助函数文件。
- public/: 包含公共资源文件,如图片、JavaScript和CSS文件。
- images/: 存放图片文件。
- javascripts/: 存放JavaScript文件。
- stylesheets/: 存放CSS文件。
- spec/: 包含测试文件。
- controllers/: 存放控制器测试文件。
- models/: 存放模型测试文件。
- views/: 存放视图测试文件。
- Gemfile: 依赖管理文件。
2. 项目的启动文件介绍
项目的启动文件通常位于 config/application.rb
。这个文件包含了应用程序的基本配置和加载顺序。
require_relative "boot"
require "rails"
# Pick the frameworks you want:
require "active_model/railtie"
require "active_job/railtie"
require "active_record/railtie"
require "active_storage/engine"
require "action_controller/railtie"
require "action_mailer/railtie"
require "action_mailbox/engine"
require "action_text/engine"
require "action_view/railtie"
require "action_cable/engine"
# require "rails/test_unit/railtie"
# Require the gems listed in Gemfile, including any gems
# you've limited to :test, :development, or :production.
Bundler.require(*Rails.groups)
module JimFramework
class Application < Rails::Application
# Initialize configuration defaults for originally generated Rails version.
config.load_defaults 6.1
# Configuration for the application, engines, and railties goes here.
#
# These settings can be overridden in specific environments using the files
# in config/environments, which are processed later.
#
# config.time_zone = "Central Time (US & Canada)"
# config.eager_load_paths << Rails.root.join("extras")
end
end
启动文件介绍
- require_relative "boot": 加载Rails的启动文件。
- require "rails": 加载Rails框架。
- Bundler.require(*Rails.groups): 加载Gemfile中定义的gem。
- module JimFramework: 定义应用程序的模块。
- class Application < Rails::Application: 定义应用程序类,并进行基本配置。
3. 项目的配置文件介绍
数据库配置文件
位于 config/database.yml
,用于配置数据库连接信息。
default: &default
adapter: postgresql
encoding: unicode
pool: <%= ENV.fetch("RAILS_MAX_THREADS