스터디를 통해 스프링부트와 AWS로 혼자 구현하는 웹 서비스(저자 이동욱) 서적을 공부하는 중입니다.

공부/실습한 내용을 정리한 포스팅입니다.
책에 모르는 부분이 있으면 구글링하거나 챗gpt에 물어봐서 보충하였습니다.
(아직 초보라 모르는 부분이 많아 이것저것 다 적었습니다.)

참고한 사이트 출처는 포스팅 맨 하단에 적었습니다.

코드 반복 제거

• 일반적인 프로그래밍에서 개선이 필요한 대표적인 나쁜 부분은 같은 코드가 반복되는 부분. 이후 수정이 필요할 때 모든 부분을 하나씩 찾아가며 수정해야 하기 때문에 유지보수성이 떨어지거나 미처 수정하지 못한 부분이 있어 문제가 발생할 수 있음.
• 앞서 했던 실습에서 IndexController의 세션값을 가져오는 부분을 개선해야 함. index 메서드 외에 다른 컨트롤러나 메서드에서 세션값이 필요하면 그때마다 직접 세션에서 값을 가져와야 함.

SessionUser user = (SessionUser) httpSession.getAttribute("user");

• 메서드 인자로 세션값을 바로 받을 수 있도록 변경.

---

@LoginUser annotation 생성

config.auth 패키지에 생성 후 작성

package com.webservice.springboot.springboot_board.config.auth;

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

• @Target(ElementType.PARAMETER)
  : annotation이 생성될 수 있는 위치 지정.
• @Retention(RetentionPolicy.RUNTIME)
  : annotation의 메타 어노테이션 중 하나로, annotation을 어떤 시점까지 유지할 것인지를 지정하는 역할을 함. 컴파일 시간에도 유지되어야 하는지, 클래스 파일까지는 유지되어야 하는지, 런타임 시에도 유지되어야 하는지 설정.
  PARAMETER로 지정했으니 메서드의 파라미터로 선언된 객체에서만 사용 가능.
• @interface
  : annotation 클래스로 지정. LoginUser annotation 생성.

---

LoginUserArgumentResolver 클래스 생성

config.auth 패키지에 생성 후 작성.

• HandlerMethodArgumentResolver interface 구현한 클래스
• HandlerMethodArgumentResolver : 조건에 맞는 경우, 메소드가 있다면 HandlerMethodArgumentResolver의 구현체가 지정한 값으로 해당 메서드의 파라미터로 넘길 수 있음.

package com.webservice.springboot.springboot_board.config.auth;

import com.webservice.springboot.springboot_board.config.auth.dto.SessionUser;
import lombok.RequiredArgsConstructor;
import org.springframework.core.MethodParameter;
import org.springframework.stereotype.Component;
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.HttpSession;

@RequiredArgsConstructor
@Component
public class LoginUserArgumentResolver implements HandlerMethodArgumentResolver {
    private final HttpSession httpSession;

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        boolean isLoginUserAnnotation = parameter.getParameterAnnotation(LoginUser.class) != null;
        boolean isUserClass = SessionUser.class.equals(parameter.getParameterType());
        return isLoginUserAnnotation && isUserClass;
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        return httpSession.getAttribute("user");
    }
}

• supportsParameter
  : 특정 파라미터 지원하는지 판단.
  @LoginUser annotation이 있고, 파라미터 클래스 타입이 SessionUser.class라면 true 반환.
• resolveArugment()
  : 파라미터에 전달한 객체 생성.

추가 설명

HandlerMethodArgumentResolver

• Spring에서 요청 핸들러 메서드(컨트롤러 메서드)의 매개변수를 해석하고 바인딩하는 인터페이스. 클라이언트의 HTTP 요청이 컨트롤러의 특정 메서드로 전달될 때, 이 인터페이스를 구현한 클래스들은 해당 메서드의 매개변수에 값을 바인딩하는 역할을 수행.

---

WebConfig

config 패키지에 추가.

• LoginUserArgumentResolver가 Spring에서 인식될 수 있도록 WebMvcConfigurer에 추가.

package com.webservice.springboot.springboot_board.config;

import com.webservice.springboot.springboot_board.config.auth.LoginUserArgumentResolver;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@RequiredArgsConstructor
@Configuration
public class WebConfig implements WebMvcConfigurer {
    private final LoginUserArgumentResolver loginUserArgumentResolver;

    @Override
    public void addArgumentResolvers`(List<HandlerMethodArgumentResolver> argumentResolvers){
        argumentResolvers.add(loginUserArgumentResolver);
    }
}

• WebMvcConfigurer 인터페이스 구현하여 웹 애플리케이션 구성을 변경하고자 할 땐 해당 클래스에 @Configuration을 붙여 구성 클래스임을 알려줌.
• 구성(Configuration) 클래스는 Spring에서 Bean의 생성과 의존성 주입 등을 담당하는 설정 클래스. Spring Container에 등록되어 Spring 설정과 관련된 작업을 수행할 수 있도록 함.
• addArgumentResolvers : HandlerMethodArgumentResolver 구현 클래스 Spring에 등록.

추가 설명

WebMvcConfigurer

• Spring Web Application의 구성을 할 수 있는 인터페이스.
  Spring은 WebMvcConfigurer을 구현하여 Web Application의 MVC 구성을 세부적으로 커스터마이징할 수 있도록 함.
• Web Application 다양한 설정을 변경하거나 추가 가능. Spring의 기본 동작을 유지하면서 Web Application에 필요한 커스텀 구성 추가 가능.
• WebMvcConfigurer인터페이스를 구현하여 구현한 HandlerMethodArgumentResolver를 등록

---

indexController 수정

@RequiredArgsConstructor
@Controller
public class IndexController {
    private final PostsService postsService;
//    private final HttpSession httpSession;

    @GetMapping("/")
    public String index(Model model, @LoginUser SessionUser user) {
        model.addAttribute("posts", postsService.findAllDesc());
//        SessionUser user = (SessionUser) httpSession.getAttribute("user");

        if(user!=null){
            model.addAttribute("userName", user.getName());
        }

        return "index";
    }
    .
    .
    .