close
プログラミング クラウド Microsoft Azure 情報処理資格 基本情報技術者 IT基礎 応用情報技術者 開発・設計方法 オブジェクト指向 内定者・新人研修 プログラミング基礎 アルゴリズム コンピュータ数学 内定者研修 新人研修 ヒューマンスキル プロジェクトマネジメント プレゼンテーション リーダーシップ 組織マネジメント ネゴシエーション ロジカルシンキング Java UI/UX HTTP JavaScript基礎 情報処理資格 ネットワークスペシャリスト ネットワーク インターネットルーティング応用 IPアドレス データベース応用 SQL応用 パフォーマンスチューニング データベース設計 ER図 概念設計(データベース) 論理設計(データベース) IT資格 Linux基礎 OS・システム基盤 セキュリティ TCP/IP OSI参照モデル データベースセキュリティ ファイアウォール 標的型攻撃 SQLインジェクション ネットワーク基本設計 CCNA Cisco プロジェクトマネジメント資格 情報処理資格プロジェクトマネージャ 情報処理安全確保支援士 人事給与 財務会計 管理会計 簿記 生産管理 在庫管理 ERP バランススコアカード 情報処理資格 ITアーキテクト 情報処理資格 ITストラテジスト 情報処理資格 ITサービスマネジメント 情報処理資格 システム監査 PMBOK® PMP® プロジェクト計画 WBS リスクコントロール ITIL ITサービスマネジメント 要求定義 要件定義 見積手法 ビジネスインダストリ 業種・業界知識 業務知識 提案力 ソフトウェアテスト基礎 情報処理資格 データベーススペシャリスト ハードウェア基礎 外部設計(基本設計) 内部設計(詳細設計) データベース基礎 SQL基礎 RDBMS 物理設計(データベース) C++ Ruby MVC基礎 Webアプリケーション開発 JavaEE Javaプログラミング応用 フレームワーク MVC応用 Spring フレームワーク ソフトウェアテスト応用 テスト手法 Junit スマートフォンアプリ開発 Androidアプリ開発 C# 基礎 C# 応用 負荷テスト Javaプログラミング基礎 ソフトウェアテスト コーチング メンタリング HTML/CSS サーバー構築 仮想化技術 KVS (NoSQL) アジャイル スクラム ファシリテーション C言語 ITパスポート JSTQB データサイエンス 単体テスト ユニットテスト キャリアアップ インターネットルーティング基礎 パケット解析 LAN構築 データベース データサイエンティスト トレンド 障害対応 インフラ監視 HTTP/2.0 コンピュータサイエンス VPN ネットワーク物理設計 データベース障害 JavaScript モダンJS (Modern JavaScript) 応用 MVS応用 バックアップ/リカバリ 分散処理 Hadoop Hive Python AI 深層学習(DeepLearning) CentOS Linux応用 Zabbix シェルスクリプト Infrastructure as Code Windowsサーバー基礎 内部設計 Docker DevOps Windowsサーバー応用 NginX chef Ainsible ロジカルライティング R テスト自動化 Jenkins Git 継続的インテグレーション (CI) バージョン管理 Vagrant 要求分析 Redmine 継続的インテグレーション(CI) 継続的デリバリー (CD) ヒューマンリソース管理 Web API マイクロサービス コミュニケーション 業務知識/業界知識 マーケティング 語学 AWS 法務 IoT ビジネスマナー OJT 業務効率化 表計算ソフト オフィスソフト コンプライアンス フロントエンド Subversion PHP 関数型プログラミング Laravel モダンJS (Modern JavaScript) 基礎 Android Studio 機械学習 iOSアプリ開発 ぷプログラミング React 次世代高度IT人材 共創 IPA Raspberry Pi Xamarin スクリプト言語 GoF CUI VBA 資格 ビジネス文書 jQuery 研修参加レポート マネジメント OSPF テーブル設計 アンガーマネジメント クリティカル・シンキング PDU 経営改善 Pマーク 問題解決技法 サイバー攻撃 エンジニア 参加してみた エンゲージメントマネジメント 労働関連法 新人育成 ネットワーク構築 情報セキュリティマネジメント デザインパターン リファクタリング マルチスレッドプログラミング ベンダーコントロール Modern JavaScript 冗長化 VLAN インフラエンジニア チームビルディング テストケース リーダブルコード セキュリティ入門 ネットワーク入門 Node.js npm gulp ビルドツール Python入門 冗長化入門 インフラ実機演習 プロジェクト管理 Active Directory ネットワーク管理 コンテナ 正規化理論 Haskell 品質管理 OpenStack シンギュラリティ DBA中級 プロトコル UX 基本設計 FinTech トラブルシューティング 並列処理 見える化 PMO ロジカルコミュニケーション Deep Learning インデックス設計 超上流工程 BGP Excel C-CENT Selenide プライベートクラウド アセンブラ コンピュータ基礎 工数見積 CCENT 法律知識 失敗から学ぶ プロジェクト失敗事例 PDCA プログラミング入門 非エンジニア向け 4Biz DNS セルフマネジメント 片付け術 サーバーダウン サーバー タイムマネジメント GO言語 プロダクトマネジメント プロダクトマネージャ LVS ロードバランサー 負荷分散 仮想通過 犯罪心理学 情報漏えい SEカレッジ導入事例 IT研修を聞いてみた 会社規模 (100~300名) IT研修制度を聞いてみた CentOS7 開発環境構築 数字力 財務 IT人材 UI Machine Learning Go言語 (golang) データマイニング 統計学 新人教育 やり直し数学 RDB つながる工場 モチベーション WebSocket WebWorker HTML5 CSS3 Bootstrap 微分・積分 システム設計 決断力 LAMP環境 トレ担 教育研修担当者向け ルーティング Linux入門 図解術 目標設定 試験対策 インタビュー技法 Vue.js ブロックチェーン 会社規模 (~50名) DHCP 仕掛け学 BSC 財務諸表 自己分析 RIP スタティックルート バッファオーバーフロー DoS攻撃 システム開発 会社規模 (~99名) Wireshark パケットキャプチャ 管理職研修 部下育成 ワークあり 文章力 情報システム部門向け プロジェクトリーダー プロジェクトマネージャ 塗り絵 リスク管理 法改定 会社の仕組み Chainer AI人材 会話術 会社規模 (~25名) テスト技法 組織規模 51名~99名 組織規模:~199名 [組織規模]199名まで 組織規模 199名まで 組織規模199名まで 会社規模199名まで 会社規模49名まで 会社規模99名まで アプリ開発 サーバサイドJava 営業知識 Cloud 栄養学 基本コマンド ウォーターフォールモデル ヘルスケア 論理設計 ニューラルネットワーク ハンズオン UML 顧客ヒアリング マウスで学ぶ Apache EC2 Lightsail M5Stack DevSecOps プロジェクト成果 画像認識 チャットポット コマンド レビュー 基本用語 自動構築 LPIC-1 サーバーサイドJavascript キャリア形成 ワークライフバランス インバスケット テック用語 GitHub Windows エディタ 教養 令和時代 RESTful API 物理設計 会社規模300名以上 データモデリング サーバーサイドJava Webサーバー基礎 Webサーバー応用 Watson IBMWatson Learning Topics OS モバイル コンテスト トレーニング手法 アーキテクチャ 人材モデル インフラ CI/CD Infrastructure as a Code チーム開発 制度づくり Special_Intro AI市場分析 研修ロードマップ 仕事術 デジタルトランスフォーメーション 財務分析手法 情報整理 PowerPoint

リファクタリングのポイント 研修コースに参加してみた


2020-05-12 更新

今回参加した研修コースは、 リファクタリングのポイント です。

私は今まで “リファクタリング” という言葉からは漠然と、レガシーコードの改善、パフォーマンスの改善、リファクタリング職人といった、限られた人がやる職人技といったイメージを持ってました。

参加してみると、人にわかりやすく、自分も楽できるコーディングのテクニックを、IDEのパワーでカジュアルに取り組めるものだったことがわかり、とても心地よい体験でした !!

教室でも、とても多くのメモを書いていた方が多く、よいリファクタリング体験をされていたのではと思っています。

プログラミングをもっと上手くなりたい、伝わりやすいリーダブルなコードを書きたいという方にはとてもオススメです !!

では、コース内容をレポートします!

コース情報

想定している受講者
  • Javaプログラミングの基礎~中級スキル
  • Eclipseの操作
受講目標 リファクタリングが必要なバッド・コードを識別し、適切なリファクタリングを施すことができるようになる

講師紹介

講師紹介のようなものはなくコースがスタートしましたが、このレポートでは講師を紹介します。

米山 学
JavaはもちろんPython/PHPなどスクリプト言語、Vue/ReactなどJSだってなんだってテックが大好き。原点をおさえた実践演習で人気

過去にはオブジェクト指向を使った開発や多くの書籍を執筆されていましたが、今はもっぱら講師としてご活躍で、SEカレッジではハイエンドな技術コースを主に担当されています。

Amazon.co.jp: 米山 学:作品一覧、著者略歴 – アマゾン

また、年間の 1 / 3 以上を海外遠征も含め山登りされています。

リファクタリングとは

マーチン・ファウラーが生み出した “リファクタリング” という書籍がきっかけ

リファクタリングという言葉が登場する前から、リファクタリングで挙げられたやり方などは存在していたのですが、リファクタリングという言葉とやり方をまとめて書籍としてパッケージしたのは マーチン・ファウラー でした。

マーチン・ファウラーというと、今回のリファクタリングをはじめ、アジャイルソフトウェア開発宣言 や最近では “Microservices”(マイクロサービス) の生みの親の1人でもあります。 テック業界におけるトレンドセッターにも見えてきますね。

今回のコースはマーチン・ファウラーが書いた原著、Refactoring: Improving the Design of Existing Code の翻訳を引用しながら進めます。

リファクタリングとは?

まずはリファクタリングを行う背景から解説いただきました。

コードそのものは機能拡張したり、スピードを優先して「とりあえず動くもの」を追加するたび、劣化していきます。
定期的にリファクタリングすることで、コードを改善できます。

リファクタリングのメリット

  • ソフトウェアの設計を改善する
  • コードをわかりやすくする
  • バグを見つけやすくする
  • より速くプログラミングできる

コードをわかりやすく改善する中でバグを見つけたり、追加しやすくなったり、それらによってスピードも速くなります。

最近話題の DX (Developer Experience) というものに通じるものかも知れませんね。

DX: Developer Experience (開発体験)は重要だ – Islands in the byte stream

いつリファクタリングをやるのか

この「いつやるのか」がとても多くの示唆に富んでいました !! (耳が痛いとも思いました..)

  • 三度目の法則
    • 同じような処理を3回書いたとき
  • 機能を追加する
  • バグフィックス
  • コードレビュー
    • 気付いたらいつやってもよいよとは言っている
  • コードの不吉な臭いを感じたらやるべき
    • “Bad Smells in Code” という言葉はケント・ベックと話していたときに出てきた
    • コードの不吉な臭いカタログがある (!!)

ググるといっぱい出てくるので、興味がある方は調べてみましよう !

リファクタリングの手法

  • 必ずテストを書く
    • Javaであれば JUnit を使いましょう
    • テストしないと、外の振る舞いが全く変わってないのか分かりません
  • リファクタリング後にテストを通して、振る舞いが変わってないことを保証しましょう

そうなんです。テストを書いてないとリファクタリング出来ないんです。

なお、テストを自然と書けるようになりたい、テストが 1 つもないのでどこから始めるかわからない、と思う方はSEカレッジで 「JUnit ではじめる単体テスト入門」( 1 日コース) も開催されていますので、ぜひご参加下さい。
(私もレポートを書きながら学びます!)

では、テストを書いて、どのようにリファクタリングを進めるのか、マーチン・ファウラーの本ではリファクタリングのテクニックを6つのカテゴリに分け、72個のテクニックを紹介しています。

 

1時間程度の解説をへて、ここからはその72のテクニックから幾つかピックアップし、実際にIDE (Eclipse) を使って実際にリファクタリングに取り組みました。

リファクタリング演習

ここからは Refactoring にあるサンプルコードをもとに実際にリファクタリングに取り組みます。

なお、米山さんがこのコースで使えるように、

  • 書かれているコードが10年前なので、ちょっと古く、今回書き直したりしてます
  • コードが抜粋されているので、実行できるようにしてます

予めコードに手を入れたものを用意いただきました。サンプルが動かなかったり、実行できないと勉強しにくいので、とても助かります。

演習内容

  • Eclipse にはリファクタリング支援機能がある (!!) ので、それを使いましょう
    • 原著はもちろん特定のIDEに依存しないやり方を紹介しているので、目を通すことをオススメします
  • よく使うテクニック、目からウロコなテクニックなどを紹介いただきました
  • 取り組んだリファクタリングのテクニックは下の通りです
    • Extract Method (メソッドの抽出)
    • Introduce Explaining Variable (説明用変数の導入)
    • Replace Parameter with Method(メソッドによるパラメーターの置き換え)
    • Introduce Parameter Object(パラメーターオブジェクトの導入)
    • Replace Error Code with Exception(例外によるエラーコードの置き換え)

ここからは実際にどのようにリファクタリングしたのか、紹介します!

Extract Method メソッドの抽出

Before

package composing_methods.extract_method.before;

import java.util.Arrays;

public class Example {

    public static void main(String[] args) {

        int[] sampleData = {9, 2, 7, 3, 6, 1, 5, 4, 8};

        System.out.println("[Before sorting]");
        for(int data : sampleData) {
            System.out.println(data);
        }

        Arrays.sort(sampleData);

        System.out.println("[After sorting]");
        for(int data : sampleData) {
            System.out.println(data);
        }
    }
}

リファクタリングのポイント

  • 不吉な臭いはどこから?
    • for(int data: sampleData) {} が重複している
    • 1つにまとめてしまいましょう
  • ここでEclipseの機能を使いましょう
    • 修正したいところをドラッグ
    • もしくは alt + shift + m でダイアログ表示
    • 新しいメソッドの名前をつけましょう
    • 関連していて、わかりやすいものにしましょう
    • OKを押します
  • リファクタリング完了 (!!)

after

package composing_methods.extract_method.after;

import java.util.Arrays;

public class Example {

    public static void main(String[] args) {

        int[] sampleData = {9, 2, 7, 3, 6, 1, 5, 4, 8};

        System.out.println("[Before sorting]");
        printArray(sampleData);

        Arrays.sort(sampleData);

        System.out.println("[After sorting]");
        printArray(sampleData);
    }

        for(int data : sampleData) {
        System.out.println(data);
        }
    }
}

IDE のパワーはすごいです。とても優秀ですね。

このことを社内のエンジニアに言うと「IDEを体験してしまうと、もうエディタとプラグインだけでは開発できない」とコメントしてました。

Java系のIDEというと、今回使用しているフリーソフトウェアの Eclipse がありますが、有料のIDEだと IntelliJ が人気ですね。 最近では Atom や Visual Studio Code などモダンなエディタでも高機能なものがあります。

と余談しているとどんどん話が広がるので、IDEの機能を紹介するだけでもコースが一つ作れそうです。

Replace Temp with Query メソッドによるパラメーターの置き換え

Before

package composing_methods.replace_temp_with_query.after;

public class Example {

    private int quantity;
    private int itemPrice;

    public double getPrice() {

        int basePrice = quantity * itemPrice;
        double discountFactor;

        if(basePrice > 1000) {
            discountFactor = 0.95;
        } else {
            discountFactor = 0.98;
        }

        return basePrice * discountFactor;
    }
}

リファクタリング1

  • コードの不吉な臭いはどこから?
    • 一次変数があることでメソッドが長くなっている
      • 変数が1回しか使われてない = 再代入されていない
  • 不要に長くならないようにしましょう
  • まず final 宣言をして一次変数にします

リファクタリングの模様

リファクタリング2

  • メソッドを抽出しましょう
  • インライン化しましょう basePrice
    • ドラッグして alt + shift + i でダイアログを表示
  • メソッドもあるのでこれも抽出しましょう discountFactor
  • さらにインライン化しましょう discountFactor
    • これによって他のコードで必要になった場合、他からメソッド呼び出しできるようになりました

リファクタリングの模様2

リファクタリング3

  • さらに discountFactor が重複しているので return にします

リファクタリングの模様3

リファクタリングのコツ

  • basePrice() discountFactor() のようなものは問い合わせメソッドと呼ばれます
  • 上からまず全体を書き、見通しをつきやすくして、詳細は下位のメソッドに書くようにしていくことがコツです

After

package composing_methods.replace_temp_with_query.after;

public class Example {

    private int quantity;
    private int itemPrice;

    public double getPrice() {

        return basePrice() * discountFactor();
    }

    private double discountFactor() {

        if(basePrice() > 1000) {
            return = 0.95;
        } else {
            return = 0.98;
        }
    }

    private int basePrice() {
        return quantity * itemPrice;
    }
}

他にもサンプルコードをもとにリファクタリングのテクニックを体験して、最後に米山さんが “必ずテストを書くこと” を強調して、コースは修了となりました。

まとめ

この研修コースではマーチン・ファウラーの原著にあるサンプルコードをもとに、実際にリファクタリングに取り組みました。

途中で体験したリファクタリングテクニックはやはり知っていないと出来ませんが、”コードの不吉な臭い” がどのようなものかわかりはじめてきました。読みやさ = リーダブルにも通ずるものがありますね。

また、サンプルコードを米山さんの見よう見まねでやってみましたが、リファクタリングのポイントをおさえて、IDEの機能を使えば、とてもカジュアルに取り組めるように感じられました。

プログラミングをもっと上手くなりたい、読みやすいコードを書きたい、という方にはとてもオススメです !!

 

 

label SE カレッジの無料見学、資料請求などお問い合わせはこちらから!!


SEカレッジについて

label SEカレッジを詳しく知りたいという方はこちらから !!

特集・キャンペーン

午前免除 FAQ

タグ一覧