📚 TIL 23일차

오늘의 주요사항 (6/16, 금요일)

1. JPA 학습
2. 개인과제 마무리

Spring-CRUD-과제-Lv1 : Blog

JPA 적용

JPA를 적용하는 것까지가 과제인 것 같아서... 어제에 그치지 않고 조금 더 살을 붙여보았다.

1) 환경 설정

build.gradle

JPA를 추가하면서 JDBC는 사용할 일이 없어지기 때문에, JPA 설정 추가와 함께 JDBC 설정은 지워주기로 했다.

dependencies {
	
    /* 중략 */
	
	// JPA 설정
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
}

application.properties

1) database 설정

spring.jpa.database=mysql
spring.datasource.username=root
spring.datasource.password=12345678
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
 

2) jpa hibernate 설정

spring.jpa.hibernate.ddl-auto=update

spring.jpa.properties.hibernate.show_sql=true
spring.jpa.properties.hibernate.format_sql=true
spring.jpa.properties.hibernate.use_sql_comments=true

spring.jpa.hibernate.ddl-auto를 create로 설정해주면, 기존 생성되어있는 테이블을 무시하고 새로운 테이블을 생성해준다.

2) Entity 수정

테이블 정보를 코드가 인식하고 넣어줄 수 있도록 @애노테이션을 활용하여 정보를 명시해준다.

기존에 사용했던 create table 명령어와 바뀐 entity를 함께 살펴보자.

CREATE TABLE

create table post (
        id int not null auto_increment,
        
		createdAt DATETIME not null,
		modifiedAt DATETIME not null,
        
		title varchar(255) not null,
        content varchar(500) not null,
        author varchar(255) not null,
		password varchar(255) not null,
        
        primary key (id)
);

Blog Entity

@Entity // JPA가 관리할 수 있는 Entity 클래스 지정
@Getter
@Setter
@Table(name = "post") // 매핑할 테이블의 이름을 지정
@NoArgsConstructor

public class Blog extends Timestamped {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id; // id
    @Column(name = "title", nullable = false)
    private String title; // 제목
    @Column(name = "content", nullable = false)
    private String content; // 내용
    @Column(name = "author", nullable = false)
    private String author; // 작성자
    @Column(name = "password", nullable = false, length = 12)
    private String password; // 비밀번호


    /* 생성자와 메서드는 동일한 형태이다 */

}

JPA을 활용하면 @Column등과 같은 애노테이션을 사용해, create table 명령문과 동일한 효과를 낼 수 있다는 것을 확인할 수 있다.

예를 들어서

title varchar(255) not null,

은,

@Column(name = "title", nullable = false)
private String title; // 제목

이제 이렇게 사용함으로써 Java-Spring 코드가 인식할 수 있게 되었다는 것이다.

3) Timestamped: 시간 타입 변경

시간 타입을 다시 varchar에서 DATETIME으로 변경해주었다. DATETIME으로 저장되어도, 밀리초까지 조회할 수 있다고 한다.

변경에 따라 시간 정보를 저장할 entity를 새롭게 생성하게 되었다. 이 Timestamped entity는 추상 클래스로, Blog가 상속 받아 사용하게 된다.

Timestamped Entity

@Getter
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)

public abstract class Timestamped {

    @CreatedDate
    @Column(updatable = false)
    @Temporal(TemporalType.TIMESTAMP)
    private LocalDateTime createdAt;

    @LastModifiedDate
    @Column
    @Temporal(TemporalType.TIMESTAMP)
    private LocalDateTime modifiedAt;
}

4) Repository 수정 (JpaRepository)

BlogRepository는 JpaRepository를 상속하게 됨으로써, 따로 구현부를 작성할 필요가 없어졌다.

public interface BlogRepository extends JpaRepository<Blog, Integer> {
}

이러한 상태만으로도 JpaRepository가 기본으로 제공해주는 기능을 대부분 사용할 수 있게 된다. 하지만 JpaRepository 기본 제공 기능 외에, 다른 유사한 기능들이 필요해진다면, 아래와 같이 선언함으로써 사용할 수 있게 된다.

public interface BlogRepository extends JpaRepository<Blog, Integer> {

	// 내림차순 정렬 - CreatedAt (생성 시간)을 기준으로
    List<Blog> findAllByOrderByCreatedAtDesc();
    
    // Id와 Password를 사용해 Blog를 찾아서 반환
    Blog findByIdAndPassword(Integer id, String password);    
}

나는 기본적으로 제공하는 findById() 외에, 비밀번호(password)도 함께 조회하고 싶어서, findByIdAndPassword()라는 메서드를 함께 만들어서 선언해주었다.

Repository에서 구현했다면, 호출은 마찬가지로 Service가 한다.

findByIdAndPassword()를 활용해 id와 비밀번호를 함께 체크할 수 있게 되었다.

@Transactional
public BlogResponseDto updateBlogPost(Integer id, BlogRequestDto requestDto) {

    // 1. 해당 게시글이 DB에 존재하는지 확인
    Blog blog = blogRepository.findByIdAndPassword(id, requestDto.getPassword());
    if(blog != null) {
    
        // 2. 존재하면 blog 수정
        blog.update(requestDto); // DB 저장
        BlogResponseDto blogResponseDto = new BlogResponseDto(blog);
        
        return blogResponseDto;
        
    } else {
        throw new IllegalArgumentException("비밀번호가 올바르지 않습니다.");
    }
}

테이블의 변경사항을 반영하기 위해서는 @Transactional 애노테이션이 필요하다.

createdAt을 기반으로 한 내림차순 정렬은 아래와 같이 변경되었다.

// BlogService.java

public List<BlogResponseDto> getBlogPosts() {

	// DB 조회
    return blogRepository.findAllByOrderByCreatedAtDesc().stream().map(BlogResponseDto::new).toList();
}

Postman을 통한 테스트 실행 화면

게시글 전체 조회 /blog/posts

선택 게시글 수정 /blog/post/{id}

선택 게시글 수정 실패 blog/post/{id}

선택 게시글 삭제 /blog/post/{id}

게시글 작성 /blog/post

선택 게시글 조회 blog/post/{id}