Webサーバを考える(2)（BNS 補助資料 サーバ編2）

1 Webサーバを動かす（その２）

Webrick で Webサーバ

Webrickのリファレンス にあるプログラムを動作させてみる。

このシステムの位置付け

• Webサーバ（にかぎらずどんなシステムでも）を動かす時の 方法論として、
  • 自分で（または注文して）作る
  • 既成のもの（有料無料を問わず）を活用する（使う）
  の２つの手法を適度に組み合わせることになる。その２つのバランスで言えば、今回のWebサーバ作り方は、 右図のようなポジションに相当すると考えられる。

Webrickについて

• Webrickは、Rubyに標準添付されるクラスライブラリの１つで、

• 基本的なWebサーバ機能を提供するもの。

• クラスライブラリなので、

  1. 適切なクラス（を選んで）の、インスタンスを生成し（newメソッド）、
  2. start させる、

  という簡単な手順（のプログラムを作成すること）で、サーバが起動できる。

  • その他のオプション設定もプログラムコードで行うことになる。

• 組み込みライブラリではなく、添付ライブラリの１つなので、 使うに先立って ‘require’（使用宣言）しておくことが必要（右図）。

a 準備作業の概要

1. エディタを開く
2. 上記ページからプログラムをコピーしてエディタ画面に貼付
3. 後述の Windows向けの変更
4. 名前をつけて保存（場所と拡張子に注意）

b Windowsでの追加作業

• windowsの場合、このサンプルに１行の追加が必要になります。
  • （サーバによく使われる）Unix系OS（LinuxやMacOSも含む）の場合は、 「shebang」と呼ぶ仕組み（右図） が働くためこういった作業は省略できることが多い。

手順：

1. まず、コマンドプロンプトで、

   where ruby

   として出てきた、rubyインタプリタの場所（をフルパス名で表記したもの）を、

   • セパレータ ‘'(または￥)を’/’ に変え、
   • （プログラムの中では）シングルクォート ' で囲み、

2. Webサーバのコードの中の、WEBrick::HTTPServer.new に渡す オプション（Hash型; ブレース { }で囲んである）の中に、

   :CGIInterpreter => 'C:/tools/ruby27/bin/ruby.exe'
   # または
   CGIInterpreter:'C:/tools/ruby27/bin/ruby.exe'

   のように渡す。

   • Hashは、ブレースの中に ｀キー => 値｀のセットを、 カンマ区切りで並べたもの。
   • RubyではHashの書き方として（最近は）JavaScript 等と同じコロン区切りの記法（上の例では２つめの方）が使える （いずれの記法もOK）。
   • さらにHashを関数に引数として渡すときに、 （最後の引数であれば）展開して（ブレースで囲まずに）も渡せる （この後のプログラム例ではその書き方になっている）。

3. また、動的コンテンツ生成の例として（CGIHandler経由で呼ばれることになるプログラム）‘view.rb’ については、 ここではこのファイルをダウンロードして、 ドキュメントルートと同じ場所に置いて）使って下さい。

c 完成例

webServer0.rb を参考にして下さい。 ただし、上記のruby.exeのパス名は、自分の環境にあったものに変えて使うこと。

d 使い方

1. ソースファイルの準備(a 準備作業を参照）
2. 起動
   • そのファイルを、コマンドプロンプトの中で起動するか、
   • 直接ダブルクリックで起動する。
3. アクセスする。
   • 簡易Webサーバの時と同様に、 （ブラウザと同じコンピュータの中で動作するサーバなので） ドメイン名（の代用名）localhost の後ろに、ポート番号。
   • このコードの場合は、ブラウザで http://localhost:20080/。
   • プログラムの中で、ポート番号は適当に変えていい。

2 動作解説

（右図を参考に理解を試みて下さい）

• 「:DocumentRoot => ‘./’」の部分は、ドキュメントルート（このWebサーバを 通じてネットにサービス提供するディレクトリの大元）を、「ここ」 （サーバを起動した時のカレントディレクトリ）にすることを指示したもの。
• （簡易Webサーバの時)に、コマンドパラメータの末尾に ‘.’ を 付加したのも同じ意味）。
  
• ‘ホスト名：ポート番号/’ の後ろに何も指示しなかった場合、
  • 一般にはドキュメントルートにある、index.html（のような名前のファイル、があれば）が サイトのトップページのコンテンツとして送信される。
• ファイル名（または、ディレクトリ名/ファイル名 など）が指定された場合は、
  • ドキュメントルートを起点としてそのファイルを探して送信する。ただし、
• srv.mount メソッドの第１引数にある名前（など）が指定された場合は、
  • それに対応する実体（第３引数）を該当するハンドラで処理した結果が送られる。
• なお、ここに出てくる foo や hoge といった名標は、意味のない名前です （プログラミング等の世界でよく使われる呪文のようなもの）。

. 要チェックの同音カタカナ語や同音異義語（補足）

• パス（pass と path)
• ルート（root と route) : 後者は ラウトとも発音される

Webサーバの動作概要

静的コンテンツと動的コンテンツ

• 静的コンテンツ： サーバ上に保管されたファイルの中身をそのままクライアントにレスポンスとして返送するもの （何度アクセスを行っても内容に変化はない）。
• 動的コンテンツ： サーバ上で（または外部プログラムとして）何かのプログラムが動作し、その結果をレスポンスとして返送するもの。
  • 外部プログラムの呼び出し（CGI サーブレット など）
    • 様々な言語で書かれる（右下図）
  • Web技術の初期の頃から使われていた外部プログラムの呼び出し方式が CGIと呼ばれていたもの。
  • その名残で、CGIという用語が外部プログラムを意味する使い方（右図の②）もされている。
  • なお、Interfaceという単語は、元来は右図のような意味で、２つのものをつなぐ際の約束事のような意味で使われている（ここではサーバと外部プログラムとの間の連絡）。
• ルーティング： 要求された資源名（またはパス名）と、それに呼応して起動するプログラムとの関係づけ。 Webrickでは、先のプログラム例で見たように、srv.mount メソッドで行っている。
• ハンドラの選択 プログラミング言語（Webアプリケーションでは様々な言語が使われる（右図））によって、 ハンドラも別個に対応する必要がある（ことがある）。
• ログ（アクセスされた資源要求を、上記プログラムでは ’puts’により端末に表示している （一般的なWebサーバではログファイルに書き残される）。

ルーティングについて

• URLは、要求を受け取るサーバ（のアドレス）と、要求の内容を / で連結して作らsmaller図）。
• 要求の内容によってサーバが動作を変える。これをルーティングと呼ぶことがある。

プログラム（再掲）

require 'webrick'
srv = WEBrick::HTTPServer.new(
   DocumentRoot:'./',  BindAddress:'127.0.0.1',
   Port:20080,    CGIInterpreter:'C:/tools/ruby27/bin/ruby.exe')
srv.mount('/view.cgi', WEBrick::HTTPServlet::CGIHandler, 'view.rb')
srv.mount('/foo.html', WEBrick::HTTPServlet::FileHandler, 'hoge.html')
trap("INT"){ srv.shutdown }
srv.start

動作解説

動作中の様子

• 同じポート番号で２つめのサーバを起動したとき（に出るメッセージの例）：

C:\Users\nobu\Documents\class\BNS>WebServer1.rb
[2018-07-05 11:21:59] INFO  WEBrick 1.3.1
[2018-07-05 11:21:59] INFO  ruby 1.9.3 (2013-11-22) [i386-mingw32]
[2018-07-05 11:21:59] WARN  TCPServer Error: Only one usage of each socket addre
ss (protocol/network address/port) is normally permitted. - bind(2)
C:/App/Ruby193/lib/ruby/1.9.1/webrick/utils.rb:85:in `initialize': Only one usag
e of each socket address (protocol/network address/port) is normally permitted.
- bind(2) (Errno::EADDRINUSE)
        from C:/App/Ruby193/lib/ruby/1.9.1/webrick/utils.rb:85:in `new'
        from C:/App/Ruby193/lib/ruby/1.9.1/webrick/utils.rb:85:in `block in crea
te_listeners'
        from C:/App/Ruby193/lib/ruby/1.9.1/webrick/utils.rb:82:in `each'
        from C:/App/Ruby193/lib/ruby/1.9.1/webrick/utils.rb:82:in `create_listen
ers'
        from C:/App/Ruby193/lib/ruby/1.9.1/webrick/server.rb:82:in `listen'
        from C:/App/Ruby193/lib/ruby/1.9.1/webrick/server.rb:70:in `initialize'
        from C:/App/Ruby193/lib/ruby/1.9.1/webrick/httpserver.rb:45:in `initiali
ze'
        from C:/Users/nobu/Documents/class/BNS/WebServer1.rb:2:in `new'
        from C:/Users/nobu/Documents/class/BNS/WebServer1.rb:2:in `<main>'

このポート番号はすでに（最初に起動したWebサーバによって）掴まれているため（右図）、 後から起動したプログラムは同じポートを使用できず、異常終了する。

3 データの表現（補足）

a 文字コードとエンコーディング（概要）

• 日本語には複数のエンコーディングがある

• ネットでの主流は最近ではUTF8。 UTF8については、ファイル先頭部の BOM にも注意を払う必要がある。

• テキストエディタによっては、扱えない形式もある。

• 主にエディタ向けの、マジックコメントが書ける（自動挿入される場合もある）。

• 転送時にHTTPヘッダーで指定されることがある。

• HTMLテキストの中（先頭部）でも指示が行える。

• それと別の問題として、OSによる差異が原因のトラブルが以下のように発生し得ることにも注意。

  • ファイル名の文字コードの問題
  • 改行文字の問題
  • 大文字小文字の区別

b ネットワークにおける文字コード

• URLの中の日本語文字 : パーセントエンコーディング
  • ファイル名での表現（OS別）
• Webコンテンツの文字コード
  • Content-typeヘッダー（ブラウザのF12 で確認）
  • meta タグの charset 属性 または Content-type属性 （ソース表示で確認）
  • 実体（ファイル）の内部コード
• 改行文字
  • ファイルの改行文字 （プログラムとして実行する際の制限）
  • HTTPでの改行文字
  • HTMLでの改行文字

c 補足

• 用語として正確には「エンコーディング」
• ブラウザ（などの文字を扱うソフト全般）で「エンコーディング」というような メニュー項目を確認して下さい
• 日本語を扱うエンコーディングはざっと４種類。
• 最近のネット界ではUTFが主流。
• コンテンツのエンコーディングはブラウザが判断するが、その際、 （前に述べたが）
  • HTML中の METAタグ
  • HTTPのレスポンスヘッダ中の Content-typeヘッダ を参考にする。