コントローラ周辺の雑多な知識 (Rails4)
[History] [Last Modified] (2015/05/31 19:37:57)

概要

クッキー、セッション、フラッシュ、リクエストヘッダー等

クッキー

app/controllers/main_controller.rb

cookies[:sample] = {
  value: 'val',
  expires: 2.months.from_now,
  domain: 'localhost', # 例えばlocalhost2のサーバからアクセスできない
  path: '/main/', # 例えば/main2/* のページを閲覧する際にサーバからアクセスできない
  secure: false, # SSL通信の場合にtrueにして暗号化可能
  http_only: true # 例えばJSからアクセスできない
}
# cookies.delete(:sample, domain: 'localhost', path: '/main/')

Uploaded Image

セッション

app/controllers/main_controller.rb

session[:sample] = 'val' # 値をセット
# アクセスもと IP を FingerPrint としてセッションに格納しておいてセッションハイジャック
# 対策で利用するなど (ただし IP が頻繁に変更される環境ではうまくいきません)
session[:sample] = nil # 値を削除
reset_session # すべてのセッション値を削除

Uploaded Image

config/initializers/session_store.rb

# Be sure to restart your server when you modify this file.
MyApp::Application.config.session_store :cookie_store, key: '_myApp_session'

一般にはセッションIDを格納するクッキー (セッションクッキー) を利用してサーバ側に保存されるセッション値ですが、既定値「:cookie_store」ではクライアント側のクッキー内に保存されます。その際、「config/initializers/secret_token.rb」の鍵を利用して暗号化されてはいますので、前述のクッキー保存と異なりユーザが自分で内容を閲覧することはできません。クッキー内に保存されることを避けたい場合、「:cache_store」に変更するとサーバ側の「tmp/cache/」内のファイルとしてキャッシュ保存されるようになります。

MyApp::Application.config.session_store :cache_store, key: '_myApp_session'

その際、ディレクトリの書き込み権限が不足しているとエラーになるので注意してください。また、既定ではブラウザを閉じるまで有効なセッションクッキーの期限を延ばすためには「expire_after」を設定します。

MyApp::Application.config.session_store :cookie_store, key: '_myApp_session', expire_after: 1.week

フラッシュ

現在のリクエストの次のリクエストまで有効なセッションです。メッセージや警告の通知に利用します。セッションでも実現できますが、通知後に不要なセッション値を自分で削除するのが手間です。具体的には「Rails4のScaffolding機能でCRUDアプリケーションの骨組みを作成する方法」で登場している「notice」がフラッシュです。「redirect_to」後は実質的には別のリクエストなのですが、noticeがフラッシュであるおかげで、状態を継続して通知文を表示できるのです。挙動は同じですが「notice」の他に「alert」という指定方法も可能です。一般の通知であるか警告かどうかで使い分けるといいかもしれません。なお、「redirect_to」とは異なるタイミングで値をセットする場合は、次のようにします。

app/controllers/main_controller.rb

class MainController < ApplicationController

  def index
    flash[:msg] = 'message'
    redirect_to '/main/show'
  end

  def show
  end

end

app/views/main/show.html.erb

<%= flash[:msg] %>

リクエストヘッダー、サーバ環境変数

app/controllers/main_controller.rb

class MainController < ApplicationController

  def index
    # サーバ環境変数とHTTPリクエストヘッダー一覧
    render text: request.headers.map{|k,v| "#{k}: #{v}"}.join("<br />")

    # render text: request.headers['REMOTE_ADDR'] # クライアントのIP (サーバ環境変数)
    # render text: request.remote_ip # ↑と同じ意味 (特殊なアクセサ)

    # render text: request.headers['User-Agent'] # HTTPリクエストヘッダは、
    # render text: request.headers['HTTP_USER_AGENT'] # HTTP_XXXX (アンダーバー、大文字としてもアクセス可能)
  end
end
Related pages
    概要 Spring Boot のテンプレートエンジンとしては、こちらで使用方法を把握した Thymeleaf が有名です。本ページでは、フォーム関連の処理について、基本的なサンプルコードをまとめます。Rails におけるビューヘルパーや、フォーム入力値のバリデーションに相当する機能です。 公式ドキュメント Handling Form Submission