メソッドのJavaBeans命名規則―daoパターンのdtoクラスに使われる規則

daoパターンのdtoクラスに使われる規則でもある、JavaのメソッドのJavaBeans命名規則についてまとめています。

▲記事トップへ

メソッドのJavaBeans命名規則

変数の値を設定したり、取得するメソッドをつくることは結構あります。 このような設定と取得の目的で作成されているメソッドをそれぞれセッター、ゲッターと呼ばれます。 頭にsetやgetを付けると分かりやすい、そのようにルール化されています。

メソッドのJavaBeans命名規則は、以下のとおりです。

• ゲッターメソッドの名前

  getで始まり、先頭文字を大文字にしたプロパティ名が続きます。

• セッターメソッドの名前

  setで始まり、先頭文字を大文字にしたプロパティ名が続きます。

このルールは、例えばJavaのデザインパターンの1つのDAOパターンで用いられるデータ転送オブジェクトのDTOクラスにも使われていいます。 DAOパターンのDTOについては、下の方補足いたします。

JavaBeans

上述のメソッドの命名規則は、いくつかの規則によってつくられたJavaBeasクラスの規則の一部です。 ここでは、JavaBeansについて少し詳しく見ていきます。

JavaBeansとは

JavaBeansとは、コードの再利用性を高めることを目的にしたクラス設計のための仕様のことです。 この仕様（一定の構文規則）にのっとって記述されたJavaクラスをBeanといいます。

プログラムを部品化して、複数の開発者間での共有やコードの再利用を容易にしたり、 出来合いのBeanやソフトメーカから提供されるBeanを組み合わせてアプリケーションソフトを 開発して、開発効率を上げることを目的にしています。

なお、EJB（Enterprise JavaBeans）と名前が似ていますが、まったく違う仕様なので注意が必要です。

JavaBeansの規則

JavaBeansは、いくつかの規則によって定義されるJavaクラスですが、 この規則には、その変数とメソッドの命名規約も含まれています。

JavaBeansの7つの規則

• メンバ―変数へのアクセスは、ゲッターとセッターメソッドのみ

  プロパティと呼ばれるクラスのメンバ―変数は、privateにします。 プロパティと呼ばれるprivate変数には、そのゲッターメソッドとセッターメソッドを通じてのみアクセスできます。

• メンバ変数は先頭が小文字、単語の区切りの頭文字は大文字

  プロパティの命名規約として、名前の最初の単語の先頭文字は小文字で、名前のその後に続く単語の先頭文字は大文字にします。 例）myName

• プロパティの値を取得できるゲッターメソッド

  プロパティの値を取得できるゲッターメソッドがあります。 ゲッターメソッドの名前はgetで始まり、プロパティの名前が続きます。 各単語の先頭文字は大文字にします。 例）getMyName()

• プロパティの値を設定できるセッターメソッド

  各プロパティには、プロパティの値を設定できるセッターメソッドがあります。 セッターメソッドの名前はsetで始まり、プロパティの名前が続きます。 各単語の先頭文字は大文字にします。 例）setMyName()

• ゲッターメソッドとセッターメソッドはpublic

  ゲッターメソッドとセッターメソッドは、このJavaBeansを使用するすべてのユーザが呼び出せるように publicとする。

• セッターは戻り値がvoidで引数はプロパティと同じ型

  セッターメソッドの戻り値の型はvoidで、対応するプロパティの型を表すパラメータを持つ必要があります。

• ゲッターは引数なし、戻り値はプロパティと同じ型

  ゲッターメソッドはパラメータを持たず、その戻り値の型は、対応するプロパティの型に一致します。

daoパターンのdtoクラス

daoパターンのdtoクラスについての補足です。

daoパターン

daoパターンはアプリケーションのロジックとデータベースやファイルなどのデータへのアクセスロジックを分離して、すっきりさせるデザインパターンです。 daoパターンを使用すると、データアクセスとアプリケーションロジックが分離され、依存度が低くなり、データアクセスやアプリケーションロジックの修正が楽になります。

dtoクラス

daoパターンでは、アプリケーションロジックとデータアクセスロジック間のデータのやり取りにdtoクラスを使います。 dtoクラスは、データ・トランスファー・オブジェクトの略です。

dtoクラスは、呼出元のアプリケーションロジックからデータアクセスオブジェクトであるDAOに渡すデータとその逆方向のデータをカプセル化して、オブジェクトとしてやり取り可能にするためのクラスです。

dtoクラスの命名規則・構成

dtoクラスの命名規則は、JavaBeans命名規則と同じでprivateなメンバ変数を用意して、それに対するsetterとgetterを用意します。 dtoに構成するデータは、一般的に関係データベースならテーブル内の1レコードを、1つのdtoにすると整理しやすいといわれています。

もっと知識を広げるための参考

• Javaのメソッドとは

  Javaのメソッドとは何かについてまとめています。クラスメソッド、staticメソッドの説明、mainメソッドやコンストラクタについてもまとめています。

• Java言語

  Javaとは？から言語の枠を超えるところまで、Java言語についてまとめています。

戻る