読者です 読者をやめる 読者になる 読者になる

Software Entropy【The Pragmatic Programmer】

二つ目は "Software Entropy"。

割れ窓理論

ソフトウェアは物理世界とは隔離されているが、エントロピー増大の法則からは逃げられない。 どんなに素晴らしいソフトウェアであっても時間と共に朽ちていく。こういう状況を錆びに例えて "Software Rot" というようだ。

これを防ぐため『割れ窓理論』を応用しようと書かれている。割れ窓理論とは次のようなものである。

割れ窓理論(われまどりろん、英: Broken Windows Theory)とは、軽微な犯罪も徹底的に取り締まることで、凶悪犯罪を含めた犯罪を抑止できるとする環境犯罪学上の理論。アメリカの犯罪学者ジョージ・ケリングが考案した。「建物の窓が壊れているのを放置すると、誰も注意を払っていないという象徴になり、やがて他の窓もまもなく全て壊される」との考え方からこの名がある。 (https://ja.m.wikipedia.org/wiki/割れ窓理論

窓が一つでも割れていると、加速度的に環境が悪化していく。 一方、綺麗に装飾された家が建ち並んでいれば環境は悪化しない。

これをソフトウェアに応用しようという話だ。 割れ窓のようなコードが一つでもあると「ここもそうしてるしいいだろう」と思ってしまう。 一方、綺麗に整理されたコードではそういうことは起こらない。 「汚す」という行為に対して心理的な抵抗が現れる。

ソフトウェアの品質

ソフトウェアの割れ窓を見つけることはそれほど難しくない。 プログラマならば担当してるソフトウェアのイケてない点をいくらでも挙げられるだろう。 きっとそれが割れ窓だ。 クラス構成がいけてない。語彙が統一されていない。ビルドシステムが古い。

しかし、割れ窓やサビに注目しすぎるもどうだろう、と思うことがある。 割れ窓理論はソフトウェアの品質に寄与すると思うけれど、「ソフトウェアの品質」とはユーザーにとっての価値がベースである、とどこかで読んだ気がする(『テストから見えてくるグーグルのソフトウェア開発』だったかな?) 割れ窓に注目しすぎて、ユーザーを置いてけぼりにしないように注意したい。

テストから見えてくるグーグルのソフトウェア開発

テストから見えてくるグーグルのソフトウェア開発

The Cat Ate My Source Code【The Pragmatic Programmer】

明けましておめでとうございます。 2017年もすでに10日ほど経過してますが…。

一年半くらい書いてきた Effective Java シリーズが終わってしまって、イマイチ継続的にブログを書く感じにならない。 やっぱり、何かをシリーズ化してノルマにすることがブログを継続するコツですね。習慣付いてるとシリーズ以外のネタを書くことへの心理的障壁も下がるし。

The Pragmatic Programmer

以前から The Pragmatic Programmer は一度読んでみたいと思っていた。ちょうど rebuild で話題になってたし、これを読んで1章ずつまとめてみようと思う。rebuild では「古い部分が多い」という話だったので、なるべく「今ならどーするか」みたいな話を入れていきたい。

rebuild.fm

The Pragmatic Programmer は日本語版が pdf で読めるようになってるんだけど、残念ながら Kindle にはなかった。今回は、英語の勉強も兼ね原著を読もうと思う。(しかし、Kindleで4000円は高いと感じてしまうな…)

The Pragmatic Programmer: From Journeyman to Master

The Pragmatic Programmer: From Journeyman to Master

The Cat Ate My Source Code

1章は Take Responsibility について述べてる。簡単にまとめると、

  • Take Responsibility しろ
  • 失敗と無知を認めることを恐れるな
  • クソな言い訳をするな
  • 失敗した時のために対案をもっておけ
  • 無理なら断れ

というところか。言ってることは至極真っ当である。うんうん、そうだよね。誠実さ。大事だよね。

でも、ここにたどり着くために実践するべき日々の行動をもう少し書いてくれれば、と感じた。あるべき姿だけ書かれていると大抵の人が「うんうん、そうだよね。誠実さ。大事だよね。」で終わってしまうわけだ。たとえば、「アクション:明日から自分のミスを毎日一つ書いて同僚と共有してみよう!」のように書いてあると少し違うのではないか。

こういう点は『Soft Skills』の方が手厚い印象を受ける(同じく『情熱プログラマ』も)。『Soft Skills』だと、"Chapter 10. Being a professional" でまさに同じことが書かれているし、取るべきアクションについても書かれているし。

SOFT SKILLS ソフトウェア開発者の人生マニュアル

SOFT SKILLS ソフトウェア開発者の人生マニュアル

情熱プログラマー ソフトウェア開発者の幸せな生き方

情熱プログラマー ソフトウェア開発者の幸せな生き方

もちろん、『Soft Skills』や『情熱プログラマ』は The Pragmatic Programmer に多くの影響を受けている、と明確に書かれているので、元ネタを基にしてさらによい方法で書かれているのは当然なのだろうけれど。

そして、まだ一つしか読んでないのでこう判断するのは早いのかもしれない。もしかしたらこの後に出てくるのかもしれないし。

次章は "Software Entropy"。

見積もりのずれ

最近、見積もりをしてから仕事に取り掛かるようにしている。プロのソフトウェアエンジニアとして見積もり能力は重要だと思う(たぶん)。「それ、簡単にできますよ(どやぁ」と放言して、できたのは半年後なんてのはプロとはいえない。

ちゃんと見積もって実績を評価してみたら、見積もりのずれは作業の遅れではなく、作業時間の不足から起こりがちだなと気づいたというお話。

見積もりの仕方

自分は次のように見積もりをする。

  1. 直感で全体の見積もり:「まあ、この機能なら1ヶ月くらいで出せるでしょ」
  2. 作業項目への分割:「作業的には、既存実装の調査、モデル側実装、ビュー側実装、テスト、バグ修正、リリース作業、かな。」
  3. 時間単位で見積もり:「これは2時間くらい、これは6時間くらい、あーこれは重そうだから16時間くらいかかりそう…」
  4. 足し算:「全部で120時間か…」
  5. 遅延係数1.5をかける:「1.5 をかけると180時間か…1ヶ月じゃおわんねーな」

脇道にそれるが、何を持って「作業終了」とするかは事前にマネジメント側と認識をあわせておくべき。しかし、「自分の作業物に一切手を加えないでプロダクション環境にリリースできる状況」を作業終了としておけばほとんどの場合でマネジメント側と認識がずれることはない。すなわち、設計、実装、コードレビュー、再修正、テスト、テストバグ修正、リリース準備とリリース、をすべて作業に含んでおく。

遅延係数

ほとんどのソフトウエアエンジニアは楽観的で自分の能力を過大評価し、作業の難易度を甘く見る。例に漏れず自分も楽観的である。「金曜までに終わるな」と思った作業は、大抵、次の週の半ばにリリースされる(or マージされる)。さすがに5年くらい仕事してると、こういう自分の性質を理解しているので、最終的な見積もりを出す時には直感の値に係数1.5をかける。

ちなみに 1.5 をかけると自分の直感と比較してだいぶスケジュールが伸びることになる。直感と反するので不安になる。こんなにも時間がかかるなんて無能だと評価されないだろうか…。しかし、仕事は信頼感の方が大事。見積もりには不安を抑える力も必要だ。

仕事は早いに越したことはない。しかし、できると言った期間にできてないのは困る。もし、早く終わらせたいのであれば、作業量を調整するかより腕の立つエンジニアを連れて来てもらうしかない。これはマネジメント層の問題であり、ソフトウェアエンジニア個人にはどうしようもない。

遅延係数の正体

さて、ようやく本題。

この遅延係数 1.5 の正体は何だろうか。この 1.5 は自分の能力の過信率だと考えていた。すなわち、自分は自分の能力を 1.5 倍過信している。直感による見積もりでは、作業をその分だけ過小評価している。と。

しかし、そうではなかった。

自分の作業にはポモドーロを導入している。これによって明確に集中した作業時間を計測することができるようになった。週のポモドーロ総数は大抵 40〜45 だ。調子のいい日は 12 程度確保できるが、調子が悪かったり打ち合わせが入ると 5〜6 だったりする。

この実績ポモドーロ数と作業見積もりの値を比較すると、実は見積もりの値は正確であることがわかった。すなわち、5〜6 時間を見積もったタスクは 10 ポモドーロ程度かかっている。ということは、この遅延係数は自分の作業自体の遅延ではない。

実は、見積もった値を日にちに変換する際に問題があった。8 時間勤務で、オーバーヘッド含めても7時間程度は作業できると考え、7時間で一日に変換していた。しかし、7時間の作業といえば14ポモドーロである。こんなにも集中して作業するのはほぼ無理だ。実測は平均で8~9である。実際、4~5時間がいい線である。

これが遅延係数の正体だ。

まとめ

結局のところ、ちゃんと集中して作業する時間を確保することこそが、遅延を回避する一番の方法だということだ(自分にとってね)

【Effective Java】各項目のまとめ

Effective Java シリーズの各項目の一覧。

第1章:はじめに

第2章:オブジェクトの生成と消滅

第3章:すべてのオブジェクトに共通のメソッド

第4章:クラスとインタフェース

第5章:ジェネリック

(以下、ジェネリックスの補足記事)

第6章:enumアノテーション

第7章:メソッド

第8章:プログラミング一般

第9章:例外

第10章:平行性

第11章:シリアライズ

EFFECTIVE JAVA 第2版 (The Java Series)

EFFECTIVE JAVA 第2版 (The Java Series)

Kindle 版はこちら(ただし英語)

Effective Java: A Programming Language Guide (Java Series)

Effective Java: A Programming Language Guide (Java Series)

『人を動かす』を読んだ

なるべく読んだ本の感想は書いておこう。今までは書いたり書かなかったりだったから。

最近、『人を動かす』を読んだ。

人を動かす 文庫版

人を動かす 文庫版

相手のことを考える

自己啓発の元祖ともいえるこの本。もちろん存在は知っていた。ここ最近読んだ本で立て続けにオススメされていたので重い腰を上げて読む。Kindle なら1000円以下だし。社会人たるものカーネギー本の一冊くらいは読んでおかないと。

購入したのは8月末。時間が取れず、読み終わるのに数ヶ月かかってしまった。面白い本ならどんどん読み進むのでやはりそれほど面白くはなかったのだろう。

やたら成功事例ばかり挙げられているので飽きてくる。そしてそれがだんだん胡散臭さへと変わる。リンカーンカーネギー(鋼鉄王の方)のエピソードが至るところで紹介される。それにくわえて筆者のセミナーの受講者の成功例。さすがに食傷気味になる。ほんとにこんなうまくいくのか?と言いたくなる事例が多々。

それでも得るものはあったと思う。この本の教えは『相手のことを考える』という点に尽きる。この教えは簡単なようでとても難しい。実践してみると、日々の生活でいかに自分が相手のことを考えず会話しているかを思い知らされた。この本で紹介されるテクニックを使ってみよう!しかし、普段からやってないのでとても難しい。脳にパターンがまったくインストールされていない。

How to win friends

過去に読んだ『インテル経営の秘密』や『あなたのチーム、機能してますか?』とは真逆の教えもある。この本は議論は徹底的に回避しろと説く。一方、『あなたのチーム、機能してますか?』では「徹底的に議論しろ。しかし、徹底的に持論しても関係が崩れない信頼をお互い持て」と説く。徹底的に議論することで問題に対する理解を深め、最適な方法を見つけようという姿勢が見て取れる。

hjm333.hatenablog.com

すこし斜めからこの本を眺めると『相手をおだてて動かそう』といってるように見えてくる。もしかしたら、そういう側面もあるのかもしれない。なぜなら、原題は How to win friends and influence people (友に勝ち、他人に影響を与える方法)なのだから。

嫁を動かす

僕が読んだのは『文庫版』。もう一つ『新装版』というエディションがあるようだ。『新装版』には「幸福な家庭をつくる七原則」という付録が含まれている。家庭を持つ僕にとってはこちらの方がよっぽど大事だったのでは…。

人を動かす 新装版

人を動かす 新装版

ぐぐると『嫁を動かす(HOW TO WIN WIFE AND INFLUENCE PEOPLE)』なんてブログもでてきて、ますます『新装版』を買わなければならない衝動にかられている。

www.move-wife.com

【Effective Java】項目78:シリアライズされたインスタンスの代わりに、シリアライズ・プロキシを検討する

Serializable を実装すると、バグやセキュリティ上の問題が発生する可能性が高くなります。 コンストラクタ以外でインスタンスが生成されるようになるからです。

これらの可能性を大幅に減らす技法が、シリアライズ・プロキシ・パターン(Serialization Proxy Pattern)です。

シリアライズ・プロキシ・パターン

シリアライズ・プロキシ・パターンの実装について、項目39項目76で利用した Period クラスを例にして説明します。

ネストしたクラスを実装

プロキシパターンを実装するにはまず、対象となるクラス内にシリアライズ可能な private static ネストクラスを追加します。

ネストしたクラスには、シリアライズ対象のクラスのシリアライズに必要な論理的な情報を保持させます。 対象のクラスのキャッシュプロパティなどはこれに含めないでください。

このネストしたクラスは、パラメータがシリアライズ対象クラスであるコンストラクタを持つべきです。 この際、防御的コピーを用いる必要はありません。

そして、単に Serializable を実装するだけでかまいません。すなわち、デフォルトのシリアライズ形式となります。

これらを実装したものは次のコードになります。

// ネストしたクラス。シリアライズ用の専用。
private static class SerializationProxy implements Serializable {
    // フィールドは final にできる
    private final Date start;
    private final Date end;

    SerializationProxy(Period period) {
        // 防御的コピーは必要はない
        this.start = period.start;
        this.end = period.end;
    }

    // UID を設定(項目75)
    private static final long serialVersionUID = 234098243823485285L;
}

writeReplace() の実装

次に対象のクラスに writeReplace() メソッドを追加します。 writeReplace() で返したインスタンスが、実際にストリームに書き込む際のインスタンスになります。

シリアライズ・プロキシ・パターンでは writeReplace() で、さきほど宣言したネストしたクラスのインスタンスを返します。 シリアライズ時には writeReplace() が呼び出され、ネストしたクラスのインスタンスシリアライズ化されます。 すなわち、シリアライズ対象クラスが自体がシリアライズされることはなくなります。

しかし、攻撃者によって改ざんされたストリームを防ぐ必要があります。 そのため、シリアライズ対象クラスに readObject メソッドを実装し、例外が発生するようにしておきます。

// シリアライズ対象クラスの readObject メソッド
private void readObject(ObjectInputStream stream) throw InvalidObjectException {
    throw new InvalidObjectException("Proxy required");
}

readResolve() の実装

最後に、readResolve() メソッド(項目77)を実装し、コンストラクタを使ってシリアライズ対象クラスのインスタンスを返します。 これでデシリアライズの時には、シリアライズ対象クラスが正しく返却されるようになります。

シリアライズプロキシパターンの利点はまさにここにあります。 この readResolve() メソッドでは、言語外のインスタンス生成機能を利用していません。 通常のコンストラクタ(または static ファクトリーメソッド)を利用して、インスタンスを生成しています。 これによって、通常のコンストラクタに実装されている不変式チェックを利用することができます。

実際の readResolve メソッドのコードは次のようになります。

private Object readResolve() {
    return new Period(start, end);
}

シリアライズ・プロキシ・パターンは防御的方法(項目76)と同様に偽りのバイトストリーム攻撃を防ぐことができます。 項目77で紹介したような内部フィールドの Steal 攻撃も防ぎます。

また、この方法を用いると他の手法と異なり、Period クラスを不変にすることができます。 これはとても重要な違いです。

EnumSet の実装例

このパターンの利点はもう一つあります。 これは、デシリアライズされた際のインスタンスとは異なるクラスのインスタンスを生成することができる点です。

EnumSet (項目32)では、Enum の要素の数によって異なるクラスのインスタンスが生成されます。 要素の数が 64 以下の場合には RegularEnumSet のインスタンスが生成され、64 を超過した場合には JumboEnumSet のインスタンスが生成されます。

もし、シリアライズ・プロクシ・パターンを使わないとすると、RegularEnumSet としてシリアライズされたストリームは、たとえ要素が増えても RegularEnumSet としてしかデシリアライズできません。 しかし、プロクシ・パーターンを使えば readResolve メソッド内で通常の static ファクトリーメソッドを利用できるため、要素に応じて異なるインスタンスを生成することができます。

実際、Java の EnumSet は次のように実装されています。

public abstract class EnumSet<E extends Enum<E>> extends AbstractSet<E>
    implements Cloneable, java.io.Serializable

...(省略)...

    // シリアライズプロキシ
    private static class SerializationProxy <E extends Enum<E>>
        implements java.io.Serializable
    {
        private final Class<E> elementType;

        private final Enum<?>[] elements;

        SerializationProxy(EnumSet<E> set) {
            elementType = set.elementType;
            elements = set.toArray(ZERO_LENGTH_ENUM_ARRAY);
        }

        @SuppressWarnings("unchecked")
        private Object readResolve() {
            // elementType の Enum の数に応じて noneOf は異なるインスタンスを返す
            EnumSet<E> result = EnumSet.noneOf(elementType);
            for (Enum<?> e : elements)
                result.add((E)e);
            return result;
        }

        private static final long serialVersionUID = 362491234563181265L;
    }

    Object writeReplace() {
        // 書き込む際には SerializationProxy を書き込む
        return new SerializationProxy<>(this);
    }

    // Enum 自体はデシリアライズさせない。
    private void readObject(java.io.ObjectInputStream stream)
        throws java.io.InvalidObjectException {
        throw new java.io.InvalidObjectException("Proxy required");
    }
}

制限

シリアライズ・プロキシ・パターンも万能ではありません。

まず、クライアントによって拡張可能なクラスとは互換性がありません。

また、オブジェクトグラフが循環しているようなクラスでは利用できません。 シリアライズプロキシの readResolve からオブジェクトのメソッドを呼び出そうとしても、シリアライズ対象のクラスのインスタンスが復元できていないので、メソッドを呼び出すことができません。

また、通常のシリアライズよりもパフォーマンスが劣化することに注意してください。

感想

ついに終わった…。

最初の記事が 2015 年の 7 月。

hjm333.hatenablog.com

1年5ヶ月かかった。

Effective Java を解説しているブログはけっこうあるけれど、最後までたどり着いているブログはほとんど見受けられないので、そういう意味ではがんばったほうかな。

次の課題図書は何にしようかな~。

子育てエンジニアの一日(朝)

いつもとは志向を変えて自分の一日について書いてみる。

自分はソフトウェアエンジニア。結婚していて子供がいる。子供は一歳で、奥さんは働いている。いわゆる共働き家庭だ。

そんな人間のある日の一日。

07:00

起床する。子供はまだ寝ている。顔を洗い、髭を剃り、寝癖を直す。このタイミングでお風呂は洗っておく。夜帰宅したらすぐにお湯を張りたい。独身時代は毎朝シャワーを浴びていたけれど、いつのまにか辞めてしまったな。

次は子供のご飯の準備。ご飯は準備が簡単なものだ。火を使って調理したりはしない。並行して子供の服を選び、保育園の荷物を準備する。荷物はオムツ3枚、その日の着替1セット、エプロンとお手拭きタオル2セット。

子供を起こす時間だ。7:30。テレビをつけて教育チャンネルにしておく。幸い子供の寝起きは悪くない。5分ほど声をかけていると目覚めて自分でベッドを抜け出してくる。機嫌よくテレビを見始めるので、その間に服を着替えさせる。

子供にご飯を食べさせる。最近は自分で食べてくれるのでだいぶ楽になった。しかし、遊ばないように監視はしておかなければならない。彼は遊びたい年頃だ。監視を継続しつつ自分もご飯を食べる。一緒に子供ともぐもぐする。

奥さんは家を出て仕事に向かう。

08:00

8時になる頃、子供がご飯を食べ終わる。テレビでは『お母さんといっしょ』が始まる。洗濯が終わるので洗濯物を干す。雨の日は浴室乾燥機を使わなければならない。風呂に干す必要があるのでやや手間がかかる。洗濯を干し終わったら皿洗い。食洗機が欲しいとも思うが、賃貸なので設置するのは難しい。

子供のトイレの時間だ。子供をトイレに連れて行く。5分くらいでばっちりトイレしてくれるので助かる。子供の手を洗い、リビングに帰らせ、トイレを片付ける。褒めることを忘れてはいけない。トイレが上手にできたことを褒めちぎる。同時に自分の歯磨きもしておく。

8時半過ぎには家を出なければならない。それまでに少し時間があるので、英語の勉強をする。実際にはこの表現は間違っている。英語の勉強をしたいので少しだけ早めに起きて時間を確保している。子供に邪魔されつつも、なるべく集中するように努力する。

08:30

8時半だ。子供に靴下を履くように言う。いつのまにか自分で靴下を履けるようになった。靴下入れから靴下を取り出し、思考錯誤して靴下を履いている。なんとか履き終わって嬉しそうにしている。かかとの位置があってないので直してあげる。

出かける準備が整った。Evernote にメモした朝の家事チェックリストを確認する。暖房が付けっ放し、生協の箱を出したり忘れ、連絡帳の置き忘れ。過去に犯したミスがメモしてある。二度とやらないようにとメモしているのだが、それでも忘れ物をすることがある。人間は不思議だ。

家を出た。駅前の保育園に連れて行く。都心生活者の例に漏れず、我が家も保活戦争に巻き込まれている。0歳の早い段階から会社の近くの無認可保育所に電車通園し、ポイントを稼いだ。その甲斐あって今年度から最寄駅の保育園に通わせている。しかし、認可保育所ではなく小規模保育である。3歳になるタイミングで退園しなければならない。我が家の保活に終わり見えない。

保育園に着いた。子供の靴と靴下を脱がせ、荷物をロッカーに入れる。子供の体温を測り、熱がないことを確認する。もちろん、家でも測っているが改めて測りなおす。ここで 37.5 度以上の熱があると預かってもらえない。こういう場合は自宅にトンボ帰りし、会社を休まなければならない。過去、トンボ帰りしたことは4〜5回ある。

子供との別れを惜しむ。が、子供が別れを惜しむことはほとんどない。登園してすぐおもちゃで遊び始めている。こちらのことなど気にしていない。我が子ながらたくましい。0歳の早い頃から保育園に預けているからだろうか?「〇〇くん、ほらお父さんがバイバイって言ってるよ〜。〇〇くんはクールですねー。」と先生にフォローされながら、保育園を後にする。

09:00

さぁ準備は全て終わった。レディトゥーゴー。しかし、すでに一仕事を終えたような達成感に包まれている。そのままどこか遠くにいってしまいたくなる。しかし、そんな度胸は私にはない。そそくさと会社に向かう。今日も電車は遅延している。

長くなったので次回に続く。