이 포스팅은 스프링 부트와 AWS로 혼자 구현하는 웹 서비스
를 보며 공부한 내용을 정리하는 포스팅입니다.
어노테이션 기반으로 개선하기
일반적인 프로그래밍에서 개선이 필요한 나쁜 코드는 같은 코드가 반복되는 부분이다
앞서 만든 코드에서 개선할만한 것은 무엇이 있을까?
IndexController에서 세션값을 가져오는 부분이다
SessionUser user = (SessionUser) httpSession.getAttribute("user");index 메소드 외에 다른 컨트롤러와 메소드에서 세션값이 필요하면 그 때마다 직접 세션에서
값을 가져와야 한다.
그래서 이 부분을 메소드 인자로 세션값을 바로 받을 수 있도록 변경 해보자.
config.auth 패키지에 @LoginUser 어노테이션을 생성한다
@Target(ElementType.PARAMETER)
-> 이 어노테이션이 생성될 수 있는 위치를 지정한다.
-> PARAMETER로 지정했으니 메소드의 파라미터로 선언된 객체에서만 사용할 수 있다.
-> 이 외에도 클래스 선언문에 쓸수 있는 TYPE 등이 있다.@interface
-> 이 파일을 어노테이션 클래스로 지정한다.
-> LoginUser라는 이름을 가진 어노테이션이 생성되었다고 보면 된다.
그리고 같은 위치에 LoginUserArgumentResolver를 생성한다.
Login-UserArgumentResolver라는 HandlerMethodArgumentResolver 인터페이스를 구현한 클래스이다.
HandlerMethodArgumentResolver 는 한가지 기능을 지원한다. 바로 조건에 맞는 경우 메소드가 있다면 HandlerMethodArgumentResolver의 구현체가 지정한 값으로 해당 메소드의 파라미터로 넘길 수 있다.
@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 어노테이션이 붙어 있고, 파라미터 클래스 타입이
SessionUser.class인 경우 true를 반환한다.resolveArgument
-> 파라미터에 전달할 객체를 생성한다.
-> 여기서는 세션에서 객체를 가져온다.
@LoginUser를 사용하기 위한 환경은 구성되었다.
이렇게 생선된 LoginUserArgumentResolve가 스프링에서 인식될 수 있도록
WebMvConfigurer에 추가하자
conifg 패키지에 WebConfig 클래스를 생성해주자
HandlerMethodArgumentResolver는 항상 WebMvcConfigure의 addArgumentResolvers()를
통해 추가해야 한다.
다른 HandlerMethodArgumentResolver가 필요하다면 같은 방식으로 추가해주면 된다
최종적으로 패키지 구조는 이렇게 된다.
모든 설정이 끝났으니 IndexController의 코드에서 반복되는 부분들을 모두 @LoginUser로 개선하자.
원래 코드
수정한 코드
@LoginUser SessionUser user
-> 기존에(User) httpSession.getAttribute("user")로 가져오던 세션 정보 값이 개선됨.
-> 이제는 어느 컨트롤러든지 @LoginUser만 사용하면 세션정보를 가져올 수 있게됨.
세션 저장소로 데이터베이스 사용하기
추가로 개선을 해보자. 우리가 만든 서비스는 애플리케이션을 재실행하면 로그인이 풀린다.
왜그럴까? 이는 세션이 내장 톰캣의 메모리에 저장되기 때문이다
기본적으로 세션은 실행되는 WAS(Web Application Server)의 메모리에서 저장되고 호출된다.
메모리에 저장되다 보니 내장 톰캣처럼 애플리케이션 실행 시 실행 되는 구조에서는
항상 초기화가 된다.
즉, 배포할 때마다 톰캣이 재시작되는 것이다.
이 외에도 2대 이상의 서버에서 서비스하고 있다면 톰캣마다 세션 동기화설정을 해야한다.
그래서 실제 현업에서는 세션 저장소에 대해 다음의 3가지 중 한 가지를 선택한다.
(1) 톰캣 세션을 사용한다
- 일반적으로 별다른 설정을 하지 않을 때 기본적으로 선택되는 방식이다.
- 이렇게 될 경우 톰캣에 세션이 저장되기 때문에 2대 이상의 WAS가 구동되는 환경에서는톰캣들 간의 세션 공유를 위한 추가 설정이 필요하다
(2) MySQL과 같은 데이터베이스를 세션 저장소로 사용한다
- 여러 WAS간의 공용 세션을 사용할 수 있는 가장 쉬운 방법이다.
- 많은 설정이 필요 없지만, 결국 로그인 요청마다 DB IO가 발생하여 성능상 이슈가 발생할 수 있다.
(3) Redis, Memcached와 같은 메모리DB를 세션 저장소로 사용한다
- B2C 서비스에서 가장 많이 사용하는 방식이다.
- 실제 서비스로 사용하기 위해서는 Embedded Redis와 같은 방식이 아닌 외부 메모리 서버가 필요하다.
여기서는 두 번째 방식은 데이터베이스를 세션 저장소로 사용하는 방식을 선택했다
이유는 설정이 간단하고 사용자가 많은 서비스가 아니며 비용 절감을 위해서다.
Spring-session-jdbc 등록
build.gradle에 의존성을 등록한다. spring-session-jdbc역시 현재 상태에선 바로 사용할 수 없다.
spring web, spring jpa를 사용했던 것과 마찬가지로 의존성이 추가되어 있어야 사용할 수 있다.
그리고 application.properties에 세션 저장소를 jdbc로 선택하도록 코드를 추가하자.
모두 변경을 했으면 애플리케이션을 실행해서 로그인을 테스트한 뒤, h2-console로 접속하자
h2-console을 보면 세션을 위한 테이블(SPRING_SESSION, SPRING_SESSION_ATTRIBUTE)가
생성된것을 볼 수 있다.
JPA로 인해 세션 테이블이 자동 생성되었기 때문에 별도로 해야할 일은 없다.
방금 로그인 해기 때문에 한 개의 세션이 등록돼있는 것을 볼 수 있다.
세션 저장소를 데이터베이스로 교체했다. 물론 지금은 기존과 동일하게 스프링을 재시작 하면 세션이 풀린다
이유는 H2 기반으로 스프링이 재실행될 때 H2도 재시작되기 때문이다.
이후 AWS로 배포하게 되면 AWS의 데이터베이스 서비스인 RDS를 사용하게 되니 이 때부터는
세션이 풀리지 않는다.
네이버 로그인
마지막으로 네이버 로그인을 추가해 보자.
네이버 API 등록
먼저 네이버 오픈 API로 이동하자.
네이버 오픈 API
항목을 채워주자
서비스 URL은 필수다. 여기서는 localhost:8080으로 등록하자
Callback URL은 구글에서 등록한 리디렉션 URL과 같은 역할을 한다.
여기서는 /login/oauth2/code/naver로 등록하자. 등록을 완료하면 다음과 같이
ClientID와 ClientSercet가 생성된다.
해당 키값들을 application-oauth.properties에 등록하자.
네이버에서는 스프링 시큐리티를 공식 지원하지 않기 때문에 그동안 Common-OAuth2Provider에서
해주던 값들도 전부 수동으로 입력해야 한다.
user_name_attribute=response
- 기준이 되는 user_name의 이름을 네이버에서는 responser로 해야한다
- 이유는 네이버의 회원 조회 시 반환되는 JSON 형태 때문이다
네이버의 오픈 API의 로그인 회원 결과는 다음과 같다
{
"resultcode": "00",
"message": "success",
"response": {
"email": "openapi@naver.com",
"nickname": "OpenAPI",
"profile_image": "https://ssl.pstaric.net/static/pwe/
address/nodata_33x33.gif",
"age": "40-49",
"gender": "F",
"id": "32742776",
"name": "오픈API",
"birhtday": "10-01"
}
}스프링 시큐리티에선 하위 필드를 명시할 수 없다.
최상위 필드들만 user_name으로 지정 가능하다. 하지만 네이버의 응답값 최상위 필드는
resultCode, message, responser다.
이러한 이유로 스프링 시큐리티에서 인식 가능한 필드는 저 3개 중에 골라야 한다
본문에서 담고 있는 responser를 user_name으로 지정하고 이후 자바 코드로
response의 id를 user_name으로 지정하자
스프링 시큐리티 설정 등록
구글 로그인을 등록하면서 대부분 코드가 확장성 있게 작성되었다 보니 네이버는 쉽게 등록이 가능하다.
OAuthAttributes에 다음과 같이 네이버 인지 판단하는 코드와 네이버 생성자만
추가해주면 된다.
package com.jojoldu.book.springboot.config.auth.dto;
import com.jojoldu.book.springboot.domain.user.Role;
import com.jojoldu.book.springboot.domain.user.User;
import lombok.Builder;
import lombok.Getter;
import java.util.Map;
@Getter
public class OAuthAttributes {
private Map<String, Object> attributes;
private String nameAttributeKey;
private String name;
private String email;
private String picture;
@Builder
public OAuthAttributes(Map<String, Object> attributes,
String nameAttributeKey, String name,
String email, String picture) {
this.attributes = attributes;
this.nameAttributeKey = nameAttributeKey;
this.name = name;
this.email = email;
this.picture = picture;
}
public static OAuthAttributes of(String registrationId,
String userNameAttributeName,
Map<String, Object> attributes) {
if("naver".equals(registrationId)){
return ofNaver("id",attributes);
}
return ofGoogle(userNameAttributeName, attributes);
}
public static OAuthAttributes ofNaver(String userNameAttributeName,
Map<String, Object> attributes) {
Map<String, Object> response = (Map<String, Object>) attributes.get("response");
return OAuthAttributes.builder()
.name((String) response.get("name"))
.email((String) response.get("email"))
.picture((String) response.get("picture"))
.attributes(response)
.nameAttributeKey(userNameAttributeName)
.build();
}
public static OAuthAttributes ofGoogle(String userNameAttributeName,
Map<String, Object> attributes) {
return OAuthAttributes.builder()
.name((String) attributes.get("name"))
.email((String) attributes.get("email"))
.picture((String) attributes.get("picture"))
.attributes(attributes)
.nameAttributeKey(userNameAttributeName)
.build();
}
public User toEntity() {
return User.builder()
.name(name)
.email(email)
.picture(picture)
.role(Role.GUEST)
.build();
}
}
성공!
