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

Spring 정리 2022. 5. 15. 17:47

인프런 강의 37일차.

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

 - 서블릿, JSP, MVC 패턴

 - 서블릿으로 1차 구현

   -> 서블릿으로 구현했을 때 불편한 점 개선을 위해 JSP로 2차 구현

   -> JSP로도 불편한 점을 개선하기 위해 MVC 패턴으로 3차 구현

 - 스프링 프로젝트 시작

   -> 스프링 기본기능 이해

   -> 스프링 MVC 웹페이지 만들기

 

4. 스프링 MVC - 기본 기능

 4.1 프로젝트 생성

  > 스프링 프로젝트 생성 (https://start.spring.io)

   - 프로젝트 선택 Project: Gradle Project

   - Language: Java

   - Spring Boot: 2.6.x

   - Group: hello

   - Artifact: springmvc

   - Name: springmvc

   - Package name: hello.springmvc

   - Packaging: Jar

   - Java: 11

   - Dependencies: Spring Web, Thymeleaf, Lombok

  > Packaging는 War가 아니라 Jar를 선택. JSP를 사용하지 않기 때문에 Jar를 사용하는 것이 좋습니다.

  > Jar를 사용하면 항상 내장 서버(톰캣등)을 사용하고, webapp 경로도 사용하지 않습니다.

  > 내장 서버 사용에 최적화 되어 있는 기능입니다.

  > War를 사용하면 내장 서버도 사용가능 하지만, 주로 외부 서버에 배포하는 목적으로 사용합니다.

* gradle.build 실행 후 아래 오류 발생 시 gradle-wrapper.properties에서 gradle 버전을 6.9 이하로 변경해서 다운로드하자. (gradle-6.9-all.zip)

 > Unable to find method 'org.gradle.api.artifacts.result.ComponentSelectionReason.getDescription()Ljava/lang/String;'. Possible causes for this unexpected error include: Gradle's dependency cache may be corrupt (this sometimes occurs after a network connection timeout.) Re-download dependencies and sync project (requires network)

 

  > Welcome 페이지 생성

   - 스프링부트에 Jar를 사용하면 /resources/static/index.html 파일이 존재할 시 Welcome 페이지로 처리해준다.

Welcome 페이지 처리 확인

 4.2 로깅 간단히 알아보기
   - 스프링부트에서는 SLF4J, Logback 라이브러리를 사용한다.

   - 로그 라이브러리는 Logback, Log4J 등 다양한 라이브러리가 있는데, 그것을 통합해서 인터페이스로 제공하는 것이 SLF4J 이다.

   - SLF4J는 인터페이스이고, 그 구현체로 Logback 같은 로그 라이브러리를 선택하면 된다

   - 실무에서는 스프링 부트가 기본으로 제공하는 Logback을 대부분 사용한다.

  > @RestController

   - @Controller 는 반환 값이 String 이면 뷰 이름으로 인식된다. 그래서 해당 뷰를 찾고 뷰가 랜더링 된다.  

   - @RestController 는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다.

   - 따라서 실행 결과로 ok 메세지를 받을 수 있다.

 

  > 로그 레벨 설정

   - application.properties 설정

#전체 로그 레벨 설정(기본 info)
logging.level.root=info

#hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=debug

  > 로그 사용법

   - log.debug("data="+data) : 로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data="+data가 실제 실행이 되어 버린다. 결과적으로 문자 더하기 연산이 발생한다. 즉 의미 없는 연산이 지속적으로 일어난다.

   - log.debug("data={}", data) : 로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않는다. 따라서 앞과 같은 의미없는 연산이 발생하지 않는다. (이렇게 사용해야함)

 

  > 로그 사용시 장점

   - 쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.

   - 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.

   - 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다.

   - 특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.

   - 성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등등) 그래서 실무에서는 꼭 로그를 사용해야 한다

 

 4.3 요청 매핑
package hello.springmvc.basic.requestmapping;

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

@RestController
public class MappingController {

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

    /**
     * 기본 요청
     * 둘다 허용 /hello-basic, /hello-basic/
     * HTTP 메서드 모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE
     */
    @RequestMapping({"/hello-basic", "/hello-go"})
    public String helloBasic(){
        log.info("helloBasic");
        return "ok";
    }
}

  > @RequestMapping("/hello-basic")

   -  /hello-basic URL 호출이 오면 이 메소드가 실행되도록 매핑한다.

   - 대부분의 속성을 배열[] 로 제공하므로 다중 설정이 가능하다. {"/hello-basic", "/hello-go"}

   - URL 요청: /hello-basic , /hello-basic/ (2개의 URL은 다른 URL이지만 스프링에서 /hello-basic으로 매핑해준다)

   - @RequestMapping 에 method 속성으로 HTTP 메소드를 지정하지 않으면 HTTP 메소드와 무관하게 호출된다.

   - 모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE

/**
 * 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 메소드로 호출했을 때만 정상반환하고, 나머지는 405 오류(Method not allowed)를 반환한다.

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

   - mapping-get-v1의 축약형 버전

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

 

   - @RequestMapping 은 URL 경로를 템플릿화 할 수 있는데, @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";
}

   - 실행 : http://localhost:8080/mapping/users/userA/orders/100

   - 실행결과 : mappingPath userId=userA, orderId=100

/**
 * 파라미터로 추가 매핑
 * 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";
}

   - 실행 : http://localhost:8080/mapping-param?mode=debug

   - 특정 파라미터가 있거나 없는 조건을 추가할 수 있다. 잘 사용하지는 않는다.

   - 정의된 모든 파라미터가 들어와야 실행된다.

/**
 * 특정 헤더로 추가 매핑
 * 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";
}

   - 파라미터 매핑과 비슷하지만, HTTP 헤더를 사용한다. (Postman으로 테스트해야한다)

   - header에 mode=debug 값을 추가해서 호출 시에만 정상적으로 호출된다.

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

  > 미디어 타입 조건 매핑 - HTTP 요청 Content-Type, consume

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

   - 만약 맞지 않으면 HTTP 415 상태코드(Unsupported Media Type)을 반환한다.

   - Postman으로 테스트 해야한다.

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

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

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

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

   - Header중 Accpet의 값을 application/json으로 테스트 해볼 시 406 에러 발생

 

* ContentType : consume 로 사용해야 한다.

* Accpet : produce 로 사용해야 한다.

 

 

  > 요청 매핑 - API 예시 (회원 관리 API)

package hello.springmvc.basic.requestmapping;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {

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

    /**
     * GET /mapping/users
     */
    @GetMapping
    public String users() {
        return "get users";
    }

    /**
     * POST /mapping/users
     */
    @PostMapping
    public String addUser() {
        return "post user";
    }

    /**
     * GET /mapping/users/{userId}
     */
    @GetMapping("/{userId}")
    public String findUser(@PathVariable String userId) {
        return "get userId=" + userId;
    }

    /**
     * PATCH /mapping/users/{userId}
     */
    @PatchMapping("/{userId}")
    public String updateUser(@PathVariable String userId) {
        return "update userId=" + userId;
    }

    /**
     * DELETE /mapping/users/{userId}
     */
    @DeleteMapping("/{userId}")
    public String deleteUser(@PathVariable String userId) {
        return "delete userId=" + userId;
    }
}

    - @RequestMapping("/mapping/users") 클래스 레벨에 매핑 정보를 두면 해당 정보를 조합해서 사용한다.