스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 15

Spring 정리 2022. 7. 16. 16:44

인프런 강의 53일차.

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

 - 1편에서 배운 MVC를 활용할 수 있는 기술 습득

 - 타입 컨버터, 파일 업로드, 활용, 쿠키, 세션, 필터, 인터셉터, 예외 처리, 타임리프, 메시지, 국제화, 검증 등등

 

 8.1 예외 처리와 오류 페이지 - 프로젝트 생성

  - MVC1 편에서 개발한 상품 관리 프로젝트를 약간 다듬어서 form-start 라는 프로젝트로 변환.

 

  - https://start.spring.io

  - 프로젝트 선택 Project : Gradle Project

  - Language : Java

  - Spring Boot : 2.7.0

  - Group : hello

  - Artifact : exception

  - Name : exception

  - Package name : hello.exception

  - Packaging : Jar

  - Java : 11

  - Dependencies : Spring Web, Thymeleaf, Lombok, Validation

* 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)

 

 8.2 예외 처리와 오류 페이지 - 서블릿 예외 처리 - 시작

  - 스프링이 아닌 순수 서블릿 컨테이너는 예외를 어떻게 처리하는지 알아보자.

  - 서블릿은 다음 2가지 방식으로 예외 처리를 지원한다.

    > Exception (예외)

    > response.sendError(HTTP 상태 코드, 오류 메시지)

 

 * Exception(예외) 처리 방식

  - 자바 직접 실행

    > 자바의 메인 메서드를 직접 실행하는 경우 main 이라는 이름의 쓰레드가 실행된다.

    > 실행 도중에 예외를 잡지 못하고 처음 실행한 main() 메서드를 넘어서 예외가 던져지면, 예외 정보를 남기고 해당 쓰레드는 종료된다.

 - 웹 애플리케이션

    > 웹 애플리케이션은 사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행된다.

    > 애플리케이션에서 예외가 발생했는데, 어디선가 try ~ catch로 예외를 잡아서 처리하면 아무런 문제가 없다.

    > 그런데 만약에 애플리케이션에서 예외를 잡지 못하고, 서블릿 밖으로 까지 예외가 전달되면 어떻게 동작할까?

웹 어플리케이션 exception 흐름

    > 최종적으로 WAS 까지 예외가 전달된다. WAS는 예외가 올라오면 어떻게 처리 할까?

server.error.whitelabel.enabled=false

 - application.properties

 - 스프링에서 기본적으로 제공하는 whitelabel 에러 페이지 표시 제외하도록 추가

package hello.exception.servlet;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Slf4j
@Controller
public class ServletExController {

    @GetMapping("/error-ex")
    public void errorEx() {
        throw new RuntimeException("예외 발생");
    }

}

 - hello/exception/servlet/ServletExController.java

 - 익셉션 발생시키는 로직 추가

 - 실행 시 tomcat이 기본적으로 제공하는 HTTP Status 500 - Internal Server Error가 표시된다.

    > 웹 브라우저에서 개발자 모드로 확인해보면 HTTP 상태 코드가 500으로 보인다.

    > Exception 의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP 상태 코드 500을 반환한다.

 

 * response.sendError(HTTP 상태 코드, 오류 메시지) 처리 방식

  - 오류가 발생했을 때 HttpServletResponse 가 제공하는 sendError 라는 메서드를 사용해도 된다.

  - 이것을 호출한다고 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있다.

  - 이 메서드를 사용하면 HTTP 상태 코드와 오류 메시지도 추가할 수 있다.

    > response.sendError(HTTP 상태 코드)

    > response.sendError(HTTP 상태 코드, 오류 메시지)

 

@GetMapping("/error-404")
public void error404(HttpServletResponse response) throws IOException {
    response.sendError(404, "404 오류!");
}

@GetMapping("/error-500")
public void error500(HttpServletResponse response) throws IOException {
    response.sendError(500);
}

 - hello/exception/servlet/ServletExController.java

 - response.sendError로 상태코드 세팅 리턴하는 메소드 추가

sendError 흐름

 - sendError 처리 흐름

    > response.sendError() 를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해둔다.

    > 그리고 서블릿 컨테이너는 고객에게 응답 전에 response 에 sendError() 가 호출되었는지 확인한다.

    > 그리고 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다

 

 8.3 예외 처리와 오류 페이지 - 서블릿 예외 처리 - 오류 화면 제공

  - 서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 고객 친화적이지 않으니 서블릿이 제공하는 기능을 사용해보자. 

  - 서블릿은 Exception (예외)가 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError() 가 호출 되었을 때 각각의 상황에 맞춘 오류 처리 기능을 제공한다.

 

 * 에러 페이지 호출 흐름

<web-app>
    <error-page>
        <error-code>404</error-code>
        <location>/error-page/404.html</location>
    </error-page>
    <error-page>
        <error-code>500</error-code>
        <location>/error-page/500.html</location>
    </error-page>
    <error-page>
        <exception-type>java.lang.RuntimeException</exception-type>
        <location>/error-page/500.html</location>
    </error-page>
</web-app>

 - 과거에는 web.xml에 각 에러 타입, 코드별 호출 페이지를 지정해서 처리했었다.

 - 지금은 스프링 부트를 통해서 서블릿 컨테이너를 실행하기 때문에, 스프링 부트가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 된다.

 

 * 서블릿 오류 페이지 등록

package hello.exception;

import org.springframework.boot.web.server.ConfigurableWebServerFactory;
import org.springframework.boot.web.server.ErrorPage;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

@Component
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {

    @Override
    public void customize(ConfigurableWebServerFactory factory) {
        //Springboot에서 제공해주는 ErrorPage 클래스는 사용해 에러 정의
        ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/404");
        ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");
        ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");

        factory.addErrorPages(errorPage404, errorPage500, errorPageEx);     //에러 페이지 등록
    }
}

 - hello/exception/WebServerCustomizer.java

 - Servlet 오류를 처리하기 위해 스프링부트가 제공하는 ErrorPage 기능을 사용하였다.

   > response.sendError(404) : errorPage404 호출

   > response.sendError(500) : errorPage500 호출

   > RuntimeException 또는 그 자식 타입의 예외: errorPageEx 호출

 - 오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다.

   > RuntimeException 은 물론이고 RuntimeException 의 자식도 함께 처리한다.

 

 * 오류를 처리할 수 있는 컨트롤러 구현

package hello.exception.servlet;

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

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
@Controller
public class ErrorPageController {

    @RequestMapping("/error-page/404")
    public String errorPage404 (HttpServletRequest request, HttpServletResponse response) {
        log.info("errorPage 404");
        return "error-page/404";
    }

    @RequestMapping("/error-page/500")
    public String errorPage500 (HttpServletRequest request, HttpServletResponse response) {
        log.info("errorPage 500");
        return "error-page/500";
    }
}

 - hello/exception/servlet/ErrorPageController.java

 - 서블릿에서 전달한 페이지를 호출하는 컨트롤러 구현

 

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="utf-8">
</head>
<body>
<div class="container" style="max-width: 600px">
    <div class="py-5 text-center">
        <h2>404 오류 화면</h2>
    </div>
    <div>
        <p>오류 화면 입니다.</p>
    </div>
    <hr class="my-4">
</div> <!-- /container -->
</body>
</html>

 - templates/error-page/404.html

 - 오류처리 404 호출 View

 

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="utf-8">
</head>
<body>
<div class="container" style="max-width: 600px">
    <div class="py-5 text-center">
        <h2>500 오류 화면</h2>
    </div>
    <div>
        <p>오류 화면 입니다.</p>
    </div>
    <hr class="my-4">
</div> <!-- /container -->
</body>
</html>

 - templates/error-page/500.html

 - 오류처리 500 호출 View

 

 

 

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 14

Spring 정리 2022. 7. 10. 21:11

인프런 강의 52일차.

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

 - 1편에서 배운 MVC를 활용할 수 있는 기술 습득

 - 타입 컨버터, 파일 업로드, 활용, 쿠키, 세션, 필터, 인터셉터, 예외 처리, 타임리프, 메시지, 국제화, 검증 등등

 

 * Filter, Interceptor, AOP 중 어떤 기능을 사용할지는 갓대희님의 깔끔한 정리본을 참고하자

https://goddaehee.tistory.com/154

 

[Spring] Filter, Interceptor, AOP 차이 및 정리

[Spring] Filter, Interceptor, AOP 차이 및 정리 안녕하세요. 갓대희 입니다. 이번 포스팅은 [ [Spring] 필터, 인터셉터, AOP 정리 ] 입니다. : ) 공통 프로세스에 대한 고민 자바 웹 개발을 하다보면, 공통..

goddaehee.tistory.com

 

 7.1 로그인 처리2 - 필터, 인터셉터 - 서블릿 필터 - 소개

  - 요구사항을 보면 로그인 한 사용자만 상품 관리 페이지에 들어갈 수 있어야 한다. 앞에서 로그인을 하지 않은 사용자에게는 상품 관리 버튼이 보이지 않기 때문에 문제가 없어 보인다.

  - 그런데 문제는 로그인 하지 않은 사용자도 상품관리 URL을 직접 호출하면 상품 관리 화면에 들어갈 수 있다는 점이다.

  - 상품 관리 컨트롤러에서 로그인 여부를 체크하는 로직을 하나하나 작성하면 되겠지만, 등록, 수정, 삭제, 조회 등등 상품관리의 모든 컨트롤러 로직에 공통으로 로그인 여부를 확인해야 한다.

  - 더 큰 문제는 향후 로그인과 관련된 로직이 변경될 때 이다. 작성한 모든 로직을 다 수정해야 할 수 있다.

  - 이렇게 애플리케이션 여러 로직에서 공통으로 관심이 있는 있는 것을 공통 관심사(cross-cutting concern)라고 한다.

  - 여기서는 등록, 수정, 삭제, 조회 등등 여러 로직에서 공통으로 인증에 대해서 관심을 가지고 있다.

  - 이러한 공통 관심사는 스프링의 AOP로도 해결할 수 있지만, 웹과 관련된 공통 관심사는 지금부터 설명할 서블릿 필터 또는 스프링 인터셉터를 사용하는 것이 좋다.

  - 웹과 관련된 공통 관심사를 처리할 때는 HTTP의 헤더나 URL의 정보들이 필요한데, 서블릿 필터나 스프링 인터셉터는 HttpServletRequest 를 제공한다.

 

 * 서블릿 필터 소개

  - 필터는 서블릿이 지원하는 수문장이다. 필터의 특성은 다음과 같다

필터 흐름

  - 필터를 적용하면 필터가 호출 된 다음에 서블릿이 호출된다.

  - 그래서 모든 고객의 요청 로그를 남기는 요구사항이 있다면 필터를 사용하면 된다.

  - 필터는 특정 URL 패턴에 적용할 수 있다.

  - /* 이라고 하면 모든 요청에 필터가 적용된다.

  - 참고로 스프링에서 말하는 서블릿은 스프링의 디스패처 서블릿으로 생각하면 된다.

 

필터 제한

  - 필터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다. 그래서 로그인 여부를 체크하기에 좋다

 

필터 체인

  - 필터는 체인으로 구성되는데, 중간에 필터를 자유롭게 추가할 수 있다.

  - 예를 들어서 로그를 남기는 필터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 필터를 만들 수 있다

 

 * 필터 인터페이스

public interface Filter {
    public default void init(FilterConfig filterConfig) throws ServletException {}
    public void doFilter(ServletRequest request, ServletResponse response,
                         FilterChain chain) throws IOException, ServletException;
    public default void destroy() {}
}

  - 필터 인터페이스를 구현하고 등록하면 서블릿 컨테이너가 필터를 싱글톤 객체로 생성하고, 관리한다.

  - init(): 필터 초기화 메서드, 서블릿 컨테이너가 생성될 때 호출된다.

  - doFilter(): 고객의 요청이 올 때 마다 해당 메서드가 호출된다. 필터의 로직을 구현하면 된다.

  - destroy(): 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출된다

 

 7.2 로그인 처리2 - 필터, 인터셉터 - 서블릿 필터 - 요청 로그

  - 필터가 정말 수문장 역할을 하는지 확인하기 위해 단순히 모든 요청을 로그로 남기는 필터를 개발하고 적용해보자.

package hello.login.web.filter;

import lombok.extern.slf4j.Slf4j;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.UUID;

@Slf4j
public class LogFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("log filter init");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("log filter doFilter");

        //ServletRequest에는 기능이 별로 없기 때문에 HttpServletRequest를 다시 선언해준다.
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String requestURI = httpRequest.getRequestURI();

        String uuid = UUID.randomUUID().toString();

        try{
            log.info("REQUEST [{}][{}]", uuid, requestURI);
            //다음 필터를 호출
            chain.doFilter(request, response);
        } catch (Exception e) {
            throw e;
        } finally {
            log.info("RESPONSE [{}][{}]", uuid, requestURI);
        }
    }

    @Override
    public void destroy() {
        log.info("log filter destroy");
    }
}

  - hello/login/web/filter/LogFilter.java

  - public class LogFilter implements Filter {}

    > 필터를 사용하려면 필터 인터페이스를 구현해야 한다.

  - doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

    > HTTP 요청이 오면 doFilter 가 호출된다.

    > ServletRequest request 는 HTTP 요청이 아닌 경우까지 고려해서 만든 인터페이스이다.

    > HTTP를 사용하면 HttpServletRequest httpRequest = (HttpServletRequest) request; 와 같이 다운 캐스팅 하면 된다.

  - String uuid = UUID.randomUUID().toString();

    > HTTP 요청을 구분하기 위해 요청당 임의의 uuid 를 생성해둔다.

  - log.info("REQUEST [{}][{}]", uuid, requestURI);

    > uuid 와 requestURI 를 출력한다.

  - chain.doFilter(request, response);

    > 가장 중요하다. 다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출한다. 만약 이 로직을 호출하지 않으면 다음 단계로 진행되지 않는다.

 

package hello.login;

import hello.login.web.filter.LogFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.servlet.Filter;

@Configuration
public class WebConfig {

    @Bean
    public FilterRegistrationBean logFilter() {
        FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
        filterRegistrationBean.setFilter(new LogFilter());  //새로 생성한 필터를 적용해준다.
        filterRegistrationBean.setOrder(1);     //chain이기 때문에 순서를 정해줘야한다.
        filterRegistrationBean.addUrlPatterns("/*");    //적용할 url pattern 지정
        return filterRegistrationBean;
    }
}

  - hello/login/WebConfig.java

  - 필터 설정하는 WebConfig 구성

  - 필터를 등록하는 방법은 여러가지가 있지만, 스프링 부트를 사용한다면 FilterRegistrationBean 을 사용해서 등록한다.

    > setFilter(new LogFilter()) : 등록할 필터를 지정한다.

    > setOrder(1) : 필터는 체인으로 동작한다. 따라서 순서가 필요하다. 낮을 수록 먼저 동작한다.

    > addUrlPatterns("/*") : 필터를 적용할 URL 패턴을 지정한다. 한번에 여러 패턴을 지정할 수 있다.

  - URL 패턴에 대한 룰은 필터도 서블릿과 동일하다. 자세한 내용은 서블릿 URL 패턴으로 검색해보자.

@ServletComponentScan @WebFilter(filterName = "logFilter", urlPatterns = "/*")

  - 컴포넌트로도 필터 등록이 가능하지만 필터 순서 조절이 안된다. 따라서 FilterRegistrationBean 을 사용하자

 

 * 실행 로그

hello.login.web.filter.LogFilter: REQUEST [0a2249f2-cc70-4db4-98d1-492ccf5629dd][/items]
hello.login.web.filter.LogFilter: RESPONSE [0a2249f2-cc70-4db4-98d1-492ccf5629dd][/items]

  - 필터를 등록할 때 urlPattern 을 /* 로 등록했기 때문에 모든 요청에 해당 필터가 적용된다.

  - 실무에서 HTTP 요청시 같은 요청의 로그에 모두 같은 식별자를 자동으로 남기는 방법은 logback mdc로 검색해보자.

 

 7.3 로그인 처리2 - 필터, 인터셉터 - 서블릿 필터 - 인증 체크

  - 인증 체크 필터를 개발해보자. 로그인 안된 사용자는 상품 관리 및 추후 개발될 페이지에도 접근 못하도록 하자.

package hello.login.web.filter;

import hello.login.web.SessionConst;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.PatternMatchUtils;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.IOException;

@Slf4j
public class LoginCheckFilter implements Filter {

    private final static String[] whiteList = {"/", "/members/add", "/login", "/logout", "/css/*"};

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String requestURI = httpRequest.getRequestURI();

        HttpServletResponse httpResponse = (HttpServletResponse) response;

        try {
            log.info("인증 체크 필터 시작 {}", requestURI);

            if (isLoginCheckPath(requestURI)) {
                log.info("인증 체크 로직 실행 = {}", requestURI);
                HttpSession session = httpRequest.getSession(false);
                if(session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null){
                    log.info("미인증 사용자 요청 = {}", requestURI);
                    //로그인으로 리다이렉트 (로그인하고 다시 현재 페이지로 돌아올 수 있도록 redirectURL을 같이 전달
                    httpResponse.sendRedirect("/login?redirectURL=" + requestURI);
                    return;
                }
            }

            chain.doFilter(request, response);
        } catch (Exception e) {
            throw e;    //예외 로깅 가능하지만 톰캣까지 예외를 보내줘야함.
        } finally {
            log.info("인증 체크 필터 종료 {}", requestURI);
        }
    }

    /**
     * 화이트 리스트의 경우 인증체크 패스
     */
    private boolean isLoginCheckPath(String requestURI) {
        return !PatternMatchUtils.simpleMatch(whiteList, requestURI);    //스프링에서 제공해주는 메소드
    }

}

  - src\main\java\hello\login\web\filter\LoginCheckFilter.java

  - 로그인 인증 체크 필터를 적용할 java

  - whitelist = {"/", "/members/add", "/login", "/logout","/css/*"};

    > 인증 필터를 적용해도 홈, 회원가입, 로그인 화면, css 같은 리소스에는 접근할 수 있어야 한다.

    > 이렇게 화이트 리스트 경로는 인증과 무관하게 항상 허용한다. 

    > 화이트 리스트를 제외한 나머지 모든 경로에는 인증 체크 로직을 적용한다. (추후 개발될 화면도 필터가 적용된다)

  - isLoginCheckPath(requestURI)

    > 화이트 리스트를 제외한 모든 경우에 인증 체크 로직을 적용한다.

  - httpResponse.sendRedirect("/login?redirectURL=" + requestURI);

    > 미인증 사용자는 로그인 화면으로 리다이렉트 한다. 그런데 로그인 이후에 다시 홈으로 이동해버리면 원하는 경로를 다시 찾아가야 하는 불편함이 있다.

    > 예를 들어서 상품 관리 화면을 보려고 들어갔다가 로그인 화면으로 이동하면, 로그인 이후에 다시 상품 관리 화면으로 돌아가는 것이 좋다.

    > 개발자 입장에서는 좀 귀찮을 수 있어도 사용자 입장으로 보면 편리한 기능이다.

    > 이러한 기능을 위해 현재 요청한 경로인 requestURI 를 /login 에 쿼리 파라미터로 함께 전달한다.

    > 물론 /login 컨트롤러에서 로그인 성공시 해당 경로로 이동하는 기능은 추가로 개발해야 한다

  - 리다이렉트 후 return;

    > 여기가 중요하다. 필터를 더는 진행하지 않는다.

    > 이후 필터는 물론 서블릿, 컨트롤러가 더는 호출되지 않는다.

    > 앞서 redirect 를 사용했기 때문에 redirect 가 응답으로 적용되고 요청이 끝난다.

 

@Bean
public FilterRegistrationBean loginCheckFilter() {
    FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
    filterRegistrationBean.setFilter(new LoginCheckFilter());  //새로 생성한 필터를 적용해준다.
    filterRegistrationBean.setOrder(2);     //chain이기 때문에 순서를 정해줘야한다.
    filterRegistrationBean.addUrlPatterns("/*");    //LoginCheckFilter에서 화이트리스트를 관리하고 있으니 모든 url에 적용
    return filterRegistrationBean;
}

  - hello/login/WebConfig.java

  - 신규로 추가한 LoginCheckFilter를 등록한다.

  - setFilter(new LoginCheckFilter()) : 로그인 필터를 등록한다.

  - setOrder(2) : 순서를 2번으로 잡았다. 로그 필터 다음에 로그인 필터가 적용된다.

  - addUrlPatterns("/*") : 모든 요청에 로그인 필터를 적용한다. 

 

 * RedirectURL 처리

  - 로그인 후 요청된 url로 리다이렉트 시키는 기능을 추가해보자.

@PostMapping("/login")
public String loginV4(@Valid @ModelAttribute LoginForm form, BindingResult bindingResult
                      , @RequestParam(defaultValue = "/") String redirectURL
                      , HttpServletRequest request) {
    if(bindingResult.hasErrors()){
        return "login/loginForm";
    }

    Member loginMember = loginService.login(form.getLoginId(), form.getPassword());

    if(loginMember == null){
        //null인 경우 글로벌오류로 처리
        bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
        return "login/loginForm";
    }

    //로그인 성공 처리
    HttpSession session = request.getSession();  //세션이 있으면 있는 세션 반환, 없으면 신규 세션을 생성해서 반환 (getssesion(false)로 호출 시 없는 경우 신규 세션을 생성하지 않고 null 반환)
    //세션에 로그인 회원 정보 저장
    session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);

    return "redirect:" + redirectURL;
}

  - hello/login/web/login/LoginController.java

  - RequestParam 으로 redirectURL을 전달받고, 해당 url로 리다이렉트하도록 추가.

  - 서블릿 필터를 잘 사용한 덕분에 로그인 하지 않은 사용자는 나머지 경로에 들어갈 수 없게 되었다.

  - 공통 관심사를 서블릿 필터를 사용해서 해결한 덕분에 향후 로그인 관련 정책이 변경되어도 이 부분만 변경하면 된다

 

 * 참고

  - 필터에는 스프링 인터셉터는 제공하지 않는, 아주 강력한 기능이 있다.

  - chain.doFilter(request, response); 를 호출해서 다음 필터 또는 서블릿을 호출할 때 request , response 를 다른 객체로 바꿀 수 있다. ServletRequest , ServletResponse 를 구현한 다른 객체를 만들어서 넘기면 해당 객체가 다음 필터 또는 서블릿에서 사용된다. 잘 사용하는 기능은 아니니 참고만 해두자.

 

 7.4 로그인 처리2 - 필터, 인터셉터 - 스프링 인터셉터 - 소개

  - 스프링 인터셉터도 서블릿 필터와 같이 웹과 관련된 공통 관심 사항을 효과적으로 해결할 수 있는 기술이다.

  - 서블릿 필터가 서블릿이 제공하는 기술이라면, 스프링 인터셉터는 스프링 MVC가 제공하는 기술이다.

  - 둘다 웹과 관련된 공통 관심 사항을 처리하지만, 적용되는 순서와 범위, 그리고 사용방법이 다르다.

 

 * 스프링 인터셉터 소개 

스프링 인터셉터 흐름

  - 스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출 된다.

  - 스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장하게 된다.

  - 스프링 MVC의 시작점이 디스패처 서블릿이라고 생각해보면 이해가 될 것이다.

  - 스프링 인터셉터에도 URL 패턴을 적용할 수 있는데, 서블릿 URL 패턴과는 다르고, 매우 정밀하게 설정할 수 있다.

 

스프링 인터셉터 제한

  - 인터셉터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다. 그래서 로그인 여부를 체크하기에 좋다.

 

스프링 인터셉터 체인

  - 스프링 인터셉터는 체인으로 구성되는데, 중간에 인터셉터를 자유롭게 추가할 수 있다.

  - 예를 들어서 로그를 남기는 인터셉터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 인터셉터를 만들 수 있다.

  - 지금까지 내용을 보면 서블릿 필터와 호출 되는 순서만 다르고, 제공하는 기능은 비슷해 보인다.

  - 앞으로 설명하겠지만, 스프링 인터셉터는 서블릿 필터보다 편리하고, 더 정교하고 다양한 기능을 지원한다.

 

 * 스프링 인터셉터 인터페이스

public interface HandlerInterceptor {
    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {}
    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {}
    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {}
}

  - 스프링의 인터셉터를 사용하려면 HandlerInterceptor 인터페이스를 구현하면 된다.

  - 서블릿 필터의 경우 단순하게 doFilter() 하나만 제공된다.

  - 인터셉터는 컨트롤러 호출 전( preHandle ), 호출 후( postHandle ), 요청 완료 이후( afterCompletion )와 같이 단계적으로 잘 세분화 되어 있다.

  - 서블릿 필터의 경우 단순히 request , response 만 제공했지만, 인터셉터는 어떤 컨트롤러( handler )가 호출되는지 호출 정보도 받을 수 있다.

  - 그리고 어떤 modelAndView 가 반환되는지 응답 정보도 받을 수 있다

 

 * 스프링 인터셉터 호출 흐름

스프링 인터셉터 호출 흐름

 * 정상 흐름

  - preHandle : 컨트롤러 호출 전에 호출된다. (더 정확히는 핸들러 어댑터 호출 전에 호출된다.)

    > preHandle 의 응답값이 true 이면 다음으로 진행하고, false 이면 더는 진행하지 않는다.

    > false 인 경우 나머지 인터셉터는 물론이고, 핸들러 어댑터도 호출되지 않는다. 그림에서 1번에서 끝이 나버린다.

  - postHandle : 컨트롤러 호출 후에 호출된다. (더 정확히는 핸들러 어댑터 호출 후에 호출된다.)

  - afterCompletion : 뷰가 렌더링 된 이후에 호출된다.

 

 * 스프링 인터셉터 예외 상황

스프링 인터셉터 예외 상황

 * 예외 흐름

  - preHandle : 컨트롤러 호출 전에 호출된다.

  - postHandle : 컨트롤러에서 예외가 발생하면 호출되지 않는다.

  - afterCompletion : afterCompletion 은 항상 호출된다.

    > 이 경우 예외( ex )를 파라미터로 받아서 어떤 예외가 발생했는지 로그로 출력할 수 있다.

    > 예외가 발생하면 postHandle() 는 호출되지 않으므로 예외와 무관하게 공통 처리를 하려면 afterCompletion() 을 사용해야 한다.

 

 * 스프링 인터셉터

  - 인터셉터는 스프링 MVC 구조에 특화된 필터 기능을 제공한다고 이해하면 된다.

  - 스프링 MVC를 사용하고, 특별히 필터를 꼭 사용해야 하는 상황이 아니라면 인터셉터를 사용하는 것이 더 편리하다

 

 7.5 로그인 처리2 - 필터, 인터셉터 - 스프링 인터셉터 - 요청 로그

  - 스프링 MVC를 사용하고, 특별히 필터를 꼭 사용해야 하는 상황

package hello.login.web.interceptor;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;

@Slf4j
public class LogInterceptor implements HandlerInterceptor {
    public static final String LOG_ID = "logId";

    //Ctrl + O 를 통해 Override할 메소드 선택이 가능하다.

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String requestURI = request.getRequestURI();
        String uuid = UUID.randomUUID().toString();

        //에러처리를 위해 afterCompletion으로 uuid를 전달해야하는데, Interceptor가 싱글톤처럼 사용되기 때문에 멤버변수로 사용 시 위험하다. 이를 해결하기 위해 request에 저장해서 보내준다.
        request.setAttribute(LOG_ID, uuid);

        //@RequestMapping으로 처리된 경우 handler는 HandlerMethod로 호출된다.
        //정적리소스로 처리된 경우 ResourceHttpRequestHandler가 사용된다.
        if(handler instanceof HandlerMethod) {
            HandlerMethod hm = (HandlerMethod) handler;     //호출할 컨트롤러 메소드의 모든 정보가 포함되어있다.
        }

        log.info("REQUEST [{}][{}][{}]", uuid, requestURI, handler);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle [{}]", modelAndView);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        String requestURI = request.getRequestURI();
        String uuid = (String) request.getAttribute(LOG_ID);
        log.info("RESPONSE [{}][{}][{}]", uuid, requestURI, handler);
        if(ex != null){
            log.error("afterCompletion error!! ", ex);
        }
    }
}

  - hello/login/web/interceptor/LogInterceptor.java

  - 스프링 인터셉터를 사용한 로그 인터셉트 구현

  - String uuid = UUID.randomUUID().toString()

    > 요청 로그를 구분하기 위한 uuid 를 생성한다

  - request.setAttribute(LOG_ID, uuid)

    > 서블릿 필터의 경우 지역변수로 해결이 가능하지만, 스프링 인터셉터는 호출 시점이 완전히 분리되어 있다.

    > 따라서 preHandle 에서 지정한 값을 postHandle , afterCompletion 에서 함께 사용하려면 어딘가에 담아두어야 한다.

    >  LogInterceptor 도 싱글톤 처럼 사용되기 때문에 맴버변수를 사용하면 위험하다. 따라서 request 에 담아두었다.

    > 이 값은 afterCompletion 에서 request.getAttribute(LOG_ID) 로 찾아서 사용한다.

  - return true

    > true 면 정상 호출이다. 다음 인터셉터나 컨트롤러가 호출된다.

 

 * handler 타입 정보

//@RequestMapping으로 처리된 경우 handler는 HandlerMethod로 호출된다.
//정적리소스로 처리된 경우 ResourceHttpRequestHandler가 사용된다.
if(handler instanceof HandlerMethod) {
    HandlerMethod hm = (HandlerMethod) handler;     //호출할 컨트롤러 메소드의 모든 정보가 포함되어있다.
}

  - HandlerMethod

    > 핸들러 정보는 어떤 핸들러 매핑을 사용하는가에 따라 달라진다. 스프링을 사용하면 일반적으로 @Controller , @RequestMapping 을 활용한 핸들러 매핑을 사용하는데, 이 경우 핸들러 정보로 HandlerMethod 가 넘어온다

  - ResourceHttpRequestHandler

    > @Controller 가 아니라 /resources/static 와 같은 정적 리소스가 호출 되는 경우 ResourceHttpRequestHandler 가 핸들러 정보로 넘어오기 때문에 타입에 따라서 처리가 필요하다

 

@Configuration
public class WebConfig implements WebMvcConfigurer {

    //인터셉터는 빈을 등록하지 않고 기존 빈을 오버라이드해서 사용해야한다.
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor())
                .order(1)
                .addPathPatterns("/**")
                .excludePathPatterns("/css/**", "/*.ico", "/error");
    }
    
    //    @Bean
    public FilterRegistrationBean logFilter() {
   	 ...
	}
    ...

  - hello/login/WebConfig.java

  - WebMvcConfigurer 가 제공하는 addInterceptors() 를 사용해서 인터셉터를 등록할 수 있다. (Ctrl + O로 오버라이드 호출)

    > registry.addInterceptor(new LogInterceptor()) : 인터셉터를 등록한다.

    > order(1) : 인터셉터의 호출 순서를 지정한다. 낮을 수록 먼저 호출된다.

    > addPathPatterns("/**") : 인터셉터를 적용할 URL 패턴을 지정한다.

    > excludePathPatterns("/css/**", "/*.ico", "/error") : 인터셉터에서 제외할 패턴을 지정한다.

  - 인터셉터와 필터가 중복되지 않도록 필터를 등록하기 위한 logFilter() 의 @Bean을 주석처리

  - 필터와 비교해보면 인터셉터는 addPathPatterns , excludePathPatterns 로 매우 정밀하게 URL 패턴을 지정할 수 있다.

 

 * 실행 로그

REQUEST [6234a913-f24f-461f-a9e1-85f153b3c8b2][/members/add][hello.login.web.member.MemberController#addForm(Member)]
postHandle [ModelAndView [view="members/addMemberForm";model={member=Member(id=null, loginId=null, name=null, password=null),
        org.springframework.validation.BindingResult.member=org.springframework.validation.BeanPropertyBindingResult: 0 errors}]]
RESPONSE [6234a913-f24f-461f-a9e1-85f153b3c8b2][/members/add]

 

 * 스프링의 URL 경로

  - 스프링이 제공하는 URL 경로는 서블릿 기술이 제공하는 URL 경로와 완전히 다르다. 자세하고, 세밀하게 설정할 수 있다. 

? 한 문자 일치
* 경로(/) 안에서 0개 이상의 문자 일치
** 경로 끝까지 0개 이상의 경로(/) 일치
{spring} 경로(/)와 일치하고 spring이라는 변수로 캡처
{spring:[a-z]+} matches the regexp [a-z]+ as a path variable named "spring"
{spring:[a-z]+} regexp [a-z]+ 와 일치하고, "spring" 경로 변수로 캡처
{*spring} 경로가 끝날 때 까지 0개 이상의 경로(/)와 일치하고 spring이라는 변수로 캡처
        
/pages/t?st.html — matches /pages/test.html, /pages/tXst.html but not /pages/toast.html
/resources/*.png — matches all .png files in the resources directory
/resources/** — matches all files underneath the /resources/ path, including /
resources/image.png and /resources/css/spring.css
/resources/{*path} — matches all files underneath the /resources/ path and
captures their relative path in a variable named "path"; /resources/image.png
will match with "path" → "/image.png", and /resources/css/spring.css will match
with "path" → "/css/spring.css"
/resources/{filename:\\w+}.dat will match /resources/spring.dat and assign the
value "spring" to the filename variable

  - PathPattern 공식 문서

  - https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/util/pattern/PathPattern.html

 

 

 7.6 로그인 처리2 - 필터, 인터셉터 - 스프링 인터셉터 - 인증 체크

  - 서블릿 필터에서 사용했던 인증 체크 기능을 스프링 인터셉터로 개발해보자.

package hello.login.web.interceptor;

import hello.login.web.SessionConst;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

@Slf4j
public class LoginCheckInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //필터와 달리 화이트리스트는 인터셉터 등록 때 처리한다

        String requestURI = request.getRequestURI();

        log.info("인증 체크 인터셉터 실행 {}", requestURI);

        HttpSession session = request.getSession();
        if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null) {
            log.info("미인증 사용자 요청");
            //로그인으로 redirect
            response.sendRedirect("/login?redirectURL=" + requestURI);
            return false;
        }


        return true;
    }
}

  - hello/login/web/interceptor/LoginCheckInterceptor.java

  - 서블릿 필터와 비교해서 코드가 매우 간결하다. 인증이라는 것은 컨트롤러 호출 전에만 호출되면 된다. 따라서 preHandle 만 구현하면 된다.

 

 

@Configuration
public class WebConfig implements WebMvcConfigurer {

    //인터셉터는 빈을 등록하지 않고 기존 빈을 오버라이드해서 사용해야한다.
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor())
                .order(1)
                .addPathPatterns("/**")
                .excludePathPatterns("/css/**", "/*.ico", "/error");

        registry.addInterceptor(new LoginCheckInterceptor())
                .order(2)
                .addPathPatterns("/**")
                .excludePathPatterns("/", "/members/add", "/login", "/logout", "/css/**", "/*.ico", "/error");
    }
    ...
    //    @Bean
    public FilterRegistrationBean loginCheckFilter() {
    ...
    }
}

  - hello/login/WebConfig.java

  - 인터셉터를 적용하거나 하지 않을 부분은 addPathPatterns 와 excludePathPatterns 에 작성하면 된다.

  - 기본적으로 모든 경로에 해당 인터셉터를 적용하되 ( /** ), 홈( / ), 회원가입( /members/add ), 로그인( /login ), 리소스 조회( /css/** ), 오류( /error )와 같은 부분은 로그인 체크 인터셉터를 적용하지 않는다.

  - 서블릿 필터와 비교해보면 매우 편리한 것을 알 수 있다

  - 인터셉터와 필터가 중복되지 않도록 필터를 등록하기 위한 logFilter() , loginCheckFilter() 의 @Bean 은 주석처리하자.

  - 서블릿 필터와 스프링 인터셉터는 웹과 관련된 공통 관심사를 해결하기 위한 기술이다. 서블릿 필터와 비교해서 스프링 인터셉터가 개발자 입장에서 훨씬 편리하다는 것을 코드로 이해했을 것이다. 특별한 문제가 없다면 인터셉터를 사용하는 것이 좋다.

 

 7.7 로그인 처리2 - 필터, 인터셉터 - ArgumentResolver 활용

  - MVC1편 6. 스프링 MVC - 기본 기능 요청 -> 매핑 헨들러 어뎁터 구조에서 ArgumentResolver 를 학습했다.

  - 이번 시간에는 해당 기능을 사용해서 로그인 회원을 조금 편리하게 찾아보자.

@GetMapping("/")
public String homeLoginV3ArgumentResolver(@Login Member loginMember, Model model) {

    //세션에 값이 없으면 홈으로 이동
    if(loginMember == null) {
        return "home";
    }

    //세션에 값이 있으면 로그인으로 이동
    model.addAttribute("member", loginMember);
    return "loginHome";
}

  - hello/login/web/HomeController.java

  - ArgumentResolver를 활용한 로그인 추가 (@Login 애노테이션 사용)

  - 다음에 설명하는 @Login 애노테이션을 만들어야 컴파일 오류가 사라진다

  - @Login 애노테이션이 있으면 직접 만든 ArgumentResolver 가 동작해서 자동으로 세션에 있는 로그인 회원을 찾아주고, 만약 세션에 없다면 null 을 반환하도록 개발.

 

package hello.login.web.argumentResolver;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface Login {

}

  - hello/login/web/argumentResolver/Login.java

  - Login 애노테이션 생성

  - @Target(ElementType.PARAMETER) : 파라미터에만 사용

  - @Retention(RetentionPolicy.RUNTIME) : 리플렉션 등을 활용할 수 있도록 런타임까지 애노테이션 정보가 남아있음

 

package hello.login.web.argumentResolver;

import hello.login.domain.member.Member;
import hello.login.web.SessionConst;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.MethodParameter;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

@Slf4j
public class LoginMemberArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        log.info("supportsParameter 실행");
        boolean hasLoginAnnotation = parameter.hasParameterAnnotation(Login.class);
        boolean hasMemberType = Member.class.isAssignableFrom(parameter.getParameterType());

        return hasLoginAnnotation && hasMemberType;
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        log.info("resolveArgument 실행");

        HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
        HttpSession session = request.getSession(false);

        if(session == null) {
            return null;
        }

        return session.getAttribute(SessionConst.LOGIN_MEMBER);
    }
}

  - hello/login/web/argumentResolver/LoginMemberArgumentResolver.java

  - supportsParameter() : @Login 애노테이션이 있으면서 Member 타입이면 해당 ArgumentResolver 가 사용된다

  - resolveArgument() : 컨트롤러 호출 직전에 호출 되어서 필요한 파라미터 정보를 생성해준다.

    > 세션에 있는 로그인 회원 정보인 member 객체를 찾아서 반환해준다.

    > 이후 스프링MVC는 컨트롤러의 메서드를 호출하면서 여기에서 반환된 member 객체를 파라미터에 전달해준다.

 

@Configuration
public class WebConfig implements WebMvcConfigurer {

    //ArgumentResolver도 오버라이드해서 사용한다.
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(new LoginMemberArgumentResolver());
    }
	...

  - hello/login/WebConfig.java

  - 앞서 개발한 LoginMemberArgumentResolver 를 등록

 

 * 실행

  - 실행해보면, 결과는 동일하지만, 더 편리하게 로그인 회원 정보를 조회할 수 있다.

  - 이렇게 ArgumentResolver 를 활용하면 공통 작업이 필요할 때 컨트롤러를 더욱 편리하게 사용할 수 있다.

 

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 13

Spring 정리 2022. 7. 10. 15:50

인프런 강의 51일차.

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

 - 1편에서 배운 MVC를 활용할 수 있는 기술 습득

 - 타입 컨버터, 파일 업로드, 활용, 쿠키, 세션, 필터, 인터셉터, 예외 처리, 타임리프, 메시지, 국제화, 검증 등등

 

 6.6 쿠키와 보안 문제

  - 쿠키를 사용해서 로그인Id를 전달해서 로그인을 유지할 수 있었다. 그런데 여기에는 심각한 보안 문제가 있다.

 

 * 보안 문제

  - 쿠키 값은 임의로 변경할 수 있다.

    > 클라이언트가 쿠키를 강제로 변경하면 다른 사용자가 된다.

    > 실제 웹브라우저 개발자모드 -> Application -> Cookie 변경으로 확인 가능

    > Cookie: memberId=1 -> Cookie: memberId=2 (변경 시 다른 사용자의 이름이 보임)

  - 쿠키에 보관된 정보는 훔쳐갈 수 있다.

    > 만약 쿠키에 개인정보나, 신용카드 정보가 있다면?

    > 이 정보가 웹 브라우저에도 보관되고, 네트워크 요청마다 계속 클라이언트에서 서버로 전달된다.

    > 쿠키의 정보가 나의 로컬 PC가 털릴 수도 있고, 네트워크 전송 구간에서 털릴 수도 있다.

  - 해커가 쿠키를 한번 훔쳐가면 평생 사용할 수 있다.

    > 해커가 쿠키를 훔쳐가서 그 쿠키로 악의적인 요청을 계속 시도할 수 있다.

 

 * 대안

  - 쿠키에 중요한 값을 노출하지 않고, 사용자 별로 예측 불가능한 임의의 토큰(랜덤 값)을 노출하고, 서버에서 토큰과 사용자 id를 매핑해서 인식한다. 그리고 서버에서 토큰을 관리한다.

  - 토큰은 해커가 임의의 값을 넣어도 찾을 수 없도록 예상 불가능 해야 한다.

  - 해커가 토큰을 털어가도 시간이 지나면 사용할 수 없도록 서버에서 해당 토큰의 만료시간을 짧게(예: 30분) 유지한다. 또는 해킹이 의심되는 경우 서버에서 해당 토큰을 강제로 제거하면 된다

 

 6.7 로그인 처리하기 - 세션 동작 방식

  - 앞서 쿠키에 중요한 정보를 보관하는 방법은 여러가지 보안 이슈가 있었다. 이 문제를 해결하려면 결국 중요한 정보를 모두 서버에 저장해야 한다. 그리고 클라이언트와 서버는 추정 불가능한 임의의 식별자 값으로 연결해야 한다.

  - 이렇게 서버에 중요한 정보를 보관하고 연결을 유지하는 방법을 세션이라 한다.

 

 

 * 세션 동작 방식

   - 로그인 > 세션 생성 > 세션id를 응답쿠키로 전달 > 클라이언트의 세션id 쿠키 전달

   - 1. 로그인

로그인

    > 사용자가 loginId , password 정보를 전달하면 서버에서 해당 사용자가 맞는지 확인한다. 

 

   - 2. 세션 생성

세션 생성

    > 세션 ID를 생성하는데, 추정 불가능해야 한다.

    > UUID는 추정이 불가능하다.

    > Cookie: mySessionId=zz0101xx-bab9-4b92-9b32-dadb280f4b61

    > 생성된 세션 ID와 세션에 보관할 값( memberA )을 서버의 세션 저장소에 보관한다

 

   - 3. 세션id를 응답쿠키로 전달

세션id를 응답 쿠키로 전달

    > 클라이언트와 서버는 결국 쿠키로 연결이 되어야 한다.

    > 서버는 클라이언트에 mySessionId 라는 이름으로 세션ID 만 쿠키에 담아서 전달한다.

    > 클라이언트는 쿠키 저장소에 mySessionId 쿠키를 보관한다.

    > 여기서 중요한 포인트는 회원과 관련된 정보는 전혀 클라이언트에 전달하지 않는다는 것이다.

    > 오직 추정 불가능한 세션 ID만 쿠키를 통해 클라이언트에 전달한다

 

   - 4. 클라이언트의 세션id 쿠키 전달

클라이언트의 세션id 쿠키 전달

    > 클라이언트는 요청시 항상 mySessionId 쿠키를 전달한다.

    > 서버에서는 클라이언트가 전달한 mySessionId 쿠키 정보로 세션 저장소를 조회해서 로그인시 보관한 세션 정보를 사용한다.

 

 * 정리

  - 세션을 사용해서 서버에서 중요한 정보를 관리하게 되었다.

  - 덕분에 다음과 같은 보안 문제들을 해결할 수 있다.

    > 쿠키값이 변조 가능 -> 예상 불가능한 복잡한 세션Id를 사용한다.

    > 쿠키에 보관하는 정보는 클라이언트 해킹시 털릴 가능성이 있다 -> 세션Id가 털려도 여기에는 중요한 정보가 없다.

    > 쿠키 탈취 후 사용 -> 해커가 토큰을 털어가도 시간이 지나면 사용할 수 없도록 서버에서 세션의 만료시간을 짧게(예: 30분) 유지한다. 또는 해킹이 의심되는 경우 서버에서 해당 세션을 강제로 제거하면 된다

 

 6.8 로그인 처리하기 - 세션 직접 만들기

  - 세션을 직접 개발해서 적용해보자. 세션 관리는 크게 3가지 기능을 제공하면 된다.

  - 세션 생성

   > sessionId 생성 (임의의 추정 불가능한 랜덤 값)

   > 세션 저장소에 sessionId와 보관할 값 저장

   > sessionId로 응답 쿠키를 생성해서 클라이언트에 전달

  - 세션 조회

   > 클라이언트가 요청한 sessionId 쿠키의 값으로, 세션 저장소에 보관한 값 조회

  - 세션 만료

   > 클라이언트가 요청한 sessionId 쿠키의 값으로, 세션 저장소에 보관한 sessionId와 값 제거

 

package hello.login.web.session;

import org.apache.catalina.filters.ExpiresFilter;
import org.springframework.stereotype.Component;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;

/**
 * 세션 관리
 */

@Component
public class SessionManager {

    public static final String SESSION_COOKIE_NAME = "mySessionId";
    private Map<String, Object> sessionStore = new ConcurrentHashMap<>();   //HashMap을 써도 되지만, 동시성 이슈가 있으므로 ConcurrentHashMap을 사용

    /**
     * 세션 생성
     *  sessionId 생성 (임의의 추정 불가능한 값)
     *  세션 저장소에 sessionId와 보관할 값 저장
     *  sessionId로 응답 쿠키를 생성해서 클라이언트에 저장
     */
    public void createSession(Object value, HttpServletResponse response) {

        //세션ID를 생성하고, 값을 세션에 저장
        String sessionId = UUID.randomUUID().toString();    //UUID를 사요하면 확실한 랜덤값을 얻을 수 있다.(java에서 제공함)
        sessionStore.put(sessionId, value);

        //쿠키 생성
        //상수화 단축키 Ctrl + Alt + C
        Cookie mySessionCookie = new Cookie(SESSION_COOKIE_NAME, sessionId);
        response.addCookie(mySessionCookie);
    }

    /**
     * 세션 조회
     */
    public Object getSession(HttpServletRequest request) {
        Cookie sessionCookie = findCookie(request, SESSION_COOKIE_NAME);
        if(sessionCookie == null) {
            return null;
        }
        return sessionStore.get(sessionCookie.getValue());
    }

    public Cookie findCookie(HttpServletRequest request, String cookieName) {
        Cookie[] cookies = request.getCookies();
        if(cookies == null) {
            return null;
        }
        return Arrays.stream(cookies)
                .filter(cookie -> cookie.getName().equals(cookieName))
                .findAny()
                .orElse(null);
    }

    /**
     * 세션 만료
     */
    public void expire(HttpServletRequest request) {
        Cookie sessionCookie = findCookie(request, SESSION_COOKIE_NAME);
        if(sessionCookie != null) {
            sessionStore.remove(sessionCookie.getValue());
        }
    }
}

  - hello.login.web.session.SessionManager.java

  - @Component : 스프링 빈으로 자동 등록한다.

  - ConcurrentHashMap : HashMap 은 동시 요청에 안전하지 않다. 동시 요청에 안전한 ConcurrentHashMap 를 사용했다

 

package hello.login.web.session;

import hello.login.domain.member.Member;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;

import javax.servlet.http.HttpServletResponse;

import static org.assertj.core.api.Assertions.*;

class SessionManagerTest {

    SessionManager sessionManager = new SessionManager();

    @Test
    void sessionTest() {

        //세션 생성
        MockHttpServletResponse response = new MockHttpServletResponse();   //HttpServletResponse는 interface이기 때문에 테스트하기가 까다로운데 이런 경우를 위해 Mock~ 클래스를 제공해주고 있다.
        Member member = new Member();
        sessionManager.createSession(member, response);

        //요청에 의한 응답 쿠키 저장
        MockHttpServletRequest request = new MockHttpServletRequest();
        request.setCookies(response.getCookies());

        //세션 조회
        Object result = sessionManager.getSession(request);;
        assertThat(result).isEqualTo(member);

        //세션 만료
        sessionManager.expire(request);
        Object expired = sessionManager.getSession(request);
        assertThat(expired).isNull();
    }

}

  - hello.login.web.session.SessionManagerTest.java

  - 여기서는 HttpServletRequest , HttpservletResponse 객체가 인터페이스기 때문에 직접 사용할 수 없다. 그렇기에 테스트에서 비슷한 역할을 해주는 가짜 MockHttpServletRequest , MockHttpServletResponse 를 사용했다.

 

 6.9 로그인 처리하기 - 직접 만든 세션 적용

  - 지금까지 개발한 세션 관리 기능을 실제 웹 애플리케이션에 적용해보자

@PostMapping("/login")
public String loginV2(@Valid @ModelAttribute LoginForm form, BindingResult bindingResult, HttpServletResponse response) {
    if(bindingResult.hasErrors()){
        return "login/loginForm";
    }

    Member loginMember = loginService.login(form.getLoginId(), form.getPassword());

    if(loginMember == null){
        //null인 경우 글로벌오류로 처리
        bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
        return "login/loginForm";
    }

    /*
    //세션 관리자를 통해 세션 생성하고, 회원 데이터를 보관하도록 변경
    //쿠키에 시간 정보를 주지 않으면 디폴트로 세션쿠키가 됨(브라우저 종료 시 모두 종료)
    Cookie idCookie = new Cookie("memberId", String.valueOf(loginMember.getId()));
    response.addCookie(idCookie);
     */
    sessionManager.createSession(loginMember, response);
    return "redirect:/";
}

  - hello/login/web/login/LoginController.java

  - private final SessionManager sessionManaber를 주입받도록 선언해둔 상태이다.

  - sessionManager.createSession(loginMember, response);

    > 로그인 성공시 세션을 등록한다. 세션에 loginMember 를 저장해두고, 쿠키도 함께 발행한다

 

@PostMapping("/logout")
public String logoutV2(HttpServletRequest request) {
    sessionManager.expire(request);
    return "redirect:/";
}

  - hello/login/web/login/LoginController.java

  - sessionManager.expire(request)를 통해 세션스토어에서 해당 uuid를 제거하도록 변경

 

@GetMapping("/")
public String homeLoginV2(HttpServletRequest request, Model model) {

    //세션관리자에 저장된 회원 정보 조회
    Member member = (Member) sessionManager.getSession(request);

    if(member == null) {
        return "home";
    }

    model.addAttribute("member", member);
    return "loginHome";
}

  - hello/login/web/HomeController.java

  - private final SessionManager sessionManaber를 주입받도록 선언해둔 상태이다.

  - sessionManager를 통해 회원정보를 조회하도록 변경

  - request에서 세션값을 읽어오기 때문에 쿠키를 사용하던 파라미터에서 HttpServletRequest로 변경

  - getSession은 return 타입이 Object이므로 Member로 캐스팅시켜주었다.

  - 세션 관리자에서 저장된 회원 정보를 조회한다. 만약 회원 정보가 없으면, 쿠키나 세션이 없는 것 이므로 로그인 되지 않은 것으로 처리한다

 

 * 정리

  - 이번 시간에는 세션과 쿠키의 개념을 명확하게 이해하기 위해서 직접 만들어보았다.

  - 사실 세션이라는 것이 뭔가 특별한 것이 아니라 단지 쿠키를 사용하는데, 서버에서 데이터를 유지하는 방법일 뿐이라는 것을 이해했을 것이다.

  - 그런데 프로젝트마다 이러한 세션 개념을 직접 개발하는 것은 상당히 불편할 것이다. 그래서 서블릿도 세션 개념을 지원한다.

  - 이제 직접 만드는 세션 말고, 서블릿이 공식 지원하는 세션을 알아보자. 서블릿이 공식 지원하는 세션은 우리가 직접 만든 세션과 동작 방식이 거의 같다. 추가로 세션을 일정시간 사용하지 않으면 해당 세션을 삭제하는 기능을 제공한다

 

 6.10 로그인 처리하기 - 서블릿 HTTP 세션1

  - 세션이라는 개념은 대부분의 웹 애플리케이션에 필요한 것이다.

  - 서블릿은 세션을 위해 HttpSession 이라는 기능을 제공하는데, 지금까지 나온 문제들을 해결해준다.

  - 우리가 직접 구현한 세션의 개념이 이미 구현되어 있고, 더 잘 구현되어 있다

 

 * HttpSession 소개

  - 서블릿이 제공하는 HttpSession 도 결국 우리가 직접 만든 SessionManager 와 같은 방식으로 동작한다.

  - 서블릿을 통해 HttpSession 을 생성하면 다음과 같은 쿠키를 생성한다.

  - 쿠키 이름이 JSESSIONID 이고, 값은 추정 불가능한 랜덤 값이다.

    > Cookie: JSESSIONID=5B78E23B513F50164D6FDD8C97B0AD05

 

 * HttpSession 사용

  - 서블릿이 제공하는 HttpSession 을 사용하도록 개발해보자

package hello.login.web;

public class SessionConst {
    public static final String LOGIN_MEMBER = "loginMember";
}

  - hello/login/web/SessionConst.java

  - HttpSession 에 데이터를 보관하고 조회할 때, 같은 이름이 중복 되어 사용되므로, 상수를 하나 정의했다.

 

@PostMapping("/login")
public String loginV3(@Valid @ModelAttribute LoginForm form, BindingResult bindingResult, HttpServletRequest request) {
    if(bindingResult.hasErrors()){
        return "login/loginForm";
    }

    Member loginMember = loginService.login(form.getLoginId(), form.getPassword());

    if(loginMember == null){
        //null인 경우 글로벌오류로 처리
        bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
        return "login/loginForm";
    }

    //로그인 성공 처리
    HttpSession session = request.getSession();  //세션이 있으면 있는 세션 반환, 없으면 신규 세션을 생성해서 반환 (getssesion(false)로 호출 시 없는 경우 신규 세션을 생성하지 않고 null 반환)
    //세션에 로그인 회원 정보 저장
    session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);

    return "redirect:/";
}

  - hello/login/web/login/LoginController.java

  - HttpSession을 사용한 세션 처리

 

 * HttpSession 생성과 조회

  - 세션을 생성하려면 request.getSession(true) 를 사용하면 된다.

  - public HttpSession getSession(boolean create);

  - 세션의 create 옵션에 대해 알아보자.

    > request.getSession(true) : 세션이 있으면 기존 세션을 반환. 세션이 없으면 새로운 세션을 생성해서 반환한다.

    > request.getSession(false) : 세션이 있으면 기존 세션을 반환. 없으면 새로운 세션을 생성하지 않고 null 을 반환한다.

 

 * 세션에 로그인 회원 정보 보관

  - session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);

  - 세션에 데이터를 보관하는 방법은 request.setAttribute(..) 와 비슷하다. 하나의 세션에 여러 값을 저장할 수 있다.

 

@PostMapping("/logout")
public String logoutV3(HttpServletRequest request) {
    HttpSession session = request.getSession(false);
    if(session != null){
        session.invalidate();
    }
    return "redirect:/";
}

  - hello/login/web/login/LoginController.java

  - HttpSession 삭제 : session.invalidate() 사용 시 세션을 제거한다

 

@GetMapping("/")
public String homeLoginV3(HttpServletRequest request, Model model) {

    //로그인 정보 없이 홈 화면에 접근한 사용자는 신규 세션을 만들면 안되므로 false로 세션 정보 가져와야함
    HttpSession session = request.getSession(false);
    if(session == null){
        return "home";
    }

    Member loginMember  = (Member) session.getAttribute(SessionConst.LOGIN_MEMBER);

    //세션에 값이 없으면 홈으로 이동
    if(loginMember == null) {
        return "home";
    }

    //세션에 값이 있으면 로그인으로 이동
    model.addAttribute("member", loginMember);
    return "loginHome";
}

  - hello/login/web/HomeController.java

  - request.getSession(false) : request.getSession() 를 사용하면 기본 값이 create: true 이므로, 로그인 하지 않을 사용자도 의미없는 세션이 만들어진다. 따라서 세션을 찾아서 사용하는 시점에는 create: false 옵션을 사용해서 세션을 생성하지 않아야 한다.

  - session.getAttribute(SessionConst.LOGIN_MEMBER) : 로그인 시점에 세션에 보관한 회원 객체를 찾는다

 

 6.11 로그인 처리하기 - 서블릿 HTTP 세션2

  - @SessionAttribute : 스프링은 세션을 더 편리하게 사용할 수 있도록 @SessionAttribute 을 지원한다.

  - 이미 로그인 된 사용자를 찾을 때는 다음과 같이 사용하면 된다. 이 기능은 세션을 생성하지 않는다.

    > @SessionAttribute(name = "loginMember", required = false) Member loginMember

 

@GetMapping("/")
public String homeLoginV3Spring(
        @SessionAttribute(name = SessionConst.LOGIN_MEMBER, required = false) Member loginMember, Model model) {

    //세션에 값이 없으면 홈으로 이동
    if(loginMember == null) {
        return "home";
    }

    //세션에 값이 있으면 로그인으로 이동
    model.addAttribute("member", loginMember);
    return "loginHome";
}

  - hello/login/web/HomeController.java

  - 세션을 찾고, 세션에 들어있는 데이터를 찾는 번거로운 과정을 스프링이 한번에 처리해주는 것을 확인할 수 있다.

 

 * TrackingMode

  - 로그인을 처음 시도하면 URL이 다음과 같이 jsessionid 를 포함하고 있는 것을 확인할 수 있다.

http://localhost:8080/;jsessionid=F59911518B921DF62D09F0DF8F83F872

  - 이것은 웹 브라우저가 쿠키를 지원하지 않을 때 쿠키 대신 URL을 통해서 세션을 유지하는 방법이다.

  - 다만 개발자입장에서 모든 url에 jsessionId를 추가해서 전달해야하므로 현실적으로 거의 사용하지 않는다.

  - 이 방법을 사용하려면 URL에 이 값을 계속 포함해서 전달해야 한다. 타임리프 같은 템플릿은 엔진을 통해서 링크를 걸면 jsessionid 를 URL에 자동으로 포함해준다.

  - 서버 입장에서 웹 브라우저가 쿠키를 지원하는지 하지 않는지 최초에는 판단하지 못하므로, 쿠키 값도 전달하고, URL에 jsessionid 도 함께 전달한다.

  - URL 전달 방식을 끄고 항상 쿠키를 통해서만 세션을 유지하고 싶으면 application.properties에 옵션을 넣어주면 된다.

server.servlet.session.tracking-modes=cookie

  - 이렇게 하면 URL에 jsessionid 가 노출되지 않는다

 

 6.12 세션 정보와 타임아웃 설정

  - 세션이 제공하는 정보들을 확인해보자

package hello.login.web.session;

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

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.util.Date;

@Slf4j
@RestController
public class SessionController {

    @GetMapping("/session-info")
    public String sessionInfo(HttpServletRequest request) {
        HttpSession session = request.getSession(false);
        if(session == null) {
            return "세션이 없습니다.";
        }

        //세션 데이터 출력
        session.getAttributeNames().asIterator()
                .forEachRemaining(name -> log.info("session name = {}, value = {}", name, session.getAttribute(name)));

        log.info("sessionId={} ", session.getId());
        log.info("getMaxInactiveInterval={} ", session.getMaxInactiveInterval());
        log.info("creationTime={} ", new Date(session.getCreationTime()));
        log.info("lastAccessTime={} ", new Date(session.getLastAccessedTime()));
        log.info("isNew={}", session.isNew());

        return "세션 출력";
    }

}

  - hello/login/web/session/SessionController.java

  - sessionId : 세션Id, JSESSIONID 의 값이다.

    > 예) 34B14F008AA3527C9F8ED620EFD7A4E1

  - maxInactiveInterval : 세션의 유효 시간

    > 예) 1800초, (30분)

  - creationTime : 세션 생성일시, long 타입이기 때문에 Date로 변환해서 출력.

  - lastAccessedTime : 세션과 연결된 사용자가 최근에 서버에 접근한 시간, 클라이언트에서 서버로 sessionId ( JSESSIONID )를 요청한 경우에 갱신된다.

  - isNew : 새로 생성된 세션인지, 아니면 이미 과거에 만들어졌고, 클라이언트에서 서버로 sessionId ( JSESSIONID )를 요청해서 조회된 세션인지 여부

 

 * 세션 타임아웃 설정

  - 세션은 사용자가 로그아웃을 직접 호출해서 session.invalidate() 가 호출 되는 경우에 삭제된다.

  - 그런데 대부분의 사용자는 로그아웃을 선택하지 않고, 그냥 웹 브라우저를 종료한다.

  - 문제는 HTTP가 비 연결성(ConnectionLess)이므로 서버 입장에서는 해당 사용자가 웹 브라우저를 종료한 것인지 아닌지를 인식할 수 없다.

  - 따라서 서버에서 세션 데이터를 언제 삭제해야 하는지 판단하기가 어렵다.

  - 이 경우 남아있는 세션을 무한정 보관하면 다음과 같은 문제가 발생할 수 있다

    > 세션과 관련된 쿠키( JSESSIONID )를 탈취 당했을 경우 오랜 시간이 지나도 해당 쿠키로 악의적인 요청을 할 수 있다.

    > 세션은 기본적으로 메모리에 생성된다. 메모리의 크기가 무한하지 않기 때문에 꼭 필요한 경우만 생성해야 한다.

 

 * 세션의 종료 시점

  - 세션의 종료 시점을 어떻게 정하면 좋을까? 가장 단순하게 생각해보면, 세션 생성 시점으로부터 30분 정도로 잡으면 될 것 같다. 그런데 문제는 30분이 지나면 세션이 삭제되기 때문에, 열심히 사이트를 돌아다니다가 또 로그인을 해서 세션을 생성해야 한다 그러니까 30분 마다 계속 로그인해야 하는 번거로움이 발생한다.

  - 더 나은 대안은 세션 생성 시점이 아니라 사용자가 서버에 최근에 요청한 시간을 기준으로 30분 정도를 유지해주는 것이다. 이렇게 하면 사용자가 서비스를 사용하고 있으면, 세션의 생존 시간이 30분으로 계속 늘어나게 된다.

  - 따라서 30분 마다 로그인해야 하는 번거로움이 사라진다.

  - HttpSession 은 이 방식을 사용한다

 

 * 세션 타임아웃 설정

  - 스프링 부트로 글로벌 설정 (application.properties)

  - server.servlet.session.timeout=60 : 60초, 기본은 1800(30분)

    > 글로벌 설정은 분 단위로 설정해야 한다. 60(1분), 120(2분), ...

 

 * 세션 타임아웃 발생

  - 세션의 타임아웃 시간은 해당 세션과 관련된 JSESSIONID 를 전달하는 HTTP 요청이 있으면 현재 시간으로 다시 초기화 된다.

  - 이렇게 초기화 되면 세션 타임아웃으로 설정한 시간동안 세션을 추가로 사용할 수 있다.

    > session.getLastAccessedTime() : 최근 세션 접근 시간

  - LastAccessedTime 이후로 timeout 시간이 지나면, WAS가 내부에서 해당 세션을 제거한다

 

 * 정리

  - 서블릿의 HttpSession 이 제공하는 타임아웃 기능 덕분에 세션을 안전하고 편리하게 사용할 수 있다.

  - 실무에서 주의할 점은 세션에는 최소한의 데이터만 보관해야 한다는 점이다.

  - 보관한 데이터 용량 * 사용자 수로 세션의 메모리 사용량이 급격하게 늘어나서 장애로 이어질 수 있다.

  - 추가로 세션의 시간을 너무 길게 가져가면 메모리 사용이 계속 누적 될 수 있으므로 적당한 시간을 선택하는 것이 필요하다. 기본이 30 분이라는 것을 기준으로 고민하면 된다.