2023.06.03 Spring

스프링 김영한 인프런

스프링 MVC - 구조 이해

34. 스프링 MVC 전체 구조

스프링 MVC 전체 구조
직접 만든 MVC 프레임워크와 스프링 MVC를 비교해보자.
직접 만든 프레임워크 스프링 MVC 비교하면 다음과 같다.
이름에만 차이가 좀 있을 뿐이다.

FrontController DispatcherServlet
handlerMappingMap HandlerMapping
MyHandlerAdapter HandlerAdapter
ModelView ModelAndView
viewResolver ViewResolver 스프링의 viewResolver는 인터페이스라 더 확장성이 있다.
MyView View

DispatcherServlet 구조 살펴보기

org.springframework.web.servlet.DispatcherServlet

스프링 MVC도 프론트 컨트롤러 패턴으로 구현되어 있다.
스프링 MVC의 프론트 컨트롤러가 바로 디스패처 서블릿(DispatcherServlet)이다.
그리고 이 디스패처 서블릿이 바로 스프링 MVC의 핵심이다.

DispacherServlet 서블릿 등록
DispacherServlet도 부모 클래스에서 HttpServlet 을 상속 받아서 사용하고 서블릿으로 동작한다.
DispatcherServlet FrameworkServlet HttpServletBean HttpServlet
스프링 부트는 DispacherServlet 을 서블릿으로 자동으로 등록하면서 모든 경로( urlPatterns="/" )에 대해서 매핑한다.

더 자세한 경로가 우선순위가 높다.
그래서 기존에 등록한 서블릿도 함께 동작한다.

요청 흐름
서블릿이 호출되면 HttpServlet 이 제공하는 serivce() 가 호출된다.
스프링 MVC는 DispatcherServlet 의 부모인 FrameworkServlet 에서 service() 를 오버라이드 해두었다.

FrameworkServlet.service() 를 시작으로 여러 메소드가 호출되면서 DispacherServlet.doDispatch() 가 호출된다.

지금부터 DispacherServlet 의 핵심인 doDispatch() 코드를 분석해보자.
최대한 간단히 설명하기 위해 예외처리, 인터셉터 기능은 제외했다.

DispacherServlet.doDispatch()

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
HttpServletRequest processedRequest = request;
HandlerExecutionChain mappedHandler = null;
ModelAndView mv = null;
// 1. 핸들러 조회
mappedHandler = getHandler(processedRequest);
if (mappedHandler == null) {
    noHandlerFound(processedRequest, response);
    return;
}
// 2. 핸들러 어댑터 조회 - 핸들러를 처리할 수 있는 어댑터
HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
// 3. 핸들러 어댑터 실행 -> 4. 핸들러 어댑터를 통해 핸들러 실행 -> 5. ModelAndView 반환
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
processDispatchResult(processedRequest, response, mappedHandler, mv,
        dispatchException);
}

private void processDispatchResult(HttpServletRequest request,
        HttpServletResponse response, HandlerExecutionChain mappedHandler, ModelAndView mv, Exception exception)
        throws Exception {
    // 뷰 렌더링 호출
    render(mv, request, response);
}

protected void render(ModelAndView mv, HttpServletRequest request,
        HttpServletResponse response) throws Exception {
    View view;
    String viewName = mv.getViewName();
    // 6. 뷰 리졸버를 통해서 뷰 찾기, 7. View 반환
    view = resolveViewName(viewName, mv.getModelInternal(), locale, request);
    // 8. 뷰 렌더링
    view.render(mv.getModelInternal(), request, response);
}

동작 순서
1.핸들러 조회: 핸들러 매핑을 통해 요청 URL에 매핑된 핸들러(컨트롤러)를 조회한다.
2.핸들러 어댑터 조회: 핸들러를 실행할 수 있는 핸들러 어댑터를 조회한다.
3.핸들러 어댑터 실행: 핸들러 어댑터를 실행한다.
4.핸들러 실행: 핸들러 어댑터가 실제 핸들러를 실행한다.
5.ModelAndView 반환: 핸들러 어댑터는 핸들러가 반환하는 정보를 ModelAndView로 변환해서 반환한다.
6.viewResolver 호출: 뷰 리졸버를 찾고 실행한다.
JSP의 경우는 InternalResourceViewResolver 가 자동 등록되고 사용된다.
7.View 반환: 뷰 리졸버는 뷰의 논리 이름을 물리 이름으로 바꾸고, 렌더링 역할을 담당하는 뷰 객체를 반환한다.
JSP의 경우는 InternalResourceView(JstlView) 를 반환하는데 내부에 forward() 로직이 있다.
8.뷰 렌더링: 뷰를 통해서 뷰를 렌더링 한다

타임리프는 내부에서 렌더링하는게 따로 있다.

인터페이스 살펴보기
스프링 MVC의 큰 강점은 DispatcherServlet 코드의 변경 없이 원하는 기능을 변경하거나 확장할 수 있다는 점이다.
지금까지 설명한 대부분을 확장 가능할 수 있게 인터페이스로 제공한다.
이 인터페이스들만 구현해서 DispatcherServlet 에 등록하면 나만의 컨트롤러를 만들 수도 있다.

주요 인터페이스 목록
핸들러 매핑: org.springframework.web.servlet.HandlerMapping
핸들러 어댑터: org.springframework.web.servlet.HandlerAdapter
뷰 리졸버: org.springframework.web.servlet.ViewResolver
뷰: org.springframework.web.servlet.View

정리
스프링 MVC는 코드 분량도 매우 많고 복잡해서 내부 구조를 다 파악하는 것은 쉽지 않다.
사실 해당 기능을 직접 확장하거나 나만의 컨트롤러를 만드는 일은 없으므로 걱정하지 않아도 된다.
왜냐하면 스프링 MVC는 전세계 수 많은 개발자들의 요구사항에 맞추어 기능을 계속 확장해왔고
그래서 웹 애플리케이션을 만들 때 필요로 하는 대부분의 기능이 이미 다 구현되어 있다.

그래도 이렇게 핵심 동작방식을 알아두어야 향후 문제가 발생했을 때 어떤 부분에서 문제가 발생했는지 쉽게 파악하고, 문제를 해결할 수 있다.
그리고 확장 포인트가 필요할 때 어떤 부분을 확장해야 할지 감을 잡을 수 있다.
실제 다른 컴포넌트를 제공하거나 기능을 확장하는 부분들은 강의를 진행하면서 조금씩 알 수 있다.
지금은 전체적인 구조가 이렇게 되어 있구나 하고 이해하면 된다. 우리가 지금까지 함께 개발한 MVC 프레임워크와 유사한 구조이다.

35. 핸들러 매핑과 핸들러 어댑터

핸들러 매핑과 핸들러 어댑터가 어떤 것들이 어떻게 사용되는지 알아보자.
지금은 어노테이션이 있어서(@Controller) 전혀 사용하지 않지만 과거에 주로 사용했던 스프링이 제공하는 간단한 컨트롤러로 핸들러 매핑과 어댑터를 이해해보자.

Controller 인터페이스
과거 버전 스프링 컨트롤러
ModelAndView를 반환하고 request response를 반환한다.

org.springframework.web.servlet.mvc.Control

public interface Controller {
    ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception;
}

간단하게 구현해보았다.

@Component("/springmvc/old-controller")
public class OldController implements Controller {

    @Override
    public ModelAndView handleRequest(HttpServletRequest request,
            HttpServletResponse response) throws Exception {
        System.out.println("OldController.handleRequest");
        return null;
    }
}

/springmvc/old-controller 라는 이름의 스프링 빈으로 등록된것을 부르면 콘솔에 OldController.handleRequest 이 출력되면 성공이다.

이 컨트롤러가 호출되려면 다음 2가지가 필요하다.

35.1 HandlerMapping(핸들러 매핑)

핸들러 매핑에서 이 컨트롤러를 찾을 수 있어야 한다.
예) 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요하다.
스프링 빈이름으로 찾을 수 있게 특수한 이름을 지어줘야한다.

35.2 HandlerAdapter(핸들러 어댑터)

핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.
예) Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 한다.

스프링은 이미 필요한 핸들러 매핑과 핸들러 어댑터를 대부분 구현해두었다.
개발자가 직접 핸들러 매핑과 핸들러 어댑터를 만드는 일은 거의 없다.

스프링 부트가 자동 등록하는 핸들러 매핑과 핸들러 어댑터가 있다.

더 많지만 일부분만 작성되어 있다.

HandlerMapping
0순위 RequestMappingHandlerMapping : 어노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
1순위 BeanNameUrlHandlerMapping : 스프링 빈의 이름으로 핸들러를 찾는다. url이들어오면 url이랑 같은 스프링빈을 찾는다.
위의 @Component("/springmvc/old-controller")

이제 핸들러를 찾으면 적용가능한 핸들러 어댑터목록을 찾게된다.

HandlerAdapter
0순위 RequestMappingHandlerAdapter : 어노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
1순위 HttpRequestHandlerAdapter : HttpRequestHandler 처리
2순위 SimpleControllerHandlerAdapter : Controller 인터페이스(어노테이션X, 과거에 사용) 처리
위에서 사용한 implements Controller했던 것의 handle

핸들러 매핑도, 핸들러 어댑터도 모두 순서대로 찾고 만약 없으면 다음 순서로 넘어간다.
1.핸들러 매핑으로 핸들러 조회

1.1.HandlerMapping 을 순서대로 실행해서, 핸들러를 찾는다.
1.2.이 경우 빈 이름으로 핸들러를 찾아야 하기 때문에 이름 그대로 빈 이름으로 핸들러를 찾아주는

BeanNameUrlHandlerMapping가 실행에 성공하고 핸들러인 OldController 를 반환한다.
2.핸들러 어댑터 조회
2.1.HandlerAdapter 의 supports() 를 순서대로 호출한다.
2.2.SimpleControllerHandlerAdapter 가 Controller 인터페이스를 지원하므로 대상이 된다.

3.핸들러 어댑터 실행
3.1.디스패처 서블릿이 조회한 SimpleControllerHandlerAdapter 를 실행하면서 핸들러 정보도 함께 넘겨준다.
3.2. SimpleControllerHandlerAdapter 는 핸들러인 OldController 를 내부에서 실행하고 그 결과를 반환한다.

정리 - OldController 핸들러매핑, 어댑터
OldController 를 실행하면서 사용된 객체는 다음과 같다.
HandlerMapping = BeanNameUrlHandlerMapping
HandlerAdapter = SimpleControllerHandlerAdapter

public interface HttpRequestHandler {
    void handleRequest(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException;
}

---

@Component("/springmvc/request-handler")
public class MyHttpRequestHandler implements HttpRequestHandler {
    @Override
    public void handleRequest(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        System.out.println("MyHttpRequestHandler.handleRequest");
    }

1.핸들러 매핑으로 핸들러 조회
1.1. HandlerMapping 을 순서대로 실행해서, 핸들러를 찾는다.
1.2. 이 경우 빈 이름으로 핸들러를 찾아야 하기 때문에 이름 그대로 빈 이름으로 핸들러를 찾아주는 BeanNameUrlHandlerMapping 가 실행에 성공하고 핸들러인 MyHttpRequestHandler 를 반환한다.

2.핸들러 어댑터 조회
2.1. HandlerAdapter 의 supports() 를 순서대로 호출한다.
2.2. HttpRequestHandlerAdapter 가 HttpRequestHandler 인터페이스를 지원하므로 대상이 된다.

3.핸들러 어댑터 실행
3.1. 디스패처 서블릿이 조회한 HttpRequestHandlerAdapter 를 실행하면서 핸들러 정보도 함께 넘겨준다.
3.2. HttpRequestHandlerAdapter 는 핸들러인 MyHttpRequestHandler 를 내부에서 실행하고, 그 결과를 반환한다.

정리 - MyHttpRequestHandler 핸들러매핑, 어댑터
MyHttpRequestHandler 를 실행하면서 사용된 객체는 다음과 같다.
HandlerMapping = BeanNameUrlHandlerMapping
HandlerAdapter = HttpRequestHandlerAdapter

@RequestMapping
조금 뒤에서 설명하겠지만 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping과 RequestMappingHandlerAdapter 이다.
@RequestMapping 의 앞글자를 따서 만든 이름인데 이것이 바로 지금 스프링에서 주로 사용하는 어노테이션 기반의 컨트롤러를 지원하는 매핑과 어댑터이다.
구조는 위와 같지만 실무에서는 99.9% 이 방식의 컨트롤러를 사용한다

36. 뷰 리졸버

이번에는 뷰 리졸버에 대해서 자세히 알아보자

OldController에서 view를 조회할수있도록 변경해보자.
논리적인 view이름만 반환하면된다.

@Component("/springmvc/old-controller")
public class OldController implements Controller {

    @Override
    public ModelAndView handleRequest(HttpServletRequest request,
            HttpServletResponse response) throws Exception {
        System.out.println("OldController.handleRequest");
        return new ModelAndView("new-form");
    }
}

웹 브라우저에 Whitelabel Error Page 가 나오고, 콘솔에 OldController.handleRequest이 출력된다.
이러면 뷰를 찾지 못한것인데

application.properties 에 다음 코드를 추가해서 뷰 리졸버를 설정해줘야한다.

spring.mvc.view.prefix=/WEB-INF/views/
spring.mvc.view.suffix=.jsp

뷰 리졸버 - InternalResourceViewResolver
스프링 부트는 InternalResourceViewResolver 라는 뷰 리졸버를 자동으로 등록하는데
이때 application.properties에 등록한 spring.mvc.view.prefix , spring.mvc.view.suffix설정 정보를 사용해서 등록한다.
참고로 권장하지는 않지만 설정 없이 다음과 같이 전체 경로를 주어도 동작하기는 한다.

return new ModelAndView("/WEB-INF/views/new-form.jsp");

원래 다음과 같이 설정해줘야하는데 스프링부트가 알아서 설정해준다.

@ServletComponentScan // 서블릿 자동 등록
@SpringBootApplication
public class ServletApplication {

    public static void main(String[] args) {
        SpringApplication.run(ServletApplication.class, args);
    }

    @Bean
    InternalResourceViewResolver internalResourceViewResolver() {
        return new InternalResourceViewResolver("/WEB-INF/views/", ".jsp");
    }
}

스프링 부트가 자동 등록하는 뷰 리졸버
실제로는 더 많지만 중요한 부분 위주로 설명하기 위해 일부 생략

1순위 BeanNameViewResolver : 빈 이름으로 뷰를 찾아서 반환한다.
(예: 엑셀 파일 생성기능에 사용)
2순위 InternalResourceViewResolver : JSP를 처리할 수 있는 뷰를 반환한다.

1.핸들러 어댑터 호출
핸들러 어댑터를 통해 new-form 이라는 논리 뷰 이름을 획득한다.

2.ViewResolver 호출
new-form이라는 뷰 이름으로 viewResolver를 순서대로 호출한다.
BeanNameViewResolver는 new-form 이라는 이름의 스프링 빈으로 등록된 뷰를 찾아야 하는데 없다.


InternalResourceViewResolver 가 호출된다.

3.InternalResourceViewResolver
이 뷰 리졸버는 InternalResourceView를 반환한다.

4.뷰 - InternalResourceView
InternalResourceView 는 JSP처럼 포워드 forward() 를 호출해서 처리할 수 있는 경우에 사용한다.

5.view.render()
view.render() 가 호출되고 InternalResourceView 는 forward() 를 사용해서 JSP를 실행한다.

참고
InternalResourceViewResolver 는 만약 JSTL 라이브러리가 있으면 InternalResourceView 를 JstlView 를 반환한다.
JstlView 는 JSTL 태그 사용시 약간의 부가 기능이 추가된다.

다른 뷰는 실제 뷰를 렌더링하지만 JSP의 경우 forward() 통해서 해당 JSP로 이동(실행)해야 렌더링이 된다.
JSP를 제외한 나머지 뷰 템플릿들은 forward() 과정 없이 바로 렌더링 된다.

Thymeleaf 뷰 템플릿을 사용하면 ThymeleafViewResolver 를 등록해야 한다.
최근에는 라이브러리만 추가하면 스프링 부트가 이런 작업도 모두 자동화해준다
-> 다른강의에서 공부할때 TilesViewResolver 등록햇엇는데 이런느낌이다.

37. 스프링 MVC - 시작하기

스프링이 제공하는 컨트롤러는 어노테이션 기반으로 동작해서 매우 유연하고 실용적이다.
과거에는 자바 언어에 어노테이션이 없기도 했고 스프링도 처음부터 이런 유연한 컨트롤러를 제공한 것은 아니다.

@RequestMapping
스프링은 어노테이션을 활용한 매우 유연하고 실용적인 컨트롤러를 만들었는데 이것이 바로 @RequestMapping 어노테이션을 사용하는 컨트롤러이다.

과거에는 스프링 프레임워크가 MVC 부분이 약해서 스프링을 사용하더라도 MVC 웹 기술은 스트럿츠 같은 다른 프레임워크를 사용했었다.
그런데 @RequestMapping 기반의 어노테이션 컨트롤러가 등장하면서 MVC 부분도 스프링의 완승으로 끝이 났다.

@RequestMapping
-RequestMappingHandlerMapping
-RequestMappingHandlerAdapter

앞서 보았듯이 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping과 RequestMappingHandlerAdapter 이다.

@RequestMapping의 앞글자를 따서 만든 이름인데 이것이 바로 지금 스프링에서 주로 사용하는 어노테이션 기반의 컨트롤러를 지원하는 핸들러 매핑과 어댑터이다.
실무에서는 진짜 레거시 프로젝트가 아닌이상 99.9% 이 방식의 컨트롤러를 사용한다.

이제 본격적으로 어노테이션 기반의 컨트롤러를 사용해보자.
지금까지 만들었던 프레임워크에서 사용했던 컨트롤러를 @RequestMapping 기반의 스프링 MVC컨트롤러 변경해보자

37.1 회원등록폼

ModelAndView애 논리이름을 넣어서 리턴한다.

@Controller
public class SpringMemberFormControllerV1 {
    @RequestMapping("/springmvc/v1/members/new-form")
    public ModelAndView process() {
        return new ModelAndView("new-form");
    }
}

@Controller
스프링이 자동으로 스프링 빈으로 등록한다.
내부에 @Component 어노테이션이 있어서 컴포넌트 스캔의 대상이 된다.
스프링 MVC에서 어노테이션 기반 컨트롤러로 인식한다.

@RequestMapping : 요청 정보를 매핑한다.
해당 URL이 호출되면 이 메소드가 호출된다.
어노테이션을 기반으로 동작하기 때문에 메소드의 이름은 임의로 지으면 된다.

ModelAndView : 모델과 뷰 정보를 담아서 반환하면 된다.

RequestMappingHandlerMapping은 스프링 빈 중에서 @RequestMapping 또는 @Controller가 클래스 레벨에 붙어 있는 경우에 매핑 정보로 인식한다.
따라서 다음 코드도 동일하게 동작한다

@Component // 컴포넌트 스캔을 통해 스프링 빈으로 등록
@RequestMapping
public class SpringMemberFormControllerV1 {
    @RequestMapping("/springmvc/v1/members/new-form")
    public ModelAndView process() {
        return new ModelAndView("new-form");
    }
}

컴포넌트 스캔 없이 다음과 같이 스프링 빈으로 직접 등록해도 동작한다(@Bean)

주의할점!!!! 스프링 3.0 이상!!!!!!
스프링 부트 3.0(스프링 프레임워크 6.0)부터는 클래스 레벨에 @RequestMapping 이 있어도 스프링 컨트롤러로 인식하지 않는다.
오직 @Controller 가 있어야 스프링 컨트롤러로 인식한다.
참고로 @RestController 는 해당 어노테이션 내부에 @Controller 를 포함하고 있으므로 인식 된다.
따라서 @Controller가 없는 위의 코드는 스프링 컨트롤러로 인식되지 않는다.
즉, RequestMappingHandlerMapping에서 @RequestMapping 는 이제 인식하지 않고 Controller 만 인식한다

37.2 회원 저장 폼

모델에 addObject()메소드를 사용해서 모델에 담아서 ModelAndView를 반환하면된다.
뷰를 렌더링할때 값이 사용된다.

@Controller
public class SpringMemberSaveControllerV1 {
    private MemberRepository memberRepository = MemberRepository.getInstance();

    @RequestMapping("/springmvc/v1/members/save")
    public ModelAndView process(HttpServletRequest request, HttpServletResponse response) {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));
        Member member = new Member(username, age);
        System.out.println("member = " + member);
        memberRepository.save(member);
        ModelAndView mv = new ModelAndView("save-result");
        mv.addObject("member", member);
        return mv;
    }
}

37.3 회원 목록 폼

@Controller
public class SpringMemberListControllerV1 {
    private MemberRepository memberRepository = MemberRepository.getInstance();

    @RequestMapping("/springmvc/v1/members")
    public ModelAndView process() {
        List<Member> members = memberRepository.findAll();
        ModelAndView mv = new ModelAndView("members");
        mv.addObject("members", members);
        return mv;
    }
}

38. 스프링 MVC - 컨트롤러 통합

@RequestMapping 을 잘 보면 클래스 단위가 아니라 메소드 단위에 적용되어 있다.
따라서 컨트롤러 클래스를 유연하게 하나로 통합할 수 있다.

@Controller
@RequestMapping("/springmvc/v2/members")
public class SpringMemberControllerV2 {
    private MemberRepository memberRepository = MemberRepository.getInstance();

    @RequestMapping("/new-form")
    public ModelAndView newForm() {
        return new ModelAndView("new-form");
    }

    @RequestMapping("/save")
    public ModelAndView save(HttpServletRequest request, HttpServletResponse response) {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));
        Member member = new Member(username, age);
        memberRepository.save(member);
        ModelAndView mav = new ModelAndView("save-result");
        mav.addObject("member", member);
        return mav;
    }

    @RequestMapping
    public ModelAndView members() {
        List<Member> members = memberRepository.findAll();
        ModelAndView mav = new ModelAndView("members");
        mav.addObject("members", members);
        return mav;
    }
}

클래스 레벨에 @RequestMapping을 두면 메소드 레벨과 조합이 된다.

조합 결과
클래스 레벨 @RequestMapping("/springmvc/v2/members")
메소드 레벨 @RequestMapping("/new-form") /springmvc/v2/members/new-form
메소드 레벨 @RequestMapping("/save") /springmvc/v2/members/save
메소드 레벨 @RequestMapping /springmvc/v2/members

39. 스프링 MVC - 실용적인 방식

MVC 프레임워크 만들기에서 v3은 ModelView를 개발자가 직접 생성해서 반환했기 때문에 불편했던 기억이 날 것이다.
물론 v4를 만들면서 실용적으로 개선한 기억도 날 것이다.

스프링 MVC는 개발자가 편리하게 개발할 수 있도록 수 많은 편의 기능을 제공한다.
실무에서는 지금부터 설명하는 방식을 주로 사용한다

@Controller
@RequestMapping("/springmvc/v3/members")
public class SpringMemberControllerV3 {
    private MemberRepository memberRepository = MemberRepository.getInstance();

    @GetMapping("/new-form")
    public String newForm() {
        return "new-form";
    }

    @PostMapping("/save")
    public String save(
            @RequestParam("username") String username,
            @RequestParam("age") int age,
            Model model) {
        Member member = new Member(username, age);
        memberRepository.save(member);
        model.addAttribute("member", member);
        return "save-result";
    }

    @GetMapping
    public String members(Model model) {
        List<Member> members = memberRepository.findAll();
        model.addAttribute("members", members);
        return "members";
    }
}

Model 파라미터
save(), members() 를 보면 Model을 파라미터로 받는 것을 확인할 수 있다.
스프링 MVC도 이런 편의 기능을 제공한다.

ViewName 직접 반환
뷰의 논리 이름을 반환할 수 있다.

@RequestParam 사용
스프링은 HTTP 요청 파라미터를 @RequestParam 으로 받을 수 있다.
@RequestParam("username")은 request.getParameter("username") 와 거의 같은 코드라 생각하면 된다.
물론 GET 쿼리 파라미터 POST Form 방식을 모두 지원한다.

@RequestMapping @GetMapping, @PostMapping
@RequestMapping 은 URL만 매칭하는 것이 아니라 HTTP Method도 함께 구분할 수 있다.

예를 들어서 URL이 /new-form 이고 HTTP Method가 GET인 경우를 모두 만족하는 매핑을 하려면 다음과 같이 처리하면 된다.
@RequestMapping(value = "/new-form", method = RequestMethod.GET)
이것을 @GetMapping , @PostMapping 으로 더 편리하게 사용할 수 있다.

참고로 Get, Post, Put, Delete, Patch 모두 어노테이션이 준비되어 있다.

스프링 MVC - 기본 기능

41. 프로젝트 생성

Packaging는 War가 아니라 Jar를 선택한다.
JSP를 사용하지 않으면 Jar를 사용하는 것이 좋다.
앞으로 스프링 부트를 사용하면 이 방식을 주로 사용하게 된다.

Jar를 사용하면 항상 내장 서버(톰캣등)를 사용하고 webapp 경로도 사용하지 않는다.
내장 서버 사용에 최적화 되어 있는 기능이다.

최근에는 주로 이 방식을 사용한다.
War를 사용하면 내장 서버도 사용가능 하지만 주로 외부 서버에 배포하는 목적으로 사용한다.

Welcome 페이지 만들기
이번 장에서 학습할 내용을 편리하게 참고하기 위해 Welcome 페이지를 만들자.
스프링 부트에 Jar 를 사용하면 /resources/static/ 위치에 index.html 파일을 두면 Welcome 페이지로 처리해준다.
스프링 부트가 지원하는 정적 컨텐츠 위치에 /index.html 이 있으면 된다.

42. 로깅 간단히 알아보기

앞으로 로그를 사용할 것이기 때문에 이번시간에는 로그에 대해서 간단히 알아보자.

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

참고로 로그 관련 라이브러리도 많고 깊게 들어가면 끝이 없기 때문에 여기서는 최소한의 사용 방법만 알아본다.

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

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

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

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

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

42.1 로그 선언

private Logger log = LoggerFactory.getLogger(getClass());
private static final Logger log = LoggerFactory.getLogger(Xxx.class)
Slf4j : 롬복 사용 가능

42.2 로그 호출

log.info("hello")
System.out.println("hello")
시스템 콘솔로 직접 출력하는 것 보다 로그를 사용하면 다음과 같은 장점이 있다.
실무에서는 항상 로그를 사용해야 한다.

로그를 찍을때 단계를 정할 수 있다.
debug 현재는 디버그할때 사용 개발서버에서 보는것
info 중요한 정보 비즈니스 정보 등등
warn 경고 위험만
error 에러 보기

@Slf4j
@RestController
public class LogTestController {
    private final Logger log = LoggerFactory.getLogger(getClass());

    @RequestMapping("/log-test")
    public String logTest() {
        String name = "Spring";

        // 여러개 취합해서 보여줌
        log.trace("trace log={}", name);
        // 디버그
        log.debug("debug log={}", name);
        // INFO라고 나오고 실행한 스레드이름 컨트롤러이름 메시지
        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";
    }
}

패키지와 그 하위 패키지의 로그 레벨 설정을 하려면 application.properties에

logging.level.hello.springmvc=debug

설정 하면 디버깅 레벨의 내용들을 다 볼 수 있다.
공부하면서 몇번씩 넣어본 적이 있는 것 같다. 사용용도를 정확히 알지 못햇었다.

개발서버에서는 debug 로컬에서는 trace로하고 운영에서는 info로 남기는경우가 많다.

42.3 테스트

로그가 출력되는 포멧 확인
시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지 로그 레벨 설정을 변경해서 출력 결과를 보자.

LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
개발 서버는 debug 출력
운영 서버는 info 출력
@Slf4j 로 변경

42.4 로그 레벨 설정

application.properties

#전체 로그 레벨 설정(기본 info)
logging.level.root=info
#hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=debug

42.5 올바른 로그 사용법

log.debug("data="+data)

로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data="+data가 실제 실행이 되어 버린다.
결과적으로 문자 더하기 연산이 발생한다.

log.debug("data={}", data)

로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않는다. 따라서 앞과 같은 의미없는 연산이 발생하지 않는다.

42.6 로그 사용시 장점

쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고 출력 모양을 조정할 수 있다.
로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.

시스템 아웃 콘솔에만 출력하는 것이 아니라 파일이나 네트워크 등 로그를 별도의 위치에 남길 수 있다.
특히 파일로 남길 때는 일별 특정 용량에 따라 로그를 분할하는 것도 가능하다.

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

로그에 대해 공부하기 위해서는 다음에서 볼 수 있다.
로그에 대해서 더 자세한 내용은 slf4j, logback을 검색해보자.

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

스프링 부트가 제공하는 로그 기능은 다음을 참고하자.

https://docs.spring.io/spring-boot/docs/current/reference/html/spring-bootfeatures.html#boot-features-logging

2023.06.03

sysout을 통해서 콘솔창에 로그를 띄우는 것을 주로 했었다. 눈으로 보고 확인하는 것이었다.
익숙하진 않지만 log를 이용해서 여러 상태를 보고 해결하는 방법에 익숙해지고 확인하는 방법을 잘 알아가는 것이 중요하다고 생각된다.
@SLF4J를 붙이고 log.info만하면된다는 것을 잊지 말자.