[Spring Boot🌿]_CRUD 게시판 만들기(2) (패키지 구조, DB,DTO)

그룹스터디에서 '무작정 게시판 만들기'프로젝트를 진행중이다. 
사실 나는 자바로 토이프로젝트까지는 해본 경험이있지만 Spring, SpringBoot는 전혀 사용경험이 없어 
하나하나 모두 막막했지만 스터디 팀장님의 엄청난 캐리로 조금씩 이해하고 있는 중이다. 감사함니다.. 

무작정 JPA를 활용해 CRUD게시판을 만들고 기능구현까지 해보았다 !
까먹지 않기 위해 포스팅을 남긴다. :) 

프로젝트 패키지 구조

프로젝트의 패키지는 다음과 같다.

config

: Swagger의 설정파일이 담긴 패키지이다.

controller

: 웹 MVC의 컨트롤러 역할을 하는 클래스들이 담겨있다.

data > Request / Response

: Request(요청), Response(응답)DTO를 정의한 클래스이다.

domain

: 테이블과 링크될 클래스임을 나타낸다.
Entity 클래스 또는 가장 Core한 클래스라고 부른다.

Entity 클래스와 DTO 클래스를 분리하는 이유

• View Layer 와DB Layer의 역할을 철저하게 분리하기 위해서
  테이블과 매핑되는 Entity 클래스가 변경되면 여러 클래스에 영향을 끼치게 된다. 하지만 View와 통신하는 DTO 클래스(Request / Response 클래스)는 자주 변경되므로 분리해야 한다.
• Domain Model을 아무리 잘 설계했다고 해도 각 View 내에서 Domain Model의 getter만을 이용해서 원하는 정보를 표시하기가 어려운 경우가 종종 있다.
  이런 경우 Domain Model 내에 Presentation을 위한 필드나 로직을 추가하게 되는데, 이러한 방식이 모델링의 순수성을 깨고 Domain Model 객체를 망가뜨리게 된다.
• 또한 Domain Model을 복잡하게 조합한 형태의 Presentation 요구사항들이 있기 때문에 Domain Model을 직접 사용하는 것은 어렵다.
• 즉 DTO는 Domain Model을 복사한 형태로, 다양한 Presentation Logic을 추가한 정도로 사용하며 Domain Model 객체는 Persistent만을 위해서 사용한다.

repository

: JPA에서의 DB Layer 접근자를 의미한다.
인터페이스를 생성 후 JpaRepository<Entity 클래스, PK 타입>을 상속하면 기본적인 CRUD 메소드가 자동으로 생성된다.
@Repository를 추가할 필요가 없다.

sevice

: 비즈니스 로직을 수행한다. Service인터페이스를 두고 ServiceImpl로 이를 구현하였다.
interface와 구현체로 나누는 이유는 여기에 보다 자세히 나와있다 !

DB

Attribute(속성)는 총 5개이다.

• id (기본키)
• brand_name
• category
• land_number
• road_number

healthInfo.java

package com.example.demo.domain;

import lombok.*;

import javax.persistence.*;
import java.util.List;

@NoArgsConstructor
@AllArgsConstructor
@ToString
@Builder
@Getter
@Entity
@Table(name = "health_info")
public class HealthInfo {

        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Long id;

        private String brand_name;

        private String land_number;

        private String road_number;


        private String category;

        public void modifyHealthinfo(String brand_name,String land_number,String road_number, String category){
                this.brand_name=brand_name;
                this.land_number=land_number;
                this.road_number=road_number;
                this.category=category;
        }


}

관련 어노케이션

• @NoArgsConstructor: 파라미터가 없는 기본 생성자 생성
• @AllArgsConstructor: 모든 필드 값을 파라미터로 받는 생성자 생성
• @ToString: 클래스의 변수들을 기반으로 ToString 메소드 자동으로 완성
• @Builder: 해당 클래스의 객체 생성에 Bulider패턴 적용시켜줌, 모든 변수들에 대해 bulid하기 원한다면 클래스위에 @bulid 붙이고 특정변수만 bulid하기 원한다면 생성자를 작성하고 그 위에 @bulid를 붙인다 !
• @Getter: 모든 변수들에 Getter메소드 자동 작성
• @Entity,@Table: 객체와 테이블 매핑

DTO

DTO(Data Transfer Object)란 계층간 데이터 교환을 위해 사용하는 객체(Java Beans)이다.
정리하면 DTO는 클라이언트 요청에 포함된 데이터를 담아 서버 측에 전달하고, 서버 측의 응답 데이터를 담아 클라이언트에 전달하는 계층간 전달자 역할이다.
계층간 데이터 교환을 위한 객체(Java Beans)이다.

DB에서 데이터를 얻어 Service나 Controller 등으로부터 보낼 때 사용하는 객체를 말한다.
즉, DB의 데이터가 Presentation Logic Tier로 넘어오게 될 때는 DTO의 모습으로 바껴서 오고가는 것이다.
로직을 갖고 있지 않는 순수한 데이터 객체이며, getter/setter 메서드만을 갖는다.
하지만 DB에서 꺼낸 값을 임의로 변경할 필요가 없기 때문에 DTO클래스에는 setter가 없다. (대신 생성자에서 값을 할당한다.)

• Request와 Response용 DTO는 View를 위한 클래스
• 자주 변경이 필요한 클래스
• Presentation Model
• toEntity() 메서드를 통해서 DTO에서 필요한 부분을 이용하여 Entity로 만든다.
• 또한 Controller Layer에서 Response DTO 형태로 Client에 전달한다.

HealthRequestDTO.java

package com.example.demo.data.request;

import com.example.demo.domain.HealthInfo;
import lombok.Getter;

@Getter
public class HealthRequestDTO {
    private Long id;
    private String brand_name;
    private String land_number;
    private String road_number;
    private String category;


    public static HealthInfo toEntity(HealthRequestDTO dto){
        return HealthInfo.builder()
                .id(dto.getId())
                .brand_name(dto.getBrand_name())
                .category(dto.getCategory())
                .land_number(dto.getLand_number())
                .road_number(dto.getRoad_number())
                .build();
    }

    
}

HealthResponseDTO.java

package com.example.demo.data.response;

import com.example.demo.domain.HealthInfo;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

@Builder
@Getter
@Setter
@ToString
public class HealthResponseDTO {

    private Long id;
    private String brand_name;
    private String land_number;
    private String road_number;
    private String category;

    public static HealthInfo toEntity(HealthResponseDTO healthResponseDTO){
        return HealthInfo.builder()
                .id(healthResponseDTO.getId())
                .brand_name(healthResponseDTO.getBrand_name())
                .land_number(healthResponseDTO.getLand_number())
                .road_number(healthResponseDTO.getRoad_number())
                .category(healthResponseDTO.getCategory())
                .build();

    }

}

Reference💡

• https://gmlwjd9405.github.io/2018/12/25/difference-dao-dto-entity.html
• https://velog.io/@yu-jin-song/SpringBoot-%EA%B2%8C%EC%8B%9C%ED%8C%90-%EA%B5%AC%ED%98%84-1-Entity-%EB%B0%8F-Repository-%EA%B5%AC%ED%98%84
• https://velog.io/@sun1203/Spring-Boot%EA%B8%B0%EB%B3%B8-CRUD-API-%EA%B5%AC%ED%98%84
• https://wonit.tistory.com/127