Servletでの非同期処理における接続維持について

Question

###前提・実現したいこと
Google Maps APIのKMLLayerにDBから取得したデータで作成したKMZファイルを表示させるプログラムを作成しています。

Google Maps APIで実装したWebサイトからHTTPリクエストをServletで受け
リクエストパラメータを元にDBを検索し、結果をKMZとして返却するプログラムを作成しました。
地図上で条件指定しリクエスト→Servlet→DB検索→KMZファイル作成→KMZバイナリデータ返却→地図上にKMZレイヤー表示
という流れになります。

データ取得に時間がかからない場合は問題なくGoogle Maps APIにKMLLayerとしてKMZを表示できるのですが、
DBからデータを作成する際に目安として10秒以上かかるようなデータを取得する場合、以下のエラーが発生します。

org.apache.catalina.connector.ClientAbortException: java.io.IOException: Broken pipe

KMLLayerを表示する場合、Google側のサーバからアクセスされていることから
Google Maps API内でタイムアウトと判断し、接続を切断しているのではないかと推測しています。

###該当のソースコード
以下のようにKMZファイルをHttpServletResponseとして返却するプログラムを記述しています。

protected void doGet(HttpServletRequest request, HttpServletResponse response) {
	try {
		// DBを検索し、KMZファイルを作成
		createKMZ();
		// KMZの返却
		try (InputStream in = new FileInputStream("kmzFile.kmz");
			OutputStream out = response.getOutputStream()) {
			response.setContentType("application/vnd.google-earth.kmz");
			response.setHeader("Content-Disposition", "filename=kmzFile.kmz");

			byte[] buff = new byte[1024];
			int len = 0;
			while ((len = in.read(buff, 0, buff.length)) != -1) {
				out.write(buff, 0, len);
			}
			out.flush();
		} catch (IOException e) {
		}
	} catch (Exception e) {
	}
}

上記プログラムの createKMZ() 内部の処理時間がかかるためタイムアウトが発生していると推測しているため
createKMZ() を非同期処理にし、HTTP接続を維持することができれば解決するのではないかと考えていますが
実装の方法がわかりません。

どなたか同じような問題に直面した経験がある方がいらっしゃれば解決方法をご教示頂きたいと思います。

よろしくお願いいたします。

###補足情報(言語/FW/ツール等のバージョンなど)
Server version: Apache Tomcat/8.0.39
OS Version: 3.10.0-514.el7.x86_64
JVM Version: 1.8.0_111-b15

Answer 1

同じ問題に直面したことはありませんが、Google Maps APIのKMZの使い方で思いついたので回答を書いてみます。

問題を解決する案ですが、HTML接続を維持するのではなく、
「KMZを作る処理とKMZを表示させる処理を分ける」
というのが良いと思います。

KMZLayerの使い方サンプルを下記のサイトで見ると、サンプルでは作成済みKMZファイルをURLに指定するようですね。
Goolge Maps API:KMZ Layers

function initMap() {
  var map = new google.maps.Map(document.getElementById('map'), {
    zoom: 11,
    center: {lat: 41.876, lng: -87.624}
  });

  var ctaLayer = new google.maps.KmlLayer({
    url: 'http://googlemaps.github.io/js-v2-samples/ggeoxml/cta.kml',
    map: map
  });
}

これに対し、CCwS3さんの作成されている方法では
"url: "の部分に作成されたServletのURLをパラメータ付きで指定している
のではないかと推察します。

私の案は、「KMZを作る処理とKMZを表示させる処理を分ける」 ですが、
ServletをKMZを作成するものと、KMZの内容を返却するものの2つに分ける
ということをします。
Ajaxを活用し、KMZの作成をさせ、そのレスポンスを受けてKMZの内容を表示させます。
こうすることで、KMZの作成とGoogle Maps APIのリクエストは分離されるので、
KMZ作成にかかる時間がGoogle Maps API(google.maps.KmlLayer)に影響することはなくなります。

Servletの中身は割愛し、かつJavaScriptもイメージを伝えるだけのものとなりますが、以下に記します。

function initMap() {
  var map = new google.maps.Map(document.getElementById('map'), {
    zoom: 11,
    center: {lat: 41.876, lng: -87.624}
  });

  var xmlReq = new XMLRequest();
  //KMZファイルを作成するServlet
  xmlReq.open('GET','http://example.com/Exsample/KMZCreateServlet', true);
  xmlReq.onreadystatechange = new function() {
    if (xmlReq.readyState == 4) {
      kmlPath = xmlReq.responseText();
      //KMZの内容を返却するServlet
      var ctaLayer = new google.maps.KmlLayer({
        url: 'http://example.com/Exsample/KMZServlet?kml=' + kmlPath,
        map: map
      });
    }
  }
  xmlReq.send();
}

KMZが物理ファイルとしてサーバ上に発生することになりますが、
KMZの内容を返却するServletにてデータの送り出しが済んだら削除すれば良いと思いかと思います。

Comments

[CCwS3]

ご回答頂きありがとうございました。

「KMZを作る処理とKMZを表示させる処理を分ける」
方法を私も検討しておりましたが、
KMZ作成ボタンとKMZレイヤー表示ボタンを分ける方法しか思いつかず
あまりスマートではないなと思っていました。

Hiroshi-Aoki様のご回答のように
XMLHttpRequestオブジェクトのイベントハンドラで
KMLレイヤーを表示する方法であればユーザ側にも影響なく
本来の目的を実現することができました。

このたびはありがとうございました。

Answer 2

broken pipeが出ている原因となる例外を握りつぶしているため、原因が特定できないと思料します。

createKMZ(); の実装内容(特にファイル出力の部分)がないので明確な回答ではないですが、例えば1つの処理中にもう1つのリクエストが要求された場合、コードを拝見した限りでは全く同じファイルへ出力したものを読み込んでいるため、例外が出ているのではないでしょうか。

最低でもスタックトレースは出して例外を正しく判断できるようにすべきでしょう。

      } catch (IOException e) {
        e.printStackTrace();
      }
    } catch (Exception e) {
      e.printStackTrace();
    }

Comments

[CCwS3]

ご回答ありがとうございました。

今回の質問ではKMZの返却処理に何らかの問題があると考えていたため、
その部分のプログラムの記載を優先しました。

実際はcatchした中でログ出力を行っていますが、
質問内容とあまり関係ないことかと思い、catch内のプログラムを省略していました。

省略したことを説明しておらず、質問内容がわかりにくくなってしまったと思います。
申し訳ありません。

今後も質問をさせて頂くことがありましたら、今回ご指摘頂いた点を参考に致します。

また、broken pipe の原因ですが
クライアント側（今回はGoogle Maps APIサーバ）から接続を切断された場合に発生する
ということがわかっています。

なぜGoogle Maps APIから切断されるかの確かな理由を今回は掴むことができませんでしたが、
何かわかれば本件で追記させていただくつもりでおります。

今後共よろしくお願いいたします。