Rack-Proxy 项目技术文档

1. 安装指南

使用 Gemfile 安装

在你的项目 Gemfile 中添加以下内容：

gem 'rack-proxy', '~> 0.7.7'

然后运行以下命令安装：

bundle install

直接安装

你也可以直接使用以下命令安装 rack-proxy：

gem install rack-proxy

2. 项目的使用说明

Rack-Proxy 是一个用于请求/响应重写的 HTTP 代理，基于 Rack 应用。你可以通过继承 Rack::Proxy 并提供 rewrite_env 和 rewrite_response 方法来实现自定义的代理逻辑。

使用场景

以下是一些实际使用场景的示例：

• 中央信任机构：允许一个应用作为中央信任机构，处理内部应用的自签名证书，并在代理请求到后端之前进行身份验证和授权。
• 子域名透传：基于子域名将请求透传到多个应用。
• 复杂重定向规则：处理不同扩展名的页面重定向（例如 .php 页面）。
• 并行请求：将单个 API 请求拆分为多个并行的后端请求，并合并结果。
• 插入或删除头部：插入或删除某些客户端需要的或有问题的头部信息。

3. 项目API使用文档

选项设置

你可以在初始化中间件时或通过重写方法来设置选项。以下是一些常用的选项：

• :streaming：默认值为 true，但在某些 Ruby 版本中可能不工作，建议设置为 false。
• :ssl_verify_none：告诉 Net::HTTP 不验证证书。
• :ssl_version：告诉 Net::HTTP 设置特定的 ssl_version。
• :backend：目标代理后端的 URI 解析格式的主机和端口。如果未设置，则假设后端目标与源相同。
• :read_timeout：设置代理超时时间，默认值为 60 秒。

示例

转发请求到主机并插入头部

class ForwardHost < Rack::Proxy

  def rewrite_env(env)
    env["HTTP_HOST"] = "example.com"
    env
  end

  def rewrite_response(triplet)
    status, headers, body = triplet
    headers["X-Foo"] = "Bar"
    headers["content-length"] = nil
    triplet
  end

end

禁用 SSL 会话验证

class TrustingProxy < Rack::Proxy

  def rewrite_env(env)
    env["HTTP_HOST"] = "self-signed.badssl.com"
    env["rack.ssl_verify_none"] = true
    env
  end

  def rewrite_response(triplet)
    status, headers, body = triplet
    headers["content-length"] = nil
    triplet
  end

end

4. 项目安装方式

在 Rails 中使用

1. 创建一个新的 Rails 应用：

   rails new test_app
   cd test_app
   

2. 在 Gemfile 中添加 rack-proxy：

   gem 'rack-proxy', '~> 0.7.7'
   

3. 安装 gem：

   bundle install
   

4. 创建 config/initializers/proxy.rb 文件，并添加以下内容：

   require 'rack_proxy_examples/example_service_proxy'
   

5. 运行 Rails 服务器：

   SERVICE_URL=http://guides.rubyonrails.org rails server
   

6. 在浏览器中打开：

   http://localhost:3000/example_service
   

在 Sinatra 中使用

class MyAwesomeSinatra < Sinatra::Base
   use RackPhpProxy, {ssl_verify_none: true}
end

通过以上步骤，你可以在不同的 Rack 应用中使用 Rack-Proxy 进行请求和响应的重写与代理。