[Spring Boot] Rest API 구현 (Feat. spring date rest)

💡 Rest API 란?

참고 : https://withseungryu.tistory.com/100

---

💡 Spring data rest 란?

spring-data-rest, a recent addition to the spring-dataproject, is a framework that helps you expose your entities directly as RESTful webservice endpoints. Unlike rails, grails or roo it does not generate any code achieving this goal. spring data-rest supports JPA, MongoDB, JSR-303 validation, HAL and many more. It is really innovative and lets you setup your RESTful webservice within minutes. In this example i’ll give you a short overview of what spring-data-rest is capable of.

 

a recent addition to the spring-dataproject, is a framework that helps you expose your entities directly as RESTful webservice endpoints.

spring-dataproject에 추가되었으며, Restful 웹서비스 엔드포인트로서 직접적으로 엔티티를 나타낼 수 있도록 도와주는 프레임워크이다.

 

It is really innovative and lets you setup your RESTful webservice within minutes

정말 혁신적이고 Restful 웹서비스를 구성하는데 큰 도움을 준다.

 

참고 : https://spring.io/projects/spring-data-rest

Spring Data REST

🔍 사용법 예시

spring:
    data:
        rest:
            base-path : /api
            default-page-size : 10
            max-page-size : 10

 

🔍 프로퍼티

• base-path : API의 모든 요청의 기본 경로

• default-page-size : 클라이언트가 따로 페이지 크기를 요청하지 않을 때 적용 할 기본 페이지 크기

• max-page-size : 최대 페이지 수

• page-param-name : 페이지를 선택하는 쿼리 파라미터명을 변경

• limit-param-name : 페이지 아이템 수를 나타내는 쿼리 파라미터명 변경

• sort-param-name : 페이지의 정렬값을 나타내는 쿼리 파라미터명을 변경

• default-media-type: 미디어 타입을 지정지 않았을 때 사용할 기본 미디어 타입 설정

• return-body-on-create : 새로운 엔티티를 생성한 이우헤 응답 바디 반환 여부 설정

• enable-enum-translation : 'rest-messages'라는 프로퍼티 파일을 만들어 지정한 enum값을 사용

• detection-strategy : 레포지토리 노출 전략을 설정하는 프로퍼티 값

---

💡 REST API 구현

🔍 Board(게시판) 만들기

• DataBase Name : board
• Columns

🔍 DB와 REST API 환경 설정

server:
  port: 8081

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/[DB명]?serverTimezone=Asia/Seoul
    username: [DB ID]
    password: [DB PASSWORD]
    driver-class-name: com.mysql.jdbc.Driver
  data:
    rest:
      base-path: /api
      default-page-size: 10
      max-page-size: 10

• 사용할 서버의 포트 지정
• DB 설정과 REST API 환경 설정

 

🔍 Board 클래스 생성 ( JPA 사용 )

JPA 란?

JPA란 DB 테이블과 자바 객체 사이의 매핑을 처리해주는 ORM1이란 기술의 표준

즉 자바의 클래스와 DB의 테이블을 매핑하는 기술

package com.example.realboard;


import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import org.springframework.boot.autoconfigure.domain.EntityScan;

import javax.persistence.*;
import java.io.Serializable;
import java.time.LocalDateTime;

@Getter
@NoArgsConstructor
@Entity
@Table
public class Board implements Serializable {
    @Id
    @Column
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long idx;

    @Column
    private String title;

    @Column
    private String subTitle;

    @Column
    private String content;

    @Column
    private LocalDateTime createdDate;

    @Column
    private LocalDateTime updatedDate;


    @Builder
    public Board(String title, String subTitle, String content,
                 LocalDateTime createdDate, LocalDateTime updatedDate){

        this.title = title;
        this.subTitle = subTitle;
        this.content = content;
        this.createdDate = createdDate;
        this.updatedDate = updatedDate;
    }

    public void setCreatedDataNow(){
        this.createdDate = LocalDateTime.now();
    }

    public void setUpdatedDateNow(){
        this.updatedDate = LocalDateTime.now();
    }

    public void update(Board board) {
        this.title = board.getTitle();
        this.subTitle = board.getSubTitle();
        this.content = board.getContent();
        this.updatedDate = LocalDateTime.now();
    }
}

@Column 과 @Table와 같은 어노테이션들은 JPA에 속한 애노테이션이기 때문에

JPA 사용법을 참고해주세요! (참고 : https://withseungryu.tistory.com/106 )

[Spring Boot] JPA란

 

 

🔍 BoardRepository 생성

• JPA의 기술을 사용하기 위해 JpaRespository를 상속하는 클래스를 만들어줌

package com.example.realboard;

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;

@RepositoryRestResource
public interface BoardRepository  extends JpaRepository<Board, Long> {
}

 

🔍 REST CONTROLLER 생성

• 요청을 받기 위한 컨트롤러
• @RepositoryRestController 어노테이션 사용
• HATEOAS 적용 (Hypermedia As The Engine Of Application State )

Hateoas : RESTful API를 사용하는 클라이언트가 전적으로 서버와 동적인 상호작용이 가능하도록 하는 것

• 매핑하는 URL 형식이 spring-data-rest에서 정의하는 Rest API 형식에 맞아야한다.
• 기본으로 제공하는 URL형식과 같게 제공해야 한다.

package com.example.realboard;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
import org.springframework.data.rest.webmvc.RepositoryRestController;
import org.springframework.data.web.PageableDefault;
import org.springframework.hateoas.CollectionModel;
import org.springframework.hateoas.PagedModel;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;


import javax.annotation.Resources;

import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.linkTo;
import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.methodOn;

@RepositoryRestController
public class BoardRestController {

    private BoardRepository boardRepository;

    public BoardRestController(BoardRepository boardRepository){
        this.boardRepository = boardRepository;
    }

    @GetMapping("/boards")//api/boards로 URL형식 오버라이드
    public @ResponseBody CollectionModel<Board> simpleBoard(@PageableDefault Pageable pageable){
        Page<Board> boardList = boardRepository.findAll(pageable);

        PagedModel.PageMetadata pageMetadata = new PagedModel.PageMetadata(pageable.getPageSize(), boardList.getNumber(),
                boardList.getTotalElements());
        //전체 페이지 수, 현재 페이지 번호, 총 게시판 수 등의 페이지 정보를 담는 pageMetadata
        PagedModel<Board> resources = new PagedModel<>(boardList.getContent(), pageMetadata );
        //컬렉션의 페이지 리소스 정보를 추가적으로 제공하는 resources
        resources.add(linkTo(methodOn(BoardRestController.class).simpleBoard(pageable)).withSelfRel());
        //필요한 링크 추가. 여기서는 withSelfRel()로 'self'만 추가
        return resources;
    }

    @PostMapping //POST 요청 매핑
    public ResponseEntity<?> postBoard(@RequestBody Board board) {
        board.setCreatedDataNow();
        boardRepository.save(board);
        return new ResponseEntity<>("{}", HttpStatus.CREATED);
    }

    @PutMapping("/{idx}") //PUT 요청 매핑
    public ResponseEntity<?> putBoard(@PathVariable("idx")Long idx, @RequestBody Board board){
        Board persistBoard = boardRepository.getOne(idx);
        persistBoard.update(board);
        boardRepository.save(persistBoard);
        return new ResponseEntity<>("{}", HttpStatus.OK);
    }

    @DeleteMapping("/{idx}")//DELETE 요청 매핑
    public ResponseEntity<?> deleteBoard(@PathVariable("idx")Long idx){
        boardRepository.deleteById(idx);
        return new ResponseEntity<>("{}", HttpStatus.OK);
    }

}

• pageMetadata : 페이지 정보를 담는 변수
• resources : Board의 페이지 리소스 정보를 추가적으로 제공하는 변수
• resources.add() : 필요한 링크를 추가해주는 메소드
• withSelfRel() : 'self' 링크를 추가해주는 메소드

🔍 결과

💡발생한 에러

1. Hateoas의 업데이트로 인해 하위 클래스 중 Resources, PageMetadata, PagedResource의 변경으로 인한 에러

   해결

   • Resources 는 CollectionModel 로 변경
   • PageMetadata 는 PagedModel.PageMetadate로 변경
   • PagedResource 는 PagedModel로 변경

2. Unknown column in 'field list' error on MySQL

   해결

   • 필드 명에 오타가 없는지 확인
   • DB에 해당 필드가 있는지 확인
   • DB mysql에서 컬럼을 생성시 Camel case(subTitle, updatedTime)이 아닌 Snake case(sub_title, updated_time)으로 명명.

3. 보안 문제 (Security Problem)

   발생 원인

   • HTTP요청 시 동일 출처 정책 정용으로 AJax 요청 실패
   • 교차 출처 HTTP 요청을 가능케 해주는 매커니즘 교차 출처 자원 공유 (CORS) 권한 부여 필요

   해결

   CORS 허용 및 시큐리티 설정

   @SpringBootApplication가 있는 클래스에 추가

   @Configuration
   @EnableGlobalMethodSecurity(prePostEnabled=true) //메소드 권한 제한
   @EnableWebSecurity //웹 시큐리티 활성화
   static class SecurityConfiguration extends WebSecurityConfigurerAdapter{
   
      @Override
      protected void configure(HttpSecurity http) throws Exception{
          CorsConfiguration configuration = new CorsConfiguration();
          configuration.addAllowedOrigin(CorsConfiguration.ALL);
          configuration.addAllowedMethod(CorsConfiguration.ALL);
          configuration.addAllowedHeader(CorsConfiguration.ALL);
          //CORS에서 orgin,method,header 별로 허용할 값을 설정
          UrlBasedCorsConfigurationSource source =
                  new UrlBasedCorsConfigurationSource();
          source.registerCorsConfiguration("/**", configuration);
          //특정 경로에 적용, "/**" -> 모든 경로를 뜻함.
   
          http.httpBasic().and().authorizeRequests()
          .anyRequest().permitAll()
          .and().cors().configurationSource(source)//위에 설정한 내용 시큐리티에 적용
          .and().csrf().disable();
          }
   
      }

resources.add(linkTo(methodOn(BoardRestController.class).simpleBoard(pageable)).withSelfRel());