まだプログラマーですが何か?

プログラマーネタとアスリートネタ中心。たまに作成したウェブサービス関連の話も http://twitter.com/dotnsf

ファイルのアップロードを伴うアプリケーションを作っていて悩ましいことの1つに「中身の変わらない(全く同じ)ファイルが別のファイル名でアップロードされることがある」ことです。

アプリケーション側の実装としては、アップロードされたファイルをストレージ等に保存する処理を用意しているのですが、その際のファイル名をどうするか? という問題があります。

例えば "a.jpg" という画像ファイルと、"b.jpg" という異なる画像ファイルがあり、これら2つがアップロードされるケースだけを考えるのであれば、ストレージに保存する際にも元のファイル名をそのまま使えることになります:
2017052201
↑異なる2つのファイルを元のファイル名のまま保存する場合(このケースは問題なし)


ところが更に "a.jpg" というファイル名で、既に保存済みの "a.jpg" とは異なるファイルがアップロードされることもあります。この3つ目のアップロードファイルは "a.jpg" というファイル名で(上書き)保存するわけにはいきません(元のファイルが消えてしまう)。ということは元のファイル名をそのまま使うことは正しい処理ではなくなります:
2017052202
↑同じファイル名で中身の違うファイル保存しようとすると上書きすることになってしまう


また別のケースとして、"c.jpg" というファイル名で、"a.jpg" と中身が全く同じ画像ファイルがアップロードされるケースを考えてみます。この場合、ファイル名そのものは元のもの(c.jpg)を使っても被ることがなくいいのですが、全く同じ画像ファイルを2つ保存することになり、無駄にストレージを消費することになります。画像ファイルであればそのサイズもたかが知れているのかもしれませんが、これが仮想イメージとかだったりすると1ファイルで数10Gバイト消費することもあるため、中身の全く同じファイルであれば複数保存せずにすませたいものです:
2017052203
↑異なる名前で中身の同じファイルを元のファイル名のまま保存すると、無駄な保存領域を使うことになる


上記の問題点を実現する方法として、「同じ中身(バイナリ)のファイルは同じファイル名で、異なる中身のファイルは異なるファイル名を用意して保存する」仕組みを用意する方法があります。で、これを比較的簡単に実現する方法がファイルのハッシュ値を使うことが考えられます:
2017052204
↑ファイルのバイナリデータのハッシュ値をファイル名に使えば、中身が異なるファイルは異なるファイル名になる


試しに Node.js で実装したものを Github に公開しました:
https://github.com/dotnsf/node-upload-sample


画像のバイナリデータ(バイト配列)からハッシュ値を生成しているのは app.js 内の以下の箇所です。Node.js 標準の crypto ライブラリを使って、SHA512 アルゴリズムで path のファイルストリームからハッシュ値を生成している箇所です:
  :
var crypto = require( 'crypto' );

  :
  var path = req.file.path;
  var destination = req.file.destination;

  //. Name after Hash value
  var hash = crypto.createHash( 'sha512' );
  var fstream = fs.createReadStream( path );
  hash.setEncoding( 'hex' );
  fstream.on( 'end', function(){
    hash.end();
    var result = hash.read();

      :

ファイル(画像)をストリーム化してハッシュ値を求め、後ろに元の拡張子を付けたものを保存時のファイル名にしています。


このアプリを実際に動かしてみた様子を以下に紹介します。まず動作確認するにあたって、3種類4つのファイルを用意しました。01.png と 02.png はファイル名は異なりますが、全く同じファイルです。03.png は名前も中身も異なります:
2017052301


これらとは別に、中身の異なる 01.png というファイルを用意しました(ファイル名だけ前述のものと被ります)。これら3種類4つのファイルを全て順にアップロードした時の様子が以下です:
2017052302


まずアプリケーションを起動するとこのような画面になります。登録した画像ファイルが一覧表示されますが、まだ何も登録していない状態では何も表示されません。ここで 01.png (03.png と同じ画像の方)を選択して登録してみます:
2017052301


01.png のハッシュ値が生成され、その値をファイル名として保存されました:
2017052302


このリンクをクリックすると、元の 01.png が登録されていることが確認できます:
2017052303


同様にして、今度は 03.png を登録してみます。すると 01.png と 03.png は異なる画像ファイルであるため、ハッシュ値も異なります。そのため別画像として新たにされます:
2017052304


続けて今度は 02.png (01.png と同じ画像ファイル)を登録します。このファイルはファイル名こそ別ですが実体が 01.png と同じものであるためハッシュ値は 01.png と同じものになります。そのため「既存のデータ」と判断され、新たに画像は登録されません(正確には同じ名前のファイル名で、同じ内容を上書きすることになるので、ファイルは増えず、中身が変わることもありません):
2017052305


更にもう1つの 01.png(元の 01.png とはファイル名は同じだが、中身の異なるもの)を登録してみると、今度は中身の違うファイルなのでハッシュ値も別のものになり、新しいファイルとして登録されます:
2017052306


結果的には3種類4つのファイルを登録しましたが、内容の異なる3つのファイルがアップロードされました。中身の同じファイルは二重登録しない、という当初の目的が達成できました:
2017052307


これでストレージの無駄な空間を使わずに済ませられそうです。

位置情報付きのマンホール画像情報ポータルサイトである、拙作「マンホールマップ」を作って運用しています(詳しくはこちら):
2017052401


このサービスに限った話をすると、仕様を決める&変えるのも、作るのも、管理運用するのも、基本的には全部僕が1人でやっています。なので現状 DevOps 的な観点では非常に楽ちんです。

ただ一般的(?)にはこれらは分業制が取られることが多いです。そこで DevOps 的なアプローチやツールが活用されたりするわけですが、特に「業務で地図アプリを作る」場合に意識しておくべきことが大きく3つあります:
(1) どこの地図 API を採用するのか?
(2) (1) の API が有償の場合、誰が支払いをするのか?
(3) 誰がキーを登録するのか?



まず (1) です。一般的、というか理想的にはまず最初に仕様を決めて、その仕様にあったものを作っていきます。地図アプリの場合、「その地図を使ったどういうアプリを作るのか」というのが仕様にあたるわけですが、「それが実現できるのは、どこの地図か?」ということを意識して決める必要があります。ウェブで使える地図にも Google MAP だったり、Yahoo! Developers の YOLP だったり、オープンマップだったり、・・・と色々あって、まず地図の見た目からして異なります。そして持っている機能や拡張機能も異なります。アプリケーションサービスとして作る場合は、そこから提供されている API でどこまでできるのか/できないのかも異なってきます(更にいうとウェブ上の情報量も異なります)。というわけで、やりたいことを実現できる地図はどこの地図か? を見極めるのがかなりの労力を要する作業になります。 機能や情報量の面で比較的メジャーなのは Google MAPs だと思っているので、とりあえず Google MAPs にしておけば柔軟な対応も可能にはなりますが、その場合は (2) の問題を意識する必要がでてきます。

次に (2) です。例えば Google MAPs は商用利用可ですが有償です。この利用料金を支払うのは仕様を決める人?作る人?管理する人?それとも別の人?作る内容によって利用頻度(つまり料金)が変わることもあるし、作っている段階で支払いが発生する可能性があるものですが、開発時の利用ルールを決めたりするとそれが足枷になったりすることもあるので、仕様を決める人と作る人、管理する人が分かれていたりすると、この支払い責任を誰が持つのか、というのが悩ましくなります。

#かといって無償のだと、それなりの機能だったりします。。。

最後に (3) です。ほとんどの地図 API はコードを書けば動く、というものではなく、アカウントを作って、そのアカウントを使ってアプリケーションキーを登録し、そのアプリケーションキーを使ってコードを書く、という開発スタイルになります。ということは、極端な例えですが、アプリケーションキーを誤って消してしまったりするした場合、作ったアプリケーションの地図は動かなくなってしまいます。 そんな大事なアプリケーションキーを管理するのは仕様を決める人、作る人、管理する人、誰のアカウントで作るべきでしょうか? で、これも (2) 同様に誰の権限でこのキーを登録するか、という問題が生じるわけです。


以下は私の私見です。

最終的な運用をイメージしなければ(試験的に使ってみるだけなら)、(2) と (3) は作る人がやると手っ取り早いと思います(試験的であればおそらく (1) も)。が、実際の運用を考えるとこれは運用者の責任範囲で行うべきです。が、そうなると見積もりとかいろいろ話が長くなって、なかなか進まなくなるというのも現実です。また実際の運用となると「商用利用」だと思うので、(1) の選択肢においても利用規約を意識する必要がでてきて、話がややこしくなるわけです。


単に「アプリで地図を使う」だけでも、上記のようなややこしい要素が含まれていて、これらを意識しておかないと (1) の調査や稟議で時間がかかってしまったり、仕様変更時に (1) に戻らないといけなくなったり、(2) や (3) で見積もりや手続きで時間がかかってしまったり、、、ということが起こり得るのでした。逆にこの辺りをタイムリーに判断できると、地図アプリを効率よく開発・運用していけるのだと思っています。

サーバーサイドで動的に画像を作りたい、という要求を実現する方法はいくつかありますが、今回は Node.js から使えるライブラリ "node-canvas" を紹介します:
https://github.com/Automattic/node-canvas/


まず、このライブラリを使う上ではいくつかのネイティブライブラリが必要です。詳しくは上記オフィシャルページを参照いただきたいのですが、例えば Ubuntu 環境であれば以下のコマンドを最初に実行して、必要なネイティブライブラリをあらかじめ用意しておきます:
$ sudo apt-get install libcairo2-dev libjpeg8-dev libpango1.0-dev libgif-dev build-essential g++

ネイティブライブラリの導入後に、以下のコマンドで node-canvas をインストールします:
$ npm install canvas

ちなみに、Bluemix の SDK for Node.js ランタイムを使う場合には上記のネイティブライブラリが導入されたビルドパックを利用するので、実行環境でのネイティブライブラリの有無に関しては意識する必要はありません。


さて、node-canvas ではサーバーサイドで HTML5 の Canvas を操作するイメージで動的に画像を作ったり、変更したりすることができます。

ブラウザ上でも Canvas は JavaScript で操作することが多いと思いますが、以下のようにほぼ同じような操作で扱うことができます:
var fs = require( 'fs' );

var Canvas = require( 'canvas' ),  //. ここでライブラリ読み込み
    Image = Canvas.Image;          //. 画像生成用オブジェクト

  :

//. public という空ディレクトリをあらかじめ用意しておく(そこに画像を作る)
app.use( express.static( __dirname + '/public' ) );

app.get( '/xxx', function( req, res ){
  //. /xxx に GET アクセスがあったら、その場で画像ファイル xxx.png を生成して、画像にリダイレクトする
  var img = new Image;
  var canvas = new Canvas( 300, 300 );
  var ctx = canvas.getContext( '2d' );

  //. 斜めに赤い線が1本引いてあるだけの画像を作る
  ctx.beginPath();
  ctx.moveTo( 100, 100 );
  ctx.lineTo( 200, 200 );
  ctx.strokeStyle = 'red';
  ctx.stroke();

  //. 画像を Base64 エンコードで取り出して、デコードして、xxx.png という名前で保存する
  var b64 = canvas.toDataURL().split( ',' )[1];
  var buf = new Buffer( b64, 'base64' );
  fs.writeFile( __dirname + '/public/xxx.png', buf, function(){
    res.redirect( '/xxx.png' ); //. 作った画像にリダイレクト
  });
});

上記は僕が作ったサンプルコードの一部を多少変更したものです。Node.js で実行して、/xxx というパスに GET アクセスがあると動的に /xxx.png という画像ファイルを作って(そこにリダイレクトして)表示する、というものです。実際に画像を描いたり作ったりしているのは赤字の部分なのですが、ほぼそのままブラウザ内の JavaScript でも動く記法になっています。

普段から HTML5 の Canvas を使っている人であれば、そのスキルをそのままサーバーサイドで動的に画像を作る技術に応用できると思います。とても便利。

 

このページのトップヘ