🌊 ._.sori🪽

[ @Controller와 @RestController ]

[ Hello,World 출력하기 ]

Controller 안에
@GetMapping( )이라는 존재가 있다.

과연 @GetMapping은 어떤 역할을 하는 것일까?

데이터에는 두가지 전송방식이 존재한다.

GET

• URL(주소)에 데이터를 포함시켜 보낸다.
• 데이터는 헤더에 포함되어있다.
• URL에 데이터가 노출되어 보안에 취약하다.
• 캐싱(데이터를 가까운 곳에 임시로 저장한 후, 빠르게 불러오는 프로세스)할 수 있다.
• 주로 조회, 검색할 때 사용한다.

POST

• URL(주소)에 데이터를 포함시키지 않는다.
• 데이터를 바디에 포함한다.
• URL에 데이터가 노출되어있지 않아 GET방식 보단 보안이 높다.
• 캐싱((데이터를 가까운 곳에 임시로 저장한 후, 빠르게 불러오는 프로세스)할 수 없다.
• 주로 데이터를 서버에 저장, 수정할 때 사용한다.

@GetMapping( )

• Get 요청을 하는 API 어노테이션이다.
• 경로 매핑에 따라 어떤 페이지를 보여줄지 결정한다.
  (매핑, 여러 요소를 연결하는 과정 혹은 결과물을 말한다. 예시를 들어보면, 강남 맛집을 검색했을시 강남에 있는 모든 식당이 검색되는 경우라고 볼 수 있을 것 같다. 매칭은 키 = 180cm 일대일로 맞는 경우)
• 데이터를 가져올 때 사용한다.
• 반환값은 하나지만 경로는 다중으로 설정 가능하다. 

코드를 보고 이해해보자.

해당 코드는 페이지 반환은 아니고 @RestController(직렬화를 통해 문자열이 페이지에 보이게 해주는)를 사용하여 문자열을 반환하는 코드의 일부이다.

Controller 내부 코드

@GetMapping("")
    public String helloWorld() {
        return "Hello, World";
	}

1. @GetMapping("")으로 ("")에 경로가 적혀있지 않아 루트를(메인 페이지) 의미한다.
2. @GetMapping("") = 사용자가 메인 페이지에 들어가면
3. "Hello, World"를 반환해라. (@RestController를 이용하여)

그러면 이번엔 페이지 반환하는 코드 일부를 살펴보자.

Controller 내부 코드

@GetMapping("")
public String homePage() {
    return "First";
}

1. page라는 이름으로 .html 혹은 .jsp가 있다고 가정하자.
2. 루트 경로("")로 들어간다면
3. First라는 페이지를 반환하라는 명령이 DispatcherServlet에게 전달된다.
4. DispatcherServlet은 ViewResolver로 전달하고
5. ViewResolver가 First라는 이름을 가진 페이지를 찾아 최종적으로 화면에 출력되도록 한다.

@RequestMapping

• 다양한 속성을 지정가능하다.
• value, method, params, headers, consumes, produces의 속성을 가지고 있다.
• 그 속성을 이용하여 Get, Post 등 다양한 동작을 구현할 수 있다.
• 속성이 하나라도 달라야 올바르게 Handler가 매핑할 수 있다.
• 쉽게 생각하면 @RequestMapping에서 조회하는 목적에 맞게 편리하도록 만들어낸 버전을 @GetMapping 등.. 이라고 생각하면 된다.

이것도 쉽게 코드로 살펴보자.

@RequestMapping(value = "", method = RequestMethod.GET)
public String helloWorld() {
    return "Hello,Wrold!";
}

=

@GetMapping("")
    public String helloWorld() {
        return "Hello, World";
    }

@RequestMapping은 method에 .GET으로 어떤 방식으로 사용할건지 명시하고 있다. 

더 자세한 건 나중에 작성하겠다.

목적에 따라 다른 어노테이션

• @PostMapping =  데이터를 게시할 때 사용한다. (Post의 특징을 그대로 가져온 것)
• @PutMapping = 수정할 때 사용하며, 데이터 전체를 갱신하다.
• @DeleteMapping = 데이터를 삭제할 때 사용한다.
• @PatchMapping = 수정할 때 사용하며, 수정된 부분만 갱신한다.

@GetMapping을 포함하여 위의 어노테이션들은 @RequestMapping에서 목적에 맞게 더 편리한 코드를 만든 것이라 생각하면 된다. @RequestMapping에서 다양한 속성을 조합해 원하는 작동방식을 만들어야했다면, 위의 어노테이션은 속성의 조합에 대한 부담을 줄여준 것으로 보인다.

@GetMapping에 대해 알아봤습니다.

그냥 한 줄로 정리하면 들어오는 경로에 맞춰 반환될 페이지를 골라주는 역할인 것 같네요.
@RequestMapping에 대해서는 다음에 정리해볼까 합니다.

아래에 출처를 남겨두겠습니다.
블로그엔 제가 최대한 이해한 내용까지만 적는거라
출처에 들어가시면 더 많은 내용이 있어 공부하시는데 도움되실겁니다.

🪽

틀린 내용이 있다면 댓글로 알려주세요

- @GetMapping의 개념

- Get과 Post

- @RequestMapping 동작방식

- @RequestMapping 옵션

- 매핑과 매칭

[ SpringMVC에 대하여 ]

[ Hello World 출력하기 ]

Hello, World를 출력했다.
그런데 @Controller가 아닌 @RestController를 사용하였다.

왜 @RestController를 사용한걸까?

@Controller

• @Controller는 주로 view를 반환한다.
• ViewResolver를 통해 view를 반환한다.
• AnnotationMethodHandlerAdapter 핸들러 어댑터가 사용한다.
• 메소드 단위로 설정할 수 있기 때문에 효율이 좋다.
• @Controller는 200 OK(성공을 알리는 상태 코드)를 기본적으로 보낸다.

@RestController

• @Controller에 @ResponseBody가 추가되었다.
• Controller를 통해 Json 형태로 반환해야하는 경우 사용한다.
• HttpMessageConverter를 통해 Json 형태로 반환한다.
• 반환되는 객체는 Json으로 Serialize(직렬화)되어 반환된다.
• @RestController는 200 OK(성공을 알리는 상태 코드)를 기본적으로 보낸다.

결론적으로 @Controller는 View를 반환할 때 사용하고, @RestController는 Hello, World 같은 어떤 Json 형태의 데이터를 반환할 때 사용한다는 걸 알았다.

그렇다면 왜 @RestController는 Json 반환이 되는걸까?

직렬화

• 컴퓨터 과학의 데이터 스토리지 문맥에서 데이터 구조나 오브젝트 상태를 동일하거나 다른 컴퓨터 환경에 저장하고 나중에 재구성할 수 있는 포맷으로 변환하는 과정이다.
• 자바 시스템 내부에서 사용되는 객체 또는 데이터를 외부의 자바 시스템에서도 사용할 수 있도록 바이트(byte) 형태로 데이터 변환하는 기술과 바이트로 변환된 데이터를 다시 객체로 변환하는 기술(역직렬화)을 아울러서 이야기한다.

직렬화를 쉽게 이해해보자면, 시스템 내부에서 처리하기 편리한 어떤 데이터 형태로 존재하다가 우리에게 보여줄 때 우리가 이해할 수 있는 모습으로 형태를 변화시키는 것을 뜻하는 것 같다.

Q. @Controller는 Json 형태로 반환을 못하나?

A. 그건 아니다. 할 수 있다. @ResponseBody를 붙여주면 Json 형태로 반환이 가능하다. 본래 @Controller는 ViewResolver가 작동하여 view를 반환할 수 있도록 해준다. 하지만 @ResponseBody를 붙이면 @RestController처럼 HttpMessageConverter가 개입하게 되어 객체를 직렬화하여 전달하게 된다. 또한 MessageConverter에는 데이터의 종류(단순 문자열인지, 객체인지...)에 따라 서로 다른MessageConverter가 작동하게 된다.

// @ResponseBody를 붙인 코드
@Controller
public class HelloController {

    @GetMapping("")
    @ResponseBody
    public String helloWorld() {
        return "Hello, World";
    }

}

<결과>

👍

Http 상태 코드

• 특정 HTTP 요청이 성공적으로 완료되었는지 알려준다.
• 가장 기본적인 성공응답은 200 OK가 있다.

- 더 다양한 상태 코드

Q. @RestController의 기본적으로 반환되는 성공 상태 코드는 200 OK다. 그런데 다른 상태 코드로 바꾸려면 어떻게 해야하나?

A. ResponseEntity를 사용하여 상태 코드를 직접 설정할 수 있다. 

1) ResponseEntity.ok()를 사용한 코드 (200 OK)

// 예제 출처 - mangkyu.tistory (망나니 개발자님)

  @GetMapping(value = "/users")
    public ResponseEntity<User> findUserWithResponseEntity(@RequestParam String userName){
        return ResponseEntity.ok(userService.findUser(userName));
    }

2) ResponseEntity.status(HttpStatus.CREATED)를 사용한 코드 (201 Created)

@GetMapping(value = "/users")
public ResponseEntity<User> findUserWithCreatedResponse(@RequestParam String userName){
    return ResponseEntity.status(HttpStatus.CREATED).body(userService.findUser(userName));
}

코드 설명 :

1. @GetMapping ▻ users 경로로 들어온 요청을 해결하고 응답을 반환한다.
2. ResponseEntity<User> ▻ User(User 안에 있을 어떤 정보들, 이름+나이+주소와 같은...) 객체를 반환하는데, 상태 코드와 함께 반환하다는 뜻. (ResponseEntity로 감싸서 반환)
3. @RequestParam  ▻ 파라미터 이름으로 바인딩(구체적인 값을 할당하는 과정, 이름 = 미나 + 나이 = 10세 + 주소 = 서울특별시와 같은...) 그런데 userName이 옆에 붙었다. 이 의미는 구체적인 값으로 userName이 들어오면(쿼리 파라미터) userName 변수에 저장하겠다는 것이다. (미나라는 값이 url로부터 받아오면 그 값을 userName에 저장하고 데이터베이스에 그 사용자에 대한 다른 정보를 추가적으로 넣을 수 있게 만든다는 의미인 것 같다.)
4. ResponseEntity.status  ▻ 응답상태 코드를 설정하도록 한다.
5. HttpStatus.CREATED  ▻ 201 Created를 의미한다. 요청이 성공적으로 처리되었으며, 자원이 생성되었음을 나타내는 성공 상태 응답 코드이다. 
6. findUser(userName)  ▻ userName을 찾아서 User 객체를 반환하라는 것이다.

결론 : users로 들어온 요청을 해결한 후 성공적이면 201 CREATED를 반환하며 반활할 때 User 내용도 같이 담아서 반환해라. 

Q. 그렇다면 @Controller는 상태 코드를 어떻게 변환할 수 있는가?

A. @RestController와 같이 ResponseEntity.status를 이용하는 방법도 있지만, HttpServletResponse 객체를 이용하여 상태 코드를 설정할 수 있다. 아래 코드를 보면  HttpServletResponse response와 response.setStatus(HttpStatus.CREATED.value()); 코드를 통해 201 CREATED로 상태를 설정하는 걸 볼 수 있다.

    @GetMapping("/users")
    public String findUser(@RequestParam String userName, HttpServletResponse response) {        
        response.setStatus(HttpStatus.CREATED.value());
    }

이번에는 @Controller와 @RestController에 대해 알아봤습니다.

생각보다 정리하는데 오래걸려서 조금 당황스러웠네요...

다 처음보는 내용들이라 하나의 개념을 이해하려면 다른 개념들도 이해해야했고
상태 코드에 대한 부분도 몰랐다가 얼떨결에 간단히 배우고 넘어가게 되는 시간이었습니다.

아래에 출처를 남겨두겠습니다.
블로그엔 제가 최대한 이해한 내용까지만 적는거라
출처에 들어가시면 더 많은 내용이 있어 공부하시는데 도움되실겁니다.

🪽

틀린 내용이 있다면 댓글로 알려주세요

- @Controller와 @RestController의 원리와 차이 그리고 상태코드

- 다양한 Controller에 대해서

- 직렬화에 대해서

- @RequestParam에 대해서

- HttpservletResponse에 대해서

- 다양한 상태 코드

- 스프링사전

- @ResponseStatus에 대하여

처음엔 대충 프로젝트를 시작해보려했지만,
이럴수가! 아는 것이 미약하니 시작할 수 없었다.

그래서 가장 기초적으로 알아야하는 개념을 차근차근 정리해볼까 한다.

두둥, Spring MVC란?

아마 정보처리기사를 준비하거나, IT관련 전공자라면 한 번은 들어봤을 MVC.
이번 기회에 자세히 알아보자.

🪽

"틀린 내용이 있을 수 있습니다."

[ Hello World를 출력하기 ]

1. MVC

• Model - View - Controller로 구성되어있다.
• Model, View, Controller는 독립적으로 움직인다. (각자 맡은 분야만 해결한다)
• MVC 사용시, 결합도를 낮출 수 있다.
• MVC 사용시, 중복코드 제거가 쉽고 유지보수에 좋다.
• MVC 사용시, 확장성과 유연성이 증가한다.

(1)  View

• 사용자가 보는 화면이라고 생각하면 된다.
• 예시를 들어보자, 사용자가 웹 검색창에 [apple]이라고 검색하길 요청했다.

(2)  Controller

• View와 Model을 연결해주는 중간에서 상호작용 역할을 해준다.
• 사용자의 요청을 Controller가 받았다. (DispatcherServlet라는 Front Controller가 받음)
• Controller는 이 요청을 처리하기 위해 [apple]이란 단어를 가지고 있을 Model에게 전달한다.

(3)  Model

• 데이터와 비즈니스 로직을 담당한다. 
• 이때 클라이언트에게 응답으로 돌려주는 작업의 처리 결과 데이터를 Model이라 한다.
• Controller에게 온 요청을 잘 받았다.
• Model은 [apple]이란 단어 관련 데이터를 찾아 Controller에게 다시 전달한다.
• Controller는 받은 정보를 다시 View에게 보내고 View는 사용자에게 결과를 보여준다.

2. Spring MVC 구성요소와 순서

1번

• 사용자에게 요청(Requeest)이 들어왔다.
• 요청은 특정 URL과 함께 들어오게 되는데 GET, POST 등 HTTP 메서드가 함께 전달된다.

2번•3번

• 요청이 들어오면 Front Controller인 DispatcherServlet이 요청을 받게 된다.
• DispatcherServlet은 적절하게 처리할 Controller를 찾기 위해 HandlerMapping을 이용한다.
• 그렇게 HandlerMapping은 들어온 요청 경로와 HTTP 메서드에 따라 적절한 Controller를 정해 반환한다.

4번•5번

• HadlerMapping이 찾은 Controller는 요청을 실제로 처리하는 역할을 한다.
• Controller는 비즈니스 로직(예시로 회원가입을 처리하거나 쇼핑몰에서 결제를 처리하는 것)을 실행하고 그에 필요한 데이터 생성 혹은 DB에서 데이터를 불러온다.
• 쉽게 말해 View로 전달할 데이터를 준비하는 것이고, Model And View가 결과에 담겨 DispatcherServlet에 반환한다.

6번•7번

• 반환된 정보를 기준으로 클라이언트에게 적절하게 보여줄 View를 고를 것이다.
• View Resolver는 Controller가 반환한 View 이름을 기반으로 실제 View 파일을 전달한다.

8번

• View에서 View Rendering이 일어난다.
• View Rendering은 프레젠테이션 로직을 포함하고 있다.
• 프레젠테이션 로직을 통해 데이터를 기반으로 웹페이지를 생성하고 사용자에게 보여준다.

10번

• View에서 Rendering된 결과는 DispatcherServlet에 반환된다.
• 사용자는 자신이 요청한 결과를 받게된다.

3. Spring MVC 를 사용하는 이유

(1) DispathcerServlet

• 기본적으로 다른 MVC는 DispatcherServlet가 없다.
• 그렇기에 Controller가 요청을 받고, 직접처리도 한다.
• DispatcherServlet이 있기엔 요청 처리를 더 간결하게 처리할 수 있도록 해준다.

(2) @로 시작하는 어노테이션의 유무

• 어노테이션의 사용으로 인해 중복적으로 사용되는 코드를(혹은 비슷한 코드) 줄일 수 있다.
•  그로인해 가독성이 향상된다.

(3) Ioc(제어의 역전)와 DI(의존성주입)

• 객체간의 의존성을 프레임워크가 자동으로 주입하고 관리한다.

4. SpringMVC는 어떤식으로 구성을 해야하는가?

쇼핑몰에서 주문을 처리하는 것을 간략하게 예로 들어보자.

(1) Controller

주문이 들어왔을 때 주문 요청을 처리할 Controller를 만들어야한다.

@RestController  혹은 Controller
@RequestMapping("/요청이 들어온 경로")
public class OrderController {

 주문 요청을 직접 처리하지 않고, 해당하는 서비스 계층으로 넘긴다.

 주문 처리 성공시 어떻게 반환할지
 상태 코드와 데이터를 함께 보내는 등...

}

(2) Service

주문 요청을 받아 주문 객체를 생성하는 비즈니스 로직을 만들어야한다.

@Service
public class OrderServiceImpl implements OrderService {

 주문내역을 직접 처리

 예시로, 주문이 들어온 상품이 존재하는지 확인하거나
 생성된 주문을 데이터 베이스에 저장하거나 등...
 결과를 누구에게 반환할지까지 정하는 곳

}

(3) Repository

주문 내역을  저장할 저장소

public interface OrderRepository <Order, Long> {

 Order과 연결된 저장소로 작업 수행

}

(4) Entity

주문 데이터 모델로 주문이 들어오면 객체를 초기화

@Entity
public class Order {

 주문 고유의 ID를 만들거나
 여러개의 주문을 하나의 상품으로 연결되도록 하거나
 생성자를 이용하여 주문을 초기화해주는 것 등...
   
}

(5) DTO
요청과 응답만 연결하는 데이터 구조만 담당, 데이터 전달 객체

public class OrderRequest {

 주문에 필요한 데이터를 받는 객체
 상품 ID, 수량...

}

public class OrderResponse {

 주문 완료한 데이터 반환 객체
 주문 ID, 총 가격...

}

사실 스프링의 패턴에는 MVC만 있는 것은 아니다. 더 다양한 디자인 패턴이 존재하지만, 모델 - 뷰 - 컨트롤러로 용도를 나누고 서로의 역할엔 침범하지 않는 것이 큰 장점이 되어 MVC를 많이 사용하는 것 같다.

공부하면서 이해가 안되는 내용이 많았다.

이해한 내용까지만 블로그에 적어보았다.

아래 적어둔 출처에 들어가 한 번씩 읽어본다면 더 좋을 것 같다.

- spring 출처

- Spring MVC 출처

- Spring MVC의 장점 출처

- Spring MVC 출처

- Spring MVC 출처

- Mapping 출처