社長BLOG

HOUOU内部パラメータの命名規則

2011-11-15 (火)
社長BLOG
　手嶋守

OpenPNEにはパラメータの名前を考えなくてはならない箇所が複数ある。

SNS全体の設定値を格納するSNS_CONFIG
メンバーのパラメータを保存するMEMBER_CONFIG
プロフィール情報を扱うPROFILEなど。
symfonyタスクの実行名もパラメータでは無いが、名前を考える必要がある。

これらのパラメータの命名規則は、いよいよきっちり定めたい。

Javaのパッケージ命名規約は参考にしている。com.sun.java というやつ。運用実績が多いというのが選定ポイント。

ただ、ドメインが逆順というのがトリッキーで嫌いだ。ディレクトリであるパッケージと違って変数は、ツリー構造の管理が必要ないので、今回は逆順にしなくてもいいかもしれない。

OpenPNEであれば、someparam.pne.jp とする。
プラグイン作者であれば、自分のドメインを利用して
somepluginparam.cqc.jpなどと命名すれば、OpenPNE本体や他のプラグインと衝突する心配がない。
こうした命名規則は、プラグインで利用するタスクの名称や略称にも適用できるはずだ。

命名規則が役に立つと思われる項目は次のようなもの

・TwitterやFacebookなど外部OAuthのアクセストークン
他のプラグインやコアアプリケーション間で共用する可能性がある。

・認証プラグインで利用するキー名
認証プラグインのキーはかなり重要なので、特別に目立つ名前で管理したほうがいい。

・OpenPNE本体で扱うメールアドレス
いまpc_addressとなってるけど、響きがオフィシャルっぽくない

現在は規約がない状態なので、HOUOUのローカルルールとして運用し、うまくいくようなら標準化
という運びにする。