Ruby on Rails所构建的应用程序基本目录结构总结

当使用rails new appname生成rails应用后，我们可以通过tree来查看rails应用的目录结构：

目录结构

应用程序目录下会有app、config、db、doc、lib、log、public、script、test、tmp和vendor等11个目录和config.ru、gemfile、gemfile.lock、rakefile、readme.rdoc等5个文件。

目录在稍后会一一解释，先看一下app目录下的文件：

config.ru 用来启动rails程序的rack设置文件

require ::file.expand_path('../config/environment', __file__)
run myapps::application

gemfile设置rails程序所依赖的gems (一旦用bundle install安装后，会生成gemfile.lock)

source 'https://ruby.taobao.org/'

gem 'rails', '3.2.1'
gem 'sqlite3'

# gems used only for assets and not required
# in production environments by default.
group :assets do
 gem 'sass-rails',  '~> 3.2.3'
 gem 'coffee-rails', '~> 3.2.1'
 gem 'uglifier', '>= 1.0.3'
end

gem 'jquery-rails'
gem ... ...

rakefile 用来载入可以被终端执行的rake任务
<!--more-->

下面是用tree命令查看，所显示的目录和文件结构：

.
├── app
│  ├── assets
│  │  ├── images
│  │  │  └── rails.png
│  │  ├── javascripts
│  │  │  └── application.js
│  │  └── stylesheets
│  │    └── application.css
│  ├── controllers
│  │  └── application_controller.rb
│  ├── helpers
│  │  └── application_helper.rb
│  ├── mailers
│  ├── models
│  └── views
│    └── layouts
│      └── application.html.erb
├── config
│  ├── application.rb
│  ├── boot.rb
│  ├── database.yml
│  ├── environment.rb
│  ├── environments
│  │  ├── development.rb
│  │  ├── production.rb
│  │  └── test.rb
│  ├── initializers
│  │  ├── backtrace_silencers.rb
│  │  ├── inflections.rb
│  │  ├── mime_types.rb
│  │  ├── secret_token.rb
│  │  ├── session_store.rb
│  │  └── wrap_parameters.rb
│  ├── locales
│  │  └── en.yml
│  └── routes.rb
├── config.ru
├── db
│  └── seeds.rb
├── doc
│  └── readme_for_app
├── gemfile
├── lib
│  ├── assets
│  └── tasks
├── log
├── public
│  ├── 404.html
│  ├── 422.html
│  ├── 500.html
│  ├── favicon.ico
│  ├── index.html
│  └── robots.txt
├── rakefile
├── readme.rdoc
├── script
│  └── rails
├── test
│  ├── fixtures
│  ├── functional
│  ├── integration
│  ├── performance
│  │  └── browsing_test.rb
│  ├── test_helper.rb
│  └── unit
├── tmp
│  └── cache
│    └── assets
└── vendor
  ├── assets
  │  ├── javascripts
  │  └── stylesheets
  └── plugins

应用目录(app/)

app目录是rails程序的主目录，不同子目录分别存放了模型 models (m)、控制器 controllersw (c)、视图 views (v)及mailers、helpers和assests等文档。

模型－控制器－视图

分别存放模型、控制器和视图。其中，模型统一存放在app/models目录下，控制器统一存放在app/controllers目录下(可以使用目录进一步组织控制器，例如cpanel目录下用于存放管理后台相关的控制器)，视图存放在app/views目录下，视图模型存放在app/view/layouts目录下，默认为applicaiton.html.erb。

assets静态文件

assets静态文件存放在app/assets目录下，分别为app/assets/images、app/assets/stylesheets、app/assets/javascripts目录。

helper

helper是一些在视图中可以使用的小方法，用来产生较复杂的html。预设的helper文件名称对应控制器，但不强制要求，在任意一个helper文件中定义的方法，都可以在任何视图中使用。

配置文件目录(config/)

虽然rails遵循“约定优于配置”的原则，但仍有一些需要设定的地方。在配置文件目录下，会存放应用程序设置文件application.rb、数据库设置文件database.yml、路由设置文件routes.rb、多重环境设置config/environments目录、其它初始设置文件config/initializers。

rails启动应用程序设置

启动rails程序(例如rails console或rails server)，会执行以下三个文档

boot.rb 载入bundler环境，这个文件由rails自动产生，不需要修改；

require 'rubygems'

# set up gems listed in the gemfile.
env['bundle_gemfile'] ||= file.expand_path('../../gemfile', __file__)

require 'bundler/setup' if file.exists?(env['bundle_gemfile'])

application.rb 载入rails gems和依赖的其它gems，接着设定rails程序；
require file.expand_path('../boot', __file__)

require 'rails/all'

if defined?(bundler)
 # if you precompile assets before deploying to production, use this line
 bundler.require(*rails.groups(:assets => %w(development test)))
 # if you want your assets lazily compiled in production, use this line
 # bundler.require(:default, :assets, rails.env)
end

module myapps
 class application < rails::application
  # settings in config/environments/* take precedence over those specified here.
  # application configuration should go into files in config/initializers
  # ... ...

  # configure the default encoding used in templates for ruby 1.9.
  config.encoding = "utf-8"

  # configure sensitive parameters which will be filtered from the log file.
  config.filter_parameters += [:password]

  # ... ...

  # enable the asset pipeline
  config.assets.enabled = true

  # version of your assets, change this if you want to expire all your assets
  config.assets.version = '1.0'
 end
end
environment.rb 执行所有启动程序(initializers)，这个文件同样由rails产生，不需要修改。
# load the rails application
require file.expand_path('../application', __file__)

# initialize the rails application
myapps::application.initialize!

初始设置文件(initializers)
由environment.rb调用，系统默认的初始设置文件有backtrace_silencers.rb、inflections.rb、mime_types.rb、secret_token.rb、session_store.rb和wrap_parameters.rb等6个，分别对应的用途是：选择性移动异常追踪、单复数转换、mime_types、加密cookies信息的token、默认session储存以及参数封装等。

###数据库存储目录(db/)

###程序帮助文档(doc/)

###共享类或模块文件(lib/)

一些共享的类或模块可以存放在该目录。另外，rake的任务，可存放在lib/tasks目录下。

###日志目录(log/)

###公共文件目录(public/)

对于web服务器来说，可以直接访问的文件目录。可以用于存放通用的images、stylesheets和javascripts (rails 2.x)。

###rails脚本文件(script/)

###测试文件目录(test/)

用于存放单元测试、功能测试及整合测试文件。

###临时文件目录(tmp/)

###第三方插件目录(vendor/)

在使用bundler安装gems插件时，也可以选择安装在该目录下。例如bundle install --path vendor/bundle。