Ruby on Rails 高级主题实战：进阶路由、嵌套布局、元编程与 SOLID 设计原则

Ruby on Rails 高级主题实战进阶路由、嵌套布局、元编程与 SOLID 设计原则【免费下载链接】curriculumThe open curriculum for learning web development项目地址: https://gitcode.com/GitHub_Trending/cu/curriculum本文是 Rails 学习课程的进阶指南聚焦于常规 CRUD 之外的那 10%路由能力单一资源、嵌套路由、成员/集合路由、重定向、保持 RESTful 风格的控制器设计、嵌套布局与content_for信息传递以及 Ruby 元编程与 SOLID 设计原则。读完本文你将能够熟练编写高表达力的config/routes.rb用嵌套控制器化解非 RESTful 动作并通过布局嵌套与元编程写出更灵活、更易维护的 Rails 应用。学习目标理解单一资源Singular resources的适用场景与路由写法。掌握嵌套路由、成员路由member与集合路由collection。学会在路由文件内直接重定向并用通配符捕获参数。能够判断何时该把自定义动作重构为独立 RESTful 控制器。使用content_for与render :template实现布局嵌套与信息传递。认识元编程的核心手段send、define_method、method_missing。理解 SOLID 五项设计原则的含义。进阶路由常规 RESTful 之外的强大选项在 路由基础 中我们已经熟悉了路由的主干用法用 HTTP 动词GET/POST/PUT/DELETE加 URL把请求映射到具体的控制器动作既可以用resources一句话生成七条 RESTful 路由也可以用get显式指定。这大约覆盖了你日常 90% 的路由需求。剩下的 10% 则提供了相当精巧的能力直接在路由文件中重定向、把路由彼此嵌套、或者从入站请求中解析参数。本节将逐一展开。单一资源Singular resources之前我们讨论的resources如posts、users面向的是存在大量个体的资源用resources :users一行即可。但有些资源在逻辑上只可能存在一个。典型例子是用户仪表盘dashboard它只有一个模板只是根据当前登录用户动态展示不同的内容。对于这种资源展示一个dashboard 的 index 列表毫无意义其他通常需要id来区分具体个体的动作如show也因为对象唯一而不再需要id参数。此时应在 config/routes.rb 中使用单数形式的resource# in config/routes.rb resource :dashboard注意这里的resource是单数dashboard也是单数。很多人想写复数资源更常见时会把resources误打成resource或者反过来——这是新手极容易踩的坑务必留意。$ rails routes的输出印证了上述逻辑单一资源只生成6 条路由因为不再有index并且路由中不再出现:id片段。对比单数与复数版本的同名路由# 单一资源无 :id edit_dashboard GET /dashboard/edit(.:format) dashboards#edit # 复数资源带 :id edit_dashboard GET /dashboards/:id/edit(.:format) dashboards#edit可以推断单数resource实际生成的是new、create、show、edit、update、destroy六条动作对应的控制器仍然是复数命名DashboardsController这与 Rails 的表单/资源命名约定一致。嵌套路由Nested routes有些资源天然从属于另一个资源。例如课程courses下的课时lessonsURL 形如http://example.com/courses/1/lessons/3。实现方式是在路由文件中把一个resources字面嵌套进另一个resources的块中# config/routes.rb TestApp::Application.routes.draw do resources :courses do resources :lessons end end注意此时resources方法接收了一个块块内是另一组路由。访问该 URL 时你必须为两个对象都提供:id参数。$ rails routes会输出类似如下的路由course_lesson GET /courses/:course_id/lessons/:id(.:format) lessons#show两个关键细节需要记住请求最终被派发到最深层嵌套资源的控制器上面的例子是lessons#show。最深层资源的参数名是:id而所有父级资源的参数会被命名为类似:course_id的形式。视图辅助方法也会按同样逻辑自动生成可以从$ rails routes输出中看到路由名。使用course_lesson_path这类辅助方法时需要按顺序传入两个参数course_lesson_path(1, 3) # /courses/1/lessons/3不要嵌套太深如果嵌套超过一两层说明设计可能需要调整。实践中常见做法是只嵌套那些确实需要父级 ID 才能唯一定位的动作。例如仅凭 Lesson 自己的 ID 就能找到某节课所以show未必需要嵌套但要取回某个 Course 名下的所有 lessons就必须知道 Course ID因此index需要嵌套创建 lesson 时同样需要指定父级所以create也应嵌套。于是可以这样收窄嵌套范围# config/routes.rb TestApp::Application.routes.draw do resources :courses do resources :lessons, :only [:index, :create] end end如果一时觉得抽象动手实践时很快会明白。判断标准很简单在控制器里需要父级 ID 时路由就应该嵌套不需要父级 ID 时就不必嵌套。成员路由与集合路由Member and collection routes有时你想给某个资源添加一条非 RESTful 的自定义路由。如果这条路由只作用于该资源的单个成员使用member方法# config/routes.rb TestApp::Application.routes.draw do resources :courses do member do get preview # Preview a single course end end endpreview会映射到courses#preview动作需要:id指定具体课程。member块内可以添加任意多条自定义动作。如果这条路由作用于资源的整个集合类似index无需指定:id则改用collection方法# config/routes.rb TestApp::Application.routes.draw do resources :courses do member do get preview # Preview a single course (requires ID) end collection do get upcoming # Show a list of *all* upcoming courses (no ID needed) end end endupcoming会映射到courses#upcoming动作但不会接收:id参数。如果对成员路由与集合路由的差异还不确定最好的办法是动手写一写然后运行$ rails routes观察后台生成的路由。重定向与通配符路由Redirects and wildcard routes有时你希望为用户提供一个方便记忆的 URL但它直接指向另一个已有路由。这时可以直接在路由文件中使用重定向# config/routes.rb TestApp::Application.routes.draw do get courses/:course_name redirect(/courses/%{course_name}/lessons), :as course end这个例子信息量不小拆解如下核心思路是使用redirect方法把一条路由导向另一条路由。若目标路由很简单redirect本身非常直白。但如果想把原始参数一并带过去就需要一点技巧把参数捕获在%{here}占位符中。注意这里整条路由使用了单引号。我们通过:as参数给这条路由起了别名course这样就能在_path之类的辅助方法中使用该名称例如course_path。同样多运行几次$ rails routes来验证这些写法的实际效果。补充在 路由基础 中提到路由名最左侧一列就是路由名Rails 会据此自动生成_path与_url两种辅助方法。上面的:as course正是利用了这一机制——自定义路由名同样能获得对应的辅助方法。控制器、模型与保持 RESTful结合上面的进阶路由还有一个值得深思的话题如何为没有对应 ActiveRecord 模型的控制器设计动作。假设应用收到需求一节课lesson可以附带多张图片images。先更新模型# app/models/lesson.rb class Lesson ApplicationRecord # other stuff has_many_attached :images end接下来要考虑从路由和控制器层面如何管理这些图片。第一种直觉写法可能是# config/routes.rb resources :lessons do member do patch :attach_image delete :remove_image end end然后在LessonsController中写相应的方法处理图片。这样做当然能工作但如果我们把Rails 控制器视为独立概念来思考会倾向于另一种更优雅的实现# config/routes.rb resources :lessons do resources :images, only: [:create, :delete] end配套地新增一个控制器Lessons::ImagesController# app/controllers/lessons/images_controller.rb module Lessons class ImagesController ApplicationController def create # logic to attach images to a course end def destroy # logic to remove an image image from a course end end end这里发生了什么我们让实现更加 RESTful不再有任何自定义的非 RESTful 动作而是引入了一个全新的RESTful 的控制器。这个控制器没有自己的模型它操作的是Lesson模型。更重要的是通过新控制器我们能够完全用 REST 动作来描述正在做的事*创建create一个图片附件或销毁destroy*某个 lesson 的图片。其实这个信号在我们的最初尝试中就已隐含attach_image和remove_image都遵循动作_名词的命名模式——一旦动作名开始出现动词_名词的组合往往就提示我们这里可能应该抽出一个新的资源。此外我们在这里使用了嵌套控制器Lessons::ImagesController向阅读代码的下一位开发者清晰地传达了意图。把动作保持在 RESTful 范畴内应用会更容易扩展也更容易在不深入挖掘的情况下理解正在发生的事情。当你能跳出控制器必须绑定模型的思维定式很多可能性会随之打开——甚至可以为一个模型的某个特定属性创建专属控制器。补充Rails 对控制器动作的执行遵循一套隐式约定。在 控制器 一课中我们看到动作执行完毕后Rails 会把实例变量交给与动作同名的视图文件渲染如果提交表单成功通常用redirect_to发起一次全新请求失败则render对应视图。上述create/destroy场景正是把附件变更看作一次独立资源操作从而复用这套成熟流程。进阶布局嵌套布局与信息传递视图与布局 一课已经覆盖了布局的基础知识布局文件位于app/views/layouts页面内容通过yield插入到布局中。本节讨论一个进阶话题为一个页面渲染多个布局从而在保持全站风格一致如统一页脚的前提下为特定区域定制外观。例如也许用户页面和首页的样式应该不同。第一反应可能是为每个布局准备不同的样式表——但请记住Rails 的 Asset Pipeline资源管道最终会把所有样式表合并在一起。更好的做法是让你的布局先执行自己该做的事通常是常规布局逻辑然后用render :template your_layout.html.erb再渲染另一个布局。这有点像是把布局当作视图使用 partial 那样来复用。你还可以用content_for方法把信息从第一个布局传递给它所渲染的布局。这让主布局能够根据各独立布局文件传入的内容编写逻辑——可能性是无限的。举个例子为静态页面准备一个专门的布局文件app/views/layouts/static_pages.html.erb。按照 Rails 默认约定StaticPagesController生成的视图会默认渲染这个布局如果它存在。现在我们希望静态页面与站点其他部分看起来几乎一样但不希望在顶部出现导航栏。那么可以告诉static_pages.html.erb调用application.html.erb布局同时用content_for传入一些特殊 CSS# app/views/layouts/static_pages.html.erb % content_for :stylesheets do % #navbar {display: none} % end % % render :template layouts/application %然后application.html.erb布局需要做好准备去接住这段内容并加以使用例如在head中添加这样一行yield# app/views/layouts/application.html.erb ... head ... style% yield :stylesheets %/style /head ... render :template static_pages.html.erb ...当你yield某个特定的内容块这里是:stylesheets时它本质上会把content_for块内的代码原样放置到yield所在的位置。因此在上面的例子中我们实际上先渲染了特殊的static_pages.html.erb布局再用content_for把样式传给主application.html.erb布局最终结果等效于# app/views/layouts/application.html.erb ... head ... style #navbar {display: none} /style /head ...这个技巧的价值远不止传递样式信息任何时候你想让站点的某个区域呈现不同外观却又不想用一套全新布局彻底重新设计时都可以考虑嵌套布局并借助content_for在布局间传递信息。这与 视图与布局 中 partial 复用局部模板的思路一脉相承只不过复用的层级从视图模板上升到了整页布局。元编程Metaprogramming in Rails什么是元编程这是一个在 Rails 中随处可见、你也能亲身实践的重要概念。简单说就是你的应用或脚本在运行过程中动态地创建函数、方法或类并且能够动态地调用它们。这是解释型语言如 Ruby的天然优势之一——它几乎内置于语言本身。本节只触及皮毛等你熟练掌握 Rails 后可以深入研究。一个 Rails 中元编程的经典实例是路由辅助方法。当 Rails 应用首次启动时它会加载config/routes.rb文件如果其中有get home static_pages#home使你的用户可以通过http://www.yoursite.com/home访问首页那么 Rails 就会在启动时为这个路由动态创建home_path和home_url两个方法——这就是元编程的一部分不过路由的例子几乎不算数因为你自己写了routes.rb很可能已经根据已知内容硬编码了大量home_path/home_url调用。真正动态的场景是事先不知道方法名会是什么该怎么办Ruby 提供了send方法来应对。如果要在某个对象上运行方法只需把方法名和参数发送给它。一个可以在命令行直接验证的基础例子——1 2 1 2 3 1.send(:, 2) 3在普通情况下没有理由使用send但当你不确定要调用哪个方法时它就是救命稻草。只需传入要在该对象上运行的方法的符号化名称Ruby 就会去寻找并调用它。那么如何在运行时定义新方法呢可以使用define_method方法它接收一个代表方法名的符号和一个代表方法体的块class Rubyist define_method :hello do |my_arg| my_arg end end obj Rubyist.new puts(obj.hello(Matz)) # Matz另一个非常强大的工具是method_missing。你一定见过类似你尝试调用了一个不存在的方法的错误其堆栈跟踪往往会经过一个叫method_missing的地方。多数情况下是你拼错了方法名。本质上method_missing是 RubyBasicObject类的一个方法被 Ruby 中的每个对象继承每当你尝试调用一个实际不存在的方法时它就会被触发并且会收到你试图发送的所有参数和伴随的块。这意味着你可以为某个对象覆写method_missing从而拦截这些本不该存在的调用。例如打印出被调用方法的名字及其参数class Rubyist def method_missing(m, *args, block) str Called #{m} with #{args.inspect} if block_given? puts str and also a block: #{block} else puts str end end end Rubyist.new.anything Called anything with [] nil Rubyist.new.anything(3, 4) { something } Called anything with [3, 4] and also a block: #Proc:0x007fa0261d2ae0(irb):38 nil元编程确实妙用无穷有大量有趣的用途。但学习 Rails 并不需要精通元编程建议在熟悉 Rails 之后再去深入不过它在真实世界中一定会派上用场。各类元编程技巧、模式和提示层出不穷已经超出本课程的范围。设计模式与 SOLID 原则设计模式在软件开发者中口碑两极一方面它们代表最佳实践——不是具体代码而是解决某类问题的模板另一方面它们有时显得过于教条。SOLID 是面向对象设计中一组核心原则的缩写如果你想写出高质量的代码需要理解其中每个字母代表的原则此处为意译S — Single Responsibility Principle单一职责原则一个类只应承担单一职责。O — Open/Closed Principle开闭原则代码实体应对扩展开放、对修改关闭。L — Liskov Substitution Principle里氏替换原则用子类型对象替换原对象不应破坏任何功能。I — Interface Segregation Principle接口隔离原则编写多个客户端专用的小接口优于一个臃肿的通用大接口想想 API 设计。D — Dependency Inversion Principle依赖倒置原则高层模块不应依赖低层模块双方都应依赖抽象。幸运的是Rails 在遵循这些原则方面做得相当不错所以仅仅通过使用它你已经在潜移默化中养成了一些好习惯。但你仍应花时间逐条研读这些原则包括听起来比较陌生的几条因为它们几乎贯穿于所有软件工程之中——也是面试中的高频考点。补充如果你对反面教材感兴趣业界有专门讨论反模式anti-patterns的书籍通过识别代码中的坏味道帮助你重构、清理代码——Rails 项目尤其受益。国际化I18n一个值得关注的延伸方向国际化与本地化Internationalization and Localization是让应用适配特定地区与语言的过程。它超出了本课程的范围但对于有兴趣的读者是一个值得自主探索的方向Rails 内置了完善的 I18n 支持通过语言文件组织翻译文本并依据请求中的 locale 自动选择展示语言。总结本课涵盖了一些相对零散但实用的进阶概念——即使你不会每天都用到它们也值得熟悉。经验才是真正的关键在构建优秀应用的过程中你会不断遇到这些需求而掌握它们可能为你的代码省下大量时间和复杂度。像 SOLID 设计与元编程这类更普适的原则无论你将来是否继续使用 Ruby 和 Rails都会持续受益。延伸学习建议研读官方路由指南中关于命名空间namespacing的章节理解如何在路由中组织模块化控制器。深入学习嵌套路由、成员路由与集合路由的各种写法。探索路由约束constraining the inputs to your routes与重定向等进阶路由主题。查阅布局与渲染指南中使用嵌套布局一节仔细理解视图文件与布局文件之间传递信息包括 CSS 样式的机制。若感兴趣可以初步了解 Ruby 元编程它对早期 Rails 应用并非必需但你在真实世界中会越来越多地遇到它。浏览 SOLID 原则的相关讲解为写出高质量代码打好基础。知识检查单一资源的路由文件行应该怎么写如何在路由文件中把一个资源嵌套进另一个资源什么时候使用member方法什么时候应该使用重定向为一个页面渲染多个布局有哪些技术手段send方法的作用是什么SOLID 五个字母分别代表哪五项设计原则【免费下载链接】curriculumThe open curriculum for learning web development项目地址: https://gitcode.com/GitHub_Trending/cu/curriculum创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考