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

[YuDeokRin]

스프링 MVC - 기본 기능

1️⃣ 프로젝트 생성

spring mvc 환경 설정

• War를 선택하지않고 Jar 선택 이유

  • 이번 프로젝트는 jsp를 사용하지 않는다. jsp를 사용하지 않는 이상 Jar로 가는 것이 좋다.
  • Jar를 하게된다면 항상 내장 서버(톰켓)를 사용하고, webapp 경로도 사용하지 않는다.
  • War를 사용하면 내장 서버도 사용가능 하지만, 주로 외부 서버에 배포하는 목적으로 사용합니다.
  • 최근에는 주로 이 방식을 사용한다.

• Welcome 페이지 만들기

  • 스프링 부트에서는 Jar를 사용하면 /resources/static/ 위치에 index.html파일을 두면 welcome페이지로 처리한다.

2️⃣ 로깅 간단히 알아보기

• 개발이 아닌 운영 서버에서는 System.out.println() 함수를 사용하지 않는다. 그 역할을 대신 해주는 것이 로깅 라이브러리이다.

➡️ 로깅 라이브러리

• 스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리(spring-boot-starter-logging)가 포함되어 있다.

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

  • SLF4J - http://www.slf4j.org
  • Logback - http://logback.qos.ch

로그 라이브러리는 Logback, Log4J, Log4J2 등등 수 많은 라이브러리가 있다. 이것을 통합해서 인터페이스로 제공하는 것이 SLF4J 라이브러리다

• 예시) 인터페이스 SLF4J → 구현체 Logback 라이브러리

실무에서는 Logback을 대부분 사용한다.

• 로깅 테스트

package hello.springmvc.basic;

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

public class LogTestController {

    private final Logger log = LoggerFactory.getLogger(getClass()); // LogTestController.class

    @RequestMapping("log-test")
    public String logTest() {

        String name = "Spring";
        log.trace("trace log={}", name); // 잘못된 방식 : System.out.println("trace log={}" + name); 
        log.debug("debug log={}", name);
        log.info(" info log={}", name);
        log.warn(" warn log={}", name);
        log.error("error log={}", name);
        
        //로그를 사용하지 않아도 a+b 계산 로직이 먼저 실행됨, 이런 방식으로 사용하면 X log.debug("String concat log=" + name);
        return "ok";
    }
}

• 결과
  • trace, debug가 안나온다

• 로그의 레벨

  • TRACE > DEBUG(개발서버) > INFO(정보) > WARN(위험) > ERROR(에러)
  • 개발 서버는 debug 출력
  • 운영 서버는 info 출력

• 로그가 출력되는 포멧 확인

  • 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지

• 전체 로그 레벨 설정

  • (기본 info) logging.level.root=info
  • root : 프로젝트 전체

• 최근에는 로그 애너테이션 쓰게된다면.

  • @Slf4j

• 레벨 설정 - 패키지 그 하위 로그 레벨 설정

  • application.properties 에서 설정 : *logging.level.hello.springmvc*=trace

• 올바른 로그 사용법

  • log.debug("data="+data)
    • 로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data="+data가 실제 실행이 되어 버린다. 결과적으로 문자 더하기 연산이 발생한다.
  • log.debug("data={}", data)
    • 로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않는다. 따라서 앞과 같은 의미없는 연산이 발생하지 않는다.

• 로그 사용시 장점

  • 쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.
  • 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게조절할 수 있다.
  • 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다. 특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.
  • 성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등등) 그래서 실무에서는 꼭 로그를 사용해야 한다.

3️⃣ 요청 매핑

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

package hello.springmvc.basic;

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

@Slf4j
@RestController
public class requestmapping {

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

}

✅@RestController vs @Cotroller

• @controller는 반환 값이 String 이면 뷰 이름으로 인식한다. → 뷰를 찾고 뷰가 랜더링 된다.
• 반면에 @RestController는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다. 따라서 실행 결과로 ok 메세지를 받을 수 있다.

Tip.
스프링 부트 3.0 이후

스프링 부트 3.0 부터는 `/hello-basic` , `/hello-basic/` 는 서로 다른 URL 요청을 사용해야 한다. 
기존에는 마지막에 있는 `/` (slash)를 제거했지만, 스프링 부트 3.0 부터는 마지막의 `/` (slash)를 유지한다. 
따라서 다음과 같이 다르게 매핑해서 사용해야 한다.

-> 매핑: `/hello-basic` URL요청: `/hello-basic`
-> 매핑: `/hello-basic/` URL요청: `/hello-basic/`

✅HTTP 메소드

• @RequestMapping 에 method 속성을 지정하지 않으면 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";
 }

✅HTTP 메서드 매핑 축약

• @GetMapping
• @PostMapping
• @PutMapping
• @DeleteMapping
• @PatchMapping

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

✅PathVariable(경로 변수) 사용

• 최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다.
• @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";
 }

✅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";
 }

✅특정 헤더 조건 매핑

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

/**
* 특정 헤더로 추가 매핑
* 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 요청 Content-Type, consume

• HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑한다.
• 만약 맞지 않으면 HTTP 415 상태코드(Unsupported Media Type)을 반환한다.
• consumes = "application/json" → consumes = MediaType.APPLICATION_JSON_VALUE

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

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

• HTTP 요청의 Accept 헤더를 기반으로 미디어 타입으로 매핑한다.
• 만약 맞지 않으면 HTTP 406 상태코드(Not Acceptable)을 반환한다.

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

4️⃣ 요청 매핑 - API 예시

회원관리를 HTTP API로 만든다 가정하고 매핑을 어떻게하는지 알아보자.

✅회원 관리 API

• 회원 목록 조회: GET → /users

• 회원 등록:POST → /users

• 회원 조회: GET → /users/{userId}

• 회원 수정: PATCH → /users/{userId}

• 회원 삭제: DELETE → /users/{userId}

• MappingClassController

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

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

 @RestController
 @RequestMapping("/mapping/users")
 public class MappingClassController {
 
   /**
    * 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;
    }
 
 }

[6om1n]

수고하셨습니당 !! 😆