LIVESENSE made*

リブセンスのエンジニアやデザイナーの活動や注目していることをまとめたブログです。

MENU

チーム全員が知っててほしい抽象化のこと

はじめまして。転職会議ユニットでエンジニアをしている狩野です。
元々PHPerでしたが、最近はRuby(Rails)やReactを触ったりして楽しくやっています。

今回は、中堅エンジニア*1が最近受けた質問とそれに対する回答を、今までのシステム開発で得た知見と併せてブログを書きたいと思います。

はじめに

最近、若手のエンジニアから「クラスとかメソッドってどう分けるんですか?」という質問を受けました。
私は「実世界をそのまま表現するだけですよ。」と答えました。
真面目に答えたのですが、若手エンジニアには全く伝わっていないようでした*2

良い機会なので、実世界の抽象化について少し掘り下げて書いてみたいと思います。

システムとは?

基本的に、システムは「あるドメインを体系的に表現した仕組み」です。
システム開発*3とは、それを作る行為になります。

「ドメイン」とは全体の中に定義される一部の領域のことを指します。
日本語にすると「領域」です。事業を展開する領域*4と考えるのが分かりやすいです。
実際にその領域にいる人々*5に対して、我々はサービスを作って届けています。

ではどのように表現するのでしょうか。実世界は複雑です。そのまま表現はできません。ですので、モデル化(モデリング)して表現をします。
モデル化とは、抽象化のプロセスです。抽象化を行なうには知識(経験やセンス)が必要になります。
抽象化と言うと「曖昧にする」という印象ですが、寧ろ「強調したい一面を明確にする」為に抽象化を行います*6

抽象化について

例えば「人間」についてモデルを考えてみましょう。
「人間」とはなんでしょう?辞書を調べると「哺乳類、道具を使う、複雑な言語を持つ」と出てきました。「人間」を抽象化すると「哺乳類、道具を使う、複雑な言語を持つ」ということになります。
ここで疑問が生じます。例えば、生まれたばかりの赤ん坊は道具も使えないし言葉も話せません。そうなると赤ん坊はこの定義から外れます。赤ん坊は人間ではないのでしょうか。

このように、我々の行うモデルは曖昧です。
この場合、より具体的な「人間」という表現では赤ん坊は含みますが、より抽象的な「道具を使う、複雑な言語を持つ」いう表現では赤ん坊は含まないことになります。
この抽象化が絶対的な正解ということではなく、抽象化の進む方向は領域によって異なります。
対象としている領域に対して矛盾なく抽象化していくことが必要になります。

抽象化を行い、いくつかの正解(様々な解釈)の中から採用するモデルを決定します。改めて、関係する側面を抽象化して、集中するモデルを決定します。これを繰り返します。
この過程を経て、モデル化が進みシステムの表現がゴールへと向かいます。

さて、抽象化はどの程度行うべきなのでしょう。
答えは「時と場合による」です。
先にも書いたとおり、抽象化が絶対的な正解はありません。
身も蓋もないのですが、これが事実です。

よくある例えで、地図の話があります。
地図はモデルです。モデルは対象の概念を表現します。
例えば、近所のお店に行く為に世界地図を用意はしないでしょう。反対に、太平洋の航海を行う為に住んでいる街の地図を用意もしないでしょう。
近所のお店に行く時は住んでいる街が対象であり、太平洋を航海する時は世界が対象になるからです。
時と場合によって、適切な地図を使用します。

f:id:livesense-made:20171003110521p:plain:w300

適切さについて

「適切さ」こそがシステム開発の肝になります。
しかしながら、またしても身も蓋もないのですが、適切さを追い求める方法に正解は無いと思います。
ただそれで終わる訳にもいかないので、主観にはなりますが、3つほど進め方のヒントを挙げてみたいと思います。

1. サイクルを回す

適切さについて、サイクルを回して定期的に見直します。
有名なサイクルとして、PDCA(計画、実行、評価、改善)サイクルや、イテレーションの開発サイクルなどがあります。
最初から完璧な適切さを求めることはできないので、定期的に見直す必要があります。無理のない範囲で小さいサイクルで回して細かく合わせていくのが良いと思います*7
そういった意味でも、開発手法はウォータフォールよりもアジャイルが適しています。

アジャイル開発の中で、習慣的にリファクタリングを繰り返して、コードをきれいな状態に保ちます。
重要なモデルを追加すると同時に、役に立たないモデルを取り除きます。
可能な限りをコードで表現して、ドキュメントとしても価値のあるコードを書きます。コード単体で意図の伝わることが理想です。
それでも「何故」などはコードに残せないので、必要があればWhyをドキュメントとして表現します*8*9

実世界をモデル化する作業を「野球のグローブ」や「革のジャンパー」に例えた話もあります。
最初はしっくりきていなくても、使っている間に自分の手や身体に合った形に馴染んでくる例えです。
モデルも使い込んで見直していく間に蒸留されて、より適切な形になっていきます。

f:id:livesense-made:20171003111621p:plain:w300
2. コードの見通しを良くする

コードの見通しを良くすることで、適切さを維持します。
「見通し良さ」とはなんでしょう?

コメントをたくさん書けば良いという訳ではありません。寧ろ冗長になって見通しが悪くなることもあります*10
寧ろ、コメントを書かずに「シンプルに保つ」ことこそが見通しを良くする手段です。
簡単なコメントなら書かなくても伝わるようなコードを考えましょう。また、簡単なコメントを書かなければいけないのであればコードの表現が誤っている可能性があります。
先に述べたように、コメントを書かない訳ではありません。ただ、極力コメントを書かず、コード単体で意図の伝わることを目指します。

コメントは書き換えなくてもコードは動きます。
コードとコメントが密である間はまだ良いですが、改修を続けていると徐々にコードとコメントが離れていきます。
例えば、別ファイルに依存したコメントなどを書いてしまうと、その別ファイルのコードを更新した際にコメントを修正しなければいけないですが、別ファイルに記述されているコメントに気付くのはほぼ不可能です。そうなると実体を表さないコメントだけ残ることになり負債となります。

コメントも運用や保守の対象であることを認識して、コメントを書かなくても意図が伝わるコードを心掛ける必要があります。
コードの読み易さにこだわりましょう。

また、技術的な層とビジネスを表現した層を混在させないことも重要です。
責務の分割して層を分けて、見通しを維持します。
可能であれば、技術的な層はフレームワークやライブラリに任せるのが良いでしょう。
フレームワークが用意している思想に合わせると、共通の認識が持ちやすく、結果的に見通しも良くなります。
その一方で、得た知識を盲信してエンジニアの思想に閉じたコードになってしまわないよう、注意が必要です*11

オーバーエンジニアリングは柔軟性を与えてくれるように見えて、実は邪魔になることが多くあります。
適切に表現されたモデルはシンプルなものが多いです。

シンプルであることこそが、最適な抽象化です。最もシンプルな表現を心掛けます。
モデルは、それを変更しようとする別の人にとっても分かりやすくなければいけません。シンプルであれば変更も容易です。
YAGNI(You Ain't Gonna Need It.)や、KISS(Keep It Simple, Stupid.)などの法則もあります*12

3. 共通の言語を持つ

共通の言語を使うことで、適切さを正していきます。
共通の言語というのは「システムに関わる全ての人が、同じ領域においては同じ言語を使う」ということです。

このような言語は「ユビキタス言語」などと呼ばれることもあります。

一例で「あるサービスの名称」について考えてみます。
同じサービスを指す名称であっても、「サービスの商品名」「システム上でサービスを示す呼称」など、別名で呼ばれることがあります。
これらは本質的には同じものを指しているので、理想的には一致しているが望ましいです。「同じものは同じ名前を付ける」が鉄則で、脳内でのマッピングを回避できて理解しやすくなります。
しかしながら、下記に挙げるような制約で「仕方なく別名にしている」というのが現状です。

  • システム上では英語で呼ばれ、商品名は日本語で呼ばれる
  • 実体を表さない商品名
  • etc.

既存でそれなりに実体を表す共通の呼称があれば、それを採用するのが良いと思います。

良くあるのが、商品名は顧客に対する表面的な名称として使いつつ営業内で使用し、サービスの呼称はエンジニア内で使用する、という状況です。
ここで問題となるのが、商品名しか知らない営業とサービス名しか知らないエンジニアの会話です。
その解決策としては、下記に挙げる三択のいずれかになります。

  • 営業がサービスの呼称を知る
  • エンジニアが商品名を知る
  • 通訳を設ける

理想的なのは「営業がサービス名の呼称を知る」です。なぜなら、サービス名の呼称こそがそのものの実体を表現した名称になっている(はずだ)からです*13
実体を表さない商品名をエンジニアが常にキャッチアップするのは難しいです*14
通訳を設けるのであれば常にディレクターなどを同席させての会話が必要になります。

こういった前提があり、エンジニアに限らず浸透しやすく、誤解なく実体を表す命名が必要となります。
省略形の命名なども、対象となる領域で浸透していないのであれば、誤解の元となるので避けた方が良いでしょう*15

更に進んで、最初にサービスを示す呼称を決めきることは難しく、多いので時間の変化と共に見直していくのが良いです。
これは先に述べた「サイクルを回す」で対応できます。
しかしながら、技術的制約で名称変更が難しい箇所などは、最初の段階でどこまで想定して名前付けを行えるかが肝となります。

新しく定義した「user」や「status」という言葉が別の人に正しく伝わるとは限りません。
寧ろ、正しく伝わらない前提で進めるくらいが良いでしょう。
そういった観点が、より正しい言語を探す道へと続きます。

群盲象を評す」という寓話があります。
目の見えない人たちが全員で同じ象を触っているのに全員が違うことを言う、という例え話です。
サービスも目に見えないものなので、これと同じような状況にあることがあります。
全員が同じモデルを持つには、共通の言語が必要になります。

開発に着手する前に、対象を言葉で表現してみます。言葉で表現(言語化)できないものは理解できていない可能性があります。
名前付けは、運用や保守にとても重要です。寧ろモデル化の大部分は名前で決まると言っても過言ではありません。
名前がしっくりこない場合は、モデル化の構造自体を見直した方が良いでしょう。
言葉で表現できるようになってから、開発に取り掛かりましょう。

f:id:livesense-made:20171004110452p:plain:w300

進化する実世界

ここまで話して、実世界の対象となる領域をモデル化してシステム開発を進める方法は、何となくは伝わったかと思います。

しかしながら、システムは完成しません。
なぜなら、実世界は進化を続けているからです。

一般的な例として、サービス領域の拡張などがあります。
大きいものでは、任天堂が花札からビデオゲーム機に主力商品を変えたり、Amazon.comが書店から総合ECサイトになったり、などが挙げられます。
小さいものであれば、身近にも無数にあるかと思います。

VUCAという言葉があるそうで、Volatility(変動)、Uncertainty(不確実)、Complexity(複雑)、Ambiguity(曖昧)の頭文字を並べた用語です。
これはサービスの領域そのもので、システム開発でも言えます。

システムは実世界に同調し続けなければいけません。
サービスの領域について絶対的な表現は無く、その時点での最善で最適な表現を見つけます。

f:id:livesense-made:20171003112752p:plain:w300

最後に

繰り返しになりますが、実世界は複雑です。
複雑な実世界を表現する作業であるシステム開発が複雑なのは、必然です。

ここで述べたことはサービスに関わるチーム全員が考えなければいけないことであり、エンジニアだけの問題ではありません。

抽象化が進まないと、強調したい箇所が分かり難くなりモデルの表現力が弱まります。
モデルの表現力が弱まると、サービスとコードの乖離が進み、小手先の技術的な解決が増えます。
柔軟性や拡張性が失われ、要求に応えることが難しくなり、保守が難しくなります。
複雑さの泥沼にはまり込み、障害やバグの頻発する価値の薄いシステムに成り下がる末路が待っています。

良いシステムを維持し続ける為に、常に実世界と向き合って、適切な抽象化を繰り返してモデル化していく必要があります。
適切な抽象化はサービスの表現に力を与えます。

これからのシステム開発の手助けになれば、幸いです。

f:id:livesense-made:20171003133424p:plain:w300

*1:いわゆる「おっさん」です。

*2:「こいつは何を言ってるんだ?」くらいに思われた気がします。

*3:このブログでの「システム開発」は「Webサービスのシステム開発」について語っていきます。

*4:「事業ドメイン」という言葉は聞き覚えがあるかもしれません。

*5:利害関係者やステークホルダーなどを指します。

*6:要らない箇所を捨てる取捨選択の作業です。

*7:手法は合ったものを適切に取り入れましょう。手法の原理主義者になってはいけません。

*8:たまにWhatやHowをコメントに書いているコードを見掛けますが、冗長になるのでやめた方が良いでしょう。

*9:https://twitter.com/t_wada/status/904916106153828352

*10:「丁寧」と「冗長」を混同してはいけません。

*11:実世界に則さない過度な共通化などは、そのひとつです。

*12:実際のコードを書くテクニックとしては、「条件分岐は短く」「否定の否定など書かない」などありますが、ここでは割愛します。

*13:もちろん、本来であればこの命名に営業の方を巻き込めるのが最適ではあります。

*14:それでも、その商品名自体が浸透してくれば、そちらを共通の言語として使用することもあります。

*15:必要以上に省略形を使ったり、新しい語彙を増やしたがる人は、注意が必要です。

CSSは簡単だなんて誰が言った

f:id:sueshin:20170915154014p:plain はじめまして!正社員転職サービス転職ナビ(旧ジョブセンスリンク)のフロントエンドを担当しているsueshinです。
CSSはプログラミング経験の浅い方でも扱いやすく、比較的習得が早い言語だと言われることが多いと感じている次第です。
もちろん、それはCSSの素晴らしい側面の一つです。
一方で、設計のアンチパターンと言われることが、CSSでは積極的に採用され、長期の保守になると難しいという側面もあります。
今回は企業様用採用管理ツールのCSSの保守で苦戦し、リファクタリングした時のお話をいたします。
お手柔らかにどうぞ。
尚、ソースコードは一部記事に合わせて表現を変えています。

なぜCSSをリファクタリングしたの?

f:id:sueshin:20170915172411j:plain 企業様用採用管理ツールのCSSをリファクタリングする前は以下のような大きな問題を抱えていました。

管理されていないCSS

転職ナビはリブセンスの創業初期からある歴史あるプロダクトです。
デザインリニューアルだけでなく、ブランド名変更によるリブランディング等、度重なる大規模変更が過去にあり、数々の負債を抱えながら成長してきました。
そのため、非常にプロダクトが複雑で、社内用の管理ツール向けのCSSを修正すると企業様用採用管理ツールのビジュアルが崩れる等、非常に保守コストがかかっていました。
また、CSSの格納ディレクトリは全てのアプリケーションのCSSを含んでいるため、40000行を超え尚肥大化し続けています。
以下はCSSディレクトリの抜粋です。

css
├── 2009/
├── file/
├── user/
├── htmlMail/
├── lp/
├── manage/
├── pc/
├── pr/
├── sp/
├── admin/
└── blog/

意味のないファイル名

下記は企業管理画面のディレクトリツリー抜粋です。
一見、トップページ用にしか見えない命名のファイルがあらゆるページで使用されていました。
他にもページ単体で使用されているように見える命名のCSSが、多数のアプリケーション全体で使用されたまま放置されており、開発は長らく混乱していました。

manage
├── recruit/
│   ├── top.css
│   ├── works.css
│   ├── works_hint_detail.css
│   └── works_title.css
├── scout/
└── vendor/

どこにいったDRY原則

開発メンバが既存コードに合わせて実装しようとして、フロントエンドエンジニアの私に質問してくれても、そもそもの保守方針はなく、残念ながら歯切れの悪い回答しかできませんでした。
結果、開発スピードを重視して繰り返されるハードコピー。
DRY原則を意識した再利用性のあるコードを書けず、私はずっと歯がゆく思っていました。

いまどき生CSSなんか触りたくないと入社2年目の後輩にいわれた

大人でも辛くて泣きたくなる時はあります。

要約すると

f:id:sueshin:20170915172407j:plain 問題点を並べましたが、成し遂げたいことを箇条書きにするとこのようになります。

  • 他のアプリケーションを修正したらバグがでるという状況を阻止する
  • 保守方針を立てる
  • CSSからSassへ移行することで、より保守を容易にする

具体的にしたこと

f:id:sueshin:20170915172418j:plain

以下の手順で進めました。

  1. コードリーディング
  2. Sassの導入
  3. アプリケーションをまたいでいるCSSをひっぺがし
  4. 各ページ単体で使用しているCSSをそれぞれディレクトリごとに分類
  5. リンター導入
  6. README.mdを作成

1.コードリーディング

まず手始めにひたすらコードを読みました。
そうすると、読み進めていくうちに既存コードの以下のような特徴に気づきました。

  • 要素タグに対するスタイル定義がCSSファイルの上部に固まっている
  • 多くのページで呼ばれているCSSファイルに組み合わせが存在する
  • (一部のCSSファイルでは)id属性とclass属性で汎用性別に使い分けられていそう

これらを踏まえると下記のようにCSSを分類できそうだと判断しました。

  • ブラウザ定義スタイルのリセット
  • 各要素タグ毎の基本的な装飾
  • グローバルで使用できるコンポーネント定義
  • 各ページ固有のコンポーネント定義
  • ヘッダーやフッターのレイアウト定義

2.Sass導入

f:id:sueshin:20170915172355p:plain コードリーディングの結果、大多数のURLで同じ組み合わせのCSSが呼ばれていることがわかったので、これらを一つのファイル(application.scss)として再定義しました。
これらはsymfonyやRoRではレイアウトファイルに記述がまとめられていることが多いと思うので、パスの置換作業などは比較的容易かと思います。
その後、作成したapplication.scssを複数のファイルに分割しました。
分割することで数千行あるCSSの可読性を高めることが狙いです。

3.アプリケーションをまたいでいるCSSをひっぺがし

別アプリケーション名のディレクトリに存在しているCSSがあったので、ファイルをコピーして作業対象の企業管理画面では、専用のディレクトリからしかCSSをよばないようにしました。

4.CSSを使用されているディレクトリごとに分類

この作業に一番時間がかかりました。
URL別にCSSを読んでいたのですが、top.cssなのにトップページ以外からも呼ばれており、判断に迷いました。
それらも踏まえて大別すると以下の3パターンに分類できました。
※尚、各ページのパスを/module/action/と考えています。(例えばトップページなら/home/indexとなります。)

  1. 複数のmoduleで使用しているがグローバルなCSSというほどではない
    • →commonディレクトリを作成
  2. 固有のmodule内でしか使用されていない
    • →module名のファイルを作成
  3. ひとつのactionでしか使用されていない
    • →moduleディレクトリにaction名のファイルを作成

実際のディレクトリ構成です。

├── common
│   ├── company.scss
│   ├── scout.scss
│   ├── top.scss
│   ├── view.scss
│   └── works-skill.scss
├── home.scss
├── info
│   ├── help.scss
│   ├── home.scss
│   └── kiyaku.scss
├── recruit
│   ├── plan.scss
│   ├── works.scss
│   └── works-title.scss
└── detail.scss

5.リンター導入

f:id:sueshin:20170915173758p:plain 今回成し遂げたいことの一つは保守性の向上。
これを逃すと機会がないと思いやや強引ですが、ユーザー側で導入しているstylelintを導入しました。 各ファイル1行1行の修正は大変なので、ファイルごとに例外処理を追加して導入しました。

コード例

/* stylelint-disable selector-no-id, declaration-no-important  */

.test {
    color: #fff;
}

なぜ、例外処理を追加してでもリンターを導入したかというと、実装方針さえ決まっていたら、守ることが容易なルールがファイル内でさえ統一できていなかったからです。
目立ったところでいうと以下のようなルールです。

  • インデントはソフトタブかハードタブか
  • インデントの深さ
  • カラーコードは大文字か小文字か
  • 空行の有無
  • セレクタの後の半角スペース

6.README.md作成

本来はプロダクションコードからコーディングルールやクラス・ディレクトリ命名方針が類推できることが良いと思います。
ただし、今回のリファクタリングでは実装方針が定まっただけであり、コードの品質が高まっただけではないので、補足説明を手厚く書きました。

躓いたポイント

f:id:sueshin:20170915172359j:plain 上記の手順を立て、リファクタリングを進めましたがスコープがあまりにも大きく、何度もつまずきました。
以下は躓いたポイントです。

1.CSSハック

設定を変更したら、変更できたのかもしれませんが、どうやらSCSSにも許せないCSSハックがあるようでした。
私はWEBを覚えて浅いこともあり、ブラウザ対応はIE8からしか対応したことがありません。
既存コードがどういった目的でCSSハックをしているのか、わからない記述も多かったです。
調べても中々良い情報に出会えず途方に暮れている中、信じられそうな情報に出会えた時は感動しました。

具体例としては、下記のようなスラッシュハックを

#footer {
  /zoom: 0;
}

こちらのアスタリスクハックに変更することで

#footer {
    *zoom: 0;
}

無事CSSへのプリコンパイルができました。

2.CSSファイルパスの変更

ファイルのパスを変えてCUIで一括置換していたのですが、以下のコードが存在する可能性が有るためにリファクタリング中の不安は拭えませんでした。

<link rel="stylesheet" type="text/css" href="<?php echo(''/css/manage/' . $val . '.css''); ?>">

このようにgrepしても検索にヒットしないファイルの存在による置換もれをどのように対応するかは最後まで悩みました。
他にいい方法が合ったのかもしれませんが、最終的に私はPHPディレクトリのCSSという文字列を全部grepして目視して確認しました。

3.CSS最大の難関、詳細度戦争

世界各地で問題になっているCSSの詳細度がやはり頭痛の種でした。
今回迷ったのは以下のような場合です。 例えばこのようなコードがあったとします。

//1
.modal {
    color: #aaa;
}
//2
#top-modal {
    color: #bbb;
}
//3
#container .modal {
    color: #ccc;
}
//4
.detail-modal {
    color: #ddd;
}

1のmodalと2のtop-modalの順番を変更した場合デザインに影響がある可能性はあるのでしょうか?

//2
#top-modal {
    color: #bbb;
}
//1
.modal {
    color: #aaa;
}
//3
#container .modal {
    color: #ccc;
}
//4
.detail-modal {
    color: #ddd;
}

答えは「可能性はない」です。
では、1のmodalを4のdetail-modalの下に変更した場合デザインに影響がある可能性はあるのでしょうか?

//2
#top-modal {
    color: #bbb;
}
//3
#container .modal {
    color: #ccc;
}
//4
.detail-modal {
    color: #ddd;
}
//1
.modal {
    color: #aaa;
}

答えは「可能性はある」です。
幸いID属性とクラス名は飛び飛びで固まっていたため、セレクタがID属性同士、class属性同士で順番を変更しないように整理しました。 可読性はあまりよくないですが、デグレーションを避けるため順番はできるだけ変えないようにしました。 application.scssの例

@import "layout/header";
@import "layout/container";
@import "layout/aside";
@import "layout/footer";
@import "object/project/modal";
.clearfix {
    *zoom: 1;
}
.clearfix:after {
    content: '';
    display: block;
    clear: both;
}
@import "object/project/tooltip";
@import "object/project/link";
@import "object/utility/margin";
ul.modBtn,
.modInfo dl {
    *zoom: 1;
}
ul.modBtn:after,
.modInfo dl:after {
    content: '';
    display: block;
    clear: both;
}

4.ユーティリティクラスがユーティリティじゃない

ユーティリティクラスとして定義されているけど、実際に使われていないユーティリティクラスをどのように分類していいか非常に悩みました。

.txtRed {
    color: #f44336;
}
.txtOrange {
    color: #f60;
}
.txtGreen {
    color: #53acac;
}
.txtGray {
    color: #999;
}

これらは開発メンバの誰も知らないクラスです。
ユーティリティクラスとして分類しても、開発メンバが余計に混乱すると考え、ユーティリティクラス専用のディレクトリに分類しませんでした。

5.リンター導入の作業は地道でした

一部例外処理として設定しましたが、可能な限りリンターのルールに違反する箇所は修正しました。
膨大なソースコードのカラーコードを小文字にしたり、ソフトタブとハードタブを統一したりと地味に膨大なコストがかかってしまいました。
守ってくれたら儲けものと思って、アプリケーションを作った際は、コーディング規約を真っ先に導入すべきだと思いました。

そしてリリース!!

f:id:sueshin:20170915165124j:plain やりました。
もう後輩にCSSなんか触りたくないなんて言われません。
数々の困難と組織的な諸事情もあり最初のコミットからリリースまで1年以上経ってしまい、隣の島にいた後輩はもう近くにはいませんが。。。
でも、問題ございません。
我々が欲しいのはハッピーエンドではなく、鍛え抜かれたハッピーマインドなのだから。(*1)

まとめ

f:id:sueshin:20170915172423j:plain

  • 学び
    • 古くなった情報でも、レガシーコードを改善する上で役に立つことがある
  • 課題
    • フロントエンドエンジニア以外には改善が実感しにくいリファクタリングになってしまった
    • 大規模改修になるため画面チェックにコストがかかってしまった
  • 効果
    • 今ならあまり心を痛めること無くレビューができる気がします。
    • ソースコード量の減少に向けて舵を切ることができた。
    • 企業管理画面を修正するとリブセンス用のツールでエラーがでるということはありません
    • 現状を整理できたことで、開発メンバの学習コストがへった。
    • 新しい開発メンバが入ってくる度に怯えなくていい

さいごに

f:id:sueshin:20170915172403j:plain このリファクタリングを進める上で、チームメンバは勿論のこと、沢山のサイトや書籍に助けられました。
特にCSSハックに対する知見を共有しているサイトを夜中に見つけたときは、本当に感動しました。
この記事が少しでも負債と戦うエンジニアの助けになれば幸いです。

*1: 元ネタは矢沢あい著「ご近所物語」です

経験者が送る新卒入社後あたふたしないために心がけたい5箇条

はじめに

みなさんこんにちは。 16新卒入社したネイティブアプリチームの井上です。
2017年4月に入社された新卒のみなさんは、研修を経て現場での業務が始まるor始まっている頃かと思います。
正直言うと、私はチームに配属直後 とっってもあたふたしてました

〜配属前の私〜
「たくさん学んで早く活躍するぞ! (^ω^)」

〜配属後の私〜
「逃げちゃダメだ。逃げちゃダメだ。逃げちゃダメだ。うわあああああ(‘ω’)あああぁぁぁぁぁ」

はい、リアルにこんな感じでした。
例えば以下のようなことをやらかしてました。

  • リリース期日に実装が間に合わない
  • リリース後、実装箇所で落ちる
  • 自分のミスを自分でフォローできない
  • ディスカッションで発言できない
  • ブログ書いたらほぼ全直し(←new 本記事)

などなど…。

きっと新卒入社される方の中には、やる気に満ち溢れていて、これからが楽しみで仕方がないという人がたくさんいると思います。

そこで本記事では、みなさんにぜひ心がけてほしい点を「配属直後にあたふたしないための処方箋」として、私自身の経験を元にまとめていきたいと思います。

配属後のスタートダッシュで転ばないために参考にしてください。

アプリチームの仕事

実際に経験した業務は以下のようなもでした。
それぞれ簡単に内容を紹介していきます。

  • 施策検討
  • iOSアプリの新規開発
  • Android・iOSアプリの改善・グロース
  • APIの実装

施策検討

 プロダクトに携わる以上は、そこにどんな課題があり、どういう価値を提供すべきなのかということを、チームの一人一人が自分自身の中でしっかり理解し、納得することがとても重要です。弊社アプリチームの場合、職種関係なくチーム全員でさまざまなディスカッションを行い、「解消すべき課題は何か」「目的・手段は適切か」「いつまでにやるべきなのか」等を検討します。

iOSアプリの新規開発

 2016年秋頃からiOSアプリを開発することになり、私もそこにjoinしました。iOSアプリはSwiftで実装し、ライブラリの選定や基盤処理の実装、画面作成・メインロジックと幅広い範囲の業務を経験しました。
 この期間は余裕がなくかなり忙しかったですが、業務としてアプリの新規開発に携わるという非常に貴重な経験ができました。

アプリの改善・グロース

 日常的に行う業務のメインはAndroid・iOSアプリの改善とグロースです。施策検討時に決定した内容を、タスクとして各担当者に振り分け開発を進めていきます。
 チーム内のエンジニアはOSごとに担当が決まっているわけではなく、全員が両OSをカバーしています。施策によっては一時的に専任担当をつけるときはありますが、基本的にはどちらの開発も行うため、両OSの開発スキルが必要とされます。

web APIの実装

 弊社のアプリでは、サーバーとのデータのやりとりにweb APIを利用しているため、その開発・保守もアプリチームの担当です。
 web APIはRuby on Railsで実装されており、Android Java・Swifttの知識だけでなくサーバーサイド開発の知識も必要です。

働いて気づいた現実

f:id:omega999:20160227172243j:plain

配属前に、「やりたいこと」「やること」については事前に伺っており、私自身配属が楽しみでした。しかしいざ業務が始まってみると、

〜業務内容を聞いた私〜
「いっぱいやることある楽しそう、幅広く学べそう、グロースグロースぅ!(˘ω˘)」

〜業務が始まった後の私〜
「開発時間かけすぎた、アイディアまとまらない、ちょ時間足りない、助けて神様(˘ω˘;)」

はい、見事に理想と現実のギャップに悩まされました。
納得できる成果が見えなかったため、なかなか自信がつきませんでした
当時、特に悩んでいたことは以下のようなものです。

  • 満足できないアウトプット
  • スムーズに定着しないスキル

満足できないアウトプット

〜タスクが決まった私〜
「来週までに完成だから前日には完成させて別のタスクもやろう(˘ω˘)」

〜タスク締め切り前の私〜
「あれバグが、これ落ちるじゃんか、何やってんだ自分(˘ω˘;)」

 当時は目の前にある一つのタスクにしか手を付けられず、しかも十分な質・スピードで対応できなかったため、自分の成果に自信がをもてない状態でした。
 チーム配属後の最初のタスクは思ったよりも複雑で、予定よりもかなり時間を要してしまいました。その後のタスクでは、リリース後に不具合が発生したこともあり、とっても凹んでいたのを覚えています。
 自分がプロダクトにどういう貢献ができているかを考えたとき、何ができているんだろう?とモヤモヤしてました。チームに貢献できていないのではないかという思い込みで、1人勝手に悩んでいました。

スムーズに定着しないスキル

〜学び始めた私〜
「アプリ・サーバーサイド両方必要だからたくさん覚えないと(˘ω˘)」
〜学んできた私〜
「Android開発してたら、iOS開発忘れた、あれAPIも、おいおい身についてるのかこれ(˘ω˘;)」

 もともと私はAndroidアプリ開発経験がなかったため、配属直後はわからないことだらけでした。iOSは少しかじってましたが業務レベルだと全然通用せず。 さらに一つのことを覚えて、一つのことを忘れる時もありました。
 「何がわからないのかわからない」状態で、覚えなければいけないことが多すぎ、コーディングを楽しむと言うよりは、タスクをこなせるだけの知識を身に着けようと必死でした。
 十分に内容を理解し、キレイなコードで実装することが理想でしたが、当時は熟考するだけの余裕がなく、納期も守れず非常に悔しかったです。その後も自分で納得できるような仕事をできるようになるまでには、時間がかかりました。

あたふたしないために心がけたい5箇条

f:id:omega999:20170305224358j:plain

毎日がむしゃらに過ごしてきて、気づけばあっという間に1年が経っていました。
改めて振り返ると、当時もっと心がけておくべきだったなと思うことがいろいろ出てきます。
こうした経験から学んだことを今回は5つ紹介します。

  • 今の成果を認める
  • 最短最大の学習をする
  • 「マイペース」を作る
  • 好奇心を育む
  • 手段を正当化しない

今の成果を認める

〜今の成果を認められた私〜
「画面のデザインできた、ロジックも実装、MTGでも発言、前より成長している感じある(^ω^)」

 当時はアウトプットの質に満足いかないことが多かったですが、不完全であろうと、あるいは締め切りに遅れようとも、そこで何かしらの成果は出してきました。こだわりきれず、納得できない、という否定的な思いばかり抱く時もあると思います。
 そのような時には、まず、 現状の力を理解するために今の成果を認めることから始めるべきです。私はタスクが終わるごとに振り返りをし、そこからの学び等を整理しました。

  • 技術的に学んだこと
  • 意識的に改善したこと
  • つまずいたこと

 1つのタスクをこなし、それによって、自分がどこまでできるようになったのかを把握することはとても重要です。現状を理解すれば問題もわかるはずです。私の場合はチームメンバーからFBをもらうことができ、客観的に自分を評価できました。もし自分で成果を認められないと悩んでしまうなら、周りの方々にFBをお願いしてみると良いと思います。
 このように現状を理解する積み重ねがあるからこそ、学びを理解し成長を感じられるようになると思います。

最短最大の学習をする

〜最短最大の学習を意識した私〜
「効率的に業務を進められて、タスク間に合ってる、作業も早くなった(^ω^)」

 私は以前から、疑問に思ったことを調べるために多くの時間をかけがちで、業務の中でも答えが見つからないものを延々と調べていたことが何度もありました。それは実はプロダクト独自の仕様であったり、まだ情報が出回っていない不具合だったりしました。もう少しで答えが見つかる気がする、そんな思い込みで多くの時間を浪費してしまい、そしていつの間にか危険信号が点滅してしまっているのです。
 まずは 目の前の課題をどうすれば最短で解決できるのか、それを考えることが重要です。手段は多くありますが、まずはその調査方法が最短経路かを一度考え直してみましょう。

  • チームメイトに聞く
  • ネットで調査
  • 社内wikiから探す

 これまでは理解するまで時間をかけて解決してきましたが、業務という限られた時間の中ではその方法では効率が悪い時もあることに気づきました。 学習効率の非効率性を限りなく排除し、最短最大の学習方法を選択することが重要です。
 そして、当時周りの方々からよく言っていただいた 「わからないことは聞いてください」という言葉の本質はここにあるのだと理解できました。
 時間をかけるべきもの、時間をかけるべきではないもの、その判断を効率よく行うための方法にたどり着くには、自分ひとりの力では難しいこともあります。

「マイペース」を作る

〜マイペースを意識した私〜
「前より覚えがスムーズになった気がする、技術も吸収してる、学習に余裕がある感じ(^ω^)」

 業務のことで悩んでばかりいると、考えることに疲れてしまい、その結果、当時は自分の学習ペースが完全に乱れてしまっていました。気持ちが焦ってばかりで単純に疲弊していたんだと思います。未熟であるから焦るというのは良い刺激ですが、空回りしてしまっては問題の解決には至りませんし、むしろ悪化させる一方です。
 最短最大の学習をすることと上記で述べましたが、その 自分にあった学習方法を習慣化し維持できるようにマイペースを保つことが重要です。足りないと思っていた時間もペースを整えればうまく調整できることもあります。例えば私は以下の項目を見直してマイペースを整えました。

  • 生活リズムを整える
  • 自由時間を決める
  • 趣味の開発をする

 ちなみにマイペースとは無茶をしないということではありません。時には無茶だと思える挑戦も必要です。そういうときは計画的な無茶をすべきです。業務だけに浸らずに、やりたいことをこなし、学習意欲とモチベーションを維持していくことが重要です。

好奇心を育む

〜好奇心を取り戻した私〜
「こういう設計にすれば良いのか、早く家帰って作業しよう(^ω^)」

 入社してからずっと思っていましたが、弊社エンジニアの方々は技術に対する好奇心がとても強いなと思っていました。(弊社に限ったことではなく、エンジニアって好奇心の強い人が多いと思いますが)
 私のペースが乱れていた時を振り返ると、学びたいことよりも必要なことを優先して学習し、気持ちの余裕があまりなかったです。 自分の興味・関心の幅を広げ好奇心を育むことは、学習のモチベーションに直結しますし、なにより充実感を得られますよ。なのでアプリ開発業務以外のことをやる時間を増やしました。

  • 業務以外の開発
  • 技術書を読む
  • webの技術調査

 当時は「何を学ぶべきか」に迷ってなかなか学習もスムーズにいかなかったのを覚えています。業務優先ばかりで、好きなことをおろそかにすることはやめましょう。技術をもっと好きになるため好奇心には素直に向き合っていきましょう。

手段を正当化しない

〜手段を正当化しなくなった私〜
「これって最適?要件整理しなおそう、実装時間かかるな、今は人に聞こう、柔軟に対応できるようになった(^ω^)」

 目的を言語化し、目の前に掲げて行動することは重要なことです。一方で、目的設定をせず手段ベースで物事が進んでしまうのは、ゴールを見失うことになってしまい注意が必要です。
 私は焦って仕事をしていた時、形式的なことだけを重視した手段ベースの考えで行動してしまい、目的を後付けしてしまう時がありました。しかし、後付の目的設定をすると 手段が正当化されてしまい目的を達成するための手段が適切であったかの判断ができなくなります。そうならないためには、目的等をもう一度考えてみましょう。

  • 達成すべき目的はなにか
  • 得られる効果はなにか
  • 今の状況で最も良い手段はどれか

 振り返ると、あのときは別の方法を取った方が良かっただろうと思うことが多々あります。目的の理解が十分でないときには注意が必要です。
 このように、後付けの目的設定をしてしまっていると気付いた時は、何かを見落としているかもしれないと考え、その場面で最も良い手段を選択できるように心がけることが重要です。

最後に

 1年を振り返ると、自分はダメダメだったということがわかりました。そして今はそれらが改善されているかのように本記事を書いていますが、まだまだ未熟者です。
 ですが、社員皆様のお力添えのお陰でできることは増え着実に成長していることに喜びを感じています。いつもご指導ありがとうございます。

 そして新卒の皆さんはあたふたせず自分のやりたいことを実現していってください!
 私と同じようにうまくいかないなーと思った方の助けになれば幸いです。

おまけ(開発しているアプリ)

f:id:omega999:20170816180201j:plain:w115f:id:omega999:20170816180211j:plain:w115f:id:omega999:20170816180218j:plain:w115f:id:omega999:20170816180221j:plain:w115f:id:omega999:20170816180223j:plain:w115

弊社アプリの紹介をさせていただきます。 業務として担当したアプリについてですが、当時から弊社では転職ナビ(旧:ジョブセンスリンク)のアプリが公開されていました。
求人を評価することができる機能や、希望にあった求人を探しやすくする機能を取り入れており、分かりやすいUIとサクサクとした動作で、とても使いやすいアプリだと思います。
当時はAndroidアプリのみでしたが、2017年1月にはiOS版も公開し、今では多くのユーザーに利用されています。 ぜひみなさんも利用してみてください。

play.google.com

itunes.apple.com

Gitのコミットの裏側で起こっていること

はじめまして。1ヶ月でエンジニアになろうとした山浦です。

先日Gitのことを突っ込んで調べる機会があり、Gitの仕組みって面白いねということを同僚に話していたら「面白いね。ところでGitって実装できる?実装できないと分かったとは言えないよね?」となぜか煽られるということがありました。

そうか、実装できないと分かったとは言えないのか、それも一理あるかもしれない。そう思い、Gitの仕組みを実装できるレベルまで掘り下げて調べてみました。

今回は実装はしないものの(過度に記事が複雑になるので)、Gitの根幹である git add コマンドと git commit コマンドの裏側で起こっていることを紹介します。

差分かスナップショットか?

ここで早速クイズです。

コミットで保存されているのはソースコードの差分でしょうか?スナップショットでしょうか?

今回の記事の中で解説していきますので、少し考えながら読み進めてみてください。 ちなみにこのデータの持ち方がGitと他のバージョン管理システム (Subversion等) との大きな違いだったりします。

git add コマンドの裏側で起こっていること

それでは、git add コマンドでインデックスに登録する裏側で何が起こっているのかをまず見ていきます。

$ git init sample
$ cd sample
$ echo 'Hello, world!' > sample.txt
$ git add sample.txt

git add コマンドを実行すると裏側では、①圧縮ファイルが作成され②インデックスに追記されます。これらを順に見ていきます。

f:id:livesense-made:20170813134138p:plain

①圧縮ファイルが作成される

git add コマンドを実行すると、addしたファイルを圧縮したファイルが .git/objects 以下に保存されます。

$ find .git/objects -type f
.git/objects/af/5626b4a114abcb82d63db7c8082c3c4756e51b

これが先ほどの git add コマンドで追加されたファイルです。 このファイルはblob (カタマリ) オブジェクトと呼ばれていて、ファイルの内容を圧縮したものになります。

どのようにblobオブジェクトを作成しているかというと、まず、ファイルの内容にヘッダーを付け加えたものをSHA1でハッシュ化します (それがblobオブジェクトのID)。IDの先頭2文字をサブディレクトリの名前に、残り38文字をそのディレクトリ内のblobオブジェクトのファイル名にします。そして、ファイルの内容にヘッダーを付け加えたものをzlibライブラリを用いて圧縮し、blobオブジェクトのファイルに書き込みます。こうやってblobオブジェクトは作成され、ファイルが圧縮保存されます。

f:id:livesense-made:20170820100304p:plain

なお、blobオブジェクトの圧縮前の内容を確認したい時は、blobオブジェクトのIDに対して git cat-file -p コマンドを使うことで確認できます。

$ git cat-file -p af5626b4a114abcb82d63db7c8082c3c4756e51b
Hello, world!

さて、ここでファイルに追記して git add コマンドを実行するとどうなるでしょう。

$ echo 'Good morning.' >> sample.txt
$ git add sample.txt
$ find .git/objects -type f
.git/objects/67/dcebe5e80cb4513b614624763ce08cf3346d8f # 新規追加されたファイル
.git/objects/af/5626b4a114abcb82d63db7c8082c3c4756e51b # 1回目のgit addで生成されたblobオブジェクト

すると、元々のblobオブジェクトは残ったまま、もう一つのファイルが追加されています。このファイルの中身はいったい何でしょう?

$ git cat-file -p 67dcebe5e80cb4513b614624763ce08cf3346d8f
Hello, world!
Good morning.

現状のsample.txtの内容が圧縮されていました。このように、git add コマンドを実行すると、その時点でのファイルの内容全部がblobオブジェクトという形で圧縮され記録されます。

ここでblobオブジェクトに関する重要な点をまとめます。

  • blobオブジェクトのIDはSHA1ハッシュで作成されているため、blobオブジェクトはファイル名に関係なく内容が同じなら同じIDになります。
  • blobオブジェクトのデータベースは追記のみで更新されません。イミュータブルなオブジェクトです。(ファイルを変更・削除してもblobオブジェクトは変更・削除されません)

②インデックスに追記される

ファイルはblobオブジェクトの形式で圧縮保存されるわけですが、blobオブジェクトはファイルの内容を圧縮しただけで、ファイル名の情報をどこにも保持していません。

そこで、ファイルの構造と名前を保持するために登場するのがインデックスです。

git add コマンドを実行すると、blobオブジェクトが作成された後、インデックスに追記されます。インデックスは、.git/index というバイナリファイルで管理されています。プロジェクトのある時点でのディレクトリツリー全体を表すデータを持ちます。

インデックスの中身を確認してみましょう。git ls-files –stage コマンドで .git/indexの内容を見ることができます。

$ git ls-files --stage
100644 67dcebe5e80cb4513b614624763ce08cf3346d8f 0       sample.txt

左からファイルモード (パーミッション)、(blob) オブジェクトのID、ステージ、ファイルパスが表示されています。ステージはマージコンフリクトのためにある数値です。通常0ですが、マージコンフリクトが起きた場合、ベースバージョン、一方のブランチのバージョン、他方のブランチのバージョンの3つをそれぞれステージ1、2、3としてインデックスに保持します。

このように、git add した時点でのblobオブジェクトのIDとファイルパスを紐付けて管理することで、ディレクトリーツリーの情報を保存します。

インデックスには次の特徴があります。

  • 次のコミットの準備をする場所。git commit すると、インデックスの情報を元にコミットされます。
  • バイナリファイルにパーミッション、オブジェクトのID、ファイルパスを持ちます。
  • treeオブジェクトの鋳型となります。treeオブジェクトに関してはこの後紹介します。

以上の2つが、git add コマンドでインデックスに追加する際に裏側で起こっていることです。

git commit コマンドの裏側で起こっていること

さて、ここからはコミットについて見ていきます。

$ git commit -m "first commit"
[master (root-commit) ef56b89] first commit
 1 file changed, 2 insertions(+)
 create mode 100644 sample.txt

git commit コマンドを実行すると裏側では、③treeオブジェクトが作成され④commitオブジェクトが作成され⑤ブランチの先頭を指すリファレンスが書き換えられます。

f:id:livesense-made:20170813153434p:plain ※ 図は①〜④まで

③treeオブジェクトが作成される

git commit コマンドを実行するとまず、treeオブジェクトが .git/objects 以下に保存されます。

$ find .git/objects -type f
.git/objects/2f/b1bd43dc899bcb3d8c1245e359716459ad992a # 今回追加されたファイル
.git/objects/67/dcebe5e80cb4513b614624763ce08cf3346d8f # 2回目のgit addで生成されたblobオブジェクト
.git/objects/af/5626b4a114abcb82d63db7c8082c3c4756e51b # 1回目のgit addで生成されたblobオブジェクト
.git/objects/ef/56b8952e72e3be4b06f61ecef53a9d282a4568 # 今回追加されたファイル

今回追加されたファイルのうち、.git/objects/2f/b1bd43dc899bcb3d8c1245e359716459ad992a を先に見ていきましょう。このファイルは、treeオブジェクトと呼ばれているものになります。

# -t オプションを付けるとオブジェクトのタイプを表示します
$ git cat-file -t 2fb1bd43dc899bcb3d8c1245e359716459ad992a
tree

# -p オプションを付けるとオブジェクトの中身を表示します
$ git cat-file -p 2fb1bd43dc899bcb3d8c1245e359716459ad992a
100644 blob 67dcebe5e80cb4513b614624763ce08cf3346d8f    sample.txt

treeオブジェクトは、左からファイルモード(パーミッション)、オブジェクトのタイプ、オブジェクトのID、ファイルパスが表示されています。中身がインデックスに似ていますね。 treeオブジェクトもインデックスと同じように、オブジェクトのIDとファイルパスを紐付けることで、ディレクトリーツリーを保持するためのものになります。

インデックスとの違いは、新たにコミットするたびにtreeオブジェクトも追加で作成されるという点です。コミットすると、そのたびにtreeオブジェクトとcommitオブジェクトが作成され、その時点でのディレクトリーツリーが毎回保存されます。そうすることでGitは変更履歴を保存しているのです。それに対してインデックスは、インデックスした時点で .git/index を毎回上書します。あくまでインデックスは、変更をまとめてコミットするための準備をする場所です。インデックスすると .git/index にディレクトリーツリーが上書きされ、コミットするとその時点での .git/index の情報を元にtreeオブジェクトが作成されるわけです。

次に、ディレクトリを追加するとtreeオブジェクトがどのようにディレクトリーツリーを保存するのかを見ていきましょう。

$ mkdir src
$ echo 'main file.' > src/main.txt
$ git add src
$ git commit -m "add directory"
[master ebf5ca0] add directory
 1 file changed, 1 insertion(+)
 create mode 100644 src/main.txt

# masterブランチ上での最後のコミットが指しているツリーオブジェクトの中身を表示します
# git cat-file -p 9a49569a4956b912f7ea59f0efbdb4a5c4d18a19aee9bb でも同じです
$ git cat-file -p master^{tree}
100644 blob 67dcebe5e80cb4513b614624763ce08cf3346d8f    sample.txt
040000 tree 94d5c7eab249212c58445ace5acadf10ed991e0c    src

# srcのtreeオブジェクトの中身を表示します
$ git cat-file -p 94d5c7eab249212c58445ace5acadf10ed991e0c
100644 blob 258dda95ffff5919f3ea5894c3bfaafdf225bf57    main.txt

上記のtreeオブジェクトの構造を図で表すと、以下のようになります。

f:id:livesense-made:20170813162224p:plain

このようにtreeオブジェクトは、1つ以上のblobオブジェクトかtreeオブジェクトを保持する階層構造になっています。そして、treeオブジェクトからblobオブジェクトをたどることで、その時点のスナップショットを確認することができます。

ここでtreeオブジェクトの特徴をまとめます。

  • コミット時に作成されます。
  • 構造や名前をもたないblobオブジェクトにファイルシステムとしての構造を与えます。
  • blobオブジェクトかtreeオブジェクトを保持しています。

④commitオブジェクトが作成される

さて、treeオブジェクトにより、コミット時のディレクトリーツリーが分かるようになりました。

しかしまだ、そのコミットを誰が、いつ、何のために変更したのかという情報がありません。それを保持するのがcommitオブジェクトです。

コミットすると、treeオブジェクトが作成された後に、.git/objects 以下にcommitオブジェクトが作成されます。

$ find .git/objects -type f
.git/objects/25/8dda95ffff5919f3ea5894c3bfaafdf225bf57 # 3回目のgit addで生成されたblobオブジェクト
.git/objects/2f/b1bd43dc899bcb3d8c1245e359716459ad992a # 1回目のgit commitで生成されたtreeオブジェクト
.git/objects/67/dcebe5e80cb4513b614624763ce08cf3346d8f # 2回目のgit addで生成されたblobオブジェクト
.git/objects/94/d5c7eab249212c58445ace5acadf10ed991e0c # 最新のコミットで追加されたtreeオブジェクト
.git/objects/9a/4956b912f7ea59f0efbdb4a5c4d18a19aee9bb # 最新のコミットで追加されたtreeオブジェクト
.git/objects/af/5626b4a114abcb82d63db7c8082c3c4756e51b # 1回目のgit addで生成されたblobオブジェクト
.git/objects/eb/f5ca03e94fe2244bb784fc4fddabf80e27a2e7 # 最新のコミットで追加されたcommitオブジェクト
.git/objects/ef/56b8952e72e3be4b06f61ecef53a9d282a4568 # 1回目のgit commitで生成されたcommitオブジェクト

# git cat-file -p HEAD でも同じ。最新コミットのcommitオブジェクトの内容を表示します
$ git cat-file -p ebf5caebf5ca03e94fe2244bb784fc4fddabf80e27a2e7
tree 9a4956b912f7ea59f0efbdb4a5c4d18a19aee9bb
parent ef56b8952e72e3be4b06f61ecef53a9d282a4568
author Harry <harry@author.co.jp> 1502608263 +0900
committer Harry <harry@author.co.jp> 1502608263 +0900

add directory

commitオブジェクトの中身は、コミットが作成された時点のトップレベルのツリー、親コミット、作者とコミッターの情報、空行、コミットメッセージです。このように、ツリーを保存することでコミットした時点のスナップショットが、作者とコミッターの情報からいつ誰が、コミットメッセージからなぜ変更したのかということが分かるようになっています。

なお、親コミットとは直前のコミットになります。親コミットの内容も確認してみましょう。

# parentに記載されているcommitオブジェクトの内容を表示します
$ git cat-file -p ef56b8952e72e3be4b06f61ecef53a9d282a4568
tree 2fb1bd43dc899bcb3d8c1245e359716459ad992a
author Harry <harry@author.co.jp> 1502606667 +0900
committer Harry <harry@author.co.jp> 1502606667 +0900

first commit

今回の親コミットは、最初のコミットになります。そのコミット内容が表示されています。

ここまでのGitリポジトリ内のオブジェクトの様子を図でまとめます。

f:id:livesense-made:20170813170631p:plain

Gitはcommitオブジェクトにtreeオブジェクトを保持することで、その時点でのスナップショットが分かるようにしています。 加えて、直前のコミットを親コミットとして保持しておくことで、コミットの履歴を辿れるようにしているわけです。これがGitのバージョン管理の根幹をなしている仕組みです。

ここでcommitオブジェクトの特徴をまとめます。

  • コミット時点でのスナップショットを示すオブジェクトです。treeオブジェクトのIDを持っていて、それがスナップショットの情報になります。
  • parentを持っていて、履歴をたどることができます。
  • なお、マージコミットの場合はparentを2つ持つことになります。

⑤ブランチの先頭を指すリファレンスが書き換えられる

git commit コマンドを実行すると、commitオブジェクト作成後に、現在のブランチの先頭を指すリファレンスが書き換えられます。

そもそも現在のブランチの情報はどこで保持されているかというと、HEADになります。HEADとは、現在使用しているブランチの先頭を表していて、.git/HEAD に保存されています。早速確認してみましょう。

$ cat .git/HEAD
ref: refs/heads/master

これを見ると、HEADは refs/heads/master へのリファレンスになっていることが分かります。HEADというのは、現在のブランチへのリファレンスで、ブランチをチェックアウトしたタイミングで書き換えられます。

では次に、refs/heads/master を確認してみます。

$ cat .git/refs/heads/master
ebf5ca03e94fe2244bb784fc4fddabf80e27a2e7

$ git cat-file -p ebf5caebf5ca03e94fe2244bb784fc4fddabf80e27a2e7
tree 9a4956b912f7ea59f0efbdb4a5c4d18a19aee9bb
parent ef56b8952e72e3be4b06f61ecef53a9d282a4568
author Harry <harry@author.co.jp> 1502608263 +0900
committer Harry <harry@author.co.jp> 1502608263 +0900

add directory

refs/heads/master は、masterブランチの先頭のcommitオブジェクトへのリファレンスになっていました。

Gitはコミットすると、refs/heads/master に最新コミットのIDを記載することで、現在のブランチの先頭コミットがどれなのかを記録しているのです(ブランチが変わると、refs/heads/ 以下が該当ブランチ名に変わります)。

まとめ

さて、はじめにコミットで保存されているのはソースコードの差分かスナップショットか、というクイズを出したのを覚えていらっしゃるでしょうか?

コミットで保存されているのは「スナップショット」でした。

git add コマンドを実行すると①圧縮ファイルが作成され②インデックスに追記されます。
git commit コマンドを実行すると③treeオブジェクトが作成され④commitオブジェクトが作成され⑤ブランチの先頭を指すリファレンスが書き換えられます。
commmitオブジェクトがtreeオブジェクトのIDを保持することで、コミット時点のスナップショットが分かるようになっているのでしたね。

ちなみに、他のバージョン管理システム (Subversion等) の多くは、基点とするバージョンへの差分としてデータを保持しています。Gitが差分ではなくスナップショットとしてデータを持っていることは、ブランチを運用する際に特に大きなメリットとなります。多くのバージョン管理システムの場合だと、データを差分として保持しているため、ブランチの作成時に全ファイルを新たなディレクトリにコピーする必要があり、ブランチ作成に長い時間がかかります。それに対してGitの場合だと、データをスナップショットとして保持ているため、ブランチの作成時はブランチのリファレンスを追加するだけですみ (ref/heads/ブランチ名 のファイルにcommitオブジェクトへのリファレンスを指定するだけ)、非常に高速です。

Gitの実態は、今回見てきた3つのオブジェクト(blobオブジェクト、treeオブジェクト、commitオブジェクト。これらをGitオブジェクトと呼びます)を中心に構成されています。もちろん他にもリファレンスやタグ等もありますが、これがGitの一番コアな部分です。 Gitのコマンドや操作の多くは、これら3つのオブジェクトに対して何らかの操作をしているだけです。

今回Gitを詳しく調べてみて、Gitは大変シンプルな構成だと思いました。本内容が皆様のGitライフの一助になれば幸いです。

参考文献

9つのWebサイトモニタリングサービスの使用感まとめ

  • はじめに
  • モニタリングサービスまとめ
    • No.1 Site24x7
    • No.2 StatusCake
    • No.3 Pingdom
    • No.4 UPTRENDS
    • No.5 GTMetrix
    • No.6 DareBoost
    • No.7 NodePing
    • No.8 Monitoring Plus
    • No.9 UptimeRobot
  • まとめ
  • おわりに

はじめに

今年4月に中途で入社したインフラストラクチャーグループ所属の内河です。 最近、ジョブセンスのインフラ担当になりました。 オンプレのサーバを触りつつAnsibleのPlaybookを書いたり、AWSのリソース設定をTerraform化しています。

現在、リブセンスではサーバの監視・外形監視にはMackerelを、WebサイトのモニタリングにはNewRelicやDatadogを利用していることが多いです。 しかし、こういったサービスの移り変わりは早く、新しいサービスが出ていたり、既存のサービスも使い勝手が変わっているかもしれません。 今回の記事は、9つのモニタリングサービスについて以下の要件を満たしているか、実際に触ってみた感想や費用について纏めてみました。

  • UIはグラフィカルで直感的か
  • 以下の点をモニタリング出来るか
     1. レスポンスタイムが分かるか
     2. アップタイムが分かるか
     3. DOMContentLoadedやLoad時間が分かるとベター

※ 有名なMackerelやNewRelicなどは除いております。ご了承ください。
※ 記載した費用は2017/08/10日現在の割引を適用していない費用に基いています。

それでは実際に見てみましょう。

続きを読む