リファクタリング勉強会

こんにちは。技術チームの柴田です。

2021年になって初めての勉強会が開催されましたので、共有させていただきます。

今回は高崎さんによるリファクタリングについての勉強会でした。

■リファクタリングとは

ソフトウェアの外部から見た振る舞いは変更せずに、内部の仕組みを改良することです。

リファクタリングは一般に難しいと言われることが多いようですが、どうして難しいのか実務的な面で見ていくと以下のような点が挙げられるようです。

・既存の動いているコードを触るとどうなるかわからないので不安

・新機能の開発ではないので利用者側からのメリットが分かりにくい

大小あると思いますが、上のような問題はどこの開発でも起きているのではないでしょうか?

では実際にリファクタリングを行った時のメリットはなんでしょうか?

考えられるものは以下のような点です。

・内部構造が統一化、簡素化、抽象化されているため、構造の把握がしやすく、新機能の追加や、修正が行いやすい

ずいぶん昔に書いたコードで忘れてしまっている部分・他の人が書いたコードで仕様をそれほど知らない部分などの修正の時に、

複雑なコードだと途方もない時間がかかることがあると思います。

ユーザーから見て簡単そうに見える部分も裏側ではとんでもないほど複雑な処理をしているということはあると思います。

リファクタリングを継続的に行うことでこうした複雑な部分を少しでも減らすことは大きなメリットと言えるでしょう。

ではリファクタリングはどのような観点で行っていくのか見ていくことにします。

■リファクタリングの観点 – テストと関数化 –

● テストについて

リファクタリングにおいてテストを書くことは重要です。テストには２種類あります。

white-box testing

・アプリケーションの内部構造をテストするソフトウェアテストの手法である。構造テストとも呼ばれる。開発したソフトウェアを中身が見える箱として扱い、内部論理を網羅的にテストする。プログラムが辿る経路をどれだけ実行したかを基準とする。

black-box testing

・内部構造や動作を覗き見することなく、アプリケーションの機能を調べるソフトウェアテストの手法のこと。アプリケーションを見えない箱として扱い、入力と結果の整合性を確認する。このテスト方法は、ソフトウェアテストのすべてのレベル(単体テスト、統合テスト、システムテスト、受け入れテスト)に適用できる。仕様ベースのテストと呼ばれることもある。

今回の勉強会ではwhite-box testingについて説明してもらいました。

きちんとテストを書いてリファクタリングをしていますか?

もし書いていない場合には、それは一種の賭けのようなものです。

既存コードとの矛盾や、予期せぬエラーに遭遇する確率が跳ね上がります。

それは非常に危険で、リファクタリングをする意味が薄れてしまいます。

リファクタリングをする際には必要に応じてテストを追加します。

テストをパスすることを確認しながら少しずつリファクタリングをしましょう。

● 関数(メソッド)化

役割が複数ある関数などは小さくできるだけ役割が一つになるように関数を分割することが必要です。

またプログラミングの抽象度を統一すると良いそうです。例をあげます。