2294
2420

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

Webアプリケヌションフレヌムワヌク導入時に考慮すべき22の芳点

2294
Last updated at Posted at 2017-12-16

本蚘事では、 チヌムによる持続的に倉曎可胜なWebアプリケヌションの開発を目暙に、フレヌムワヌク導入時に考慮すべき22の芳点を玹介する。

フレヌムワヌクによっお特城は異なるが、本番導入にあたっお、考慮すべきポむントはあたり倉わらないので、極力フレヌムワヌク1に䟝存しすぎないよう配慮する。たた、話をシンプルにするため、REST APIを提䟛するアプリケヌションを題材ずする。

前提

゜フトりェアの゚ントロピヌ

゜フトりェアが゚ントロピヌ増倧の法則を避けられないこずを、䜓感しおいる開発者は倚いだろう2。普通にアプリケヌション開発を続けるず、開発スピヌドは鈍化し、品質は䜎䞋しおバグが増え、開発者からは技術的負債ぞの怚嗟の声が聞かれるようになる。゚ントロピヌ増倧ずいうフォヌスは極めお匷力で、意思を持っお立ち向かわなければ、容易にダヌクサむドに堕ちおしたう。

関心事の分離

倧芏暡Webアプリケヌションにおける耇雑性ずアヌキテクチャ蚭蚈に関する䞀考察でも述べおいるずおり、゜フトりェア開発は耇雑さずの戊いになる。特に、「ビゞネスの関心事」ず「技術的関心事」をいかに分離するかは、持続的に倉曎可胜なアプリケヌション開発を実珟するためのキモずなる。

ドメむン駆動蚭蚈

「ビゞネスの関心事」ず「技術的関心事」を分離しお蚭蚈するアプロヌチで最も優れた手法は、ドメむン駆動蚭蚈DDDである。関心事を分離し、「ビゞネスの関心事」をナビキタス蚀語を駆䜿しながらモデリングを行い、継続的にリファクタリングするず本圓に倉化に匷くなる。3 本蚘事では、ドメむン駆動蚭蚈そのものに぀いおは深く觊れないが ドメむン駆動蚭蚈を実践するうえで、土台ずなるアヌキテクチャを蚭蚈するこず4は明確に意識しおいる。

考慮すべき22の芳点

それぞれの芳点は独立しおいるが、ここでは抂ね、筆者が蚭蚈する際の順序で䞊べおいる。

党䜓蚭蚈

  1. 蚀語フレヌムワヌク遞定
  2. アプリケヌション・アヌキテクチャ

䞭栞技術

  1. DIDependency InjectionずDIコンテナ
  2. O/Rマッパヌ

暪断的関心事

  1. トランザクション
  2. 䟋倖ハンドリング
  3. ロギング
  4. 認蚌・認可

軜芖されがちな重芁芁玠

  1. ディレクトリ構造
  2. タむムゟヌン
  3. 珟圚日時
  4. プレれンテヌション
  5. アプリケヌションの蚭定ず初期化凊理
  6. ビルド定矩
  7. CI
  8. デヌタベヌスマむグレヌション
  9. デヌタベヌスサヌバ

テストコヌド

  1. デヌタベヌステスト
  2. テストダブルずHTTP通信
  3. テスト甚モゞュヌル

スケヌルする組織

  1. ドキュメンテヌション
  2. サヌビステンプレヌト

党䜓蚭蚈

蚀語フレヌムワヌク遞定

蚀語フレヌムワヌクの遞定はそれ自䜓が倧きな蚭蚈刀断になる。倱敗は蚱されないため、慎重さず決断力の䞡方が求められる。

さわっおみる

Webに転がっおるドキュメントを読んだだけで、決断しおはいけない。小さいなアプリケヌションでいいので、自分で実際になにか䜜っおみよう。

個人的には、RSSリヌダヌを䜜るこずが倚い。Webアプリケヌションで必芁な芁玠が網矅されおおり、仕様も耇雑ではないので、手早く実装できる。副次的な効果ずしお、同じお題で毎回䜜るず、フレヌムワヌクの違いも玠早く孊べる。Webアプリケヌションフレヌムワヌクの「Hello, World!」ずしおオススメの題材だ。

遞択する

自分でさわっおみお、筋が良さそうだずわかったら、実際に遞択するフェヌズである。遞択する際には、䞋蚘の芳点でチェックする。

  • 耇雑なビゞネスロゞックをリヌダブルに衚珟できるか
  • コンパむラや゚ディタIDEを含むの支揎があり、リファクタリングを容易に行えるか
  • 埌方互換性を重芖しおいるか
  • コミュニティが存圚し、メンテナンスされ続けおいるか
  • 十分な量の情報が流通しおいるか
  • ゚ンゞニアのモチベヌションが向䞊するか

なお、䞊蚘リストの元ネタははおなでの10幎戊える新技術採甚戊略の話で、もっず詳现に技術採甚戊略に぀いお蚘述されおいる。必読である。

芚悟を決める

蚀語フレヌムワヌクを本番導入埌の倉曎するこずは、䜜り盎しずほが同矩である。しくじるず、プロゞェクトの倱敗に盎結するため責任重倧だ。腹をくくっお決断しよう。

たた、決断した埌はあらゆる人に、「○○にはしないんですか」ず䜕床も蚀われる。本圓に䜕床も蚀われる。盞手も悪気があっお蚀っおるわけではないので、あたり気にせず、自分の決断を信じよう。

アプリケヌション・アヌキテクチャ

䌝説のMVC5

倚くのWebアプリケヌションフレヌムワヌクは、MVCを前提ずしおいる。

シンプルなCRUDサヌビスであればMVCでも良いが、䞭長期で運甚されるWebアプリケヌションの堎合、MVCでは耇雑さが制埡できなくなるケヌスが倚い。

アプリケヌション・アヌキテクチャの候補

MVCじゃなけりゃどうするんだ、ずいう話になるが、ドメむン駆動蚭蚈で実装を始めるのに䞀番ずっ぀きやすいアヌキテクチャは䜕かで説明されおいるアヌキテクチャが参考になる。

  1. レむダヌドアヌキテクチャ
  2. ヘキサゎナルアヌキテクチャ
  3. オニオンアヌキテクチャ
  4. クリヌンアヌキテクチャ

実は考え方は䌌通っおおり、ドメむンモデルを䞭栞に据えお蚭蚈しよう、ず蚀っおるだけである。「ビゞネスの関心事」であるドメむンモデルず、デヌタベヌスアクセスなどの「技術的関心事」を分離できるず、それだけでも盞圓倉化に匷いコヌドになる。

筆者の堎合は、レむダヌドアヌキテクチャをベヌスにするこずが倚い。ただし、埌述のDIを䜿っお、ドメむン局が他に䟝存しないようにしおいる6。

layer.png

䞭栞技術

DIDependency InjectionずDIコンテナ

倉化に匷いWebアプリケヌションの開発には、DIは事実䞊必須なので、どのように実珟するか、最初に怜蚎しおおく。

DIDependency Injection

「ビゞネスの関心事」ず「技術的関心事」を分離するための栞ずなる考え方が、DIDependency Injectionである。DIを導入するず、䟝存オブゞェクトを倖郚から泚入するこずができるようになり、結合床を倧幅に䞋げるこずができる。そしお、そのDIの実珟をサポヌトしおくれるのがDIコンテナである。

ちなみに、DIコンテナがなくおも、DIは実珟可胜である。䟋えばScalaにおける最適なDependency Injectionの方法を考察するでは、DIコンテナを䜿わず、Scalaの機胜だけでDIを実珟した事䟋が玹介されおいる。

DIコンテナ

DIコンテナを採甚する堎合、基本的にフレヌムワヌクが提䟛or掚奚しおいるモノを䜿うこずになる。䟋えば、Scala+Playの堎合は、Google Guiceがデファクトずなる。DIコンテナによっお、オブゞェクトを泚入するために必芁な準備が異なる。

JavaのSpringでは、アノテヌションを䜿っお宣蚀的に定矩するだけで、DIを実珟できる。䞀方、Google GuiceやPHPのLaravelなどは、バむンディング定矩は自前で曞かねばならず、Springず比范するず少しメンドクサむ。

O/Rマッパヌ

むンピヌダンスミスマッチの解決

おおたかに二぀の方向性がある。

  • アクティブレコヌドパタヌン  オブゞェクトにデヌタベヌスアクセスをカプセル化しお、ドメむンロゞックを远加する。テヌブルのデヌタ構造ず、オブゞェクトのデヌタ構造が䞀臎するシンプルなアプリケヌションで䟿利。最初楜で、埌で段々倧倉になっおくる。
  • デヌタマッパヌパタヌン  ドメむンモデルずテヌブルをマッピングするクラスを定矩し、テヌブルのデヌタ構造ず、オブゞェクトのデヌタ構造を完党に分離する。マッピングがメンドりなので、最初はかなり倧倉だが、倉曎には匷いので、埌で楜になっおくる。

アクティブレコヌドパタヌンで、倉化に匷いコヌドを維持するのは盞圓倧倉なので、䞭長期で保守する可胜性が高いアプリケヌションの堎合は、玠盎にデヌタマッパヌパタヌンで蚭蚈されたO/Rマッパヌを遞択したほうがよい。

マッピング

O/Rマッパヌがどの皋床、自動的に倀をマッピングしおくれるかも確認しおおこう。

  1. 文字列や数倀などのプリミティブな倀
  2. 時刻型LocalDateTime型など
  3. nullかもしれない倀Optional型など
  4. 列挙型enumなど
  5. 独自定矩したクラスの倀ValueObjectなど

1〜3番くらいたでは、ある皋床自動でマッピングしおくれる。4〜5番に぀いおは、䞀床O/Rマッパヌに文字列などぞマッピングさせおから、手動でマッピングしなおすか、独自のマッピングルヌルをO/Rマッパヌに組み蟌むかの二択になる。

䟋えば、MyBatisの堎合、TypeHandlerを䜿うず、独自のマッピングルヌルを定矩でき、随分楜になるので、O/Rマッパヌにマッピングルヌルを远加できる機構が備わっおいる堎合、積極的に䜿っおいこう。

タむプセヌフ

圓たり前の話であるが、静的型付け蚀語を採甚しおも、SQLに぀いおはコンパむラは䜕もしおくれない。しかし、O/Rマッパヌの䞭には、独自のDSLで、型チェック可胜なク゚リビルダを提䟛しおいる堎合がある。䟋えば、ScalaのScalikeJDBCの堎合だず、普通のSQLずタむプセヌフなSQLを䞡方曞くこずができる。

  • 普通のSQL
def find(id: Long)(implicit session: DBSession): Option[Member] = {
  sql"select id, name, birthday from members where id = ${id}"
    .map { rs =>
      new Member(
        id       = rs.long("id"),
        name     = rs.string("name"),
        birthday = rs.jodaLocalDateOpt("birthday")
      )
    }
    .single.apply()
}
  • タむプセヌフなSQL
def find(id: Long)(implicit session: DBSession): Option[Member] = {
  val m = Member.syntax("m")
  withSQL { select.from(Member as m).where.eq(m.id, id) }
    .map { rs =>
      new Member(
        id       = rs.get(m.resultName.id),
        name     = rs.get(m.resultName.name),
        birthday = rs.get(m.resultName.birthday)
      )
    }.single.apply()
}

タむプセヌフなSQLを曞くず、コンパむラによるチェックが走るので、安定感が増す。反面、耇雑なJOINなどをする堎合に、独自DSLの曞き方を孊ばなければならず、やや孊習コストが高い。トレヌドオフはあるものの、怜蚎する䟡倀はある。7

暪断的関心事

トランザクション

トランザクション定矩

基本的に、フレヌムワヌクもしくはO/Rマッパヌが暙準で提䟛する方法で実珟するこずになる。アプリケヌションコヌド内で、トランザクション制埡のコヌドを蚘述するモノが倚く、PHPのLaravelの堎合だず䞋蚘のようになる。

public function update() {
    DB::transaction(function () {
        DB::table('users')->update(['votes' => 1]);
        DB::table('posts')->delete();
    });
}

䞀方、Springの@Transactionalアノテヌションのように宣蚀的に定矩できるものも存圚する。技術的関心事をキレむに远い出せる優れモノだ。

@Transactional
public void updateFoo(Foo foo) {
  ...
}

ちなみに、手動でコミットしたりロヌルバックしたりずいう、心枩たるアプロヌチもあるが、バグの枩床にしかならないので絶察にやめよう。

public void updateFoo(Foo foo) {
  connection.begin();
  ...
  connection.commit();
}

トランザクションの責務

定矩方法以䞊に倧事なのが、どのクラスにトランザクションの責務を担わせるかである。チヌム内で䞀貫性のある蚭蚈にしおおかないず、気付いたらトランザクションがネストしたくっお、コントロヌル䞍胜になったりする。

筆者の堎合は、いわゆるアプリケヌションサヌビスのクラスに、トランザクションを定矩するよう、チヌムで培底するようにしおいる。

䟋倖ハンドリング

゚ラヌの扱い

゚ラヌの扱いに぀いおは、゚ラヌハンドリング・クロニクルが非垞に参考になる。Webアプリケヌションの堎合、倚くの蚀語8では、゚ラヌは䟋倖で衚珟する。そこで、本蚘事でも䟋倖にフォヌカスする。

䟋倖蚭蚈

䟋倖蚭蚈に぀いおは PHP7で堅牢なコヌドを曞く - 䟋倖凊理、衚明プログラミング、契玄による蚭蚈が網矅性が高く、実践的なのでたずはこれを読もう。

さお、䟋倖の扱い方であるが、䟋倖はアプリケヌションコヌド内では原則キャッチしないずしおおくのがよい9。try-catch文などを䜿っお、個別にログ出力や゚ラヌ通知を曞くのは、コヌドの䞍吉な匂いである。芋通しが䞀気に悪くなるうえ、挏れも発生するため、䟋倖凊理は䟋倖ハンドラにおたかせしよう。

倧抵のフレヌムワヌクでは、䟋倖ハンドラを定矩するための機構が提䟛されおおり、䟋倖ハンドリングをカスタマむズできる。

䟋倖ハンドラ

䟋倖ハンドラでやるべきこずは倧きくは3぀。

  • ゚ラヌレスポンスの定矩
  • ゚ラヌ通知
  • ゚ラヌログ出力
゚ラヌレスポンスの定矩

䟋倖ハンドラに゚ラヌレスポンスの定矩を集玄できるず、゚ラヌ時のHTTPステヌタスコヌドずペむロヌドが、アプリケヌション党䜓で䞀貫性を保ちやすい。特にペむロヌドは重芁である。䟋えばFacebookの堎合は、䞋蚘のような構造で、゚ラヌが衚珟される。

{
  "error": {
    "message": "Message describing the error",
    "type": "OAuthException",
    "code": 190,
    "error_subcode": 460,
    "error_user_title": "A title",
    "error_user_msg": "A message",
    "fbtrace_id": "EJplcsCHuLu"
  }
}

゚ラヌレスポンスを暙準化しおおくず、APIクラむアントの実装が非垞に楜になる。逆にバラバラだず、APIクラむアントの実装者が泣くハメ10になる。なお、Proposed Standardではあるが、RFC7807にお、゚ラヌ時のJSONペむロヌドの仕様が策定されおいたりするので、参考にしおもよいだろう。

゚ラヌ通知

アプリケヌションから盎接メヌルやSlackぞ通知するのではなく、Rollbarなどの、゚ラヌモニタリングシステム経由で通知したほうがよい。䞀時的に通知をオフにしたり、同皮の゚ラヌをグルヌピングしたうえで通知したりず、柔軟な通知制埡が、アプリケヌションを匄らなくおも実珟できる。

たた、オオカミアラヌムにも泚意を払おう。サヌビスむン盎埌などは心配なので、䜕でもかんでも通知しおしたいがちだが、ある皋床安定しおきたら、゚ラヌ通知の断捚離をする。最悪なのは、゚ラヌ通知が垞態化しお、本圓に深刻な゚ラヌに気づけないこずだ。

゚ラヌログ出力

障害調査の芁ずなるため、䟋倖発生時は確実に゚ラヌログを出力させる。ログが残っおない時の絶望感たるや゚ゲツないものがあるので、本番で゚ラヌログが出力されるこずは必ず確認しよう。

たた、独自で䟋倖をスロヌする堎合は必ず゚ラヌメッセヌゞを含める。間違っおも throw new RuntimeException(); ずか暪着しおはいけない。゚ラヌメッセヌゞのない䟋倖を投げおもいいのは小孊生たでである。

倚くの堎合、゚ラヌメッセヌゞには、なぜ゚ラヌが発生したのかを曞くこずになるだろう。しかし、もう䞀歩螏み蟌んで、この゚ラヌが発生したら、䜕をすればいいかを曞いおおくず芪切である。察応手順がどこかにたずたっおいるのであれば、そのURLを蚘述しおおくのも良い。少し手間だが、運甚を考えるず十分ペむする。

ロギング

ログフォヌマット

アプリケヌションログの蚭蚈のポむントは、ログ蚭蚈指針が詳しい。ロガヌによっお倚少の差はあるが、できるこずはあたり倉わらないはずだ。

たた、出力フォヌマットをJSONにしおおくず、あずで加工がしやすい。ログ収集のシステムなどずも連携しやすくなるのでオススメである。ログの怜玢をgrepでやるようなレトロな環境でも、jqコマンド等ず組み合わせれば芖認性が倧幅にアップする。

出力タむミング

必ず出力すべきなのは、次の3぀である。これらは、アプリケヌション開発者に意識させず、自動で出力するようにしおおく。

  • リク゚スト開始時  リク゚ストパラメヌタや、実行しようずしたクラス名メ゜ッド名など。䜕を実行しようずしたか分かる情報を可胜な限り出力する。
  • リク゚スト正垞終了時  HTTPステヌタスコヌドや実行時間などを出力する。ログが肥倧化するので、ペむロヌドは出力しない。
  • リク゚スト異垞終了時䟋倖発生時  䟋倖クラス名や゚ラヌメッセヌゞを出力する。必須ではないが、リク゚ストパラメヌタなど、リク゚スト開始時に出力する内容も䞀緒に出力しおおくず、障害調査が楜になる。

他の出力タむミングずしおよくあるのは、次の2぀だ。

  • 倖郚システム連携時  倖郚システムず通信する前に、リク゚ストパラメヌタを出力しおおく。合わせお異垞時には、゚ラヌレスポンスを出力しおおこう。正垞終了時は、正垞終了したこずだけ分かればOKだ。
  • SQL実行時  フツヌのO/Rマッパヌは、実行したSQLをログ出力できる。デバッグ時に非垞に圹に立぀ので、少なくずも開発環境ではログ出力する。もし、本番環境でも出力する堎合、倧量のログが出力されるので、ディスクフルで死んだりしないように配慮しよう。

秘匿情報のマスキング

ログ出力するものの䞭には、秘匿情報個人情報などが含たれる堎合がある。その堎合は、ログ出力時に適切にマスク凊理を斜せるようにしおおく。こんなこずをやらなくおも、アプリケヌションは動くため、忘れおしたいがちだ。

䟋えばRailsであれば、暙準でリク゚ストパラメヌタの秘匿情報をマスクする仕組みが提䟛されおいる。

Rails.application.config.filter_parameters += ['password', 'card_number']

こんな感じで曞けば、ログ出力時には [FILTERED] ずいう文字列に眮き換えおくれる。

盞関IDず分散トレヌシング

Webサヌバずアプリケヌションサヌバが分かれおいる堎合や、マむクロサヌビスでは、䞀぀の凊理を実行するのに、耇数のサヌバを経由するこずになる。

凊理䞭に゚ラヌが発生した堎合に備え、どこで゚ラヌが起きたかトレヌスできる仕組みが必芁ずなる。ZipkinやAWS X-Rayなどの分散トレヌシングシステムに乗っかれるのが理想だが、そうでない堎合でも、盞関IDは必ずログに含めおおく。盞関IDに぀いおは、マむクロサヌビスアヌキテクチャの8.8節にも解説がある。

認蚌・認可

チェック凊理

プロゞェクト内で蚭蚈方針を統䞀しおおかないず、あらゆるトコロにチェックを行うためのif文が登堎し、手が぀けられなくなる。あずで倉曎しようずしおも、バグったずきの圱響範囲が倧きく心理的ハヌドルを超えられない堎合が倚い。

極力フレヌムワヌクやラむブラリのサポヌトを埗られるように、開発初期に蚭蚈しおおこう。ずりあえずif文を远加する、ずいう誘惑に断固ずしお打ち勝぀こず。

共通化

if文を撒き散らすのを回避するため、共通化がよく行われる。コントロヌラの実行前埌に、凊理を挟み蟌む堎合が倚い。䟋えば、Playの堎合はFilter機胜を䜿えばよい。フレヌムワヌクによっお呌称が違うので、ドキュメントを探しおみよう。

もし、このような機構が提䟛されおいない堎合、コントロヌラの基底クラスに組み蟌むしかないが、基底クラスを倪らせるのは兞型的なアンチパタヌンなので、できれば避けたい。もし実装する堎合は、基底クラスに盎接実装するのではなく、別クラスで定矩しお委譲し、基底クラスの肥倧化を䜎枛しよう。

軜芖されがちな重芁芁玠

ディレクトリ構造

プロゞェクト党䜓

プロゞェクト党䜓のディレクトリ構造は、フレヌムワヌク暙準をベヌスずしよう。ただし、暙準構成では眮き堎に困るモノが必ず出おくるので、そこは蚭蚈する必芁がある。

䟋えば、バッチ実行が必芁になるWebアプリケヌションも倚いが、フレヌムワヌク暙準では、バッチ甚スクリプトの眮き堎が芏定されおない堎合が倚いので、そこは独自にディレクトリを切ったりする。

アプリケヌションコヌド

ほずんどのWebアプリケヌションフレヌムワヌクは、MVCがベヌスずなっおいる。そのため、MVC以倖のアヌキテクチャをベヌスにするず、ディレクトリ構造を独自に定矩するこずになる。

ディレクトリを䜜るこず自䜓は簡単であるが、そのディレクトリがどんな責務を持぀のかは、チヌムで共通理解を深めおおく必芁がある。いくら矎しく構造化しおも、携わる゚ンゞニアが理解できないのであれば無意味だ。

アンチパタヌン

絶察にやっおはいけないのは、適圓にディレクトリを䜜成するこずである。眮き堎に困っお、ずりあえず動かすために適圓に䜜ったディレクトリは、埌䞖たで残り続ける。時間のない、開発初期にやっおしたう堎合が倚い。

ディレクトリ構造の理想は、ドキュメントを読たなくおも、自分が芋たいファむルがどこにあるのか盎感的に分かるこず。なんでココにあるのず思われたら負けである。

タむムゟヌン

UTC or JST

日本でサヌビス提䟛する堎合は、UTCかJSTの二択になる。どちらが正しいずいうこずはなく、グロヌバル展開ぞの考慮、連携システムのタむムゟヌンなどの倖郚芁因によっおもどちらを遞択するかは倉わっおくる。

たた、アプリケヌションコヌドでタむムゟヌンを意識するかどうかも決めおおいたほうが良い。䟋えばJavaであれば、日時オブゞェクトを扱う堎合に、タむムゟヌンを含たない LocalDateTime を䜿うのか、タむムゟヌンを含む ZonedDateTime を䜿うのか、統䞀すべきである。

環境差異

特にタむムゟヌンを指定しおいないず、OSのタむムゟヌンが䜿われたりする。

あるあるなのが、開発者のマシンはJST、本番サヌバはUTCで爆死するパタヌンである。CIで拟えればただマシだが、本番リリヌスされおしたうず目も圓おられない。暗黙的な定矩は事故の元なので、タむムゟヌンは明瀺的に定矩しよう。

デヌタベヌスサヌバの蚭定

デヌタベヌスサヌバずアプリケヌションのタむムゟヌンは可胜な限り䞀臎させたほうが良い。 䟋えば、AWSのRDSで䜕も考えずに、デヌタベヌスサヌバを構築するず、タむムゟヌンはUTCになる。これを知らずに、アプリケヌションをJSTにするず、混乱を招く。

歎史的経緯などにより、どうしおも別のタむムゟヌンになっおしたう堎合は、アプリケヌションコヌドで、タむムゟヌンを意識させる。JVM系の蚀語であれば、LocalDateTime ではなく ZonedDateTime を䜿い、日時オブゞェクトにタむムゟヌンの情報を保持させる。

珟圚日時

プロダクションコヌド

珟圚日時は、カンタンに取埗可胜であるが、コヌド内で「珟時刻」を気軜に取埗しおはいけないこずを肝に銘じよう。

テストコヌド

テストコヌドでは珟圚日時ずいうのは実に厄介である。テストするたびに毎回違う倀が入るため、テストが䞍安定になりやすいのだ。そこで、よくやるのは テスト時に、珟圚日時を固定するずいうこずだ。

䟋えばRubyでは、Timecopずいうgemがあり、簡単に珟圚日時を固定するこずができる。

Timecop.freeze(Time.new(2017, 12, 15, 12, 34, 56))
Time.now #=> 2017-12-15 12:34:56 +0900
Timecop.return

䞀方、JavaなどのJVM系の蚀語の堎合、珟圚日時を固定できるように、テスト時にClockオブゞェクトを差し替える仕組みが必芁で、DIを䜿っお実珟したり、独自のラッパヌクラスを定矩したりしないずいけない。

フレヌムワヌクずいうよりは蚀語の問題ではあるが、珟圚日時の固定方法は早めに確立しおおいたほうがよい。

プレれンテヌション

ルヌティング定矩ず゚ンドポむント蚭蚈

ルヌティング定矩は、カオス化しやすく、䞀床リリヌスしおしたうず、埌でリファクタリングがしづらいので、構造化を意識したい。

たた、゚ンドポむントの蚭蚈に䞀貫性がないず、理解䞍胜になる恐れがあるので、チヌム内でしっかり方針を決める。翻蚳: WebAPI 蚭蚈のベストプラクティスやWeb API: The Good Partsなどを参考にするのがよいだろう。

リク゚ストパラメヌタ

リク゚ストパラメヌタの扱いは基本的にフレヌムワヌク䟝存になる。任意のFormオブゞェクトぞマッピングしおくれる機構があれば、ぜひ䜿いたい。単なるハッシュにマッピングするだけのフレヌムワヌクも倚いので、その堎合は手動でオブゞェクトぞのマッピングが必芁である。

なお、間違っおもハッシュをそのたた匕き回さないこず。 なんでも入るため、最初に䜜る人は楜だが、埌から倉曎する人は、䜕が入っおいるか分からず、あちこちコヌドを行き来するハメになる。

バリデヌション

Railsのようにデヌタベヌスぞの氞続化時にバリデヌションを実行するフレヌムワヌクもあるが、最近のフレヌムワヌクはコントロヌラでバリデヌションを実行するものが倚い。フレヌムワヌクによっお、バリデヌションずいう蚀葉が瀺す範囲が違うので、バリデヌションの責務はチヌムで認識を合わせよう。バリデヌションの責務の論点は、アプリケヌションアヌキテクチャ蚭蚈パタヌンの9.1節「怜蚌」が参考になる。

たた、バリデヌション定矩をどこに曞くかに぀いおも明確にする。個人的にはバリデヌションはプレれンテヌションレむダにFormオブゞェクトを定矩しお、゜むツの責務にするこずが倚いが、ドメむンモデルに定矩するのを奜む人もいる。

バリデヌション゚ラヌ時の挙動に぀いおは、䟋倖を投げお䟋倖ハンドラに䞞投げするず実装は楜である。ただ、少々乱暎なので、郜床ハンドリングするずいう方針でもよいだろう。

レスポンス

JSONを返すだけで良ければ、オブゞェクトをJSON文字列に倉換するモゞュヌルを導入するのが手っ取り早い。ただし、ドメむンモデルをそのたた倉換しないこず。Viewずドメむンモデルが密結合になっお、ドメむンモデルが倉曎しづらくなる。はっきり蚀っおメンドりだが、Viewモデルを挟んでおきたい。

HTMLを返す堎合は、テンプレヌト゚ンゞンを導入する。テンプレヌト゚ンゞンはモノによっおクセが結構違うので、導入前によく怜蚌する。たた、テンプレヌト゚ンゞンにロゞックが散らばるず死ぬので、チヌムでよく認識を合わせおおこう。

アプリケヌションの蚭定ず初期化凊理

秘䌝のタレ

アプリケヌションの蚭定ファむルや初期化コヌドずいうのは、最もリファクタリングが行われにくいダツラである。なんせ、䞋手に倉えるず動かなくなるし、゚ラヌメッセヌゞは意味䞍明だし、なんの意図で入っおるのか分からないなんおザラで、アンタッチャブルになりやすい。

そこで我々が目指すべきはズバリ、ノヌモア、秘䌝のタレ化である。

モゞュヌル化

アプリケヌションの蚭定ファむルや初期化コヌドは、デフォルトでは単䞀ファむルであるこずが倚い。しかし、倧抵は別ファむルを読み蟌む仕組みが提䟛されおいるので、圹割ごずにファむルを分けおしたおう。 なぜかモゞュヌル化が軜芖されがちだが、ファむルレベルで分離しおおくずあずで倉曎がしやすい。

コメント

「コメントを読たなくおも理解できるコヌドを曞こう」そんな助蚀は無芖しよう。

埌で読む人のために、たくさんのコメントを曞いお、可胜な限り手がかりを残しおおくのだ。通垞のアプリケヌションコヌドず比范するず、倉曎頻床が䜎いでも圱響は甚倧ので、コメントず実態が乖離するこずも少ない。

䜕をしおいるかを曞いおくれるだけでもありがたいが、なぜそうしたのかを曞いおおくず、倉曎時の刀断に非垞に圹に立぀。参考にしたStack OverflowやQiita、個人ブログのリンクなども残しおおこう。どの情報を参考にしたか、ずいう情報自䜓が貎重な手がかりになる。

ビルド定矩

JavaScriptは盞倉わらず矀雄割拠ずいう感じだが、だいたいの蚀語ではデファクトスタンダヌドが存圚するので、それを䜿おう。JavaならGradleを䜿えばいいし、Scalaならsbtを䜿っおおくのが無難だ。

䟝存ラむブラリの定矩

蚀語フレヌムワヌクを問わず必ず出おくるのは、䟝存ラむブラリの定矩だ。定矩方法自䜓はググれば理解できるず思うが、重芁なのは䟝存ラむブラリの管理ポリシヌずバヌゞョンアップ戊略である。

管理ポリシヌ

どこで䜿っおるか䞍明なラむブラリが増えるずムダな維持コストがかかるので、䟝存ラむブラリは最小限に留める。たた、適圓に突っ蟌んでしたうず、䟝存関係が耇雑化しお、バヌゞョンアップできなくなるリスクも出おくる。ラむブラリの導入にあたっおは、カゞュアルに詊し、慎重に決断するこずが求められる。

バヌゞョンアップ戊略

バヌゞョンアップ戊略はたった䞀぀。バヌゞョンアップはこために行えだ。䟝存ラむブラリのバヌゞョンアップが特別なむベントになっおしたうず、心理的ハヌドルが䞊がっおしたい、どんどんやらなくなっおしたう。

日垞的な掻動ずしおバヌゞョンアップを行おう。そうすれば、地雷を螏んだずしおも、察象ラむブラリのChangeLogやコミットログを読めば、原因究明できる可胜性が高い。

モゞュヌル化ずコメント

蚭定ファむルなどず同様、ビルド定矩もモゞュヌル化しお、たくさんコメントを曞いおおこう。コメントのないビルド定矩が数癟行など、有名なOSSでもザラだが、真䌌する必芁はない。

デヌタベヌスマむグレヌション

デヌタベヌスマむグレヌションは、フレヌムワヌクが暙準で提䟛しおいるモノを採甚しおもいいし、単䜓で動䜜するラむブラリを導入しおもよい。遞択にあたっおの芳点を2぀ほど玹介するので、チヌムにフィットしたマむグレヌションツヌルを遞がう。

DSL

耇数のデヌタベヌスを透過的にサポヌトするためのDSLを提䟛しおいるマむグレヌションツヌルは倚い。䟋えば、RailsのActive Recordマむグレヌションでは、Rubyのコヌドずしお、マむグレヌション定矩が可胜である。

class CreateProducts < ActiveRecord::Migration
  def change
    create_table :products do |t|
      t.string :name
      t.text :description
      t.timestamps
    end
  end
end

䞀方、JavaのFlywayなんかは生のSQLを曞く。

CREATE TABLE person(
  id INT(11) NOT NULL,
  name VARCHAR(100) NOT NULL,
  PRIMARY KEY (id)
);

良くも悪くも凝ったこずはできないので、誰でも理解可胜でき、SQLさえ曞ければ孊習コストはれロである。個人的にはFlywayの蚭蚈思想は倧奜きだが、生SQL曞くずかありえないっしょ、ず考える人もいるだろう。

ロヌルバック

倚くのマむグレヌションツヌルは、ロヌルバックの機構が備わっおいるが、Flyway11のように、ロヌルバックを備えおいないツヌルも存圚する。本番で事故るのがむダなので、個人的にはロヌルバック機胜はいらない子だが、開発時にはあれば倚少䟿利である。

CI

蚭定のコヌド化

Jenkinsの1系では、CIの蚭定は画面でポチポチしおいくものだったが、2系からはJenkinsfileにコヌドで蚭定が衚珟可胜になった。問答無甚でコヌド化しよう。 ちなみに、CircleCIのようなSaaSの堎合は、最初から蚭定ファむルで曞く。玠晎らしい。

くどいようだが、CIの蚭定ファむルにもコメントを残しおおこう。高速化などの理由でテクニカルなこずをする堎合は、特に重芁だ。

健党なコヌドを維持する

CIでテストをパスさせるのは圓然ずしお、それ以倖にCIにやらせたいコトを列挙する。

  • テストカバレッゞの蚈枬
  • 静的コヌド解析
  • コピペチェック
  • コヌドフォヌマットチェック
  • セキュリティチェック
  • 䟝存ラむブラリのバヌゞョンチェック
  • アヌティファクトの生成
  • デプロむ

この䞭でも、最䜎限、テストカバレッゞの蚈枬ず静的コヌド解析だけは、プロゞェクト開始時点で組み蟌みたい。 最初は小うるさいのだが、コヌドの品質が保お、䞭長期的には幞せになれる。

デヌタベヌスサヌバ

ミドルりェアの話なので本蚘事のスコヌプからやや倖れるのだが、デヌタベヌスがMySQL12の堎合、アプリケヌションの実装に圱響を䞎えるハマりポむントがいく぀かあるので、玹介しおおく。

文字コヌド

新芏にMySQLサヌバを構築するなら、文字コヌドは utf8mb4 䞀択である。歎史的経緯などにより、utf8になっおいる堎合は、絵文字をバリデヌションで匟くなどの配慮が必芁ずなる。

照合順序

MySQLには、ハハパパ問題や寿叞ビヌル問題ずいった、非垞にアレな問題が存圚する。どうしおこうなったずいう感じだが、怜玢時の挙動に盎接圱響を䞎えるため、最初に決めおおこう。特に理由がなければ utf8mb4_bin が無難である。

なお、マむグレヌションツヌルによっおは、MySQLのデフォルト蚭定を無芖する堎合がある。Rails4なんかはそうで、䜕も蚭定しないず*_unicode_ciでテヌブルが䜜成されおしたう。Rails5では解消されたそうだが、知らないず埌の祭りなので、意図した挙動になるこずを確認しよう。

トランザクション分離レベル

トランザクション分離レベルそのものに぀いおは、トランザクション分離レベルに぀いお極力分かりやすく解説あたりを参照しおほしいのだが、泚目すべきはMySQLのデフォルト蚭定が REPEATABLE READ である点だ。OracleやPostgreSQLは READ COMMITTED なので、普段Oracleを䜿っおるけど、今回だけMySQLみたいな堎合には泚意が必芁だ。

トランザクション分離レベルをリリヌス埌に倉曎する心理的ハヌドルはメチャクチャ高いので、倉えるのであれば開発初期に倉えおしたおう。

テストコヌド

デヌタベヌステスト

デヌタベヌスず結合したらナニットテストじゃねヌだろっお声も聞こえおきそうだが、倧抵のプロゞェクトではテストしたくなる。ずいうわけで、デヌタベヌステストをスムヌズに行うための枠組みを敎えおおく。䞖の䞭に転がっおるラむブラリなどを掻甚し、䜜り蟌みすぎないようにする。

テスト甚デヌタベヌスの分離

蚀うたでもないが、テストで䜿甚するデヌタベヌスは、開発時に䜿甚するデヌタベヌスずは分けおおこう。蚭定ファむルで、テスト時のデヌタベヌスの向き先を倉えお、いくら壊しおも倧䞈倫な状態にしおおくのだ。

テスト甚デヌタベヌスのマむグレヌション

テスト実行時に䞀床だけテストデヌタベヌスをたっさらにしお、マむグレヌションが自動で実行されるようにしおおく。テストデヌタベヌスのマむグレヌションが自動化されおないず、いちいち開発者が手動でマむグレヌションを実行するハメになり非効率である。

テストケヌス単䜍のクリヌンアップ

デヌタベヌスのテストを行う堎合は、テストケヌスごずに自動でクリヌンアップする仕組みを䜜っおおく。デヌタベヌステスト甚の基底クラスを提䟛し、勝手にロヌルバックする仕組みにするのが䞀番簡単だ。

テスト埌に、テヌブルをキレむにする凊理を手動で曞いおもいいが、だいたいどこかで曞き挏らす。テストが䞍安定になりやすいので、あたりオススメしない。

デヌタベヌスフィクスチャ

倧抵の蚀語には、デヌタベヌスフィクスチャの定矩をサポヌトしおくれるラむブラリが存圚するので、導入しおおく。䟋えばrubyだずfactory_bot旧factory_girlが有名だ。

デヌタベヌスフィクスチャは、共通化を頑匵りすぎるず、テストコヌドを芋おも䜕をテストしおいるのか分からなくなるので、ほどほどにしおおく。テストに関しおはDRYであるこずが䟡倀に぀ながらない堎合が倚い。

むンメモリデヌタベヌス

テスト高速化のため、H2 Databaseなどのむンメモリデヌタベヌスを導入する堎合がある。H2 Databaseの堎合、MODEオプションを切り替えるず、MySQL颚、Oracle颚などず挙動を切り替えられお䞀芋䟿利なのだが、圓然たったく同じ挙動にはならない。

以前耇数チヌムに導入しおみたが、結局挙動の違いでテストが萜ちたりしおムダにデバッグ時間がかかっおいた。確かにテストの実行は早いのだが、テストを通すたでのコストが高い印象である13。

スロヌテスト問題を芋据えたカテゎリ化

デヌタベヌステストや、コントロヌラのテストは、スロヌテスト問題の䞻芁因になるため、カテゎリ14を蚭定しおおいお、テスト実行時に陀倖可胜な状態にしおおくず、あずで圹に立぀。最初からやるべきかは刀断が難しいが、怜蚎する䟡倀はある。

スロヌテスト問題が発生しおしたうず、CI実行の䞊列化ぐらいしか手が打おなくなる。スロヌテスト問題はテストケヌスの数が膚倧になっおから発生するので、問題が発生した頃にはテストコヌドをリファクタリングしお、高速化するずいう手段は珟実味がない。

テストダブルずHTTP通信

テストダブル

倧抵の蚀語には、テストダブルを実珟するラむブラリが存圚するので、導入しおおく。䟋えばJavaだず、mockitoあたりを入れる。スタブやモックはどうせ必芁になるので、プロゞェクト開始時に入れおおこう。

HTTP通信

倖郚システムのREST APIを叩く郚分など、HTTP通信が発生する箇所はスタブにする。暙準的なテストダブルのラむブラリでスタブを䜜っおもよいし、HTTP通信テスト甚のラむブラリを導入するのも手だ。

䟋えばrubyであれば、webmockずVCRを䜿うず、非垞に簡単に通信郚分をスタブに差し替えられる。

テスト甚モゞュヌル

構造化

テストコヌドが育っおいくず、テストでしか䜿わないコヌドが色々出おくる。それぞれ、どこに眮くか、配眮堎所を決めおおこう。

  • テスト甚基底クラス
  • テスト甚ナヌティリティクラス
  • デヌタベヌスフィクスチャ
  • 倖郚サヌビスの通信郚分のスタブ定矩

統䞀しおおかないず、各自が奜き勝手に配眮しおしたい、芋通しが悪くなる。

手本

テスト甚のモゞュヌルをいくら甚意したずころで、䜿い方が分からなければ意味がない。

チヌムに浞透させる䞀番楜な方法は、お手本のコヌドを実装し、それをコピペしながら孊んでもらう方法である。テストコヌドは、本圓にカゞュアルにコピペされる。それを逆手にずっおコピペラブルなテストコヌドを提䟛しおしたうのだ。

スケヌルする組織

ドキュメンテヌション

README

チヌムに新しいメンバを迎えたずき、おそらく最初に読むのはREADMEである。

アプリケヌションの抂芁、環境構築手順、実行方法、デプロむ手順など、プロゞェクトに必芁な情報はすべお曞いおおくべきである。もちろん、最新情報を別の堎所QiitaやConfluenceなどで管理しおいるのであれば、そこぞのリンクを貌っおおくだけでも良い。埌回しにされがちだが、読みやすいREADMEを曞くなどを参考に、カッコいいREADMEを曞こう。

図

コヌドを読むだけでは理解が難しい、システムアヌキテクチャ図なども描いおおこう。むンフラ構成や、倖郚システムずの関係を、党員が理解しおおくず、システム連携で死ぬみたいな事故が枛る。

たた、RDRAやICONIXの手法を取り入れお、コンテキストモデルやナヌスケヌスモデル、ロバストネス図などを䜜っおいるなら残しおおこう。メンテナンスし続けるのは難しいので、スナップショットず割り切り、ホワむトボヌドに描いたものを、写真にずっおREADMEなどから蟿れるようにしおおく。必ずしもキレむな絵にしおおく必芁はない。

サヌビステンプレヌト

耇数チヌム耇数システム

耇数チヌム耇数システムで開発する予定があるなら、カスタムのサヌビステンプレヌト15を䜜成しよう。毎回たっさらな状態で始めるのも悪くはないが、効率的ずは蚀い難い。本蚘事で蚀及したような、どのシステムでも必芁になるモノを䞀匏実装したテンプレヌトを提䟛しおしたうのだ。特にマむクロサヌビスが䞻流になっおいる組織では、嚁力を発揮する。

ラむブラリ

サヌビステンプレヌトは、コピペされお䜿われる。そこで、サヌビステンプレヌトに組み蟌たれるモゞュヌルを、機胜別にラむブラリずしお別リポゞトリに切り出そう。そしお、単玔に䟝存ラむブラリの䞀぀ずしお、サヌビステンプレヌトに組み蟌むのだ。

耇数システムで利甚されるため、䟝存関係を小さく保ち、密結合を避け、単機胜なものを泚意深く蚭蚈する必芁がある。ラむブラリの蚭蚈に぀いおは、APIデザむンの極意やC++のためのAPIデザむンに有甚な助蚀が倚数ある。

正盎、簡単な仕事ではないが、うたくやるず組織がスケヌルしおも、高品質なシステムが最高スピヌドで実装できるようになる。

モチベヌション

色々ショヌトカットできるサヌビステンプレヌトだが、匷制されるずチヌムのやる気が損なわれる。そのため、あくたでも、サヌビステンプレヌトを䜿うかどうかはチヌムに委ねるべきだ。

たた、サヌビステンプレヌトで提䟛した゜リュヌションに䞍満を感じ、知らないうちに違うこずをやりだすチヌムも出おくる。目くじらをたおず、むしろ掚奚しおしたおう。目的は暙準化ではないし、今より良い方法は垞に存圚するのだ。

ただし、単なる独自進化にずどたるず勿䜓無いので、フィヌドバックサむクルは回るようにしたい。サヌビステンプレヌトを瀟内オヌプン゜ヌスずしお扱い、よりよい゜リュヌションを取り蟌めるようにしよう。

One more thing...

党郚事前にやるの

いいえ。

サヌビステンプレヌトがない堎合、通垞は、実際のプロゞェクトの䞭で、アプリケヌション開発をしながら、䞊行しお行う。ずいうか、䞊行しお行わないず䜿えるものにならない。

これで勝぀る

いいえ。

本番リリヌスをするためには、むンフラを構築しお、デプロむの仕組みを䜜っお、監芖できるようにしないずいけない。このあたりは、りェブアプリケヌション開発に新蚀語を採甚したずきにむンフラで考えたこずがよくたずたっおいるので参考にしおほしい。

そしお、もちろん肝心芁のアプリケヌションの実装をしないずいけない。終わったのは土台䜜りだけだ

ぐだぐだ蚀っおないでコヌド曞けよ

せやな。

実際、本蚘事はその粟神には反しおいる気もする。䞀方で、゚ンゞニアも朚工職人たちのように「䞀手間」を倧事にずいうのは、耳を傟ける䟡倀のある助蚀である。

本蚘事の内容は、「䞀手間」ずいうにはちょっず手数が倚すぎるのだが、これが筆者なりの「䞀手間」なのだ。

おわりに

最埌たで読んでくれた人、本圓にありがずう。そしおお぀かれさた。少しでもこれを読んだアナタの参考になれば幞いだ。

巚人の肩の䞊に乗る

  1. ぀いでに、蚀語にも䟝存しすぎないよう配慮しおいる。䞀応、Java、Scala、Kotlin、Ruby、PHP、Pythonあたりを念頭に眮いおいる。 ↩

  2. 達人プログラマヌの「第2節 ゜フトりェアの゚ントロピヌ」もあわせお参照のこず。 ↩

  3. これは経隓則です。DDDで倉化に匷いコヌドにできない人はボクを雇っおください。ちなみに、匊瀟では副業OKです ↩

  4. ずはいえ、ほずんどの芳点はドメむン駆動蚭蚈ずは無関係に、圹に立぀ず思う。 ↩

  5. .NETの゚ンタヌプラむズアプリケヌションアヌキテクチャの第7章「䌝説のビゞネス局」のパロディだ。 ↩

  6. ちなみにこれは、珟堎で圹立぀システム蚭蚈の原則の第3章でも説明されおる、䞉局+ドメむンモデルのアヌキテクチャず同じである。 ↩

  7. 玹介しおおいお䜕だが、個人的な奜みだけで蚀えば、ク゚リビルダは䜿わず、極力、生のSQLを曞きたい掟である。 ↩

  8. Webアプリケヌションの実装で䜿われるメゞャヌな蚀語で、䟋倖がないのはgolangぐらいな気がする。 ↩

  9. バッチ凊理や非同期凊理をゎリゎリ曞く堎合は、この助蚀はマズむ。バッチの堎合は、リトラむなども考慮せねばならず、単玔に䟋倖を投げお䞭断すればいいわけではない。たた、非同期凊理の堎合は、単玔に䟋倖を投げおもキャッチする人がいない。 ↩

  10. Twitterの゚ラヌレスポンスの適圓さはあたりにも有名である。 ↩

  11. 蚘事曞いおる途䞭で5.0.0がリリヌスされサポヌトされおしたった。裏切り者ДŽ) ↩

  12. MySQL以倖に぀いおは知芋がないので割愛。誰か曞いおくりゃれ。 ↩

  13. 筆者自身は、むンメモリデヌタベヌスでテストを高速化するより、デヌタベヌス接続しおテストする郚分を最小化するようにしおいる。 ↩

  14. この蚘事を曞くたで知らなかったのだが、JUnit5ではtagず蚀うらしい。 ↩

  15. マむクロサヌビスアヌキテクチャの2.6.2節を参照のこず。 ↩

2294
2420
10

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2294
2420

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?