skillup

技術ブログ

アーキテクト設計全般 プログラミング全般

抽象性と可読性のトレードオフに関して

投稿日:2022年12月10日 更新日:

私自身プログラムを書く場合、とにかくコードを書く量を制限したいという思いが強く、多少でも共通化できる箇所がある場合はなるべく共通化するようにしておりましたが、時と場合によっては過剰に共通化したことによって可読性が下がり、結果として保守しにくくなるということもありました。(特に可読性が落ちることが多いです。)

直近で悩んだテーマ

類似のクラス

例えばDogとCatみたいなクラスがあるとします(あえて内部にどのようなメソッドがあるかはここでは書かずに説明させていただきます。)

  1. 共通化してAnimalのようなクラスにしてしまう
  2. DogとCatの親クラスを作り、継承する
  3. DogとCatをのクラスをあえて共通化させず残す

上記のような3つの選択肢があり、私としては1(妥協して2)の選択肢が最適と考えることが多かったですが、正しいかどうかはケースバイケース(DogとCatの類似性)になります。

コードを書くときは書く以上に、読みやすいか(仕様がわかるか)というのも同じぐらい大切になってきます。

コードを書く量で考えると3>2>1のようになることが多いですが(3が一番ダメで1がベスト)、可読性も3>2>1(3がベストで1がダメ)になることがあり得ます。

変数の統合

また編集画面などで大量の入力項目がある際に以下のように引数がずらずら並ぶのは基本的にNGでなるべく少ない変数にした方がいいと考えて案1→案2のようなケースを考えておりました。

この場合変数が増えることが往々にして多く、案1の場合、その度に修正が発生します。

案1

案2

ただ案2の方が優れた書き方かというとそんなことはありません。確かに変数が増えるなどの影響には強いのですが、デメリットとしては

「連想配列だと内部にどんな変数が入っているかがわからず、内部構造を隠蔽されてしまい、他者からは分かりにくい」

というデメリットがあり、一概に推奨はできないです。変数を統一することで、可読性が減ってしまっているというデメリットがあります。

その場合、personalのようなオブジェクトを作るという選択肢もありますが、そうしますと案1と同等になり、コードを書く量としてはそれほど大差ないかと思います。

動的な呼び出し

メソッドを呼び出す場合に類似性が高かったり、数が多いとループから動的な関数あるいは変数を作ったりすることも多かったのです。

こうすることで一気にコード量を減らすことは確かにできますし、類似の変更があったときに、メンテが非常に楽ということもありますが、定義元が変更した場合に修正の影響をエディタの補完機能などでさがせないというリスクもあります。

まとめ

このように抽象度を上げたりすると一般的にコードの量は減るのですが、その分可読性が減るというデメリットもあります。

大切なことは

  • 保守性(メンテナンスのしやすさ、修正時間)
  • テストのしやすさ
  • 可読性(他者が読んで読みやすいか)
  • 統一性(可読性の一種ですが、他の箇所と処理が統一されているか否か)

を考慮してそれぞれにメリット、デメリットを考えられることかと思います。

-アーキテクト設計全般, プログラミング全般
-

執筆者:


comment

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

関連記事

no image

コメントについて

リーダブルコード 第5・6章はコメントについて。 今回はコメントです。ここは結構賛否両論になるところではないかと思います。 ざっくり分けると「できるだけコメントは詳しく書くこと」という意見と「コメント …

no image

リーダブルコードまとめ

リーダブルコードほぼ読み切ったのでまとめを。チェックリスト化して、常にこれを見ながらコードは書いたほうがよさげ 前半のまとめや参考リンクでみたものとマージします。 Contents1 変数の名称2 コ …

no image

トークン認証に関して

Contents1 トークンでの認証2 Laravelでのtoken トークンでの認証 APIアプリケーションを作る場合、認証方式としてはクッキーとセッションを利用したものよりもトークンを使った認証方 …

no image

API仕様書に関する注意事項

API仕様書を作っていて、基本的な点についてのまとめ コードと連動できれば理想(現実的には設定ファイルをJSONかYamlで作るぐらいが限界だと思う) 型のチェック、必須チェック、桁数チェック、日付の …

no image

テスト環境のデータ作りに関して

単体テスト以降の環境ですとテストのデータを作ることがなかなか大変だと思います。マスタなどはそのままもらうこともあると思いますので、主にトランザクションデータについて。 以前もこのネタに関しては色々書い …

アーカイブ