Spring Boot에서 Interceptor에 대해 알아보기! (ง •̀ω•́)ง

• 사용 IDE : IntelliJ IDEA Ultimate
• 사용 DB : MySQL
• 사용 언어 & SDK : Java & Amazon correto 11
• 정리본입니다 참고용으로만 봐주세요 :D
• 회원관리 예제에서 진행할 예정입니다!
  궁금하신 분들은 전에 내용을 참고해보세요 :D
  
  

이전 글
θ Spring Boot 예제1 (회원관리)
𝜅 Spring Boot 예제2 (회원관리)
𝜆 Spring Boot 예제3 (회원관리)
𝜇 Spring Boot 예제4 (회원관리)
𝜈 Spring Boot 회원관리 TEST 모음
𝜉 Spring Boot Mybatis 사용법

Interceptor

Interceptor는 단어 뜻 그대로 가로채는 기능을 수행합니다.
예를 들면 이해하기 매우 간단합니다!
쇼핑몰같은 사이트에서 로그인없이 장바구니를 누르면 로그인페이지로 넘어가는 그 상황
많이 겪어보신적 있으시죠??
사용자가 필수 기능(ex : 로그인)을 수행하지 않고 필수 기능을 조건으로 하는 작업(ex : 장바구니)를 수행하는 것을 방지하는 역할이라고 볼 수 있습니다!!
저는 로그인을 먼저 수행하게 하는것을 만들어보도록 하겠습니다!
그럼 지금부터 알아보러 갑시다 ʕっ•ᴥ•ʔっ

LoginCheck용 Interceptor Class

// 인터셉터 클래스는 HandlerInterceptor 를 속한 메서드를 쓰기 위해 implements 해야합니다.
public class LoginCheckInterceptor implements HandlerInterceptor {

	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws IOException {
	// preHandle : 사전에 조작하다.
	// 컨트롤러에 가기 전 Interceptor에서 캐치해서 다른 작업을 수행하게 보냄.
	// HttpServletRequest : 각종 클래스를 요청하게 해주는 메서드. 스프링에서는 굳이 안써도 다 잡아주지만 근본적으로는 이 메서드가 필수이다.

	// 사용자가 요청한 주소
	String requestURI = request.getRequestURI();
	System.out.println("requestURI = " + requestURI);
	// 세션 가져옴
	HttpSession session = request.getSession();
	// 세션에 로그인 정보가 있는지 확인
	if (session.getAttribute(SessionConst.LOGIN_EMAIL)==null) {
		// 미 로그인 상태
		// 로그인을 하지 않은 경우 바로 로그인페이지로 보내고, 로그인을 하면 요청한 화면을 보여줌.
		session.setAttribute("redirectURL", requestURI);
		response.sendRedirect("/member/login");
		return false;
	} else {
		// 로그인 상태
		return true;
	}
    
}

위 코드는 주석에서 알 수 있듯이 Controller에 요청을 보내기 전 로그인 검증을 한 뒤,
로그인이 필요하다면 로그인 페이지로 이동 & 사용자가 이전에 요청한 주소로 보내기 위한 작업을 하는 클래스라 보시면 됩니다.
이제 사용자가 특정 주소를 요청 했을 때 Interceptor를 수행하게 하는 클래스를 만들러 가봅시다!

WebConfig Class

// @Configuration : 설정정보를 스프링 실행 시 등록해줌
// 차후에 확인할 때 불편하다면 아래 @Configuration 을 주석처리하면 됨
@Configuration
public class WebConfig implements WebMvcConfigurer {
// WebMVCConfigurer에 속한 메서드를 사용하기 위해 implements 하기!

// 로그인 여부에 따른 접속 가능 페이지 구분
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		registry.addInterceptor(new LoginCheckInterceptor())
		// 아까 만든 LoginCheckInterceptor 클래스 내용을 넘김
			.order(1)
			// order : 해당 인터셉터가 적용되는 순서, 1이면 첫번째로 실행
			.addPathPatterns("/**")
			// 현재 프로젝트의 모든 주소에 대해 인터셉터를 적용
			.excludePathPatterns("/", "/member/save", "/member/login","/member/logout", "/css/**");
			// 그중에 이 주소는 제외
	}

}

지금 만든 클래스는 아까 만든 클래스를 어떤 주소에 몇번째로 특정 주소를 제외하고 실행할 건지 결정해 주는 클래스입니다. 해당 클래스가 없다면, 또는 @Configuration가 없다면 인터셉터는 실행되지 않습니다.
이제 인터셉터를 위한 준비는 끝났으니 Controller로 넘어가봅시다! ٩( ᐛ )و

Controller

• WebConfig에서 주소설정을 했기 때문에 컨트롤러에 메서드를 따로 만들 필요는 없습니다.
  전에 만든 로그인 메서드에 내용을 추가하기만 하면 사용이 가능하기 때문에 이를 해보러 갑시다!!

// 로그인
@PostMapping("login")
public String login(@ModelAttribute MemberLoginDTO memberLoginDTO, HttpSession session) {

	System.out.println("MemberController.login");

	if (ms.login(memberLoginDTO)) {
		session.setAttribute(LOGIN_EMAIL,memberLoginDTO.getMemberEmail());
		// return "member/mypage"; // 기존 리턴
        
		String redirectURL = (String) session.getAttribute("redirectURL");
		// 인터셉터를 거쳐서 오면 redirectURL에 값이 있을것이고,
		// 그냥 로그인을 해서 오면 redirectURL에 값이 없을것임.
		// 따라서 if else로 구분해줌
		if (redirectURL != null) {
			return "redirect:"+redirectURL;
			// 사용자가 요청한 주소로 보내주기 위해 리턴값을 위와 같이 세팅
		} else {
			return "redirect:/";
			// 로그인이 이미 된 회원이므로 index 페이지로 가게 설정
		}
	} else {
		return "member/login";
	}
}

위와 같이 컨트롤러에서의 설정도 끝났다면 이제 Interceptor가 작동되는 프로젝트가 완성된겁니다!!
이렇게 회원관리 예제는 끝마치도록 하겠습니다.
다음 시간에는 게시글 관리 예제로 돌아올테니 그 전까지는 회원관리를 복습하면 좋을거같습니다. :D
그럼 다음에 건강한 모습으로 만나요 ~ ˓˓ก₍⸍⸌̣ʷ̣̫⸍̣⸌₎ค˒˒