【はじめてのJava】ダッシュボードAPIを作成しよう！②コース情報取得編

{
  "corporateId": 1
}

{
    "errorMessageList": null,
    "courseList": [
        {
            "course_id": 1,
            "corporate_id": 1,
            "course_name": "プログラミング基礎",
            "create_date": "2024-06-01T01:00:00.000+00:00",
            "update_date": "2024-06-01T01:00:00.000+00:00"
        },
        {
            "course_id": 2,
            "corporate_id": 1,
            "course_name": "データベース管理",
            "create_date": "2024-06-15T00:00:00.000+00:00",
            "update_date": "2024-06-15T00:00:00.000+00:00"
        }
    ]
}

package jp.co.smsdatatech.questiongenerate.entity;

import java.io.Serializable;
import java.sql.Timestamp;

import jakarta.persistence.Column;
import lombok.Data;

/**
 * courseテーブルEntity
 */
@Data
public class CourseEntity implements Serializable {

    /** シリアルバージョンUID */
    private static final long serialVersionUID = 1L;

    /** コースID */
    private Integer course_id;

    /** 法人ID */
    private Integer corporate_id;

    /** コース名 */
    private String course_name;

    /** 作成日 */
    private Timestamp create_date;

    /** 更新日 */
    private Timestamp update_date;
}

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="jp.co.smsdatatech.questiongenerate.repository.CourseMapper">
    <select id="getAllByCorporateId" parameterType="Integer" resultType="jp.co.smsdatatech.questiongenerate.entity.CourseEntity">
        SELECT
            course_id,
            corporate_id,
            course_name,
            create_date,
            update_date
        FROM
            course
        WHERE
            corporate_id = #{corporateId}
        ORDER BY
            course_id
    </select>
</mapper>

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import jp.co.smsdatatech.questiongenerate.entity.CourseEntity;
import jp.co.smsdatatech.questiongenerate.repository.CourseMapper;

/**
 * コーステーブルService
 */
@Service
public class CourseService {

    /** ログ出力クラス */
    private static final Logger log = LoggerFactory.getLogger(clazz:CourseService.class);

    /** courseテーブルMapper */
    @Autowired
    private CourseMapper courseMapper;

    /**
     * コース検索（法人ID検索）
     * 1.機能概要
     * courseテーブルから法人IDに紐づくコースを取得し、Listで返却する。
     * 2.処理フロー
     * ①DB接続・抽出
     * ②返却
     *
     * @param corporateId 法人ID
     * @return {@literal List<CourseEntity> コース一覧}
     */
    public List<CourseEntity> getAllByCorporateId(Integer corporateId) {
        List<CourseEntity> courseList = courseMapper.getAllByCorporateId(corporateId);
        log.info("courseテーブルから法人ごとのレコードを取得しました。");
        return courseList;
    }
}

/**
 * コースリスト取得.
 *
 * 法人IDに紐づくコースリストを取得し、CorporateCourseResponseForm に詰めて返却する。
 *
 * <h3>処理フロー</h3>
 * 1. コース情報（コースIDとコース名）を取得<br>
 * 2. 取得したリストを返却
 *
 * @param form Top画面Form
 * @param result バリデーション結果
 * @return コースリスト CorporateCourseResponseForm
 */
@PostMapping("/top/getCourseListByCorporateId")
public CorporateCourseResponseForm getCourseListByCorporateId(@RequestBody @Valid TopForm form,
        BindingResult result) {
    log.debug("TopRest (getCourseListByCorporateId) 呼び出し開始");

    CorporateCourseResponseForm responseForm = new CorporateCourseResponseForm();
    List<String> errorMessageList = new ArrayList<>();

    Set<String> processedFields = new HashSet<>();

    // バリデーションエラーがある場合、詳細なエラーメッセージを追加
    if (result.hasErrors()) {
        for (FieldError fieldError : result.getFieldErrors()) {
            // フィールド名を基に重複チェック
            if (!processedFields.contains(fieldError.getField())) {
                String errorMessage = messageSource.getMessage(fieldError, Locale.getDefault());
                errorMessageList.add(errorMessage);
                processedFields.add(fieldError.getField());
            }
        }
        responseForm.setErrorMessageList(errorMessageList);
        return responseForm;
    }

    // 法人IDを整数に変換
    Integer corporateId = Integer.parseInt(form.getCorporateId());

    // 法人IDを基にコースリストを取得
    List<CourseEntity> courseList = courseService.getAllByCorporateId(corporateId);

    if (CollectionUtils.isEmpty(courseList)) {
        // コースが見つからなかった場合
        errorMessageList.add(messageSource.getMessage(ErrorMessages.COURSE_NOT_FOUND, args:null, Locale.getDefault()));
        responseForm.setErrorMessageList(errorMessageList);
        log.debug("CourseRest (getCourseList) コースが見つかりません: ");
        return responseForm;
    }

    // コースリストをレスポンスに設定
    responseForm.setCourseList(courseList);
    return responseForm;
}