2020-01-25

Service Locator + Visitor Patternのようなものでrequire地獄を避ける

勘違いがあったらツッコミください。

前提

JavaScriptには扱いやすい名前空間がない

Ruby や PHP は global な名前空間に簡単に class を置くことができ、必要に応じて module や namespace を使ってその影響範囲をコントロールすることができる。

対して JavaScript は伝統的にはすべて global leak させるか、特定のオブジェクトの中にぶら下げるかしかなかった。require / import 登場以降の時代は、読み込んだものに対して「任意の名前を付けることができる」ようになったので特定のコードを書いているファイルの中では自分で名前の衝突を避けるという作法になった。

逆に言うと思った通りの名前を思った通りにあちこちに影響させることはできない。例えば特定のディレクトリ以下にある class を全部読み込んでおけばアプリケーション内のどこからでもその名前を指定してオブジェクトを利用するといった使い方をするには一手間必要になる。そこで Service Locator ですよ。

Service Locatorの役割

Service Locator は単に名前とオブジェクトを紐づけてくれる KVS の役割を果たすオブジェクトだと思っておけばよい。

ServiceLocator.add('<name>', object) のようなメソッド 1 でオブジェクトの登録を行い、ServiceLocator.get('<name>') のようなメソッドでオブジェクトの取得を行う。ものすごく単純にインターフェイスだけ書くとこう。

class ServiceLocator {
  /**
   * @param {string} name
   * @param {object} object
   */
  static add (name, object) {
  }

  /**
   * @param {string} name
   * @return {object}
   */
  static get (name) {
  }
}

この Service Locator を使うと、ありとあらゆるところで

const Klass = require('klass')

を書きまくらなければいけないという問題を避けることができるのと、文字列からオブジェクトの取得ができるので、Ruby で言う Object.const_get() のようなものも実現できる。

requireしまくる人とaddしまくる人を消す工夫

上のような ServiceLocator をただ入れるだけだと、どこかで ServiceLocator.add() しまくる人は必要になる。ということは

const Klass = require('klass')
const Klass2 = require('klass2')
..

しまくる人も必要になる。

ただし、require される側に以下のようなコードを用意すると、この問題は解消できる。

class Klass {
  static get name () {
    return 'Klass'
  }

  static accept (locator) {
    locator.add(this.name, this)
  }
}

※ accept が汎用的すぎると感じたら(感じるよね?) locate などの名前でもよい。

こうしておくと、例えば以下のように Service Locator と組み合わせることで、上で書いた「特定のディレクトリ以下の class をすべてまとめて require しておく」ことを「いい具合に add を呼ぶ機能」で実現できる。

const glob = require('glob')
const ServiceLocator = require('service-locator')

glob(__dirname + '/sub/*.js', (err, files) => {
  files.forEach((file) => {
    const klass = require(file)
    klass.accept(ServiceLocator)
  })
})

やっていることは以下。

  • ServiceLocator で利用するオブジェクトに対して特定のルールを用意しておく
  • 特定のルールを用意しているオブジェクトに対し、ServiceLocator そのものを投げてしまう

お互いがお互いのインターフェイスを知っていればできる方法。上のコードでは accept メソッドの有無の確認などはしていないので、実践投入の際にはいろいろ考えて書くこと。

この程度の行数で済むなら Ruby や PHP のような感じなカジュアルさで class を使えるようになったと言ってもよさそう。

  1. add は set や register みたいな場合もあり得る 

About

例によって個人のなんちゃらです

Recent Posts

Categories

Tool 日々 Web Biz Net Apple MS ことば News Unix howto Food PHP Movie Edu Community Book Security Text TV Perl Ruby Music Pdoc 生き方 RDoc ViewCVS CVS Rsync Disk Mail FreeBSD Cygwin PDF Photo Zebedee Debian OSX Comic Cron Sysadmin Font Analog iCal Sunbird DNS Linux Wiki Emacs Thunderbird Sitecopy Terminal Drawing tDiary AppleScript Life Money Omni PukiWiki Xen XREA Zsh Screen CASL Firefox Fink zsh haXe Ecmascript PATH_INFO SQLite PEAR Lighttpd FastCGI Subversion au prototype.js jsUnit Apache Trac Template Java Rhino Mochikit Feed Bloglines CSS del.icio.us SBS qwikWeb gettext Ajax JSDoc Rails HTML CHM EPWING NDTP EB IE CLI ck ThinkPad Toy WSH RFC readline rlwrap ImageMagick epeg Frenzy sysprep Ubuntu MeCab DTP ERD DBMS eclipse Eclipse Awk RD Diigo XAMPP RubyGems PHPDoc iCab DOM YAML Camino Geekmonkey w3m Scheme Gauche Lisp JSAN Google VMware DSL SLAX Safari Markdown Textile IRC Jabber Fastladder MacPorts LLSpirit CPAN Mozilla Twitter OpenFL Rswatch ITS NTP GUI Pragger Yapra XML Mobile Git Study JSON VirtualBox Samba Pear Growl Mercurial Rack Capistrano Rake Win RSS Mechanize Sitemaps Android JavaScript Python RTM OOo iPod Yahoo Unicode Github iTunes God SBM friendfeed Friendfeed HokuUn Sinatra TDD Test Project Evernote iPad Geohash Location Map Search Simplenote Image WebKit RSpec Phone CSV WiMAX USB Chrome RubyKaigi RubyKaigi2011 Space CoffeeScript Nokogiri Hpricot Rubygems jQuery Node GTD CI UX Design VCS Kanazawa.rb Kindle Amazon Agile Vagrant Chef Windows Composer Dotenv PaaS Itamae SaaS Docker Swagger Grape WebAPI Microservices OmniAuth HTTP 分析基盤 CDN Terraform IaaS HCL Webpack Vue.js BigQuery Middleman CMS AWS PNG Laravel Selenium OAuth OpenAPI GitHub UML GCP TypeScript SQL Hanami Document SVG AsciiDoc Pandoc DocBook Develop Jekyll macOS Node.js Vite Heroku Transformer AI Data Cloud Wasm