リファクタリング プログラミング

メソッドを切り出すメリット。リーダブルなコードで行こう!

投稿日:

概要

大きなクラス、長いメソッドを書いたり読んだりしていて、ロジックが追えなくなってきています。
私の周りではすごく理解が良く、長い処理でも追っていける人がいますが私はそうではありません。

私はごくごく短いロジック、意図が明確な名称でないとちゃんと頭に入りません。
読み返してももう一回理解し直さなくてはならなかったりとかで、結構つらいものがあります。

そんな私が自分自身に対して、もっと短くて、もっとわかり易くて、もっと美しいコードを書きたいという思いと、周りの人にもそのようにしてほしい(自己都合)という願いで執筆しました。
 

実装例

リーダブルでないコード

Q. さて、このコードは何を行っているでしょうか?

A. エラーがある場合は全てを表示する。

簡単なコードなので見てすぐわかる人にはわかると思いますが、
見にくく(醜く)ないですか?

私は見にくいです。
それに、視覚的に頭に入ってきません。
これをリーダブルに変えます。
 

リーダブルなコード

 
<改善ポイント>

  • 各変数で正確な意味が表現されている。
  • ロジックがメソッド名で明確に表現されている。
  • ifのネストが無くなり、判定ロジックが独立するようになった。(メンテナンスしやすい!)
  • エラーを追加する列の位置を合わせたので、見やすくなっている。

 
実際、現場で自分またはレビュー対象のコードをリーダブルにしようと思ったら、これくらいの単位から行うものなんじゃないかと思う。

リーダブルであることは「文化」なので、読みにくいコードを書いているプロジェクトや会社ではそもそもリーダブルにしようとすることを多くの人が諦めているだろうと思っています。

でも諦めないでほしい!
まずは自分から、ちょっとでも読みやすいコードを書こう!
ソースコードだけじゃなく、設計書もリーダブルにしていこう!
理解しやすいとコミュニケーションロスがなくなって、仕様が明確になって、手戻りが減る!
良いこと尽くめ!!

私も今のプロジェクトで悪戦苦闘しながら、少しでもリーダブルになる努力を続けています。
 

まとめ

  • 変数やメソッド名で意図を明確に表現するとわかり易い。
  • 列を揃えると、思いのほか読みやすい!
  • ifをネストしないのは読みやすさの定番。
  • 自分の状況がどうであれ、リーダブルに行こう!

 
最後までお読み頂き、ありがとうございました!
ご意見・ご要望がありましたら、遠慮なくコメント下さい!
もし内容が良かったらランキング評価を頂けると励みになります(^^)

ランキング評価する

-リファクタリング, プログラミング
-,

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA


関連記事

【SpringBoot入門】#10~ 更新機能の実装

概要 既に登録済みの書籍情報を画面上で編集し、更新する処理を実装します。 更新した内容が反映されていることを確認するところまでを行います。   フロントエンド 更新情報のリクエスト edit.html …

【Java】オブジェクト指向の練習題材(成績オブジェクト)

前回記事、オブジェクト指向とは何なのかを簡単に説明してみるの練習題材です。 ここでは2つのオブジェクトを作成していきます。 成績オブジェクト:教科と点数などを保持 生徒オブジェクト:氏名と成績を保持 …

【Java】オブジェクト指向の練習題材(会員オブジェクト)

前回記事、オブジェクト指向とは何なのかを簡単に説明してみるの練習題材です。   仕様 以下の会員クラスを作成し、Mainクラスで表示する。 会員クラスには、「会員」という単位で持つことできる …

【Java入門】インターフェースの使い方まとめ

概要 インターフェースとは、内部実装を知る必要なく、利用する機能の接点のみを提供する仕組みです。 接点をソフトウェア的にいうと、メソッドのシグネチャと戻り値の型に当たります。 つまり、どんなメソッドに …

【Java入門】メソッドとは?使い方まとめ

概要 メソッドとは何か? また使い方をわかり易く説明します。   メソッドとは? 固く言うと、一連の処理を一つにまとめたものです。 平たく言うと、何らかの処理を1つにまとめたものです。 例 Syste …

記事を探す

SpringFramworkの良書

■おすすめ教材
Javaの基本を学んだ人が、次のステップとして読む本(中級者向け)

※SpringはJavaのFrameworkの1つです。
変更のしやすさ、保守性の高さが特徴です。