# Sinatra 模式技巧 ## 第 1 层：快速参考 ### 常见路由模式 **基本路线：** 得到 '/' 做《你好世界》结束发布'/用户'做 # 创建用户结束把 '/users/:id' 做 # 更新用户结束删除 '/users/:id' 执行 # 删除用户结束 **路线参数：** # 命名参数获取 '/users/:id' 执行 User.find(参数[:id]) 结束 # 参数约束获取 '/users/:id', :id => /\d+/ 执行 # 只匹配数字ID 结束 # 通配符获取 '/files/*.*' 执行 # params['splat'] 包含匹配的段结束 **查询参数：** 获取“/搜索” 查询=参数[:q] 页面 = 参数[:页面] || 1 结果=搜索（查询，页面：页面）结束 ### 基础中间件 # 会话中间件使用 Rack::Session::Cookie，秘密：ENV['SESSION_SECRET'] # 安全中间件使用机架::保护 # 日志记录使用 Rack::CommonLogger # 压缩使用机架::放气机 ### 简单的错误处理 not_found 做 “找不到页面” 结束错误做 “内部服务器错误” 结束错误 401 做 “未经授权” 结束 ### 助手帮手做的 def 已登录？ !session[:user_id].nil？结束 def 当前用户 @current_user ||= User.find_by(id: session[:user_id]) 结束结束 ** ** ## 第 2 层：详细说明 ### 高级路由 **模块化应用：** # 应用程序/控制器/base_controller.rb 类 BaseController < Sinatra::Base 配置做设置 :views, Proc.new { File.join(root, '../views') } 设置 :public_folder, Proc.new { File.join(root, '../public') } 结束帮手做的 def json_response(数据, 状态 = 200) 内容类型：json 停止状态，data.to_json 结束结束结束 # 应用程序/控制器/user_controller.rb 类 UsersController < BaseController 得到 '/' 做用户=用户.all json_response(users.map(&:to_hash)) 结束获取 '/:id' 执行 user = User.find(params[:id]) ||停止(404) json_response(user.to_hash) 结束后 '/' 做用户 = User.create(params[:用户]) 如果 user.persisted？ json_response(用户.to_hash, 201) 否则 json_response({ 错误: user.errors }, 422) 结束结束结束 # 配置.ru 映射'/用户'做运行用户控制器结束 **命名空间：** 需要“sinatra/命名空间” 类 App < Sinatra::Base 注册 Sinatra:: 命名空间命名空间 '/api' 执行命名空间 '/v1' 执行获取 '/users' 执行的操作 # 获取/api/v1/用户结束命名空间 '/admin' 执行之前做验证管理员！结束获取“/stats” # 获取 /api/v1/admin/stats 结束结束结束结束结束 **路线条件：** # 用户代理条件获取 '/', :agent => /iPhone/ 执行 # 手机版结束 # 自定义条件 set(:auth) 执行|角色| 条件做除非 current_user && current_user.has_role?(角色) 停止 403 结束结束结束获取 '/admin', :auth => :admin 做 # 只有管理员可以访问结束 # 基于主机的路由获取 '/', :host => 'admin.example.com' 执行 # 管理子域结束 **协商内容：** 获取 '/users/:id', :provides => [:json, :xml, :html] 执行 user = User.find(params[:id]) 案例 request.accept.first.to_s 当'应用程序/json'时 json 用户.to_json 当“应用程序/xml”时 xml 用户.to_xml 否则 erb：用户，当地人：{用户：用户} 结束结束 # 或者使用提供的帮助器获取 '/users/:id' 执行 user = User.find(params[:id]) respond_to do |格式| format.json { json user.to_json } format.xml { xml user.to_xml } format.html { erb :user, locals: { user: user } } 结束结束 ### 中间件组成 **自定义中间件：** 请求记录器类 def 初始化（应用程序） @应用=应用结束 def 调用(env) 开始时间 = 时间.now 状态、标题、正文 = @app.call(env) 持续时间 = Time.now - start_time 放置“#{env['REQUEST_METHOD']} #{env['PATH_INFO']} - #{status} (#{duration}s)” [状态、标题、正文] 结束结束使用请求记录器 **中间件订购：** # 配置.ru 使用 Rack::Deflater # 首先压缩 use Rack::Static # 静态文件使用 Rack::CommonLogger # 日志记录使用 Rack::Session::Cookie # 会话使用 Rack::Protection # 安全使用 CustomAuthentication # 身份验证运行应用程序 ### 模板集成 **ERB 模板：** # 视图/layout.erb <头> <标题><%=@标题|| “我的应用程序”%> <正文> <%=产率%> # 视图/用户/index.erb

用户

<%= 用户名 %>

# 控制器获取 '/users' 执行的操作 @users = User.all @title = '用户列表' erb :'用户/索引' 结束 **内联模板：** 得到 '/' 做 erb :索引结束 __结束__ @@布局 <%=产量%> @@索引

欢迎

**模板引擎：** # 哈姆尔得到 '/' 做哈姆尔：索引结束 # 苗条得到 '/' 做苗条：指数结束 # Liquid（对用户内容安全）得到 '/' 做液体：索引，局部变量：{ 用户：current_user } 结束 ### 错误处理模式 **全面的错误处理：** 类应用程序 < Sinatra::Base # 开发配置配置：开发做设置：show_exceptions，：after_handler 设置：dump_errors，true 结束 # 生产配置配置：生产做设置：显示异常，假设置：dump_errors，假结束 # 特定的异常处理程序错误 ActiveRecord::RecordNotFound 做状态404 json({ 错误: '找不到资源' }) 结束错误 ActiveRecord::RecordInvalid 执行状态 422 json({ error: '验证失败', 详细信息: env['sinatra.error'].message }) 结束错误 Sequel::NoMatchingRow 做状态404 json({ 错误: '未找到' }) 结束 # HTTP 状态处理程序 not_found 做 json({ 错误: '未找到端点' }) 结束错误 401 做 json({ 错误: '未经授权' }) 结束错误 403 做 json({ 错误: '禁止' }) 结束错误 422 做 json({ error: '无法处理的实体' }) 结束 # 捕获所有错误处理程序错误做错误 = env['sinatra.error'] logger.error("错误：#{error.message}") logger.error(error.backtrace.join("\n")) 状态 500 json({ error: '内部服务器错误' }) 结束结束 ### 过滤器之前/之后 **请求过滤器：** # 全局前过滤器之前做内容类型：json 结束 # 特定于路径的过滤器在 '/admin/*' 之前验证管理员！结束 # 条件过滤器之前做通过除非 request.path.start_with?('/api') 验证_api_用户！结束 # 过滤后做完之后 # 添加 CORS 标头标头 'Access-Control-Allow-Origin' => '*' 结束 # 修改响应做完之后 response.body = response.body.map(&:upcase) if params[:uppercase] 结束 ### 会话管理 **Cookie 会话：** 使用机架::会话::Cookie， key: 'app.session', 秘密：ENV['SESSION_SECRET']， expire_after: 86400, # 1 天安全：生产？， httponly：正确，相同站点：：严格帮手做的 def 登录（用户）会话[:user_id] = user.id 会话[:logged_in_at] = Time.now.to_i 结束默认注销会话.清除结束 def 当前用户返回 nil 除非 session[:user_id] @current_user ||= User.find_by(id: session[:user_id]) 结束结束 ** ** ## 第 3 层：资源和示例 ### 完整应用示例有关完整的模块化应用程序结构，请参阅“assets/modular-app-template/”。 ### 性能模式 **缓存：** # HTTP 缓存获取“/public/data” 缓存控制：公共，最大年龄：3600 etag计算_etag 上次修改时间上次更新时间 json PublicData.all.map(&:to_hash) 结束 # 使用Redis进行片段缓存需要“redis” 帮手做的 def cache_fetch(key, expires_in: 300, &block) 缓存 = REDIS.get(key) 如果已缓存，则返回 JSON.parse(cached) 数据 = 块.call REDIS.setex(key, expires_in, data.to_json) 数据结束结束获取“/昂贵数据” data = cache_fetch('昂贵的数据', expires_in: 600) 做执行昂贵的查询结束 json数据结束 **流媒体响应：** # 流式传输大量响应得到 '/large-export' 做流式执行|输出| User.find_each 做 |user| 输出 << user.to_csv_row 结束结束结束 # 服务器发送的事件获取“/events”，提供：“text/event-stream” 流 :keep_open 做 |out| EventSource.subscribe 做|事件| out <<“数据：#{event.to_json}\n\n” 结束结束结束 ### 生产配置 **完整的config.ru：** # 配置.ru require_relative '配置/环境' # 生产中间件 if ENV['RACK_ENV'] == '生产' 使用机架::SSL 使用机架::放气机结束 # 静态文件使用机架::静态， urls: ['/css', '/js', '/images'], 根：“公共”，标头规则：[ [:all, {'Cache-Control' => 'public, max-age=31536000'}] ] # 日志记录使用 Rack::CommonLogger # 会话使用机架::会话::Cookie，秘密：ENV['SESSION_SECRET']，同一站点：：严格， httponly：正确，安全：ENV['RACK_ENV'] == '生产' # 安全使用机架::保护，除外：[:session_hijacking], 使用：：全部 # 速率限制（生产） if ENV['RACK_ENV'] == '生产' 需要“机架/攻击” 使用机架::攻击结束 # 挂载应用程序映射'/api/v1'做运行 ApiV1::Application 结束映射'/'做运行网络应用程序结束 **机架::攻击配置：** # 配置/rack_attack.rb 类机架::攻击 # 限制登录尝试节流阀（'登录/ IP'，限制：5，周期：60）做 |req| req.ip if req.path == '/login' && req.post? 结束 # 限制 API 请求节流阀（'api/ip'，限制：100，周期：60）做 |req| req.ip if req.path.start_with?('/api') 结束 # 阻止可疑请求 blocklist('阻止不良用户代理') do |req| req.user_agent =~ /bad_bot/i 结束结束 ### 测试模式有关全面的测试模式，请参阅“references/testing-examples.rb”。 ### 项目结构 **推荐的模块化结构：** 应用程序/ 控制器/ 基本控制器.rb api_controller.rb 用户控制器.rb posts_controller.rb 型号/ 用户.rb 后rb 服务/ 用户服务.rb 身份验证服务.rb 帮手/ application_helpers.rb view_helpers.rb 配置/ 环境.rb 数据库.yml 美洲狮.rb 分贝/ 迁移/ 库/ 中间件/ 自定义验证.rb 任务/ 公共/ CSS/ js/ 图片/ 观点/ 布局.erb 用户/ 索引.erb 显示.erb 规格/ 控制器/ 型号/ 规范助手.rb 配置.ru 宝石文件耙文件自述文件.md ### 其他资源 * **路由示例：** `assets/routing-examples.rb` * **中间件模式：** `assets/middleware-patterns.rb` * **模块化应用程序模板：** `assets/modular-app-template/` * **生产配置：** `references/product-config.rb` * **测试指南：** `references/testing-examples.rb`

西纳特拉模式

包含技能