Develop

HTTP_ACCEPT 是 'application/json, */*' 时 Rails 按 'text/html' 处理

用 Rails3 做移动端 App 的 Backend 时，出现一种情况，当移动端使用中国移动的网络时（中国联通无此状况），发送到服务端的 HTTP 请求的 Header 中的 Accept 莫名其妙的的被加上了 */*。而本来客户端只给 Accept 赋值了 application/json，现在就变成了 application/json, */*。Rails 在接收到这种请求时，request 的 format 就会识别为 text/html，导致 controller 最终返回给客户端的是 html 格式的应答。

为什么会被添加 */* 就不做深究了，网络运营商对数据的传输做了哪些处理策略不得而知，就算知道了也无能为力。于是考虑从服务端着手想办法解决。

之前为了发现为什么 Rails 返回的是 html 格式的应答时添加了一些 debug 日志，来观察客户端有没有正确的设置 HTTP Header。

app/controllers/application_controller.rb

1
2
3
4
5
6
7
8
9
10
11
12
13
class ApplicationController < ActionController::Base
  protect_from_forgery
  before_filter :log_request
  def log_request
    logger.debug "HTTP_ACCEPT = #{request.headers['HTTP_ACCEPT']}"
    logger.debug "CONTENT_TYPE = #{request.headers['CONTENT_TYPE']}"
    logger.debug "request.content_type = #{request.headers['action_dispatch.request.content_type']}"
    logger.debug "request.accepts = #{request.headers['action_dispatch.request.accepts']}"
    logger.debug "request.formats = #{request.headers['action_dispatch.request.formats']}"
  end
end

正是根据这些日志发现了被添加的 */*，而且发现只有这一种情况会导致返回 html 应答，所以就针对这种情况做一下处理。
在 application_controller.rb 中添加如下代码：

1
2
3
4
5
6
7
8
9
before_filter :modify_request_header
def modify_request_header
  if request.headers['HTTP_ACCEPT'].include? "*/*"
    preferred_accept = request.headers['HTTP_ACCEPT'].split(",").first
    logger.debug "Preferred ACCEPT: #{preferred_accept}"
    request.format = :json if preferred_accept == "application/json"
  end
end

采用这种方式修改了 request.formats 的值，于是终于可以正确返回 json 格式的应答了。

可是为什么 Rails 不按照 Accept 的值的顺序优先采用 application/json 指定的格式呢？

阅读全文

Develop

Rails 环境变量设置

什么是环境变量(Environment Variables)

所有的操作系统都提供了各自的机制可以设置环境变量，所有的 Unix 和 类Unix 系统中的每个进程都有各自的环境变量设置，很多 PaaS 的开发者平台(比如Heroku)也提供了配置环境变量的机制。我的理解是，环境变量就是可以在不同环境中单独配置(对环境有依赖)，可以让进程在运行时加载并使用，一些底层的基础变量。常见的环境变量比如：PATH、HOME 等等。

为什么在 Rails 中使用环境变量

主要有两方面原因，

  • 应用程序通常都是设计成可以在多种不同环境下部署和运行的，所以代码中不应该出现针对特定环境的内容(比如文件绝对路径)，而是应该在运行时根据当前环境使用合适的内容。那么对与这些对环境有所依赖的部分，就可能需要使用环境变量来进行配置。
  • 当应用程序中需要使用一些涉及到安全和隐私的内容时(比如邮箱密码)，把这类内容直接写在代码里是很不明智的，因为可能会有很多人可以浏览这部分代码，或者这些代码根本就是开源的。为了保护此类数据，就有必要把它们配置在只有你自己可以访问的环境中，让程序在运行时根据变量名去获取。

怎样在 Rails 中获取环境变量

Ruby 提供了一个很方便的访问环境变量的方式：

1
ENV["VARIABLE_NAME"]

比如要在一个 Rails 应用中配置一个 Gmail 账号来发邮件：

1
2
3
4
5
6
7
8
9
config.action_mailer.smtp_settings = {
  address: "smtp.gmail.com",
  port: 587,
  domain: "example.com",
  authentication: "plain",
  enable_starttls_auto: true,
  user_name: ENV["GMAIL_USERNAME"]
  password: ENV["GMAIL_PASSWORD"]
}

这个配置对 Rails 开发者肯定不陌生，这里就是使用环境变量对 Gmail 的用户名和密码进行了保护。

如何配置环境变量

配置环境变量对大多数人来说也并不陌生，比如 Windows 系统属性设置里面就可以找到配置环境变量的按钮，在 Linux/Unix/Mac 之类的操作系统中可以通过配置 .bashrc 或者 .zshrc (根据使用shell来定)之类文件来设置。

比如在 ~/.bashrc 中加入下面内容：

1
2
export GMAIL_USERNAME="foobar@gmail.com"
export GMAIL_PASSWORD="password"

阅读全文