Ruby 的 CGI 編程
在本教程中,我們將學習 Ruby 編程語言中的 CGI(Common Gateway Interface)編程。
1. 什么是 CGI
CGI 是Common Gateway Interface的縮寫,它是用于在萬維網和 CGI 程序之間傳送數據或信息的標識。CGI 程序提供了一種與用戶進行交互的動態方式,并以可以接受和返回數據的方式進行設計。所有處理都在 Web 服務器上進行。因此,它被用作服務器端解決方案。
簡單來說,就是返回 HTML 代碼。
2. Ruby中編寫CGI的方式
2.1 輸出 Hello World
在 Ruby 中我們要輸出 HTML 代碼的話,應該這樣去做。
print "Content-type: text/html\r\n\r\n"
print "<html><body>Hello World!</body></html>\r\n"
# ---- 輸出結果 ----
Content-type: text/html
<html><body>Hello World!</body></html>
**解釋:**在打印出任何真實的 HTML 內容之前,我們需要發送 HTML 標頭,后跟空白行。至少我們需要打印出Content-type
。下一行將打印內容類型,后跟兩個換行符。第一個是Content-type
行的結尾,第二個是空行的結尾。例子中最后顯示的是 Hello World。
為了更簡便地使用 CGI,Ruby 將 CGI 封裝到了 cgi 的庫里面,您可以在require 'cgi'
之后,創建表單、Cookie、維護狀態會話等。
我們用 cgi 庫來實現剛剛的代碼:
#!/usr/bin/ruby
require 'cgi'
cgi = CGI.new
puts cgi.header
print "<html><body>Hello World!</body></html>\r\n"
# ---- 輸出結果 ----
Content-Type: text/html
<html><body>Hello World!</body></html>
解釋:
第一行是用來確認系統中使用哪個解釋器來理解文件中的代碼。
Tips:如果您在實行腳本的時候在終端出現:(offline mode: enter name=value pairs on standard input)的提示,請按
ctrl + d
繼續執行腳本。
2.2 輸出表單
HTML 每一個標簽在 CGI 中都有一個方法。
實例:
#!/usr/bin/ruby
require "cgi"
cgi = CGI.new("html5")
cgi.out {
cgi.html {
cgi.head { "\n"+cgi.title{"It is an Example of form"} } +
cgi.body { "\n"+
cgi.form {"\n"+
cgi.hr +
cgi.h1 { "A Form: " } + "\n"+
cgi.h2 { "A Basic Form:"} + "\n" +
cgi.textarea("get_text") +"\n"+
cgi.button("click_here") +"\n"+
cgi.hr +
cgi.br +
cgi.submit
}
}
}
}
# ---- 輸出結果 ----
Content-Type: text/html
Content-Length: 317
<!DOCTYPE HTML><HTML><HEAD>
<TITLE>It is an Example of form</TITLE></HEAD><BODY>
<FORM METHOD="post" ="application/x-www-form-urlencoded">
<HR><H1>A Form: </H1>
<H2>A Basic Form:</H2>
<TEXTAREA NAME="get_text" COLS="70" ROWS="10"></TEXTAREA>
<BUTTON></BUTTON>
<HR><BR><INPUT TYPE="submit"></FORM></BODY></HTML>
解釋:
上面的代碼生成了一個HTMl表單,首頁我們為了使用方法,先實例化了CGI,所有的方法都返回一個字符串,該字符串是標簽的內容。
2.3 字符串轉義
在處理 URL 或 HTML 表單數據中的參數時,需要指定轉義特殊字符,例如:引號(“),斜杠(/)。Ruby CGI 對象提供CGI.escape
、CGI.unescape
和方法來轉義這些特殊字符:
escape 的例子:
#!/usr/bin/ruby
require 'cgi'
puts CGI.escape(Zara Ali/A Sweet & Sour Girl")
# ---- 輸出結果 ----
Zara+Ali%2FA+Sweet+%26+Sour+Girl
另一組示例:
#!/usr/bin/ruby
require 'cgi'
puts CGI.escapeHTML('<h1>Zara Ali/A Sweet & Sour Girl</h1>')
# ---- 輸出結果 ----
<h1>Zara Ali/A Sweet & Sour Girl</h1>
CGI 還有許多的方法,詳細可以通過點擊這里查看。
2.4 CGI 的 Cookies
您可以創建一個名為 cookie 的對象并存儲文本消息,將信息發送到瀏覽器,調用 CGI.out 設置cookie頭:
#!/usr/bin/ruby
require "cgi"
cgi = CGI.new("html5")
cookie = CGI::Cookie.new('name' => 'mycookie',
'value' => 'Zara Ali',
'expires' => Time.now + 3600)
cgi.out('cookie' => cookie) do
cgi.head + cgi.body { "Cookie stored" }
end
# ---- 輸出結果 ----
Content-Type: text/html
Content-Length: 32
Set-Cookie: mycookie=Zara+Ali; path=; expires=Sun, 30 Aug 2020 18:01:17 GMT
<HEAD><BODY>Cookie stored</BODY>
我們回到頁面時可以通過下面的方式獲取到 Cookies:
#!/usr/bin/ruby
require "cgi"
cgi = CGI.new("html5")
cookie = cgi.cookies['mycookie']
cgi.out('cookie' => cookie) do
cgi.head + cgi.body { cookie[0] }
end
2.5 CGI 的 Sessions
CGI::Session
可以保存為用戶和 CGI 環境的持久會話狀態,在需要關閉會話后,因此可以確保將數據寫入內存,當會話結束時,您需要刪除數據。
#!/usr/bin/ruby
require 'cgi'
require 'cgi/session'
cgi = CGI.new("html4")
sess = CGI::Session.new( cgi, "session_key" => "a_test", "prefix" => "rubysess.")
lastaccess = sess["lastaccess"].to_s
sess["lastaccess"] = Time.now
if cgi['bgcolor'][0] =~ /[a-z]/
sess["bgcolor"] = cgi['bgcolor']
end
cgi.out{
cgi.html {
cgi.body("bgcolor" => sess["bgcolor"]) {
"The background of this page" +
"changes based on the 'bgcolor'" +
"each user has in session." +
"Last access time: #{lastaccess}"
}
}
}
# ---- 輸出結果 ----
Content-Type: text/html
Content-Length: 216
Set-Cookie: a_test=8239f376c9e2cb2b77a0512bb3b8fa0b; path=
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><HTML><BODY>The background of this pagechanges based on the 'bgcolor'each user has in session.Last access time: </BODY></HTML>
會話數據存在于服務器上的臨時文件目錄中,prefix 參數指定會話的前綴,作為臨時文件的前綴。在服務器上,以便您可以輕松識別不同的會話臨時文件。
3. 小結
本章節中我們了解了 CGI,學習了如何使用 Ruby 的 cgi 庫,來進行頁面的輸出、表單生成、Cookies 和 Session 的生成與獲取。