[Spring MVC] Spring 세션 종료 시 로그아웃 시간 자동 기록하는 방법: HttpSessionListener와 빈 주입 문제 해결 (Mybatis)

 

서론

 

로그인 접속 기록 기능을 개발하던 중이었고, 로그아웃 시간도 같이 기록을 해야 했다.
사용자가 로그아웃 버튼을 클릭했을 때의 로그아웃 시간 기록은 쉽게 처리할 수 있었다.
하지만 세션 만료 시 자동 로그아웃 시간을 기록하고  브라우저를 닫았을 때에도 자동 로그아웃 시간을  기록하는 부분은 구현하는 데 어려움이 있었다.

 

 

기존 작성된 코드에서는 프론트에서 세션 시간이 만료되면 /logout 컨트롤러 보내 로그아웃 처리를 진행하고 있다.
그래서 이 /logout 컨트롤러에서 로그인했던 세션 정보를 가져와 로그아웃 시간을 기록하고, 세션을 삭제하면 되겠다고 생각을 했다.

 

 

문제 : getSession()이 null이라고? 

 

하.지.만.. 문제는 세션 시간이 종료되면 세션 정보가 자동으로 삭제되기 때문에 /logout 컨트롤러에서 getSession()을 호출해도 세션 정보가 null로 반환됐다.

(HttpSessionListener가 세션의 종료를 감지함)

 

 

 

 

해결 : HttpSessionListener 이용

 

첫 번째 해결 : 그래서 이 HttpSessionListener로 세션 종료 시에 로그아웃 시간을 기록하면 되겠다고 생각했다.

    <listener>
        <listener-class>example.com.listener.SessionTimeoutListener</listener-class>
    </listener>

web.xml에 listener를 등록해주고 하나의 클래스를 만들어 HttpSessionListener를 implements해 사용할 수 있다.

example.com.listener는 패키지 이름이고, SessionTimeoutListener는 클래스 이름이다.

 

 

package example.com.listener;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;

import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;

public class SessionTimeoutListener implements HttpSessionListener {
    
    @Override
    public void sessionCreated(HttpSessionEvent se) {
        // 세션 생성 시 로직 필요하면 여기에 추가
    }

    @Override
    public void sessionDestroyed(HttpSessionEvent se) {
        // 세션 종료 시 로직 필요하면 여기에 추가
    }
}

 

httpSessionListener 인터페이스를 implements하여 로직을 재정의할 수 있다.

sessionCreated는 세션 생성시 실행되는 메서드이고, sessionDestroyed는 세션 종료시 실행되는 메서드이다.

sessionDestroyed에 로그아웃 시간을 기록해주는 서비스를 작성했다. 

 

 

 

 

 

문제 2: 서비스 빈이 제대로 주입되지 않아서 에러가 발생 @Autowired

import javax.servlet.ServletContext;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;

public class SessionTimeoutListener implements HttpSessionListener {

    @Autowired
    private LoginLogService loginLogService;  // @Autowired로 주입받으려 시도하는 부분 (잘못된 접근)

    @Override
    public void sessionCreated(HttpSessionEvent se) {
        // 세션 생성 시 로직 필요하면 여기에
    }

    @Override
    public void sessionDestroyed(HttpSessionEvent se) {
        Object loginLogIdObj = se.getSession().getAttribute("loginLogId");
        if (loginLogIdObj != null) {
            Long loginLogId = Long.valueOf(loginLogIdObj.toString());
           
            // 로그아웃 시간 기록
            loginLogService.updateLogoutTime(loginLogId);

            } else {
                System.out.println("Spring Context를 찾을 수 없음");
            }

        } else {
            System.out.println("세션 만료, loginLogId 없음");
        }
    }
}

 

 

org.apache.catalina.session.StandardSession expire
SEVERE: 세션 이벤트 리스너가 예외를 발생시켰습니다.
java.lang.NullPointerException
	at example.com.listener.SessionTimeoutListener.sessionDestroyed(SessionTimeoutListener.java:30)
	at org.apache.catalina.session.StandardSession.expire(StandardSession.java:768)
	at org.apache.catalina.session.StandardSession.isValid(StandardSession.java:628)
	at org.apache.catalina.connector.Request.doGetSession(Request.java:2941)
	at org.apache.catalina.connector.Request.getSessionInternal(Request.java:2677)
	at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:451)
	at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:130)
	at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:93)
	at org.apache.catalina.valves.AbstractAccessLogValve.invoke(AbstractAccessLogValve.java:670)
	at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:74)
	at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:346)
	at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:390)
	at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:63)
	at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:928)
	at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1786)
	at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:52)
	at org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191)
	at org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659)
	at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:63)
	at java.base/java.lang.Thread.run(Thread.java:834)

 

위 에러를 보면 NullPointerException 에러가 발생했다.

loginLogService를 불러와 사용을 하려고 했는데 loginLogService가 Null이라는 오류이다.

 

 

 

왜?

@Autowired는 Spring 컨텍스트에 등록된 빈을 주입받는 방식이다. 그러나 HttpSessionListener는 Spring 컨텍스트가 완전히 초기화되기 전에 실행된다.(빈을 등록하기 전에 HttpSessionListener가 실행되는 것)

이 때문에 @Autowired를 사용하여 빈을 주입받으려고 하면, Spring 컨텍스트가 아직 준비되지 않았기 때문에 해당 빈을 찾을 수 없다.(당연함. 등록이 안 됐으니 못찾을 수 밖에)

 

간단히 말하자면:

• 리스너는 Spring 컨텍스트가 초기화되기 전에 실행됨.
• 따라서 Spring 컨텍스트 초기화 전에 @Autowired로 빈을 주입받을 수 없음

과 같다. 

 

 

 

 

해결 : 직접 컨텍스트를 참조하여 빈을 얻어야 한다.

WebApplicationContextUtils.getWebApplicationContext(servletContext)

 

 

 

 

1. context-common.xml에 base-package와 bean을 등록해준다.

<context:component-scan base-package="example.com.loginlog" />

<!-- mapper 인식하도록 등록 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
	<property name="basePackage" value="example.com.mapper"/>
</bean>

 

 

 

2. 직접 호출하는 서비스를 작성한다.

// Spring의 ServletContext를 통해 현재 웹 애플리케이션의 전역 정보를 가져온다.
ServletContext servletContext = se.getSession().getServletContext();

// WebApplicationContextUtils를 사용해 Spring의 ApplicationContext (즉, BeanFactory) 를 가져온다.
// 이 컨텍스트에서 우리가 필요한 서비스 Bean을 수동으로 얻어올 수 있다.
WebApplicationContext context = WebApplicationContextUtils.getWebApplicationContext(servletContext);

if (context != null) {
    LoginLogService loginLogService = (LoginLogService) context.getBean("loginLogService");

    // 로그아웃 시간 기록
    loginLogService.updateLogoutTime(loginLogId);
} else {
    System.out.println("Spring Context를 찾을 수 없음");
}

 

이렇게 작성했더니 세션 만료시에, 브라우저를 종료했을 때에도 자동으로 로그아웃 기록 서비스가 실행되어 기록이 제대로 되었다.

 

테스트를 위해 로그인 세션을 약 2분정도로 두고 테스트를 진행했다!.

 

 

---

 

오늘의 문제 정리 

 

1. 세션 생성, 만료 감지는 HttpSessionListener로 처리한다.

→ 세션이 생성될 때와 소멸될 때를 오버라이드하여 원하는 로직을 작성할 수 있다.

 

2. 하지만 HttpSessionListener는 Spring Bean이 아니기 때문에 @Autowired 등으로 Bean 주입이 불가능하다.

→  Spring Context가 초기화되기 전에 먼저 등록되기 때문.

 

3. 따라서 직접 Spring Context에서 필요한 Bean을 꺼내서 사용해야 한다.

→ WebApplicationContextUtils.getWebApplicationContext(servletContext)를 사용해 Bean 수동 획득.

 

4. 이렇게 직접 Bean을 꺼내서 사용하려면 context-common.xml에 해당 패키지 등록 및 Mapper 설정이 필수이다.