[SPRING] 스프링 MVC - 기본 기능

3 분 소요

프로젝트 생성

스프링 부트 스타터 사이트로 이동해서 스프링 프로젝트를 생성한다.
https://start.spring.io

Welocome 페이지 만들기

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

로깅 간단히 알아보기

운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않고, 별도의 로깅 라이브러리를 사용해서 로그를 출력한다. 참고로 로그 관련 라이브러리도 많고, 깊게 들어가면 끝이 없기 때문에, 여기서는 최소한의 사용 방법만 알아본다.

로깅 라이브러리

로그 라이브러리는 Logback, Log4J, Log4J2 등등 수 많은 라이브러리가 있는데, 그것을 통합해서 인터페이스로 제공하는 것이 바로 SLF4J 라이브러리다.
쉽게 이야기해서 SLF4J는 인터페이스이고, 그 구현체로 Logback 같은 로그 라이브러리를 선택하면 된다. 실무에서는 스프링 부트가 기본으로 제공하는 Logback을 대부분 사용한다.

예시

... 

// import org.slf4j.Logger; // slf4j 라이브러리를 사용한다.
// import org.slf4j.LoggerFactory; // slf4j 라이브러리를 사용한다.

@Slf4j // lombok이 제공하는 애노테이션
@RestController // 반환 값을 HTTP 메시지 바디에 바로 입력한다.
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 log={}", name);
        log.debug("debug log={}", name);
        log.info("info log={}", name);
        log.warn("warn log={}", name);
        log.error("error log={}", name);

        return "ok";
    }
}

이때 lombok이 제공하는 @Slf4j 애노테이션을 사용함으로써 로그 선언 코드를 제거할 수 있다.

로그가 출력되는 포멧 확인
- 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지
로그 레벨 설정을 변경해서 출력 결과를 보자.
- LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
- 개발 서버는 debug 출력
- 운영 서버는 info 출력

@RestController

@Controller는 반환 값이 String 이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 랜더링 된다.
@RestController는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다.
따라서 실행 결과로 ok 메세지를 받을 수 있다. @ResponseBody와 관련이 있는데, 뒤에서 더 자세히 설명한다.

올바른 로그 사용법

log.trace("trace log={}", name); 처럼 사용해야지, log.trace("trace log=" + name);로 사용하면 안된다! 🚨
(후자와 같은 방법으로 사용하게 되면 의미없는 + 연산이 일어나기 때문이다.)

로그 레벨 설정을 변경하는 방법

main/resources/application.properties에서 아래 코드를 추가해 설정을 변경할 수 있다.

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

# hello.springmvc 패키지와 그 하위 로그 레벨 설정 (debug로 설정하면 debug,info,warn,error 레벨을 볼 수 있다.)
logging.level.hello.springmvc=debug

이때 trace로 설정하면 TRACE > DEBUG > INFO > WARN > ERROR을 모두 볼 수 있으며, info로 설정하면 INFO > WARN > ERROR를 볼 수 있는 것이다.

로그 사용시 장점

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

따라서 실무에서는 꼭 로그를 사용해야 한다!

요청 매핑

PathVariable(경로 변수) 사용

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

최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다.

/mapping/userA
users/1

@RequestMapping은 URL 경로를 템플릿화 할 수 있는데, @PathVariable을 사용하면 매칭 되는 부분을 편리하게 조회할 수 있다.
@PathVariable의 이름과 파라미터 이름이 같으면 아래와 같이 생략할 수 있다.

public String mappingPath(@PathVariable userId){ ... }

PathVriable 사용 - 다중

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

API 예시

회원 관리를 HTTP API로 만든다 생각하고 매핑을 어떻게 하는지 알아보자. (실제 데이터가 넘어가는 부분은 생략하고 URL 매핑만!)

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

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

    // 회원 목록 조회
    @GetMapping
    public String user(){
        return "get users";
    }

    // 회원 등록
    @PostMapping
    public String addUser(){
        return "post users";
    }

    // 회원 조회
    @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;
    }
}

💛 개인 공부 기록용 블로그입니다. 👻

맨 위로 이동하기

Twitter Facebook LinkedIn

Minju412