検索機能の作成¶

プロジェクト情報を検索する¶

フォームの作成

クライアントから送信された値を受け付けるフォームを作成する。

ProjectSearchForm.java

public class ProjectSearchForm implements Serializable {

    /** 顧客ID */
    @Domain("id")
    private String clientId;

    /** プロジェクト名 */
    @Domain("projectName")
    private String projectName;

    // ゲッタ及びセッタは省略
}

この実装のポイント

• プロパティは全てString型で宣言する。詳細は バリデーションルールの設定方法 を参照。

検索条件を保持するBeanの作成

検索条件を保持するBeanを作成する。

ProjectSearchDto.java

public class ProjectSearchDto implements Serializable {

    /** 顧客ID */
    private Integer clientId;

    /** プロジェクト名 */
    private String projectName;

    // ゲッタ及びセッタは省略

この実装のポイント

• Beanのプロパティは、対応する条件カラムの定義(型)と互換性のある型とする こと。

検索に使用するSQLの作成

検索に使用するSQLを作成する。

Project.sql

FIND_PROJECT =
SELECT
    *
FROM
    PROJECT
WHERE
    $if(clientId) {CLIENT_ID = :clientId}
    AND $if(projectName) {PROJECT_NAME LIKE :%projectName%}

この実装のポイント

• SQLインジェクションを防ぐため、SQLは外部ファイルに記述する。詳細は SQLをファイルで管理する を参照。
• Beanのプロパティ名を使って、SQLに値をバインドする。詳細は Beanオブジェクトを入力としてSQLを実行する を参照。
• 検索条件として指定された項目のみを条件に含める場合には、 $if 構文を使用してSQL文を構築 する。

業務アクションメソッドの実装

検索条件をもとにデータベースから検索する処理を実装する。

ProjectAction.java

@Produces(MediaType.APPLICATION_JSON)
public List<Project> find(JaxRsHttpRequest req) {

    // リクエストパラメータをBeanに変換
    ProjectSearchForm form =
            BeanUtil.createAndCopy(ProjectSearchForm.class, req.getParamMap());

    // BeanValidation実行
    ValidatorUtil.validate(form);

    ProjectSearchDto searchCondition = BeanUtil.createAndCopy(ProjectSearchDto.class, form);
    return UniversalDao.findAllBySqlFile(Project.class, "FIND_PROJECT", searchCondition);
}

この実装のポイント

• 検索結果をJSON形式でクライアントに返却するため、 Produces アノテーションに MediaType.APPLICATION_JSON を指定する。
• クエリパラメータは JaxRsHttpRequest から取得する。
• BeanUtil を使用してリクエストパラメータからフォームを作成する。
• ValidatorUtil#validate を使用してフォームのバリデーションを行う。
• フォームの値を BeanUtil を使用して検索条件Beanにコピーする。
• ユニバーサルDAO を使用して取得したプロジェクト情報のリストを戻り値として返却する。
• 戻り値のオブジェクトは リクエストボディ変換ハンドラ によってJSON形式に変換されるため、 業務アクションメソッド内で変換処理を実装する必要はない。

URLとのマッピングを定義

ルーティングアダプタ を使用して、業務アクションとURLのマッピングを行う。 マッピングには Jakarta RESTful Web ServicesのPathアノテーション を使用する。

ProjectAction.java

@Path("/projects")
public class ProjectAction {
  @GET
  @Produces(MediaType.APPLICATION_JSON)
  public List<Project> find(JaxRsHttpRequest req) {

      // リクエストパラメータをBeanに変換
      ProjectSearchForm form =
              BeanUtil.createAndCopy(ProjectSearchForm.class, req.getParamMap());

      // BeanValidation実行
      ValidatorUtil.validate(form);

      ProjectSearchDto searchCondition = BeanUtil.createAndCopy(ProjectSearchDto.class, form);
      return UniversalDao.findAllBySqlFile(Project.class, "FIND_PROJECT", searchCondition);
  }

この実装のポイント

• @Path アノテーションと @GET アノテーションを使用して、GETリクエスト時にマッピングする業務アクションメソッドを定義する。