Ringとnamespace-qualified keywordについて

handler-resolverのところはとりあえず無視してもらってもいいんですが、注目してほしいのはviewの各inputタグにあるname属性です。Railsなんかをやっている方だと馴染みの深い記法なのではないでしょうか。また、他の言語の他のフレームワークなどでも、ネストしたものを扱いたいときは似たような記法が用意されていることが多いと思います。

そして、これをサブミットすると次の結果を得ることができます。

code:clojure

{:alice {:hometown "Saitama", :age "19"}, :bob {:hometown "Tokyo", :age "20"}}

良い感じの結果を得ることができます。ところで一体なにが問題なのでしょうか?まずはHiccupについておさらいしてみましょう。

code:clojure

(require 'hiccup.core :as h)

(h/html :input {:name :alice.hometown})

;; => "<input name=\"alice.hometown\" />"

Hiccupは通常name属性をキーワードで記述することができます。ですが、先程のようにネストしたデータを扱いたい場合は文字列で記述する必要があります。別にいいじゃないか、という声が聞こえてきそうですね。別にいいんですが、Clojureにはこのような構造を扱うためのもっと良い方法があったような気がしませんか?そう、それが今回話題にあげたい名前空間付きキーワードです。

早速Hiccupで名前空間付きキーワードを使ってみましょう。

code:clojure

(h/html :input {:name :alice/hometown})

;; => "<input name=\"hometown\" />"

…?hometownだけしか残りませんでした。これはHiccupがname関数を何も考えずに利用しているからですね。ちなみに文字列で同じようにするとどうなるかというと、次のようになります。

code:clojure

(h/html :input {:name "alice/hometown"})

;; => "<input name=\"alice/hometown\" />"

期待通りの結果を得ることができましたね。ただ、キーワードとして記述したいので、ちょっとしたトリックを使いましょう。HiccupのデータをHiccupのデータに変換してあげる前処理を入れてみます。

code:clojure

(require 'kuuga.tool :as k.tool

'kuuga.growing :as k.growing)

(defmethod k.growing/transform-by-tag :input

_ tagvec

(let [tag tagopts contents (k.tool/parse-tag-vector tagvec)]

`[~tag

(update ~tagopts :name #(if (keyword? %) (subs (str %) 1) %))

~@contents]))

このようなメソッドを定義すると以下のように記述することができます。

code:clojure

(require 'kuuga.ultimate :as k.ultimate)

(h/html (k.ultimate/transform* :input {:name :alice/hometown}))

;; => "<input name=\"alice/hometown\" />"

これで名前空間付きキーワードで書いても、Hiccupは期待通りに変換してくれます。これを利用してviewを書き換えてみましょう。

code:clojure

(def view

(h/html

(k.ultimate/transform*

[:form {:method :post}

[:div

:label "アリス:出身地"

:input {:name :alice/hometown}]

[:div

:label "アリス:年齢"

:input {:name :alice/age}]

[:div

:label "ボブ:出身地"

:input {:name :bob/hometown}]

[:div

:label "ボブ:年齢"

:input {:name :bob/age}]

:button {:type :submit} "submit"])))

この状態で画面を表示して、サブミットすると以下のような結果を得ることができます。

code:clojure

{"alice/hometown" "Saitama", "alice/age" "19", "bob/hometown" "Tokyo", "bob/age" "20"}

マップのキーがキーワードではなく、文字列のままです。これはRingのkeyword-paramsミドルウェアが問題なんですが、Jamesおじさんがあまり乗り気じゃなさそうなのでざっくりハックしてしまいます(問題はこのあたり参照: https://github.com/ring-clojure/ring/pull/116 /たぶん止まってしまってるのはPR作った人がコンフリクトを解消しないからなんだけど…)。

code:clojure

;; 良い子はこれをこのまま真似しないで、上のPRにあるようなコードと等価になるようにするなどしてください

(alter-var-root #'mw.keyword-params/keyword-syntax? (fn v (constantly true)))

ここまでするとようやく求めた結果を得ることができるようになります。

code:clojure

{:alice/hometown "Saitama", :alice/age "19", :bob/hometown "Tokyo", :bob/age "20"}

さて、名前空間付きキーワードにするメリットは実際どのくらいあるんでしょうか?パッと浮ぶ利点は以下の通り。

分配束縛がスマートになる

任意の値へのアクセスが容易になる

補完が効くので間違い難い

こんなもんでしょうか。あとは前日に書いた記事(ユーザー入力のバリデーションにstructを利用する)で、ネストした構造を扱うのが不安定だと話したstructですが、ネストしなければいいのであれば名前空間付きのキーワードは持ってこいです(実際プロダクトでこんなことしてるから、structの問題気付かなかった…)。

code:clojure

(def nested

{:alice {:hometown "Saitama" :age "19"}

:bob {:hometown "Tokyo" :age "20"}})

(let [{{:keys hometown age} :alice} nested]

(str hometown ", " age))

;; => "Saitama, 19"

(get-in nested :alice :hometown)

;; => "Saitama"

(def flat

{:alice/hometown "Saitama" :alice/age "19"

:bob/hometown "Tokyo" :bob/age "20"})

(let [{:alice/keys hometown age} flat]

(str hometown ", " age))

;; => "Saitama, 19"

(:alice/hometown flat)

;; => "Saitama"

ほとんどの人には共感してもらえないかもしれないんですが、特に「任意の値へのアクセスが容易になる(get-inを利用せずキーワードを関数として扱える)」というのはマクロなどを書く際にとても重要で、拙作のkuugaを利用して「フォーム上にある全てのinputタグのvalue属性を前回の入力値で埋める」みたいなことを実現するときには重宝しました。古い昔ながらのやり方に従い続けるのではなく、その言語らしいやり方みたいなのを模索するのも悪くないですよね。

ここまでに出てきたコードの完全版は以下にあります。

https://gist.github.com/ayato-p/668f78af41919218885f13f2212eb96a

ちなみにこれをやるとnested-paramsが不要になったように見えますが、実際はそんなことなくてusers[0]みたいに数値の添字を期待するようなパターンには対応できないです。まあ、そういうのが必要な場合は諦めましょうってことで笑

余談

途中で出てきたkuugaですが、同僚のuochan.iconに「よくできている」とお褒めの言葉をいただけたので最高です。わりとオーソドックスな昔ながらのWebアプリケーションを作るときには重宝すると思うので、是非使ってみてください(面倒なHiccupデータの繰り返しを省略できたりします)。汎用性が高いので色々な用途で利用できます :)

宣伝

ところでCybozu Startups, inc.では、Clojureを書きたいエンジニア募集してます。もし、Clojureを書きたくて興味があって、話だけでも聞いてみたいという方はayato-p.iconまでご連絡ください(/icons/twitter.iconのDMあたりで)。カジュアルにお寿司を食べながらお話しましょう :)

詳しくはこっち -> Cybozu Startups, inc.

#Clojure #アドベントカレンダー2017