0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

メソッド設計について

Posted at

メソッド設計とは
オブジェクト指向プログラミング(OOP)や関数型プログラミングなど、さまざまなプログラミングパラダイムにおいて「メソッド(メンバー関数)」や「関数」は、コードを再利用可能かつ保守しやすい部品に分解するための重要な概念です

この「メソッド設計」は、メソッドをどのように分割・命名し、どのような引数・戻り値を取らせ、どのように責務を持たせるかを検討する作業を指します。

1. メソッド設計の基本原則

1-1. 単一責任の原則(Single Responsibility Principle)
メソッドは「一つのこと」に集中して行うように設計することが重要です。

良い例: calculateTotalPrice() というメソッドであれば、単に合計金額を計算する責務だけを持たせる。
悪い例: メソッドの中で商品の合計金額を計算しつつ、在庫管理やログ出力など複数の責務を抱える。
メソッドがあまりにも多くのことをやり始めると、保守やテストが難しくなります。単一責任を意識して、メソッドをできるだけ小さく分割することが望ましいです。

1-2. 命名規則
メソッド名は、そのメソッドが「何をするか」を明確かつ簡潔に示すものであるべきです。

なるべく動詞を先頭に置き、目的や役割を表現する。
get, calculate, find, create, set などの動詞を適切に使う。
英語であればなるべくパスカルケースまたはキャメルケースを用いる (言語やチームのコーディング規約に準拠)。
メソッド名と役割を一貫させる(命名が変わったら、処理内容も見直す)。
例:

calculateTaxAmount()
fetchUserData()
updateUserProfile()

1-3. 引数と戻り値の設計
メソッドに与える引数の数や戻り値の型は、メソッドの使いやすさに直結します。

引数の数は最小限に
パラメータが増えすぎると、メソッドの使い方を理解しにくくなる。
必要であれば、オブジェクトやDTO(Data Transfer Object)にまとめるなどして整理する。
戻り値の型は明確に
意図しない型変換やラップは避け、呼び出し側が理解しやすいデータ型にする。
例外処理やエラーコードなどが必要な場合は、戻り値を複合型で返したり、例外をスローしたりするなど一貫したルールを設ける。

1-4. 副作用の管理
メソッドを呼び出すことで、外部の状態が変更されるのか、それともただ計算結果を返すだけなのかを明確にします。

副作用が無い(Pure Function): 入力が同じならば必ず同じ結果を返す。状態変更を行わない。
副作用がある: 例として、DBへの書き込みやファイル書き込みなど。
副作用があるメソッドはテストしにくくなる傾向があります。そのため、副作用が必要な処理とそうでない処理を分割することで可読性やテスト容易性を高めることができます。

2. 設計の流れとポイント

メソッドを設計する際に意識したいステップやポイントを紹介します。

2-1. 処理の明確化
最初にメソッドで実装したい「具体的な処理内容」を明確にします。

入力と出力は何か?
どのような処理が必要か?
処理結果を誰(どの部分)が利用するのか?
これらを整理しながら、仕様の「抜け」や「重複」を発見しやすくなります。

2-2. メソッド名の決定
処理が明確化したら、その内容がひと目でわかるメソッド名を考えます。

「calculate」「validate」「fetch」「update」「delete」などの動詞を先頭に置き、処理の対象を後ろに続ける。
名前の長さが長くなりすぎる場合は、凝縮度を高めたり、命名規則で略語を使う場合はチームで合意する。

2-3. 引数リストの整理
考えた処理の中で本当に必要な引数はどれかを再確認します。

もし引数が 3 個以上になるなら、オブジェクトにまとめることを検討する。
変更がありそうなパラメータはオブジェクトにまとめる、あるいはバリアントとして別メソッドを用意するなど、変更に強いデザインを心がける。

2-4. 返却値の設計
基本的には「処理結果」を返す。
返す情報が増えすぎる場合はデータクラスやDTOにまとめるなど、複数の値を整理して返す。
例外をスローするか、失敗を戻り値で表現するかも検討する。

2-5. 実装レベルの注意点
コードは読みやすく、保守しやすい形にする(コメントが多すぎるよりは、意図がわかる変数名や処理順序で表現)。
長すぎる処理はメソッドを分割し、小さい単位に切り出す。
ループや条件分岐が複雑になる場合は、部分的に別メソッドへ抽出するなどして複雑度を下げる。

3. メソッド設計のベストプラクティス例

以下の例は、商品リストから指定したカテゴリの商品だけを抽出し、合計価格を計算したい場合を想定したものです。

// 悪い例
public double getCategoryPriceSum(List<Product> products, String category) {
    double sum = 0.0;
    for (Product p : products) {
        // カテゴリチェック
        if (p.getCategory().equals(category)) {
            // 合計価格を計算
            sum += p.getPrice();
            
            // 在庫減らす(!本来ここで行う処理ではない)
            p.setStock(p.getStock() - 1);

            // ログ出力(!本来ここで行う処理ではない)
            System.out.println("在庫を減らしました: " + p.getName());
        }
    }
    return sum;
}

上記の悪い例では、以下の問題があります。

メソッド名と行っている処理の内容が合っていない(在庫操作やログ出力までやっている)。
単一責任の原則に反している

そこで、処理を分割した例が以下です

// よい例
public double calculatePriceSumByCategory(List<Product> products, String category) {
    List<Product> filteredProducts = filterProductsByCategory(products, category);
    return calculateTotalPrice(filteredProducts);
}

private List<Product> filterProductsByCategory(List<Product> products, String category) {
    return products.stream()
                   .filter(p -> p.getCategory().equals(category))
                   .collect(Collectors.toList());
}

private double calculateTotalPrice(List<Product> products) {
    return products.stream()
                   .mapToDouble(Product::getPrice)
                   .sum();
}

// 在庫の更新やログ出力は別途行う
public void decrementStock(Product product, int amount) {
    product.setStock(product.getStock() - amount);
    System.out.println("在庫を減らしました: " + product.getName());
}

calculatePriceSumByCategory: カテゴリに合わせて商品を絞り込み、合計価格を計算して返すところまでに責務を絞っている。
filterProductsByCategory: 商品リストのフィルタ処理だけを行う。
calculateTotalPrice: 渡された商品リストの合計金額を算出するだけに責務を集中している。
在庫減らしやログ出力などの副作用は、別メソッドとして分けることで、目的ごとにテストしやすくなっている。

4. まとめ

メソッド設計では、

単一責任
わかりやすい命名
引数や戻り値を簡潔に
副作用を管理する

といった点を常に意識することが重要です。
メソッドはアプリケーションの基礎的な構成要素であり、設計が適切であれば、コードの可読性・保守性・拡張性が大幅に向上します。短くシンプルで、役割が明確なメソッドに分割していくことで、より品質の高いソフトウェアを開発することができるでしょう。

0
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?