[강의] 김영한님의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 정리 - 로그인 처리

크리링·2023년 2월 26일

강의

인프런 김영한님 스프링 강의 정리

목록 보기

5/13

출처 : 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술
코드 : github.com/Woongi9/study_mvc2-code

로그인 처리

로그인이 되면 홈 화면에 고객 이름이 보여야 한다는 요구사항이 있을 때에 어떻게 로그인의 상태를 유지하면서, 쿼리 파라미터를 계속 유지하면서 보내는 번거로운 작업 없이 로그인에 성공한 사용자는 홈 화면에 고객의 이름을 보여줄 수 있을까?

서버에서 로그인에 성공하면 HTTP 응답에 쿠키를 담아서 브라우저에 전달하자. 그러면 브라우저는 앞으로 해당 쿠키를 지속해서 보내준다.

쿠키 생성

클라이언트 쿠키 전달 1

클라이언트 쿠키 전달 2

쿠키에는 영속 쿠키와 세션 쿠키가 있다.

영속 쿠키 : 만료 날짜를 입력하면 해당 날짜까지 유지
세션 쿠키 : 만료 날짜를 생략하면 브라우저 종료시까지만 유지

쿠키 생성 로직

...
// 로그인 성공 처리
// 쿠키에 시간 정보를 주지 않으면 세션 쿠키(브라우저 종료시 모두 종료)

Cookie idCookie = new Cookie("memberId", String.valueOf(loginMember.getId()));
 response.addCookie(idCookie);
...

로그인에 성공하면 쿠키를 생성하고 HttpSevletResponse에 담는다. 쿠키 이름은 memberId이고, 값은 회원의 id를 담아둔다. 웹 브라우저는 종료 전까지 회원의 id를 서버에 계속 보내줄 것이다.

홈 - 로그인 처리

@GetMapping("/")
 public String homeLogin(@CookieValue(name = "memberId", required = false) Long memberId,Model model) {
...
}

@CookieValue를 사용하면 편리하게 쿠키를 조회할 수 있다.
로그인하지 않은 사용자도 홈에 접근할 수 있기 때문에 required = false를 사용한다. (default는 true)

LoginController - logout 기능

@PostMapping("/logout")
public String logout(HttpServletResponse response) {
 expireCookie(response, "memberId");
 return "redirect:/";
}

private void expireCookie(HttpServletResponse response, String cookieName) {
 Cookie cookie = new Cookie(cookieName, null);
 cookie.setMaxAge(0);
 response.addCookie(cookie);
}

쿠키와 보안 문제

보안 문제

쿠키 값은 임의로 변경할 수 있다.
- 클라이언트가 쿠키를 강제로 변경하면 다른 사용자가 된다.
쿠키에 보관된 정보는 훔쳐갈 수 있다.
해커가 쿠키를 한번 훔쳐가면 평생 사용할 수 있다.

대안

쿠키에 중요한 값을 노출하지 않고, 사용자 별로 예측 불가능한 임의의 토큰(랜덤 값)을 노출하고, 서버에서 토큰과 사용자 id를 매핑해서 인식한다. 그리고 서버에서 토큰을 관리
토큰은 해커가 임의의 값을 넣어도 찾을 수 없도록 예상 불가능 해야한다.
해커가 토큰을 털어가도 토큰의 만료시간을 짧게 유지한다.

세션

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

세션 동작 방식

세션 생성

세션 ID를 생성하는데, 추정 불가능해야 한다.
UUID는 추정이 불가능하다.
- Cookie : mySessionId=zz0101xx-bab9-4b92-9b32-dadb280f4b61
생성된 세션 ID와 세션에 보관할 값 (memberA)을 서버의 세션 저장소에 보관한다

세션id를 응답 쿠키로 전달

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

서버는 클라이언트에 mySessionId라는 이름으로 세션ID만 쿠키에 담아서 전달한다.ㅏ
클라이언트는 쿠키 저장소에 mySessionId 쿠키를 보관한다.

중요

여기서 중요한 포인트는 회원과 관련된 정보는 전혀 클라이언트에 전달하지 않는다는 것이다.
오직 추정 불가능한 세션 ID만 쿠키를 통해 클라이언트에 전달한다.

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

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

정리

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

쿠키 값을 변조 가능 -> 예상 불가능한 복잡한 세션Id를 사용한다.
쿠키에 보관하는 정보는 클라이언트 해킹시 털릴 가능성이 있다. -> 세션Id가 털려도 여기에는 중요한 정보가 없다.
쿠키 탈취 후 사용 -> 세션의 만료시간을 짧게 유지한다.

세션 직접 만들기

세션 생성

sessionId 생성
세션 저장소에 sessionId와 보관할 값 저장
sessionId로 응답 쿠키를 생성해서 클라이언트에 전달

세션 조회

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

세션 만료

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

SessionManager

@Component
public class SessionManager {
 public static final String SESSION_COOKIE_NAME = "mySessionId";
 private Map<String, Object> sessionStore = new ConcurrentHashMap<>();
 
 /**
 * 세션 생성
 */
 public void createSession(Object value, HttpServletResponse response) {
 	//세션 id를 생성하고, 값을 세션에 저장
 	String sessionId = UUID.randomUUID().toString();
 	sessionStore.put(sessionId, value);
 
 	//쿠키 생성
 	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 void expire(HttpServletRequest request) {
 	Cookie sessionCookie = findCookie(request, SESSION_COOKIE_NAME);
 	if (sessionCookie != null) {
 		sessionStore.remove(sessionCookie.getValue());
 	}
 }
 
 private Cookie findCookie(HttpServletRequest request, String cookieName) {
 	if (request.getCookies() == null) {
 		return null;
 	}
    
 	return Arrays.stream(request.getCookies())
 	.filter(cookie -> cookie.getName().equals(cookieName))
 	.findAny()
 	.orElse(null);
 }
}

@Component : 스프링 빈으로 자동 등록한다.
ConcurrentHashMap : HashMap은 동시 요청에 안전하지 않다. 동시 요청에 안전한 ConcurrentHashMap을 사용했다.

세션 사용

@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());
 log.info("login? {}", loginMember);
 if (loginMember == null) {
 	bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
 	return "login/loginForm";
 }
 
 //로그인 성공 처리
 //세션 관리자를 통해 세션을 생성하고, 회원 데이터 보관
 sessionManager.createSession(loginMember, response);
 return "redirect:/";
}

private final Session Manager sessionManager; 주입
sessionManager.createSession(loginMember, response);
- 로그인 성공시 세션을 등록한다. 세션에 loginMember를 저장해두고, 쿠키도 함께 발생한다.

logout

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

정리

세션 개념을 직접 개발하는 것은 상당히 불편하다. 그래서 서블릿도 세션 개념을 지원한다.
서블릿이 공식 지원하는 세션을 알아보자.

서블릿 HTTP 세션 1

세션이라는 개념은 대부분의 웹 애플리케이션에 필요한 것이다. 서블릿은 세션을 위해 HttpSession이라는 기능을 제공하는데, 지금까지 나온 문제들을 해결해준다.

HttpSession

서블릿이 제공하는 HttpSession도 결국 우리가 만든 SessionManager와 같은 방식으로 동작한다. 서블릿을 통해 HttpSession을 생성하면 다음과 같은 쿠키를 생성한다. 값은 추정 불가능한 랜덤 값이다.
Cookie: JSESSIONID=5B78E23B513F50164D6FDD8C97B0AD05

HttpSession 사용

SessionConst

package hello.login.web;
public class SessionConst {
 public static final String LOGIN_MEMBER = "loginMember";
}

Session에 데이터를 보관하고 조회할 때, 이름이 중복 되어 사용되므로 상수를 정의

LoginController

@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());
 log.info("login? {}", loginMember);
 if (loginMember == null) {
 	bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
 	return "login/loginForm";
 }
 
 //로그인 성공 처리
 //세션이 있으면 있는 세션 반환, 없으면 신규 세션 생성
 HttpSession session = request.getSession();
 //세션에 로그인 회원 정보 보관
 session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);
 return "redirect:/";
}

세션 생성과 조회

세션을 생성하려면 request.getSession(true)를 사용하면 된다.
public HttpSession getsession(boolean create);

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

request.getSession(true)
- 세션이 있으면 기존 세션을 반환한다.
- 세션이 없으면 새로운 세션을 생성해서 반환한다.
request.getSession(false)
- 세션이 있으면 기존 세션을 반환한다.
- 세션이 없으면 새로운 세션을 생성하지 않는다. null 반환
request.getSession() : 신규 세션을 생성하는 request.getSession(true)와 동일하다.

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

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

logout V3

...
public String logoutV3(HttpServletRequest request) {
 //세션을 삭제한다.
 HttpSession session = request.getSession(false);
 if (session != null) {
 	session.invalidate();
 }
...

기존 logoutV2()의 @PostMapping("/logout") 주석 처리
session.invalidate() : 세션을 제거한다.

HomeController - homeLoginV3

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

	//세션이 없으면 home
	HttpSession session = request.getSession(false);
 	if (session == null) {
 		return "home";
 	}
 
 	Member loginMember = (Member) session.getAttribute(SessionConst.LOGIN_MEMBER);
 	//세션에 회원 데이터가 없으면 home
 	if (loginMember == null) {
 		return "home";
 	}
 	//세션이 유지되면 로그인으로 이동
 	model.addAttribute("member", loginMember);
 ...

request.getSession(false) : request.getSession()를 사용하면 기본 값이 create : true 이므로, 로그인 하지 않을 사용자도 의미없는 세션이 만들어진다. 세션을 찾아서 사용하는 시점에는 create: false 옵션을 사용해서 세션을 생성하지 않아야 한다.
session.getAttribute(SessionConst.LOGIN_MEMBER) : 로그인 시점에 세션에 보관한 회원 객체를 찾는다.

서블릿 HTTP 세션 2

@SessionAttribute

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

이미 로그인 된 사용자를 찾을 때는 다음과 같이 사용하면 된다. 이 기능은 세션을 생성하지 않는다.
@SessionAttribute(name = "loginMember", required = false) Member loginMember

HomeController

@GetMapping("/")
public String homeLoginV3Spring(
 @SessionAttribute(name = SessionConst.LOGIN_MEMBER, required = false)
Member loginMember, Model model) {
 //세션에 회원 데이터가 없으면 home
 if (loginMember == null) {
 	return "home";
 }
 
 //세션이 유지되면 로그인으로 이동
 model.addAttribute("member", loginMember);
 return "loginHome";
}

homeLoginV3()의 @GetMapping("/") 주석 처리

세션을 찾고, 세션에 들어있는 데이터를 찾는 번거로운 과정을 스프링이 한번에 편리하게 처리해준다.

세션 정보 확인


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("maxInactiveInterval={}", session.getMaxInactiveInterval());
 	log.info("creationTime={}", new Date(session.getCreationTime()));
 	log.info("lastAccessedTime={}", new Date(session.getLastAccessedTime()));
 	log.info("isNew={}", session.isNew());
 	return "세션 출력";
 
	}
}

maxInactiveInterval : 세션의 유효 시간
lastAccessedTime : 세션과 연결된 사용자가 최근에 서버에 접근한 시간, 클라이언트에서 서버로 sessionId를 요청한 경우에 갱신된다.
isNew : 새로 생성된 세션인지, 아니면 이미 과거에 만들어졌고, 클라이언트에서 서버로 sessionId를 요청해서 조회된 세션이지 여부

세션 타임아웃 설정

application.properties에서
server.servlet.session.timeout=60 : 60초, 기본은 1800(30분)
(글로벌 설정은 분 단위로 설정해야 한다. 60(1분), 120(2분), ...)

서블릿 필터

위의 코드에서의 문제는 로그인 하지 않은 사용자도 URL을 직접 호출하면 관리 화면에 들어갈 수 있다.
서블릿 필터나 스프링 인터셉터를 사용하는것이 좋다.

필터 흐름

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러

필터를 적용하면 필터가 호출된 다음에 서블릿이 호출된다. 그래서 모든 고객의 요청 로그를 남기는 요구사항이 있다면 필터를 사용하면 된다. 필터는 특정 URL 패턴에 적용할 ㅅ ㅜ있다.
참고로 스프링을 사용하는 경우 여기서 말하는 서블릿은 스프링의 디스패치 서블릿으로 생각하면 된다.

필터 제한

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러   // 로그인 사용자
HTTP 요청 -> WAS -> 필터(적절하지 않은 요청이라 판단, 서블릿 호출 X)   // 비 로그인 사용자

필터에서 적절하지 않은 요청이라 판단하면 거기서 끝낼 수 있다.

필터 체인

HTTP 요청 -> WAS -> 필터1 -> 필터2 -> 필터3 -> 서블릿 -> 컨트롤러

필터는 체인으로 구성되는데, 중간에 필터를 자유롭게 추가할 수 있다. 예를 들어서 로그를 남기는 필터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 필터를 만들 수 있다.

필터 인터페이스

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() : 필터 종료 메소드, 서블릿 컨테이너가 종료될 때 호출된다.

로그 필터


...

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException{
	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);
    }
}
...

public class LogFilter implemets 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);
- 이 부분이 가장 중요 다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출한다. 이 로직이 없다면 다음 단계로 진행되지 않는다.

WebConfig - 필터 설정

@Configuration
	public class WebConfig {
	@Bean
	public FilterRegistrationBean logFilter() {
		FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
		filterRegistrationBean.setFilter(new LogFilter());
		filterRegistrationBean.setOrder(1);
		filterRegistrationBean.addUrlPatterns("/*");
		return filterRegistrationBean;
	}
}

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

setFilter(new LogFilter()) : 등록할 필터를 지정한다.
setOrder() : 필터는 체인으로 동작한다. 순서가 필요하다. 낮을수록 먼저 동작
addUrlPatterns("/*") : 필터를 적용할 URL 패턴을 지정한다. 한번에 여러 패턴을 지정할 수 있다.

참고

@SevletComponentScan, @WebFilter(filterName = "logFilter", urlPatterns = "/*")로 필터 등록이 가능하지만 필터 순서 조절이 안된다. FilterRegistrationBean을 사용하자.

서블릿 필터 - 인증 체크


@Slf4j
public class LoginCheckFilter implements Filter {
	private static final 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);
					//로그인으로 redirect
					httpResponse.sendRedirect("/login?redirectURL=" +
	requestURI);
					return; //여기가 중요, 미인증 사용자는 다음으로 진행하지 않고 끝!
				}
			}
			chain.doFilter(request, response);
		} catch (Exception e) {
			throw e; //예외 로깅 가능 하지만, 톰캣까지 예외를 보내주어야 함
		} finally {
			log.info("인증 체크 필터 종료 {}", requestURI);
		}
	}
    
	/**
	* 화이트 리스트의 경우 인증 체크X
	*/
	private boolean isLoginCheckPath(String requestURI) {
		return !PatternMatchUtils.simpleMatch(whitelist, requestURI);
	}
}

whitelist = {"/", "/members/add", "/login", "/logout", "/css/*"};
- 화이트 리스트 경로는 인증과 무관하게 항상 허용
isLoginCheckPath(requestURI)
- 화이트 리스트를 제외한 모든 경우 인증 체크 로직 적용
httpResponse.sendRedirect("/login?redirectURL=" + requestURI");
- 미인증 사용자는 로그인 화면으로 리다이렉트 한다. 그런데 로그인 이후에 다시 홈으로 이동해버리면, 원하는 경로를 다시 찾아가야 하는 불편함이 있다. 이러한 기능을 위해 현재 요청한 경로인 requestURI를 /login에 쿼리 파라미터로 함께 전달한다. 물론 /login 컨트롤러에서 로그인 성공시 해당 경로로 이동하는 기능은 추가로 개발해야 한다.
return; : 필터를 더는 진행하지 않는다. 필터는 물론이고 서블릿, 컨트롤러가 더는 호출 되지 않는다.

WebConfig - loginCheckFilter() 추가

@Bean
public FilterRegistrationBean loginCheckFilter() {
	FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
	filterRegistrationBean.setFilter(new LoginCheckFilter());
	filterRegistrationBean.setOrder(2);
	filterRegistrationBean.addUrlPatterns("/*");
	return filterRegistrationBean;
}

setFilter(new LoginCheckFilter()) : 로그인 필터를 등록한다.
setOrder(2) : 순서를 2번으로 잡았다. 로그 필터 다음에 로그인 필터가 적용된다.
addUrlPatterns("*") : 모든 요청에 로그인 필터를 적용한다.

LoginController - loginV4()

RedirectURL 처리

@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());
	log.info("login? {}", loginMember);
    
	if (loginMember == null) {
		bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
		return "login/loginForm";
	}
	//로그인 성공 처리
	//세션이 있으면 있는 세션 반환, 없으면 신규 세션 생성
	HttpSession session = request.getSession();
	//세션에 로그인 회원 정보 보관
	session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);
	//redirectURL 적용
	return "redirect:" + redirectURL;
}

로그인 체크 필터에서, 미인증 사용자는 요청 경로를 포함해서 /login에 redirectURL 요청 파라미터를 추가해서 요청했다. 이 값을 사용해서 로그인 성공시 해당 경로로 고객을 redirect한다.

정리

서블릿 필터를 잘 사용한 덕분에 로그인 하지 않은 사용자는 나머지 경로에 들어갈 수 없다. 공통 관심사를 서블릿 필터를 사용해서 해결한 덕분에 로그인 관련 정책이 변경되어도 이 부분만 변경하면 된다.

스프링 인터셉터

스프링 인터셉터도 서블릿 필터와 같이 웹과 관련된 공통 관심 사항을 효과적으로 해결할 수 있는 기술이다. 서블릿 필터가 서블릿이 제공하는 기술이라면, 스프링 인터셉터는 스프링 MVC가 제공하는 기술이다. 둘다 웹과 관련된 공통 관심 사항을 처리하지만, 적용되는 순서와 범위, 그리고 사용 방법이 다르다.

스프링 인터셉터 흐름

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러

스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출된다.
스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장하게 된다.
- 스프링 MVC의 시작점이 디스패처 서블릿 이라 생각하면 이해가 될것
스프링 인터셉터에도 URL 패턴을 적용할 수 있는데, 서블릿 URL 패턴과는 다르고, 매우 정밀하게 설정할 수 있다.

스프링 인터셉터 제한

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러   // 로그인 사용자
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 (적절하지 않은 요청이라 판단, 컨트롤러 호출X)  // 비 로그인 사용자

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

스프링 인터셉터 체인

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 인터셉터1 -> 인터셉터2 -> 컨트롤러

스프링 인터셉터는 체인으로 구성되는데, 중간에 인터셉터를 자유롭게 추가할 수 있다. 예로 로그를 남기는 인터셉터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 인터셉터를 만들 수 있다.

지금까지 내용은 서블릿 필터와 비슷해 보이지만 더 편리하고 정교한 기능을 지원한다.

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

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

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 {}
}

서블릿 필터의 경우 단순하게 doFilter() 하나만 제공된다. 호출 전(preHandle), 호출 후 (postHandle), 요청 완료 이후 (afterCompletion)와 같이 단계적으로 세분화 되어있다.
서블릿 필터의 경우 단순히 request, response만 제공했지만, 인터셉터는 어떤 컨트롤러(handler)가 호출되는지 호출 정보도 받을 수 있다. 그리고 어떤 modelAndView가 반환되는지 응답 정보도 받을 수 있다.

스프링 인터셉터 호출 흐름

정상 흐름

preHandle : 컨트롤러 호출 전에 호출된다. (더 정확히는 핸들러 어댑터 호출 전에 호출된다.)
- preHandle의 응답값이 true이면 다음으로 진행하고, false이면 더는 진행하지 않는다. false인 경우 나머지 인터셉터는 물론이고, 핸들러 어댑터도 호출되지 않는다. 그림에서 1번에서 끝난다.
postHandle : 컨트롤러 호출 후에 호출된다. (더 정확히는 핸들러 어댑터 호출 후에 호출된다.)
afterCompletion : 뷰가 렌더링 된 이후에 호출된다.

스프링 인터셉터 예외 상황

예외가 발생시

preHandle : 컨트롤러 호출 전에 호출된다.
postHandle : 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않는다.
afterCompletion : afterCompletion은 항상 호출된다. 이 경우 예외를 파라미터로 받아서 어떤 예외가 발생했는지 로그로 출력할 수 있다.

afterCompletion은 예외가 발생해도 호출된다.

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

정리

인터셉터는 스프링 MVC 구조에 특화된 필터 기능을 제공한다고 이해하면 된다. 스프링 MVC를 사용하고, 트별히 필터를 꼭 사용해야 하는 상황이 아니라면 인터셉터를 사용하는 것이 더 편리하다.

스프링 인터셉터 - 요청 로그

@Slf4j
public class LogInterceptor implements HandlerInterceptor {
	public static final String LOG_ID = "logId";
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    
		String requestURI = request.getRequestURI();
		String uuid = UUID.randomUUID().toString();
		request.setAttribute(LOG_ID, uuid);
	
    	//@RequestMapping: HandlerMethod
		//정적 리소스: ResourceHttpRequestHandler
		if (handler instanceof HandlerMethod) {
			HandlerMethod hm = (HandlerMethod) handler; //호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
 		}
 		log.info("REQUEST [{}][{}][{}]", uuid, requestURI, handler);
 		return true; //false 진행X
 	}
 
		@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 logId = (String)request.getAttribute(LOG_ID);
			log.info("RESPONSE [{}][{}]", logId, requestURI);
			if (ex != null) {
				log.error("afterCompletion error!!", ex);
			}
		}
	}

String uuid = UUID.randomUUID().toString()
- 요청 로그를 구분하기 위한 uuid를 생성한다.
request.setAttribute(LOG_ID, uuid)
- 서블릿 필터의 경우 지역변수로 해결이 가능하지만, 스프링 인터셉터는 호출 시점이 완전히 분리되어있다. 따라서 preHandle에서 지정한 값을 postHandle, afterCompletion에서 함께 사용하려면 어딘가에 담아두어야 한다. LogInterceptor도 싱글톤처럼 사용되기 때문에 멤버변수를 사용하면 위험하다. 따라서 request에 담아두었다. 이 값은 afterCompletion에서 request.getAttribute(LOG_ID)로 찾아서 사용한다.
return true
- true면 정상 호출이다. 다음 인터셉터나 컨트롤러가 호출된다.

if (handler instanceof HandlerMethod) {
	HandlerMethod hm = (HandlerMethod) handler; //호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
}

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

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

postHandle, afterCompletion
종료 로그를 postHandle이 아니라 afterCompletion에서 실행한 이유는, 예외가 발생한 경우 postHandle가 호출되지 않기 때문이다. afterCompletion은 예외가 발생해도 호출되는 것을 보장한다.

WebConfig - 인터셉터 등록

@Configuration
public class WebConfig implements WebMvcConfigurer {
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		registry.addInterceptor(new LogInterceptor())
			.order(1)
			.addPathPatterns("/**")
			.excludePathPatterns("/css/**", "/*.ico", "/error");
	}
	//...
}

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

WebMvcConfigurer가 제공하는 addInterceptors()를 사용해서 인터셉터를 등록할 수 있다.

registry.addInterceptor(new LogInterceptor()) : 인터셉터를 등록한다.
order(1) : 인터셉터의 호출 순서를 지정한다. 낮을수록 먼저 호출된다.
addPathPatterns("/**") : 인터셉터를 적용할 URL 패턴을 지정한다.
excludePathPatterns("/css/**", "/*.ico", "/error") : 인터셉터에서 제외할 패턴을 지정한다.

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

스프링 인터셉터 - 인증 체크

LoginCheckInterceptor

@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(false);
	
		if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null) {
			log.info("미인증 사용자 요청");
			//로그인으로 redirect
			response.sendRedirect("/login?redirectURL=" + requestURI);
			return false;
		}
		return true;
	}
}

서블릿 필터와 비교해서 코드가 간결 인증이라는 것이 컨트롤러 호출 전에만 호출되면 된다.-> 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"
		);
	}
	//...
}

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

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

정리

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

ArgumentResolver 활용

MVC 1편의 6. 스프링 MVC - 기본 기능 -> 요청 매핑 핸들러 어댑터 구조에서 `ArgumentResolver를 사용해보자.

HomeController - 추가

@GetMapping("/")
public String homeLoginV3ArgumentResolver(@Login Member loginMember, Model model) {
	//세션에 회원 데이터가 없으면 home
	if (loginMember == null) {
		return "home";
	}
    
	//세션이 유지되면 로그인으로 이동
	model.addAttribute("member", loginMember);
	return "loginHome";
}

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

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

@Target(ElementType.PARAMETER) : 파라미터에만 사용
@Retention(RetentionPolicy.RUNTIME) : 리플렉션 등을 활용할 수 있도록 런타임까지 애노테이션 정보가 남아있음

LoginMemberArgumentResolver 생성

@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);
	}
}

supportsParameter() : @Login 애노테이션이 있으면서 Member 타입이면 해당 ArgumentResolver가 사용된다.
resolveArgument() : 컨트롤러 호출 직전에 호출되어서 필요한 파라미터 정보를 생성해준다. 여기서는 세션에 있는 로그인 회원 정보인 member 객체를 찾아서 반환해준다. 이후 스프링MVC는 컨트롤러의 메소드를 호출하면 여기에서 반환된 member 객체를 파라미터에 전달해준다.

WebMvcConfigurer에 설정 추가

@Configuration
public class WebConfig implements WebMvcConfigurer {
	@Override
	public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
		resolvers.add(new LoginMemberArgumentResolver());
	}
	//...
}

실행

실행해보면 결과는 동일하지만, 더 편리하게 로그인 회원 정보를 조회할 수 있게된다. ArgumentResolver를 활용하면 공통 작업이 필요할 때 컨트롤러를 더욱 편리하게 사용할 수 있다.

크리링

이전 포스트

[강의] 김영한님의 실전_스프링_데이터_JPA 정리

다음 포스트

[강의] 김영한님의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 정리 - 로그인 처리

인프런 김영한님 스프링 강의 정리

로그인 처리

Cookie

쿠키 생성

쿠키 생성

클라이언트 쿠키 전달 1

클라이언트 쿠키 전달 2

쿠키 생성 로직

홈 - 로그인 처리

LoginController - logout 기능

쿠키와 보안 문제

보안 문제

대안

세션

세션 동작 방식

로그인

세션 생성

세션id를 응답 쿠키로 전달

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

정리

세션 직접 만들기

세션 생성

세션 조회

세션 만료

SessionManager

세션 사용

logout

정리

서블릿 HTTP 세션 1

HttpSession

HttpSession 사용

세션 생성과 조회

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

logout V3

HomeController - homeLoginV3

서블릿 HTTP 세션 2

@SessionAttribute

HomeController

세션 정보 확인

세션 타임아웃 설정

서블릿 필터

필터 인터페이스

로그 필터

WebConfig - 필터 설정

서블릿 필터 - 인증 체크

WebConfig - loginCheckFilter() 추가

LoginController - loginV4()

RedirectURL 처리

정리

스프링 인터셉터

스프링 인터셉터 흐름

스프링 인터셉터 제한

스프링 인터셉터 체인

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

스프링 인터셉터 호출 흐름

스프링 인터셉터 예외 상황

정리

스프링 인터셉터 - 요청 로그

WebConfig - 인터셉터 등록

스프링 인터셉터 - 인증 체크

정리

ArgumentResolver 활용

HomeController - 추가

@Login 애노테이션 생성

LoginMemberArgumentResolver 생성

WebMvcConfigurer에 설정 추가

[강의] 김영한님의 실전_스프링_데이터_JPA 정리

[강의] 김영한님의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 정리 - 예외 처리

0개의 댓글