レガシーコード改善のススメ

ULS レガシーコード改善のススメ～保守開発を楽しくする技術を身につけよう～ Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 2014/9/27 ウルシステムズ株式会社平澤章 http://www.ulsystems.co.jp mailto:info@ulsystems.co.jp Tel: 03-6220-1420 Fax: 03-6220-1402

自己紹介 平澤章（ひらさわあきら） ULS – 35才の時に生涯一技術者として身を立てると決意したが、浮き世のしがらみもあり、若干不本意に思いつつもここ数年は中間管理職としての会社生活を楽しんでいる。 [著書] [翻訳書- すべて共訳] Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 1 ウルシステムズ株式会社 – 企業の戦略的ITに特化したIT技術者集団 – 技術ブログ – http://enterprisegeeks.hatenablog.com/ エンタープライズギークス検索

最近、保守開発が増えたと思いませんか？ ULS ERPでなんとかなるなら、無理してスクラッチ開発なんかしないでしょメインフレームのアプリは、 2000年代前半にJava や.NETで作り替えちゃったしゼロから全部作り替えたいけど、お金と時間がもったいないでしょそんなこんなで保守開発が主流に Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 4

だけど、保守開発って大変ですよね（続き） ULS 修正中に見つけた別の潜在バグはどうすりゃいいのよ？元のドキュメントがないのに、変更分をどこに書けばいいのよ？手間暇かけてテストする時間をどうやって作ればいいのよ？そもそも、ちゃんと動くのが当たり前だと、みんなが思ってること自体どうなのよ？ Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 6

保守開発のデフレスパイラル ULS コードがよくわからないデグレードが起きる Copyright © 2014 UL Systems, Inc. All rights reserved. 手探りで修正する Proprietary & Confidential Powered by 7 慌ててやっつけで修正する顧客や上司に怒られるさらにコードがわからなくる時間外に呼び出される人事評価が悪くなる仕事がどんどんつまらなくなるスキルが身につかないオーマイガッ

レガシーコードのジレンマ ULS 安全にリファクタリングするためには先に単体テストを整備する必要がある。（しかし、レガシーコードの場合）単体テストを整備するためには先にリファクタリングする必要がある。 Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 9 その通り！オー、ノー

ということで、レガシーコード改善ガイド ULS Copyright © 2014 UL Systems, Inc. All rights reserved. 地味ながらロングセラーになっています Proprietary & Confidential Powered by 10  原題 Working Effectively with Legacy Code  著者マイケル・C・フェザーズ  発刊 2004年9月（米国） 2009年7月（日本）テストがないコードはレガシーコードだ！あなたも、Javaや.NETでレガシーコードを書いていませんか？

「レガシーコード改善ガイド」に書いてあること ULS 1.レガシーコードをテストで保護する手法「レガシーコードのジレンマ」をすり抜けて、単体テストを整備するためのさまざまな手法 2.レガシーコードと闘うための技術大全コード修正に限らない、レガシーコードを退治するための、ありとあらゆる技術 3.レガシーコードとの闘いで得られる果実レガシーコードを改善することの意義と効果技術者にとっての価値 Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 11

「レガシーコード改善ガイド」はTDDケンカ本だ！ 例えるなら、TDD本がリング上で行われるボクシングの試合について記した本であるのに対し、本書は街のケンカについて記した本である。 TDD本が構え方、ステップ、ジャブの打ち方について解説しているのに対し、本書は相手が目潰しのために砂を投げてきた時にどうするか、刃物を出してきたらどうするか、といった類の、綺麗事だけではすまされない様々な現実的な状況への対処方法が例示されている。 いわばTDDケンカ本である。 ULS 小野和俊さんのブログ（2012年10月1日のエントリー）からの引用 Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 12

レガシーコードのジレンマへの対処方法（その1） ULS リファクタリングの前に単体テストを整備したい単体テストを整備する前にリファクタリングしたい Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 14 レガシーコードのジレンマ対処方法（その1）リファクタリングせずに強引に単体テストを整備するきちんとリファクタリングする

リファクタリングせずに単体テストを整備する手法例(1) ULS スプラウトメソッド/ スプラウトクラス Sprout Method / Sprout Class Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 15 –状況 機能を追加する際に、汚い既存のコードには極力手を加えたくない。 –対処法 追加機能を独立したメソッドやクラスとして作り、既存のコードには新しいコードを呼び出すロジックだけ追加する。 単体テストは新しく書いたコードにだけ整備し、既存コードのテストはひとまずあきらめる。既存の汚いコード既存の汚いコードスプラウトメソッド [before] [after] ここだけ単体テストを整備する

リファクタリングせずに単体テストを整備する手法例(2) ULS Nullを渡す Pass Null Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 16 –状況 テストしたいメソッドが、生成しづらいオブジェクトを引数に取るため、テストコードを書けない。 –対処法 引数にNullを渡す。それでテストが動いたら結果オーライ。テストしたいメソッド生成しづらいオブジェクトテストしたいメソッド Null [before] [after]

レガシーコードのジレンマへの対処方法（その2） ULS レガシーコードのジレンマリファクタリングの前に単体テストを整備したい単体テストを整備する前にリファクタリングしたいジレンマへの対処方法（その2） Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 17 単体テストを書けるように、最低限のリファクタリングを行う単体テストを整備するきちんとリファクタリングする追加のステップ

単体テストを書くためのリファクタリング手法例(1) ULS 静的メソッドの公開 Expose Static Method テスト対象クラステスト対象クラス Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 18 –状況 インスタンス生成は困難だが、テストしたいメソッドはインスタンス変数や他のインスタンスメソッドを使っていない。 –対処法 テストしたいメソッドをstaticメソッドに変えてしまうインスタンスメソッドstaticメソッド [before] [after]

単体テストを書くためのリファクタリング手法例(2) ULS テスト対象クラスインスタンス変数の入れ替え Supersede Instance Variable Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 19 –状況 内部で生成しているオブジェクトが邪魔な実処理を行っているため、単体テストを書けない。 –対処法 テストのためのsetterを追加して、実処理を行う邪魔なオブジェクトを強引にダミーに置き換えるテスト対象クラス邪魔なインスタンス邪魔なインスタンステスト用setter [before] [after]

単体テストを書くためのリファクタリング手法例(3) ULS インタフェースの抽出 Extract Interface Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 20 –状況  メソッドの引数に指定する邪魔なオブジェクトのせいで、単体テストを書けない。 –対処法 引数に指定するオブジェクト用のインタフェースを定義して、シグニチャを置き換える。 単体テストでは、テスト用オブジェクトに置き換える。 [before] [after]

単体テストを書くためのリファクタリング手法例(4) ULS 呼び出しの抽出とオーバーライド Extract and Override Call Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 21 –状況  メソッドの内部に邪魔な処理があるために単体テストを書けない。 –対処法 邪魔な処理をメソッドに切り出す。 テスト用のサブクラスを定義して、邪魔な処理をオーバーライドする。 [before] [after]

レガシーコードを解読するためのさまざまな手法(1) ULS 仕様化テスト Characterization Test –既存のコードをそのまま動かすテストケースを書いて動作を把握する。 –そのテストケースはドキュメントとして扱う。試行リファクタリング Scratch Refactoring –コードを理解するために自由にリファクタリングする。 –ただし修正したコードはチェックインせず破棄する。 Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 23

レガシーコードを解読するためのさまざまな手法例(2) ULS メソッド分類法 Method Grouping –巨大なクラスに定義されているメソッドを、名前とアクセス属性で分類することで、責務を把握する evaluate branchingExpression causalExpression variableExpression valueExpression nextTerm hasMoreTerms Copyright © 2014 UL Systems, Inc. All rights reserved. addVariable Proprietary & Confidential Powered by 24

レガシーコードを解読するためのさまざまな手法(3) ULS 機能スケッチ Feature Sketch –レガシーコードを解読する際に、メソッドの呼び出しや変数へのアクセスの関係を図に描いてみる duration extend() dailyRate Copyright © 2014 UL Systems, Inc. All rights reserved. extendForWork() Proprietary & Confidential Powered by 25 getPrincipalFee() getTotalFee()

レガシーコードと闘うためのその他の技術(1) ULS コンパイラまかせ Lean on the Compiler –力作業は自分で行わず、コンパイラにまかせるペアプログラミング Pair Programming –間違いを防止するために、二人で作業する Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 27

レガシーコードと闘うためのその他の技術(2) ULS 超集中編集 Hyperaware Editing –世界をシャットアウトし、レガシーコードとの闘いに没頭できる状態にして作業を行う。心頭滅却すれば火もまた涼し Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 28

コードが自然にきれいになる 単体テストを整備すると、クラスやメソッドの独立性が高くなる コードがどんどんきれいになる ULS –依存関係を排除することで、テスト対象クラスやメソッドの凝集度が上がり、結合度が下がる –単体テストを整備する作業を繰り返すと、テストコードが整備されるだけでなく、優れたコードのオアシスができてくる Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 30

ULS Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 31 技術者にとってのメリット 隣の新規開発の芝はそれほど青くない –新規開発プロジェクトはデスマーチになりがち 実践的な設計スキルが身につく –具体的なコードを前提に作業するので、設計のトレードオフ判断がしやすい –すぐにリリースするため、フィードバックを早く得られる レガシーコードとの闘いは意外と楽しい –少しずつ改善して、優れたコードのオアシスを広げていく充実感

ULS Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 33 翻訳時のこぼれ話(1) レガシーなのにCOBOLが出てこないなんて！ –2004年冬に、某出版社さんから翻訳を打診されましたが、そのときは断っちゃいました 当時の感覚では、Javaでレガシーはないなと。

ULS Copyright © 2014 UL Systems, Inc. All rights reserved. Proprietary & Confidential Powered by 34 翻訳時のこぼれ話(2) 翻訳作業中に原書の読書会を発見！ –猛者たちが集う、濃いコミュニティだったので、出版後にこっぴどく批判されることを心配しました(笑) –で、おそるおそる読書会に参加して、翻訳作業への協力を依頼したところ、快く対応していただきました。 貢献していただいたこと – 原稿の査読 – 質問や嘆きを表現した第2部の章タイトルの日本語表現 – 「レガシーコード改善ガイド」というタイトルの命名

保守開発のデフレスパイラル ULS コードがよくわからないデグレードが起きる Copyright © 2014 UL Systems, Inc. All rights reserved. 手探りで修正する Proprietary & Confidential Powered by 36 慌ててやっつけで修正する顧客や上司に怒られるさらにコードがわからなくる時間外に呼び出される人事評価が悪くなる仕事がどんどんつまらなくなるスキルが身につかないオーマイガッ

レガシーコード改善技術を身につけて保守開発のデフレスパイラル余裕を持ってリファク ULS デグレードが起こら Copyright © 2014 UL Systems, Inc. All rights reserved. ない Proprietary & Confidential Powered by 37 設計スキルが上がる顧客や上司に褒められるコードがどんどんきれいになるデート中に呼び出されない給料が上がる仕事がどんどん楽しくなるレガシーコード改善技術を身につけるとタリングできる確信を持って修正できる保守開発を楽しもう！

http://enterprisegeeks.hatenablog.com	73
https://twitter.com	17
http://www.slideee.com	1

レガシーコード改善のススメ

by ahirasawa

on Sep 28, 2014

Statistics

Views

Actions

3 Embeds 91

Accessibility

Categories

Upload Details

Usage Rights

Report content

レガシーコード改善のススメ Presentation Transcript