[스프링 MVC 1편] #6. 스프링 MVC - 기본 기능 (1) #262

6om1n · 2024-06-25T14:24:55Z

6om1n
Jun 25, 2024
Maintainer

✏️ 프로젝트 생성

프로젝트 생성시 주의할 점 : War 가 아닌 Jar 를 선택하기
Jar를 사용하면 항상 내장 서버 (톰켓) 을 사용하고, webapp 경로도 사용하지 않는다. 즉, 내장 서버 사용에 최적화 되어 있는 기능이다.
War 를 사용하면 내장 서버도 사용 가능하지만, 주로 외부 서버에 배포하는 목적으로 사용한다.

Annotation Processors 에 가서 enable annotaion processing 체크하기 !

🔍 Welcome 페이지 만들기

스프링 부트에 Jar 를 사용하면 /resources/static/ 위치에 index/html 파일을 두면 Welcome 페이지로 처리해준다.
스프링 부트가 지원하는 정적 컨텐츠 위치 /index.html 이 있으면 된다 !

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<ul>
    <li>로그 출력
        <ul>
            <li><a href="/log-test">로그 테스트</a></li>
        </ul>
    </li>
    <!-- -->
    <li>요청 매핑
        <ul>
            <li><a href="/hello-basic">hello-basic</a></li>
            <li><a href="/mapping-get-v1">HTTP 메서드 매핑</a></li>
            <li><a href="/mapping-get-v2">HTTP 메서드 매핑 축약</a></li>
            <li><a href="/mapping/userA">경로 변수</a></li>
            <li><a href="/mapping/users/userA/orders/100">경로 변수 다중</a></li>
            <li><a href="/mapping-param?mode=debug">특정 파라미터 조건 매핑</a></li>
            <li><a href="/mapping-header">특정 헤더 조건 매핑(POST MAN 필요)</a></li>
            <li><a  href="/mapping-consume">미디어 타입 조건 매핑 Content-Type(POSTMAN 필요)</a></li>
            <li><a href="/mapping-produce">미디어 타입 조건 매핑 Accept(POST MAN 필요)</a></li>
        </ul>
    </li>
    <li>요청 매핑 - API 예시
        <ul>
            <li>POST MAN 필요</li>
        </ul>
    </li>
    <li>HTTP 요청 기본
        <ul>
            <li><a href="/headers">기본, 헤더 조회</a></li>
        </ul>
    </li>
    <li>HTTP 요청 파라미터
        <ul>
            <li><a href="/request-param-v1?username=hello&age=20">요청 파라미터 v1</a></li>
            <li><a  href="/request-param-v2?username=hello&age=20">요청 파라미터 v2</a></li>
            <li><a href="/request-param-v3?username=hello&age=20">요청 파라미터 v3</a></li>
            <li><a href="/request-param-v4?username=hello&age=20">요청 파라미터 v4</a></li>
            <li><a href="/request-param-required?username=hello&age=20">요청 파라미터 필수</a></li>
            <li><a href="/request-param-default?username=hello&age=20">요청 파라미터 기본 값</a></li>
            <li><a href="/request-param-map?username=hello&age=20">요청 파라미터 MAP</a></li>
            <li><a href="/model-attribute-v1?username=hello&age=20">요청 파라미터
                @ModelAttribute v1</a></li>
            <li><a href="/model-attribute-v2?username=hello&age=20">요청 파라미터
                @ModelAttribute v2</a></li>
        </ul>
    </li>
    <li>HTTP 요청 메시지
        <ul>
            <li>POST MAN</li>
        </ul>
    </li>
    <li>HTTP 응답 - 정적 리소스, 뷰 템플릿
        <ul>
            <li><a href="/basic/hello-form.html">정적 리소스</a></li>
            <li><a href="/response-view-v1">뷰 템플릿 v1</a></li>
            <li><a href="/response-view-v2">뷰 템플릿 v2</a></li>
        </ul>
    </li>
    <li>HTTP 응답 - HTTP API, 메시지 바디에 직접 입력
        <ul>
            <li><a href="/response-body-string-v1">HTTP API String v1</a></li>
            <li><a href="/response-body-string-v2">HTTP API String v2</a></li>
            <li><a href="/response-body-string-v3">HTTP API String v3</a></li>
            <li><a href="/response-body-json-v1">HTTP API Json v1</a></li>
            <li><a href="/response-body-json-v2">HTTP API Json v2</a></li>
        </ul>
    </li>
</ul>
</body>
</html>

✏️ 로깅 간단히 알아보기

⭐ 운영 시스템에서는 `System.out.println()` 같은 시스템 콘솔을 사용해서 정보를 출력하지 않고, 로깅 라이브러리를 사용해서 로그 를 출력한다.

스프링 부트 로깅 라이브러리는 기본으로 다음 로깅 라이브러리를 사용한다.

SLF4J - http://www.slf4j.org

Logback - http://logback.qos.ch

로그 라이브러리는 많이 있는데 그것을 통합해서 인터페이스로 제공하는 것이 SLF4J 라이브러리 이다.

로그 선언

private Logger log = LoggerFactory.getLogger(getClass());

private static final Logger log = LoggerFactory.getLogger(Xxx.class)

@Slf4j : 롬복 사용 가능

로그 호출

log.info("hello")

System.out.println("hello")

LogTestController

package hello.springmvc.basic;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RestController
public class LogTestController {

    // private final Logger log = LoggerFactory.getLogger(getClass()); // 안에 클래스 정보만 있으면 된다.

    @RequestMapping ("/log-test")
    public String logTest() {
        String name = "Spring";
        System.out.println("name = " + name); // 이건 무조건 출력이 되서 사용하면 안된다.

        log.trace("trace my log=" + name); // 이렇게 하면 쓸모없는 리소스가 사용이 되어서 이렇게 하면 안된다.
        log.trace("trace log={}", name); // 두개는 기록되지 않음
        log.debug("debug log={}", name); // 두개는 기록되지 않음
        log.info ("info log={}", name);
        log.warn(" warn log={}", name);
        log.error("error log={}", name);
        return "ok";
    }
}

매핑 정보

@RestController

@Controller 는 반환 값이 String 이면 뷰 이름으로 인식된다. 따라서 뷰를 찾고 뷰가 랜더링 된다.

@RestController 는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력 한다. 따라서 실행 결과로 ok 메시지를 받을 수 있다.

위의 코드를 실행시켰을 때 볼 수 있는 로그

시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스 명, 로그 메시지가 로깅되는 것을 확인할 수 있다.

위와 같은 실행 결과를 내기 위해 application.properties 에서
logging.level.hello.springmvc=trace 를 추가하였다.

로그 레벨 설정 변경하여 출력 결과 확인하기

LEVEL : TRACE > DEBUG > INFO > WARN > ERROR

개발 서버는 debug 출력

운영 서버는 info 출력

⭐ 올바른 로그 사용법

log.debug("data="+data)
- 로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data="+data 가 실제 실행이 된다. (실제 로그는 출력되지 않음)
- 결과적으로 문자 더하기 연산이 발생한다. (자원 낭비)
log.debug("data={}", data)
- 로그 출력 레벨을 info 로 설정하면 아무 일이 발생하지 않는다.
- 앞과 같은 의미 없는 연산이 발생하지 않는다.
로그 사용시 장점
- 쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.
- 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.
- 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다. 특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.
- 성능도 일반 System.out 보다 좋다.
- 따라서 실무에서는 꼭 로그를 사용해야 한다.

✏️ 요청 매핑

MappingController

package hello.springmvc.basic.requestmapping;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;

@RestController
public class MappingController {

    private Logger log = LoggerFactory.getLogger(getClass());

    @RequestMapping("/hello-basic")
    public String helloBasic() {
        log.info("helloBasic");
        return "OK";
    }
}

🔍 HTTP 메서드

@RequestMapping 에 method 속성으로 HTTP 메서드를 지정하지 않으면 HTTP 메서드와 무관하게 호출된다.
GET, HEAD, POST, PUT, PATCH, DELETE 모두 허용

🔍 HTTP 메서드 매핑

  /**
     * method 특정 HTTP 메서드 요청만 허용
     * GET, HEAD, POST, PUT, PATCH, DELETE
     */
    @RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)
    public String mappingGetV1() {
        log.info("mappingGetV1");
        return "ok";
    }

위의 코드는 GET 메서드만을 사용해야 한다. 만약 POST 요청을 하면 HTTP 405 상태코드 (Method Not Allowed) 를 반환한다.

🔍 HTTP 메서드 매핑 축약

/**
     * 편리한 축약 애노테이션 (코드보기)
     * @GetMapping
     * @PostMapping
     * @PutMapping
     * @DeleteMapping
     * @PatchMapping
     */
    @GetMapping(value = "/mapping-get-v2")
    public String mappingGetV2() {
        log.info("mapping-get-v2");
        return "ok";
    }

method = 이런 식으로 사용하지 않고 HTTP 메서드를 축약한 애노테이션을 사용하는 것이 직관적이다.

🔍 PathVariable(경로 변수) 사용

    /**
     * PathVariable 사용
     * 변수명이 같으면 생략 가능
     * @PathVariable("userId") String userId -> @PathVariable String userId
     */
    @GetMapping("/mapping/{userId}")
    public String mappingPath(@PathVariable("userId") String data) {
        log.info("mappingPath userId={}", data);
        return "ok";
    }

실행 : http://localhost:8080/mapping/userA
@RequestMapping 은 URL 경로를 템플릿화 할 수 있는데, @PathVariable 을 사용하면 매칭 되는 부분을 편리하게 조회할 수 있다.
@PathVariable 의 이름과 파라미터 이름이 같으면 생략할 수 있다.

🔍 PathVariable 사용 - 다중

/**
     * PathVariable 사용 다중
     */
    @GetMapping("/mapping/users/{userId}/orders/{orderId}")
    public String mappingPath(@PathVariable String userId, @PathVariable Long
            orderId) {
        log.info("mappingPath userId={}, orderId={}", userId, orderId);
        return "ok";
    }

🔍 특정 파라미터 조건 매핑

 /**
     * 파라미터로 추가 매핑
     * params="mode",
     * params="!mode"
     * params="mode=debug"
     * params="mode!=debug" (! = )
     * params = {"mode=debug","data=good"}
     */
    // 특정 파라미터 정보가 있으면 출력이 된다라는 뜻 -> 잘은 사용안한다.
    @GetMapping(value = "/mapping-param", params = "mode=debug")
    public String mappingParam() {
        log.info("mappingParam");
        return "ok";
    }

잘은 사용되지 않는다.

🔍 특정 헤더 조건 매핑

 /**
     * 특정 헤더로 추가 매핑
     * headers="mode",
     * headers="!mode"
     * headers="mode=debug"
     * headers="mode!=debug" (! = )
     */
    @GetMapping(value = "/mapping-header", headers = "mode=debug")
    public String mappingHeader() {
        log.info("mappingHeader");
        return "ok";
    }

Postman 으로 테스트 해야 한다.

🔍 미디어 타입 조건 매핑 - HTTP 요청 Content-Type

 /**
     * Content-Type 헤더 기반 추가 매핑 Media Type
     * consumes="application/json"
     * consumes="!application/json"
     * consumes="application/*"
     * consumes="*\/*"
     * MediaType.APPLICATION_JSON_VALUE
     */
    @PostMapping(value = "/mapping-consume", consumes = MediaType.APPLICATION_JSON_VALUE)
    public String mappingConsumes() {
        log.info("mappingConsumes");
        return "ok";
    }

HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑한다.
만약 맞지 않으면 HTTP 415 상태코드를 반환한다.

🔍 미디어 타입 조건 매핑 - HTTP 요청 Accept, produce

 /**
     * Accept 헤더 기반 Media Type
     * produces = "text/html"
     * produces = "!text/html"
     * produces = "text/*"
     * produces = "*\/*"
     */
    @PostMapping(value = "/mapping-produce", produces = MediaType.TEXT_HTML_VALUE)
    public String mappingProduces() {
        log.info("mappingProduces");
        return "ok";
    }

HTTP 요청 Accept 헤더를 기반으로 미디어 타입으로 매핑한다.

만약 맞지 않으면 HTTP 406 상태코드(Not Acceptable) 을 반환한다.

✏️ 요청 매핑 - API 예시

🔍 회원 관리 API

회원 목록 조회 : GET /users
회원 등록 : POST /users
회원 조회 : GET /users/{userId}
회원 수정 : PATCH /users/{userId}
회원 삭제 : DELETE /users/{userId}
MappingClassController

package hello.springmvc.basic.requestmapping;

import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {
    /**
     * 회원 목록 조회 : GET   /users
     * 회원 등록 : POST      /users
     * 회원 조회 : GET       /users/{userId}
     * 회원 수정 : PATCH     /users/{userId}
     * 회원 삭제 : DELETE    /users/{userId}
     */
    @GetMapping
    public String user() {
        return "get users";
    }

    @PostMapping
    public String addUser() {
        return "post user";
    }

    @GetMapping("/{userId}")
    public String findUser(@PathVariable String userId) {
        return "get userId=" + userId;
    }
    @PatchMapping("/{userId}")
    public String updateUser(@PathVariable String userId) {
        return "update userId=" + userId;
    }
    @DeleteMapping("/{userId}")
    public String deleteUser(@PathVariable String userId) {
        return "delete userId=" + userId;
    }
}

/mapping 은 다른 예제들과 구별하기 위해 사용함.
@RequestMapping("/mapping/users")
- 클래스 레벨에 매핑 정보를 두면 메서드 레벨에서 해당 정보를 조합해서 사용한다.
- 위의 예시에서는 우선 string으로 반환값만 지정해주었다.

Postman 으로 테스트

회원 목록 조회 : GET /mapping/users
회원 등록 : POST /mapping/users
회원 조회 : GET /mapping/users/id1
회원 수정 :PATCH /mapping/users/id1
회원 삭제 : DELETE /mapping/users/id1
url은 같고 method를 사용하여 구분한다.

🔗출처

김영한 - 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술

seyxxn · 2024-06-25T15:53:37Z

seyxxn
Jun 25, 2024
Maintainer

귣귣 ! 👏

0 replies

YuDeokRin · 2024-06-26T12:09:35Z

YuDeokRin
Jun 26, 2024
Maintainer

점점 정리가 퀄리티가 높아지네요 ㅎㅎ

2 replies

seyxxn Jun 27, 2024
Maintainer

인정 !!!

6om1n Jun 29, 2024
Maintainer Author

왕 감사합니다 !! 😆😊

Navigation Menu

Uh oh!

[스프링 MVC 1편] #6. 스프링 MVC - 기본 기능 (1) #262

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 2 comments 2 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Uh oh!

[스프링 MVC 1편] #6. 스프링 MVC - 기본 기능 (1) #262

Uh oh!

Uh oh!

6om1n Jun 25, 2024 Maintainer

✏️ 프로젝트 생성

🔍 Welcome 페이지 만들기

✏️ 로깅 간단히 알아보기

⭐ 운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 정보를 출력하지 않고, 로깅 라이브러리를 사용해서 로그 를 출력한다.

⭐ 올바른 로그 사용법

✏️ 요청 매핑

🔍 HTTP 메서드

🔍 HTTP 메서드 매핑

🔍 HTTP 메서드 매핑 축약

🔍 PathVariable(경로 변수) 사용

🔍 PathVariable 사용 - 다중

🔍 특정 파라미터 조건 매핑

🔍 특정 헤더 조건 매핑

🔍 미디어 타입 조건 매핑 - HTTP 요청 Content-Type

🔍 미디어 타입 조건 매핑 - HTTP 요청 Accept, produce

✏️ 요청 매핑 - API 예시

🔍 회원 관리 API

Postman 으로 테스트

🔗출처

Replies: 2 comments · 2 replies

Uh oh!

seyxxn Jun 25, 2024 Maintainer

Uh oh!

YuDeokRin Jun 26, 2024 Maintainer

Uh oh!

seyxxn Jun 27, 2024 Maintainer

Uh oh!

6om1n Jun 29, 2024 Maintainer Author

6om1n
Jun 25, 2024
Maintainer

⭐ 운영 시스템에서는 `System.out.println()` 같은 시스템 콘솔을 사용해서 정보를 출력하지 않고, 로깅 라이브러리를 사용해서 로그 를 출력한다.

Replies: 2 comments 2 replies

seyxxn
Jun 25, 2024
Maintainer

YuDeokRin
Jun 26, 2024
Maintainer

seyxxn Jun 27, 2024
Maintainer

6om1n Jun 29, 2024
Maintainer Author