[Spring Boot] 컨트롤러와 REST API

Spring Boot

Spring Framework를 보다 손쉽게 활용할 수 있게 지원하는 기술

 

- Spring Framework를 기반으로 한다.

- 설정, 의존성 관리, 애플리케이션 모니터링, 서버의 실행 등을 가볍고 빠르게 수행할 수 있다.

 

* Spring Boot의 주요 기능

  - 설정 간편화를 위한 Auto Configuration

  - 의존성 관리를 위한 Starter Project

  - 배포 프로세스 간소화를 위한 Embedded WAS

  - 애플리케이션의 모니터링을 위한 Actuator

 

 

---

 

* SW 아키텍쳐란?

  : SW의 구조를 정의한 것으로 SW를 구성하는 주요 요소들과 요소들의 관계를 정의한 것

 

 

그 중 웹 서비스 개발에 주로 사용되는 패턴인 계층형 아키텍쳐 패턴에 대해 간단히 알아보자.

 

계층형 아키텍쳐 패턴은 SW를 서로 다른 역할을 하는 3~4개의 계층으로 구분한 패턴이다.

  - Presentation Layer

  - Application Layer

  - business Layer

  - Data Access Layer

또한 이 패턴은 계층 간에 호출을 하고 데이터를 주고 받으며 협력하여 전체 웹 서비스를 구성한다.

 

그림으로 보면

Spring Boot Application과 DB와의 구조

Client에서 요청하면 그 요청을 처음 받는 계층은 Presentation Layer이다.

→ 그리고 Application Layer로, 또 Data Access Layer로 요청을 전달한 후 Data Access Layer는 DB에 접근한다.

→ 그 다음 DB에서 Database를 가져오고, 그 Database를 역방향으로 Data Access Layer → Application Layer → Presentation Layer로 전달한 후, 최종적으로 Client에게 전달 하는 구조이다.

 

Spring Boot에서는 Presentation Layer는 Controller, Application Layer는 Service, Data Access Layer는 Repository라는 용어가 사용 된다.

 

각각 독립적으로 분리된 책임과 역할

 

  

---

 

Spring Controller

 - 계층형 아키텍쳐의 Presentation Layer에 해당한다.

 - Client의 요청을 받고, Application Layer 요청에 대한 처리를 위임하며, Client에 최종 응답을 하는 역할이다.

 

 

Spring Controller를 구현하기 위해서는 3개의 기본 Annotation이 사용 된다.

  1. @Controller,   2. @RestController

    → Controller 역할을 하는 클래스를 지정하는 것으로, 클래스 상단에 명시한다.

  3. @RequestMapping

    → 특정 Request를 처리하는 메소드를 지정하는 것으로, 클래스 또는 메소드 상단에 명시한다.

Annotation이 부착 된 코드들은 Spring Famework에 의해 관리되며, Spring Framework에 의해서 특정한 목적으로 사용된다.

 

* Annotataion이란?
  → Java 소스코드에 추가적인 정보를 제공하는 방법으로, @로 시작하며 클래스, 메소드, 멤버변수, 파라미터 등에 부착 가능하다.
  · Annotation의 3가지 유형
    - 자바 컴파일러에게 정보를 제공한다.
    - SW 툴에 의해 사용되어 코드 생성이나 추가 작업을 진행한다.
    - run-time 시 특정 동작을 추가적으로 실행한다.

* Spring Framework란?
  → 약속된 Annotation을 인식하여 특정적업을 수행하는 것

 

※ @Controller  VS  @RestController

  · 요청을 받아서 처리하고 응답을 하는 등 대부분의 동작은 유사하다.

     But, 응답하는 형태가 다르다.

      - Controller: view를 응답(html 파일 등)

      - RestController: data를 응답(문자열, Json, xml 등)

왼) @RestController / 오) @Controller

@RestController는 메소드가 반환하는 데이터 자체를 응답받고, 

@Controller에서 문자열 "hello"는 html파일(view)의 이름을 의미하여 hello.html이라는 문서가 응답되었다

 

 

※ @RequestMapping

  · @RequestMapping이 붙어 있는 메소드는 Client의 특정 요청이 왔을 때 Spring Framework에 의해 호출 된다.

 

 

그럼 RequestMapping이 붙어 있는 메소드가 여러 개 일 때는 어떤 메소드가 호출될까?

 

Spring Controller의 메소드들은 URI에 따라 호출이 결정된다. 

(URI(Uniform Resource Identifier)는 URL과 유사한 개념으로 특정한 자원에 접근하기 위한 이름 또는 주소를 말한다.)

기본 도메인에 이어지는 '/path' 들에 의해 결정이 된다. (ex. http://localhose:8080/user)

RequestMapping Annotation에 URI Path 정보를 명시한다. → ex. @RequestMapping(value = "/user")

 

따라서

기본 도메인에 이어지는 /뒤에 path 정보에 의해 어떤 메소드가 호출될지 Spring Framework가 결정한다.

 

 

* URI (Uniform Resource Identifier)
  URI는 요청하는 자원의 종류에 따라 이름을 정한다.
   - www.codepresso-blog.com/user   → user정보를 요청하기 위한 이름
   - www.codepresso-blog.com/posts  →  글 목록 등을 요청하기 위한 이름 등으로 명확하게 이름을 정해야 한다.

  또한 계층 관계로 표현이 가능하며, ' / '로 계층을 구분한다.
   - www.codepresso-blog.com/user/paid 
   - www.codepresso-blog.com/user/enterprise 등  

  Naming 규약
   - 소문자를 사용하고, 명사 형태로 작성하낟.
   - 두 단어 이상 연결 될 경우 ' - '를 사용한다.
   - 의미 있는 이름으로 일관성 있게 작성한다.

 

 

※ HTTP API vs REST API

  - HTTP API

    : HTTP(s)를 활용하여 원격의 데이터를 공유하기 위한 API

  - REST API (REpresentational State Transfer API)

    : Roy Fielding이 저술한 논문에 소개된 개념으로, 웹 상에서 효율적으로 데이터를 공유하기 위한 아키텍쳐 스타일

 

  → @RestController Annotation은 REST API, HTTP API를 위한 클래스를 명시하는 것이고, 클래스 내에 @RequestMapping이 붙은 개별 메소드들이 하나의 REST API, HTTP API이다.

 

 

---

 

" Request 파라미터 "

 

  Client가 Server에 요청(Request)을 할 때 추가적으로 전송하는 데이터

    Spring Framework는 Request 파라미터를 (@Request Mapping이 붙은)메소드의 파라미터에 저장한다

 

 

Request파라미터는 2가지 유형이 있다.

1. Query String

  - URI와 파라미터의 영역을 구분하여 사용한다.

    ( URI에 이어지는 '?' 뒤에 key1=value1&key2=value2&··· 형태로 작성 됨)

  - key는 파라미터의 이름, value는 파라미터의 값

    (ex. https://www.google.com/search ?q=codepresso&sourceid=chrome&ie=UTF-8)

  - 메소드 파라미터에 @RequestParam Annotation을 사용한다.

  - name 요소는 Query String에 key에 매핑된다.

 

 

  * @RequestParam의 요소

    - name: Query string의 key이다. key와 변수명이 같을 경우 생략이 가능하다.

    - required: 필수 여부

    - defaultValue: 데이터가 없을 경우 자동으로 세팅되는 기본 값

 

 

2. Path Parameter

  - URI의 일부로 파라미터 값을 사용한다.

    (domain/user/1 ,   domain/user/3/post/27  →  파란숫자가 파라미터 값)

    ( ex. http://brunch.co.kr/@thinkabout/199

         → @~는 user의 계정, 199는 계정의 글 id로 thinkabout user의 199번 글을 요청한다는 의미 )

{ }로 Path 파라미터가 올 것이라고 명시함

  - @RequestMapping value URI에 { }로 Path Param임을 표시한다.

  - 메소드 파라미터에 @PathVariable Annotation을 사용한다.

  - 선택적 데이터의 경우에는 Path Param을 잘 사용하지 않는다.

  - 위 예제로 예를 들면 

     http://localhost:8080/user/admin/id/100  →  출력값: You requested admin-100 user

 

※ Path Parameter vs Query String 언제 사용할까?
  - 일반적인 추천 사항
    (Path Param: 특정 자원을 요청하는 경우, Query String: 자원에 대한 정렬이나 추가 필터링을 위한 데이터)
      → ex. https://codepresso.kr/courses/spring?order=latest
  - 필수 데이터는 Path Param으로, 선택적 데이터는 Query String을 사용하라
    (Path Param이 포함 된 URI는 Client가 영향을 받기 때문에 변경 비용이 높지만,
     Query String은 상대적으로 편하게 확장이 가능하다)

 

 

≫ Tip
- spring initializr
    : Spring Boot 프로젝트를 쉽게 구성할 수 있게 지원하는 사이트

 

 

---

 

코드프레소 Java 웹 개발 체험단 활동 중 'Spring Boot 웹 개발 입문' 이러닝 강의를 듣고 작성하였습니다 :)
코드프레소 URL: https://www.codepresso.kr/

프리미엄 IT 교육 서비스 - 코드프레소