操作
メソッド名¶
メソッド名の命名は、**「そのメソッドが何をするかを一目で理解できる」**ことが最も大切です。以下に、良い命名の原則と具体的なガイドラインを整理してご紹介します。
✅ 1. 基本原則：命名で「動作」と「対象」がわかるように ¶
| 要素 | 内容の例 | 説明 |
|---|---|---|
| 動詞 | set / update / load / build / create | 何をするか（動作）を表す |
| 対象 | CustomerData / Header / Status / DTO | どのデータに対する処理か（対象） |
| 情報の出所 | fromDB / fromForm / fromRequest / fromXxx | 必要に応じて出所を明示 |
| 情報の用途 | ForUpdate / ForInsert / ForDisplay など | 処理目的が限定的なら加える |
✅ 2. 一般的なパターン別 命名例 ¶
| 処理内容 | よくある命名パターン例 |
|---|---|
| 値の設定 |
setXxx / populateXxx / fillXxx
|
| 値の取得 |
getXxx / extractXxx / fetchXxx
|
| 条件チェック |
isValidXxx / checkXxxCondition
|
| データ生成 |
createXxx / buildXxx
|
| 加工・変換処理 |
convertXxxToYyy / mapXxxToYyy
|
| 更新用フィールド準備 |
prepareXxxForUpdate / setUpdateFieldsToXxx
|
| 保存 |
saveXxx / persistXxx
|
| 削除 |
deleteXxx / removeXxx
|
✅ 3. Javaらしい命名例（プロパティ操作系） ¶
| 目的 | メソッド名例 |
|---|---|
| DTOに他オブジェクトから値をセット | populateDtoFromEntity() |
| データ更新用に構造体を準備 | prepareStructureForUpdateFromData() |
| 入力フォームからエンティティに値をマッピング | mapFormToEntity() |
| 特定の条件でエンティティを初期化 | initializeCustomerIfNew() |
✅ 4. アンチパターン（避けたい命名） ¶
| 悪い例 | 問題点 |
|---|---|
doIt() / handle()
|
何をするか不明 |
setData() |
どんなデータを設定するのか曖昧 |
update() |
何を更新するのか、どういう処理なのか不明 |
method1() / aMethod()
|
内容が全く伝わらない |
🔚 補足：英語が長すぎると感じたら¶
プロジェクト内で短縮表現（略語や共通プレフィクス）を使うこともOKですが、一貫性が何より重要です。
必要であれば、あなたのプロジェクトの他のメソッド名と整合性をとった命名案を一緒に考えることもできます。気軽にお知らせください！