現在は巷にあるWebAPIの検証を行っています。
リクエスト送信機能
さて、WebAPIを実行するにはリクエスト送信機能が無くてはなりません。HTTPリクエスト送信には一般に「Getメソッド」と「Postメソッド」があります。
本当はHTTPには「Deleteメソッド」とか「Putメソッド」とか色々と策定されているのですが、HTTPブラウザを初めとして送受信するソフトウェアの方が非対応だったりすることが多く、ほとんど使われていません。
「各メソッドはちゃんと決められたルールに則って使おう」という呼びかけもありますが、それが実現するのはまだ相当先となるでしょう。（永久に来ないかも）
というわけで、今回は「Getメソッド」と「Postメソッド」のみを考察します。
GetとPostの本来の用途は以下です。
- Get：リソースの取得に使用する。(例えば、テーブルの主キーをGet送信して検索し結果を取得する、など)
- Post：情報の送信に使用する。(例えば、入力フォームの全情報をPost送信してテーブルに保存する、など)
今回のテキスト解析APIは「テキスト解析結果を取得する」機能ですので、Getを使う方が標準と言えます。
しかし、Getメソッドの場合、Webサーバに最大長制限があります。
（Apacheの場合はデフォルトで「8190バイト」など。）
今回のテキスト解析ＡＰＩでは、解析するテキストの長さがどれくらいになるか分かりませんので、
「Getで大量データを送信したらエラー」といったケースが想定されます。
その一方、Postにも上限はありますが、こちらはGetよりも大量データを送信出来ます。
（Tomcatの場合はデフォルトで「2メガバイト」など。）
この為、今回はPost送信を使います。
- テーブルの主キー検索など、リクエスト長の上限が明確に決まっている場合はGetメソッド。
- 今回のテキスト解析ＡＰＩのテキスト送信みたいに、リクエスト長が不明 or 大量な場合はPostメソッド。
こういう使い分けにするのが合理的でしょう。
以下に私がJavaで作ったPost送信機能のサンプルソースを記載しておきます。
特に変わった機能は無く、普通に送信して、人間が目で見て分かりやすい形に出力するソースです。
HTTP通信は汎用的なプロトコルですので、JavaScript、PHP、Rubyなど、各言語でも作成できます。
各自の環境で都度、都合の良いように作れば良いでしょう。
public class RequestSender {
/** logger */
private Logger logger = Logger
.getLogger(RequestSender.class);
/**
* リクエストをPOST送信する
*
* @param url
* @param postBody
* @return
* @throws IOException
*/
public String sendPost(String url, String postBody) throws IOException {
//log4j使用
//送信パラメータをトレースログに出力
if(logger.isTraceEnabled()){
logger.trace("送信先URL：" + url);
logger.trace("リクエストボディ：" + postBody);
}
URL sendURL = new URL(url);
URLConnection con = sendURL.openConnection();
// POST送信モードを指定
con.setDoOutput(true);
// 送信実行
OutputStreamWriter osw = null;
BufferedWriter bw = null;
try {
osw = new OutputStreamWriter(con.getOutputStream());
bw = new BufferedWriter(osw);
// POSTの内容を書き出す
bw.write(postBody);
} finally {
if (bw != null) {
bw.close();
}
if (osw != null) {
osw.close();
}
}
// 受信
InputStreamReader isr = null;
BufferedReader br = null;
StringBuilder bul = new StringBuilder();
try {
isr = new InputStreamReader(con.getInputStream());
br = new BufferedReader(isr);
String line;
while ((line = br.readLine()) != null) {
//肉眼で見やすいように改行コードを付与
bul.append(line).append(System.getProperty("line.separator"));
}
} finally {
if (br != null) {
br.close();
}
if (isr != null) {
isr.close();
}
}
//apachecommons使用
//最後の改行コード削除
return StringUtils.chomp(bul.toString());
}
}
リクエスト発行編へ
文面が長くなってきましたので、今回はここまで。
次回はいよいよ、上記ソースを使ってレスポンスの中身を検証してみます。
