TIL 20일차 (2022.11.07)

🐥 마이바티스, 인터셉터, 빈스코프  10강 ~ 13강

1️⃣ 인터셉터 도입 (스프링 시큐리티를 대신하는 역할 수행)

➡️ Controller 앞 단에서 작동한다는 점에서 스프링 시큐리티와 유사하지만 보안에 집중된 시큐리티와 달리 범용적으로 쓰인다. 일종의 필터 역할을 한다고 생가하면 된다. (보안, 렌더링 등)

➡️ ex) 은행에서의 청원경찰 같은 역할로 복면을 쓴 강도라면 은행원(= Controller) 이 업무를 보기 전 제압 가능하므로 은행원에게 이 부분에 대한 메뉴얼이 없어도 됨.

[인터셉터 1]&[인터셉터 2]& ... [인터셉터 N] ➡️ Controller ➡️ Service ➡️ Repository

① 인터셉터 생성

Override Method 빨리 찾는법

@Component
@Slf4j // 해당 기능을 사용하기 위해서는 yml 파일에 logging 에 대한 추가 설정 필요
public class BeforeActionInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.debug("BeforeActionInterceptor:::preHandle 실행됨");

        return HandlerInterceptor.super.preHandle(request, response, handler);
    }
}

🤔 @Component 의 역할

개발자가 직접 작성한 Class 를 싱글톤 클래스 빈으로 생성하는 어노테이션으로 해당 Class 가 스프링의 구성요소임을 말해주기 위한 목적이다. 여기서 더 세부적으로 역할의 정의하면 @Controller, @Service 등으로 파생된다.

➕ cf) @Slf4j 를 위한 yml 추가 설정

logging:
    level:
    com.ay.study.mybatis_1101: debug

② 인터셉터 작동 설정

방법 (1) : 해당 파일에서 모든 내용 추가

@Configuration
@RequiredArgsConstructor
public class WebMvcConfig implements WebMvcConfigurer {
    private final BeforeActionInterceptor beforeActionInterceptor;
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        InterceptorRegistration ir;
        ir = registry.addInterceptor(beforeActionInterceptor);

        // interceptor 작동 기준 추가
        ir.addPathPatterns("/**");

        // 예외 경우들
        ir.excludePathPatterns("/favicon.ico");
        ir.excludePathPatterns("/resource/**");
        ir.excludePathPatterns("/gen/**");
        ir.excludePathPatterns("/error");
    }
}

방법 (2) : applicaiton.yml 파일 활용

• yml 파일에 변수 생성

# interceptor notLoadLIst
resources:
    notload:
        list: /favicon.ico, /resource/**, /gen/**, /error

//	(생략)
import org.springframework.beans.factory.annotation.Value; // lombok 의 Value 가 아님

@Configuration
@RequiredArgsConstructor
public class WebMvcConfig implements WebMvcConfigurer {
    private final BeforeActionInterceptor beforeActionInterceptor;

    @Value("${resources.notload.list}") // application.yml에 설정된 값을 가지고 오기
    private List<String> notLoadList;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        InterceptorRegistration ir;
        ir = registry.addInterceptor(beforeActionInterceptor);

        // 방법(2) : yml 파일 활용
        notLoadList.add("/article/test"); // 예외 경로 추가
        ir.addPathPatterns("/**").excludePathPatterns(notLoadList);
    }
}

➡️ 가독성이 좋아졌다.

③ 작동 확인

yml 파일에서 설정한 경로들과 notLoadList 에 추가한 "/article/test" 경로에서는 발생하지 않고, 그 외의 경로들에서는 발생한다.

2️⃣ 인터셉터를 활용해서 스프링 시큐리티와 유사한 역할 수행하도록

① Member 테이블 및 DTO 생성

② Controller, Service 및 Repository 작성

• Controller

@Controller
@RequiredArgsConstructor
@RequestMapping("/member")
public class MemberController {
    private final MemberService memberService;

    @GetMapping("/login")
    public String showLogin() {
        return "member/login";
    }

    @PostMapping("/login")
    public String login(String username, String password, HttpSession session ) {
        Member member = memberService.getMemberByUsername(username);

        if (member == null) {
            return "redirect:/?msg=NotFoundMember";
        }

        if (!member.matchPassword(password)) {
            return "redirect:/?msg=passwordError";
        }

        // login 관련 인터셉터에게 로그인 정보를 전달
        // 단순히 logined 에 T/F 를 보내면 로그인한 유저가 누군지 알 수 없음
        session.setAttribute("loginedMemberId", member.getId());

        return "redirect:/?msg=loginSuccess";
    }
}

• (Service 생략)
• Repository

@Mapper
public interface MemberRepository {
    @Select("""
        SELECT *
        FROM member
        WHERE username = #{username}
        """)
    Member getMemberByUserName(String username);
}

③ 인터셉터 생성 및 설정

@Configuration
@Slf4j
public class NeedToLoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.debug("NeedToLoginInterceptor::preHandle 실행됨");

        // Session 활용
        HttpSession session = request.getSession();
        Long loginedMemberId = (Long) session.getAttribute("loginedMemberId");

        boolean isLogined = loginedMemberId != null;

        if(!isLogined) {
            response.setCharacterEncoding("UTF-8");
            response.setContentType("text/html; charset=UTF-8");
            response.getWriter().append("로그인 후 이용바랍니다.");

            return false; // Controller 진입 못해보고 종료됨
        }

        return HandlerInterceptor.super.preHandle(request, response, handler);
    }
}

@Configuration
@RequiredArgsConstructor
public class WebMvcConfig implements WebMvcConfigurer {
//		(생략)
    private final NeedToLoginInterceptor needToLoginInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
//		(생략)
        ir = registry.addInterceptor(needToLoginInterceptor);
        ir.addPathPatterns("/article/write");
    }
}

④ 결과 확인

로그인 전 (interceptor 작동)

로그인 후

🦊 프로그래머스 Java 문제풀이

따로 정리 : https://like099.tistory.com/80

[Programmers] Level 2 Java 문제 풀이 (1)