빌더 패턴은 생성 패턴 중 하나로, 생성자가 많을 경우 사용한다. 빌더 패턴을 이용하게 되면 생성자의 필드 순서를 알 필요 없이 필드명을 통해서 손쉽게 객체 생성을 할 수 있다. 그러나 매 객체마다 빌더 패턴을 만드는 것은 번거로운 작업인데 Builder 어노테이션을 사용하면 해결이 가능하다.
CREATE TABLE Treat (
treatId Int PRIMARY KEY,
treatStartDate DATE NOT NULL,
treatSubject INT NOT NULL,
hospitalName VARCHAR(50) NOT NULL,
visitDays INT NOT NULL,
userName VARCHAR(10) NOT NULL,
userIdentity VARCHAR(13) NOT NULL,
prescribeCnt INT NOT NULL,
deductibleAmt INT NOT NULL,
publicCharge INT NOT NULL
);
SQL 쿼리문으로 테이블을 작성해주었음에도 불구하고, column명 에러가 계속 발생하였다. entity 클래스를 확인한 결과 column 이름을 지정해 줄 때 언더바( _ )를 넣어서 DB에서도 언더바로 지정이 되고 있었다.
클래스 선언 앞에 @Repository 어노테이션을 붙이면 해당 인터페이스가 JpaRepository임을 나타낸다.
JpaRepository 인터페이스는 JPA를 좀 더 쉽게 사용할 수 있도록 도와주며, CRUD 기능을 기본적으로 제공한다.
Optional
Optional<T>라는 크래스가 있다. .get()의 경우 결과값이 null일 경우 NoSuchElementException이 발생한다. 값이 없을 경우 orElseThrow()를 통해 예외를 던져줘야 한다. 레포지토리에서 Optional을 반환하는 경우 원하는 값이 있으면 원하는 객체로 받고 없으면 Exception 처리를 할 수 있다.
package com.example.apiServer.service;
import com.example.apiServer.entity.Medication;
import com.example.apiServer.repository.MedicationRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.transaction.annotation.Transactional;
import java.util.Optional;
public class MedicationService {
@Autowired
private MedicationRepository medicationRepository;
// 처방 정보
@Transactional
public Medication findById(Long id){
Optional<Medication> medication = medicationRepository.findById(id);
return medication.get();
}
}
4. DTO 작성하기
DTO는 프레젠테이션 계층에서 클라이언트와 데이터를 주고 받기 위해 존재하는 객체이다. 클라이언트와 프레젠테이션 계층의 통신은 JSON 방식으로 이루어진다. 엔티티는 테이블과 매핑된 데이터로 굉장히 민감한 정보이다. DTO를 사용하면 엔티티는 내부에 숨기고 대신 필요한 데이터만 클라이언트에 넘길 수 있다.
package com.example.apiServer.dto.treat;
import com.example.apiServer.entity.Medication;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.time.LocalDateTime;
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class TreatResponse {
Long id; //진료내역
Long medicationId; //처방내역
LocalDateTime treatStartDate; //진료개시일
int treatSubject; //진료과목
String hospitalName;
String visitDays; //방문일수
int prescribeCnt; //복용기간
int deductibleAmt; //본인부담금
int publicCharge; //공단부담금
}
@NoArgsConstructor
파라미터가 없는 디폴트 생성자를 자동으로 생성한다. 이 어노테이션을 생성하면, 클래스에 명시적으로 선언된 생성자가 없더라도 인스턴스를 생성할 수 있다.
@AllArgsConstructor
클래스의 모든 필드 값을 파라미터로 받는 생성자를 자동으로 생성한다. 이 어노테이션을 사용하면, 클래스의 모든 필드를 한 번에 초기화할 수 있다.
스프링은 클라이언트로 객체를 전달하는 과정에서 Json 직렬화를 실행하고 이를 도와주는 것은 Jackson 라이브러리이다.
즉, JSON에서 JavaObject로 변환하는 과정, medicationRequest가 완성되는 과정에서는 변수 이름을 기반으로 Getter와 Setter 둘 중 하나를 이용해서 DTO 필드를 가져오며, Reflection을 통해 DTO 필드에 주입한다. Setter는 보안상의 이유로 Getter를 사용하고, Reflection을 위해서는 기본 생성자도 필요하다. 빌더 패턴으로 DTO를 만들면 위와 같다.
RequestDTO
ResponseDTO
Getter + 기본 생성자
Getter
* 직렬화- 자바의 객체를 클라이언트로 전달하는 과정에서객체를 JSON 형식을 변환해주는 과정
* 역직렬화- 클라이언트로부터 받아오는JSON 값을 자바의 객체로 변환해주는 과정
5. 공통 응답 형식 생성
모든 Response에서 공통적으로 들어가야 하는 값을 사용하거나, Error가 발생했을 때 일관되게 처리할 수 있도록 하기 위해서 Response를 구조화 할 필요성이 있다.
import com.example.MyPage.api.status.BaseCode;
import com.example.MyPage.api.status.SuccessStatus;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;
@Getter
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@JsonPropertyOrder
public class CommonResponse<T> {
private final Boolean isSuccess;
private final String code;
private final String message;
private T result;
public static <T> CommonResponse<T> ok(T result) {
return new CommonResponse<>(true, SuccessStatus._OK.getCode(),
SuccessStatus._OK.getMessage(), result);
}
public static <T> CommonResponse<T> of(BaseCode code, T result) {
return new CommonResponse<>(true, code.getCode(), code.getMessage(), result);
}
public static <T> CommonResponse<T> onFailure(String code, String message, T result) {
return new CommonResponse<>(false, code, message, result);
}
}
public interface BaseCode {
String getCode();
String getMessage();
}
XML이나 JSON 형태의 데이터를 Java 객체에 매핑할 때 사용하는 어노테이션이다. 주로 POST, PUT 요청에서 사용되며, HTTP 요청의 body 부분에 있는 데이터를 Java 객체로 매핑할 때 사용이 된다.@RequestBody로 지정한 객체는 DTO에 기본 생성자가 있어야 한다.
@ResponseBody
return하는 객체를 해당 타입으로 변환해서 클라이언트로 전달한다.
@RequestParam
주로 GET 요청에서 사용되며, URL의 쿼리 파라미터들을 메소드의 파라미터로 매핑할 때 사용된다.
< 상태 코드 >
200
OK
요청 수행 성공
201
Created
요청 수행 성공 및 새로운 리소스생성
400
Bad Request
요청 값이 잘못되어 요청에 실패
403
Forbidden
권한이 없어 요청에 실패
404
Not Found
요청 값으로 찾은 리소스가 없어 요청에 실패
500
Internal Server Error
서버 상 문제가 있어 요청에 실패
비동기 통신을 하기 위해서는 클라이언트에서 서버로 요청 메세지를 보낼 때 본문에 데이터를 담아서 보내야 하고, 서버에서 클라이언트로 응답을 보낼 때에도 본문에 데이터를 담아서 보내야 한다. 본문에 담기는 데이터 형식에서 가장 대표적으로 사용되는 것은 JSON 이다.
* HTTP Request 구조
Start line
Headers
Body
* HTTP Response 구조
Status line (응답 상태 코드)
Headers
Body
8. DB 구축
use apiserver;
CREATE TABLE Treat (
treatId Int PRIMARY KEY,
treatStartDate DATE NOT NULL,
treatSubject INT NOT NULL,
hospitalName VARCHAR(50) NOT NULL,
visitDays INT NOT NULL,
userName VARCHAR(10) NOT NULL,
userIdentity VARCHAR(13) NOT NULL,
prescribeCnt INT NOT NULL,
deductibleAmt INT NOT NULL,
publicCharge INT NOT NULL
);
CREATE TABLE Medication (
medicationId INT PRIMARY KEY,
treatId INT NOT NULL,
diseaseId VARCHAR(50),
prescribeDays INT ,
treatDate DATE NOT NULL,
FOREIGN KEY (treatId) REFERENCES Treat(treatId)
);
show columns from treat;
select * from treat;
INSERT INTO Treat (treatId, treatStartDate, treatSubject, hospitalName, visitDays, userName, userIdentity, prescribeCnt, deductibleAmt, publicCharge)
VALUES
(1, '2024-04-04', 23, '수연합의원', 1, '김유진', '1234561234567', 1, 10000, 5000);
-- (2, 2, '2024-04-08', 23, '늘푸른연세의원', 1, '김유진', '12345671234567', 1, 8000, 4000),
-- (3, 3, '2024-04-18', 23, '늘푸른연세의원', 1, '김유진', '1234561234567', 1, 8000, 4000),
show columns from medication;
select * from medication;
INSERT INTO Medication (medicationId, treatId, diseaseId, prescribeDays, treatDate)
VALUES
(1, 1, 'J0100', 5, '2024-04-04');
-- (2, 2, 'J0100', 5, '2024-04-08'),
-- (3, 3, 'J0100', 5, '2024-04-18'),
show columns from medidetail;
select * from treat;
