[211025-211031] 2021 GDSC Spring Study - 4주차

🌱   이번주 스터디 목표, 스터디 범위

• 스프링 시큐리티와 스프링 시큐리티 Oauth2 클라이언트
• 구글 서비스 등록
• 구글 로그인 연동하기
• 어노테이션 기반으로 개선하기
• 세션 저장소로 데이터베이스 사용하기
• 네이버 로그인
• 기존 테스트에 시큐리티 적용하기

🌱 스프링 시큐리티와 스프링 시큐리티 Oauth2 클라이언트

[Spring Boot] 스프링 시큐리티와 스프링 시큐리티 Oauth2 클라이언트

🌱 구글 서비스 등록

[Spring Boot] 구글 서비스 등록

🌱 구글 로그인 연동하기

[Spring Boot] 구글 로그인 연동하기

🌱 어노테이션 기반으로 개선하기

[Spring Boot] 어노테이션 기반으로 개선하기

🌱 세션 저장소로 데이터베이스 사용하기

[Spring Boot] 세션 저장소로 데이터베이스 사용하기

🌱 네이버 로그인

[Spring Boot] 네이버 로그인

🌱 기존 테스트에 시큐리티 적용하기

[Spring Boot] 기존 테스트에 시큐리티 적용하기

🌱 스터디하면서 어려웠던 부분 (트러블 슈팅)

🌟 userName 표기 관련 문제점 : 구글에 설정한 내 이름이 아닌, 윈도우 노트북에 설정된 이름이 출력되었음

       윈도우에서 사용 중인 환경변수 %USERNAME%과 연관되어 문제가 발생한 것이었으므로

        변수명을 userName에서 myName으로 변경하여 사용

🌟 콘솔창 한글 깨짐

        1. [Setting] - [File Encodings] - [UTF-8]

        2. [VM Options] - Dfile.encoding=UTF-8, -Dconsole.encoding=UTF-8 추가

🌱   새롭게 배운 것

• 스프링 시큐리티의 의미 : 스프링 기반의 막강한 인증과 인가 기능을 가진 프레임워크
• 스프링 부트 1.5와 2.0의 차이 : url 주소 명시 → client 인증 정보만 입력,  'CommonOAuth2Provider' enum이 새롭게 추가
• 구글 서비스, 네이버 API에서 인증 정보 (clientId, clientSecret) 발급
• 스프링 부트 2의 경우 리다이렉트 URL 지원 : {도메인}/login/oauth2/code/{소셜서비스코드}
• 스프링부트에서는 application-xxx.properties를 만들면 xxx라는 이름의 profile이 생성되고 이를 통해 관리
• 구글, 네이버 로그인 연동에 필요한 클래스 :

1. User.java : 사용자 정보를 담당할 도메인 (Domain - Entity 영역)
2. Role.java : 각 사용자의 권한을 관리할 Enum 클래스 (Domain)
3. UserRepository.java : User의 CRUD를 책임질 클래스 (Domain - 데이터 저장소 접근 영역)

• 스프링 시큐리티 설정에 관련된 클래스 :

1. SecurityConfig.java : OAuth 라이브러리를 이용한 소셜 로그인 설정 코드 (로그인, 로그아웃, 열람 권한 관리)
2. CustomOAuth2UserService.java : 구글 로그인 후 가져온 사용자의 정보를 기반으로 가입, 정보수정, 세션 저장 등 기능 지원
3. OAuthAttributes.java : Dto를 위한 클래스 (Dto - 데이터 교환, 변경을 위한 영역, 처음 가입 시 User 엔티티 생성)
4. SessionUser.java : 로그인 성공 시 인증된 사용자 정보만 세션에 저장 (Dto - 세션에 사용자 정보를 저장하기 위함)

• index.mustache에 버튼을 추가하여 로그인을 테스트하는 방법 : 로그인 후, myName이 있을 시 사용자 이름 노출 
• index.mustache에서 myName을 사용할 수 있도록하는 방법 : IndexController에서 myName을 model에 저장

 

• 어노테이션을 기반으로 IndexController에서 세션값을 가져오는 부분의 반복 코드를 개선하는 방법
• 어노테이션에 관련된 클래스 :

1. LoginUser.java : 메소드 인자로 세션값을 바로 받을 수 있도록 변경하기 위한 @LoginUser 어노테이션 생성
2. LoginUserArgumentResolver.java : HandleMethodArgumentResolver 인터페이스를 구현한 클래스
3. WebConfig.java : addArgumentResolvers()를 통해 LoginUserArgumentResolver가 스프링에서 인식될 수 있도록 추가
4. IndexController.java : IndexController의 코드에서 반복되는 부분들을 모두 @LoginUser로 개선

 

• 세션 저장소로 데이터베이스를 사용하는 이유와 사용 방법 : 간단한 설정, 비용 절감을 위해 사용, 세션 저장소를 jdbc로 설정

 

• 시큐리티 옵션 활성으로 인증된 사용자만 API를 호출할 수 있으므로 다른 테스트 코드도 이처럼 작동하도록 수정하는 방법 :

1. test는 application-oauth.properties 파일을 가져오지 못하므로 application.properties를 생성하고 가짜 설정값 등록
2. 인증되지 않은 사용자의 요청을 이동시키는 것을 막기 위해 임의의 인증된 사용자를 추가하여 API만 테스트하도록 PostsApiController.java에 @WithMockUser(roles="USER")로 권한을 주어 임의의 사용자 인증 추가
3. @WebMvcTest는 SecurityConfig를 생성하기 위해 필요한 CustomOAuth2UserService.java는 스캔대상이 아니므로 읽을 수 없으나 SecurityConfig는 스캔 대상이므로 SecuritoyConfig를 스캔 대상에서 제거한 후 JpaConfig.java를 생성하여 @EnableJpaAuditing 분리

🌱   PR 

🌱   참조했던 링크, 문서 및 소스파일 GIT 주소

• '스프링 부트와 AWS로 혼자 구현하는 웹 서비스' 교재 활용

http://www.yes24.com/Product/Goods/83849117

스프링 부트와 AWS로 혼자 구현하는 웹 서비스 - YES24

https://github.com/dsc-sookmyung/2021-02-Spring-Study/tree/GaGa-Kim

GitHub - dsc-sookmyung/2021-02-Spring-Study: [2021 GDSC Sookmyung 2기] 1분기 스터디(Spring)를 위한 저장소

https://github.com/jojoldu/freelec-springboot2-webservice/issues/169

[오류] p.189 userName 표기 관련 · Issue #169 · jojoldu/freelec-springboot2-webservice

https://da-nyee.github.io/posts/intellij-console-encoding-issue/

[IntelliJ] 콘솔 한글 깨짐 (Console Encoding Issue)