日本語の扱い

Mojoliciousにおける日本語の扱いについて解説しておきます。Perlを使う場合に、学習するのを難しく感じるのは、文字コードの扱いでしょう。Perlでの文字コードの扱い自体はきわめて簡単なのですが、現代的な方法を知らないという理由で混乱されている方も多いと思います。

過去の歴史や理論はおいておいて、ここでは実用的な項目に絞って絞って解説します。詳しい解説については「Encode - 日本語などのマルチバイト文字列を適切に処理する / Perlモジュール徹底解説」を参考にしてください。

バイト文字列と内部文字列

Perlでは、プログラムの内部では内部文字列を使って、プログラムの外部に対しては、特定の文字コードで表現されたバイト文字列を入力として受け取ったり、出力したりします。

プログラムの内部では内部文字列、プログラムの外部ではバイト文字列と考えてください。

プログラムの内部 - 内部文字列

プログラムの外部 - バイト文字列

Javaを知っているのであれば、単純に文字列ストリームとバイトストリームだと考えてみてください。

つまりPerlでは、内部文字列とバイト文字列の変換が必要だということです。この変換を行うモジュールが、Encodeモジュールです。

use Encode qw/encode decode/;

# デコード(特定の文字コードで表現されたバイト文字列を内部文字列に変換)
my $str_internal = decode('UTF-8', $str_byte);

# エンコード(内部文字列を特定の文字コードで表現されたバイト文字列に変換)
my $str_byte = encode('UTF-6', $str_internal);

Encodeモジュールのencode関数とdecode関数を使って、内部文字列とバイト文字列の変換を行います。

utf8プラグマ

次にもうひとつutf8プラグマの利用方法を見ておきましょう。ソースコードがUTF-8で保存された場合は、ソースコードの中の文字列は、UTF-8バイト文字列です。

# UTF-8バイト文字列
my $str_byte = 'あいうえお';

utf8プラグマを有効にすると、ソースコードの中の文字列は、内部文字列として解釈されます。

# 内部文字列
my $str_internal = 'あういうえお';

Perlでソースコードの中で日本語を扱う場合は、必ずutf8を有効にして、ソースコードをUTF-8で保存するようにしてください。

Mojoliciousにおける日本語の扱い

Mojoliciousというフレームワークも、この現代的なPerlの文字列の扱いとまったく同じ考え方になっています。かつ、それらすべてを自動的に行ってくれるので非常に楽です。前提としてソースコードとテンプレートはUTF-8で必ず保存しましょう。

Mojoliciousというフレームワークは、以下の機能を提供します。

utf8プラグマは自動的に有効になります。
テンプレートに描画するときは内部文字列がUTF-8バイト文字列に自動的に変換されます
フォームから受け取るときはUTF-8バイト文字列が内部文字列に自動的に変換されます

ひとつづつ解説します。

utf8プラグマは自動的に有効になる

Mojoliciousでは、Mojo::Baseというクラスを継承しているクラスは、utf8プラグマが自動的に有効になります。Mojoliciousの機能を使うときは、必ずMojo::Baseを継承しているクラスを使うことになるので、すべてのクラスとテンプレートでutf8プラグマが自動的に有効になることになります。

# 自動的に有効になる
use utf8;

ですから、ソースコードとテンプレートで記述する文字列は、すべて内部文字列になります。

テンプレートに描画するときは内部文字列がUTF-8バイト文字列に自動的に変換

テンプレートに描画するときは、内部文字列がUTF-8バイト文字列に自動的に変換されます。

get '/' => sub {
  my $self = shift;

  $c->render('index', message => 'あいうえお');
};

@@ index.html
<%
  my $message = stash('message');
%>

日本語を書く
<%= $message %>

普通に記述すれば、普通に自動変換されるので、普段は特別に意識する必要はないです。

フォームから受け取るときはUTF-8バイト文字列が内部文字列に自動的に変換

フォームから文字列を受け取るときは、自動的に内部文字列に変換されます。

post '/' => sub {
  my $self = shift;  
  my $message = $self->param('message');
  ...
}

paramメソッドで受け取った文字列は内部文字列へと自動的に変換されています。

このようにMojoliciousではバイト文字列と内部文字列の変換を自動的に行ってくれるので、普段はあまり意識する必要がありませんが、仕組み自体は覚えておいてほしいと思います。

Mojolicious入門