3.2.3.1. 登録機能の作成¶

3.2.3.1.1. 登録を行う¶

1. フォーマットファイルの作成
2. フォームの作成
3. 業務アクションの作成

フォーマットファイルの作成

HTTPメッセージングでは、リクエストされたHTTPメッセージを 汎用データフォーマット を使用して解析する。

ProjectSaveAction_RECEIVE.fmt

file-type:        "JSON"
text-encoding:    "UTF-8"

[project]
1  projectName                       N
2  projectType                       N
3  projectClass                      N
4  projectStartDate[0..1]            N
5  projectEndDate[0..1]              N
6  clientId                          X9
7  projectManager[0..1]              N
8  projectLeader[0..1]               N
9  note[0..1]                        N
10 sales[0..1]                       X9
11 costOfGoodsSold[0..1]             X9
12 sga[0..1]                         X9
13 allocationOfCorpExpenses[0..1]    X9
14 userId[0..1]                      X9

この実装のポイント

• フォーマットファイルの名称は、「リクエストID + “_RECEIVE”」という形式にする。
• フォーマットファイルの記述方法は フォーマット定義ファイルの記述ルール を参照。

フォームの作成

リクエストボディの内容をバインドするフォームを作成する。

ProjectForm.java

public class ProjectForm {

    // 一部項目のみ抜粋

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

    /**
     * プロジェクト名を取得する。
     *
     * @return プロジェクト名
     */
    public String getProjectName() {
        return projectName;
    }

    /**
     * プロジェクト名を設定する。
     *
     * @param projectName 設定するプロジェクト名
     *
     */
    public void setProjectName(String projectName) {
        this.projectName = projectName;
    }
}

この実装のポイント

• Bean Validation を用いてバリデーションを行うため、バリデーション用のアノテーションを設定する。

業務アクションの作成

プロジェクトをDBに登録する業務アクションを作成する。

ProjectSaveAction.java

public class ProjectSaveAction extends MessagingAction {

    /**
     * 電文を受信した際に実行される業務処理。
     * <p>
     * プロジェクト情報をバリデーションし、DBに登録する。
     * このメソッドは、一つのプロジェクトを登録するための処理である。
     * (汎用フォーマットによる形式チェックにより単独プロジェクトであることが保証される)
     * </p>
     * 登録が完了した場合は、レスポンスコードを記載した応答電文を設定する。
     * 例外が発生した場合は、{@link ProjectSaveAction#onError(Throwable, RequestMessage, ExecutionContext)}
     * にて応答電文を設定する。
     *
     * @param requestMessage   受信したメッセージ
     * @param executionContext 実行コンテキスト
     * @return 応答電文
     */
    @Override
    protected ResponseMessage onReceive(RequestMessage requestMessage,
                                        ExecutionContext executionContext) {

        // 入力値をフォームにバインドする
        ProjectForm form = BeanUtil.createAndCopy(ProjectForm.class,
                requestMessage.getParamMap());

        // バリデーションエラーがある場合は業務例外を送出
        ValidatorUtil.validate(form);

        UniversalDao.insert(BeanUtil.createAndCopy(Project.class, form));

        // 応答電文のフォーマッタを作成する
        requestMessage.setFormatterOfReply(createFormatter());

        // 応答電文に記載するステータスコードを設定する
        Map<String, String> map = new HashMap<>();
        map.put("statusCode", String.valueOf(HttpResponse.Status.CREATED.getStatusCode()));

        // 応答データ返却
        return requestMessage.reply()
               .setStatusCodeHeader(String.valueOf(HttpResponse.Status.CREATED.getStatusCode()))
               .addRecord("data", map);
    }
}

この実装のポイント

• MessagingAction を継承し、業務メソッドを作成する。
• MessagingAction#onReceive に、リクエスト受信時に実行する処理を実装する。
• リクエストボディの値は、 汎用データフォーマット を使用して解析された状態で引数の RequestMessage オブジェクト が保持している。 getParamMap メソッドを使用してリクエストボディの値を取得する。
• Bean Validation を使用してリクエスト値のバリデーションを行う。
• UniversalDao を用いてプロジェクトをDBに登録する。
• 処理結果を表すレスポンスコードを ResponseMessage に設定して返却する。

補足

業務例外が送出された場合は、 HTTPメッセージングエラー制御ハンドラ の処理によってレスポンスコード「400」が設定される。