Compare commits
10 Commits
spring-eve
...
security
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
73c759be30 | ||
|
|
4f750fd176 | ||
|
|
1942d5720e | ||
|
|
1c6fea1412 | ||
|
|
5af5256bd5 | ||
|
|
a02c3d0065 | ||
|
|
7ca21f70fa | ||
|
|
e32da44a0d | ||
|
|
b3ea750bc4 | ||
|
|
6392cb8c6d |
@@ -1,39 +0,0 @@
|
||||
### 🚀 step1
|
||||
|
||||
- 현재 코드를 분석 하면서 어떤 점을 고치고 싶은지 니즈를 파악해본다.
|
||||
|
||||
### 🚀 step2
|
||||
|
||||
- 상속 기반의 이벤트로 변경 해본다.
|
||||
- 이벤트 객체를 만들기 위해 ApplicationEvent 를 상속 받아 데이터 전달을 위해 객체를 만들어본다.
|
||||
- 이벤트 객체로 부터 전달 받을 EventListener 구현체를 만들어본다.
|
||||
- ApplicationEventPublisher 를 주입 받아서 이벤트를 발행 시킨다.
|
||||
- 테스트 코드 작성
|
||||
> Mockito 활용
|
||||
|
||||
### 📖 살펴볼 객체
|
||||
|
||||
- `AbstractApplicationContext` 를 intellij 의 diagram 을 통해서 구조를 살펴보면 `ApplicationEventPublisher` 를 상속 받고 있습니다.
|
||||
- `AbstractApplicationContext`::publishEvent 메소드를 보면 이벤트의 발행이 어떻게 되는지 알 수 있습니다.
|
||||
|
||||
> 조금 설명을 드리면 위의 메소드 안에서 ApplicationEventMulticaster 를 주입 받아 이벤트를 실행 시키는데 구현체 중 `SimpleApplicationEventMulticater` 를 살펴보면 (위와 같이 다이어그램으로 표현) multicastEvent 메소드를 통해서 빈으로 등록된 이벤트 객체를 실행을 합니다
|
||||
|
||||
### 🚀 step3
|
||||
|
||||
- 추가 기능(어드민에서 쿠폰 및 환영 메시지를 보낼 수 있는 기능이 있다.)
|
||||
- `@EventListener` 어노테이션을 활용해 코드를 변경 해보자.
|
||||
- > 스프링 4.2 부터 ApplicationEvent 를 상속 받아 객체를 생성하지 않아도 이벤트 객체 처럼 활용할 수 있다. `ApplicationListenerMethodAdapter` 객체에서 어노테이션을 찾아서 실행
|
||||
- 어드민에 알람을 보내는 중에 예외처리를 해보자
|
||||
- > `@TransactionalEventListener` 를 활용해 트랜잭션 단위를 제어해보자.
|
||||
- 비동기 활용
|
||||
- > `@EnableAsync` 와 `@Async` 를 활용해 비동기 처리를 해보자.
|
||||
|
||||
### 🚀 step4
|
||||
|
||||
- Domain Event
|
||||
- > AbstractAggregateRoot 를 상속 받아 이벤트를 제공
|
||||
- > registerEvent 를 통해 jpa의 save 를 명시적으로 할 때 마다 이벤트를 발행
|
||||
|
||||
---
|
||||
|
||||
#### 출처 : https://github.com/tongnamuu/SpringEvent
|
||||
@@ -1,24 +0,0 @@
|
||||
# 프로젝트 세팅 #
|
||||
|
||||
Java 11을 사용합니다.
|
||||
|
||||
처음부터 세팅하고 싶다면
|
||||

|
||||
|
||||
이후 annotation processing 옵션을 켜주세요
|
||||

|
||||
|
||||
이후 프로젝트 repository의 커밋을 따라오시면 그대로 실습하실 수 있습니다.
|
||||
|
||||
# 우리가 실습해볼 것 #
|
||||
|
||||
- 회원 가입 api를 이벤트를 활용해 개선해 봅니다.
|
||||
- 회원가입 플로우는 아래와 같습니다.
|
||||
- 회원가입을 하면 유저를 저장합니다
|
||||
- 알람이 나갑니다
|
||||
- 쿠폰을 발급해 줍니다
|
||||
- 이메일과 SMS로 환영 메시지를 보냅니다
|
||||
|
||||
---
|
||||
|
||||
#### 출처 : https://github.com/tongnamuu/SpringEvent
|
||||
@@ -19,6 +19,11 @@ repositories {
|
||||
|
||||
dependencies {
|
||||
implementation("org.springframework.boot:spring-boot-starter-data-jpa")
|
||||
implementation("org.springframework.boot:spring-boot-starter-security")
|
||||
|
||||
// OAuth2 로그인을 위해 추가. spring-boot-starter-security 의존성이 있어도 기본적으로 추가되지 않기 때문.
|
||||
implementation("org.springframework.boot:spring-boot-starter-oauth2-client")
|
||||
|
||||
implementation("org.springframework.boot:spring-boot-starter-validation")
|
||||
implementation("org.springframework.boot:spring-boot-starter-web")
|
||||
implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
|
||||
@@ -28,6 +33,7 @@ dependencies {
|
||||
runtimeOnly("mysql:mysql-connector-java")
|
||||
runtimeOnly("org.mariadb.jdbc:mariadb-java-client")
|
||||
testImplementation("org.springframework.boot:spring-boot-starter-test")
|
||||
testImplementation("org.springframework.security:spring-security-test")
|
||||
}
|
||||
|
||||
tasks.withType<KotlinCompile> {
|
||||
@@ -40,7 +46,3 @@ tasks.withType<KotlinCompile> {
|
||||
tasks.withType<Test> {
|
||||
useJUnitPlatform()
|
||||
}
|
||||
|
||||
tasks.named("jar") {
|
||||
enabled = false
|
||||
}
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 91 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
@@ -1,41 +0,0 @@
|
||||
package com.banjjoknim.playground.common
|
||||
|
||||
import org.springframework.http.HttpHeaders
|
||||
import org.springframework.http.HttpStatus
|
||||
import org.springframework.http.ResponseEntity
|
||||
import org.springframework.web.bind.MethodArgumentNotValidException
|
||||
import org.springframework.web.bind.annotation.ExceptionHandler
|
||||
import org.springframework.web.bind.annotation.RestControllerAdvice
|
||||
import org.springframework.web.context.request.WebRequest
|
||||
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler
|
||||
|
||||
@RestControllerAdvice
|
||||
class ExceptionHandler : ResponseEntityExceptionHandler() {
|
||||
override fun handleMethodArgumentNotValid(
|
||||
ex: MethodArgumentNotValidException,
|
||||
headers: HttpHeaders,
|
||||
status: HttpStatus,
|
||||
request: WebRequest
|
||||
): ResponseEntity<Any> {
|
||||
logger.error("message", ex)
|
||||
val errors = ex.fieldErrors.map { fieldError ->
|
||||
mapOf(
|
||||
("propertyName" to fieldError.field),
|
||||
("reason" to fieldError.defaultMessage)
|
||||
)
|
||||
}
|
||||
return ResponseEntity.badRequest().body(errors)
|
||||
}
|
||||
|
||||
@ExceptionHandler(value = [NoSuchElementException::class])
|
||||
fun handleNoSuchElement(ex: NoSuchElementException): ResponseEntity<String> {
|
||||
logger.error("message", ex)
|
||||
return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.message)
|
||||
}
|
||||
|
||||
@ExceptionHandler(value = [Exception::class])
|
||||
fun handleException(ex: Exception): ResponseEntity<String> {
|
||||
logger.error("message", ex)
|
||||
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(ex.message)
|
||||
}
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
package com.banjjoknim.playground.config
|
||||
|
||||
import org.springframework.context.annotation.Configuration
|
||||
import org.springframework.scheduling.annotation.EnableAsync
|
||||
|
||||
/**
|
||||
* ```
|
||||
* @EnableAsync 어노테이션을 이용해서 비동기 설정을 활성화할 수 있다.
|
||||
*
|
||||
* 비동기 설정을 활성화했다면, 비동기로 실행할 이벤트 리스너에 @Async 어노테이션을 붙이면 된다.
|
||||
* ```
|
||||
*
|
||||
* @see EnableAsync
|
||||
* @see Async
|
||||
*/
|
||||
@EnableAsync
|
||||
@Configuration
|
||||
class AsyncConfiguration {
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
package com.banjjoknim.playground.config;
|
||||
|
||||
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
|
||||
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
|
||||
|
||||
// @EnableWebSecurity
|
||||
public class SecurityConfig extends WebSecurityConfigurerAdapter {
|
||||
|
||||
@Override
|
||||
protected void configure(HttpSecurity http) throws Exception {
|
||||
http.csrf().disable();
|
||||
http.authorizeHttpRequests()
|
||||
.antMatchers("/user/**").authenticated()
|
||||
.antMatchers("/manager/**").hasAnyRole("MANAGER", "ADMIN")
|
||||
.antMatchers("/admin/**").hasRole("ADMIN")
|
||||
.anyRequest().permitAll()
|
||||
.and()
|
||||
.formLogin()
|
||||
.loginPage("/login");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,250 @@
|
||||
package com.banjjoknim.playground.config.security
|
||||
|
||||
import com.banjjoknim.playground.domain.user.User
|
||||
import com.banjjoknim.playground.domain.user.UserRepository
|
||||
import org.springframework.context.annotation.Bean
|
||||
import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity
|
||||
import org.springframework.security.config.annotation.web.builders.HttpSecurity
|
||||
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity
|
||||
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter
|
||||
import org.springframework.security.core.GrantedAuthority
|
||||
import org.springframework.security.core.userdetails.UserDetails
|
||||
import org.springframework.security.core.userdetails.UserDetailsService
|
||||
import org.springframework.security.core.userdetails.UsernameNotFoundException
|
||||
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder
|
||||
import org.springframework.security.crypto.password.PasswordEncoder
|
||||
import org.springframework.security.oauth2.client.userinfo.DefaultOAuth2UserService
|
||||
import org.springframework.security.oauth2.client.userinfo.OAuth2UserRequest
|
||||
import org.springframework.security.oauth2.client.userinfo.OAuth2UserService
|
||||
import org.springframework.security.oauth2.core.user.OAuth2User
|
||||
import org.springframework.stereotype.Service
|
||||
|
||||
/**
|
||||
* OAuth2의 경우, 로그인이 완료된 뒤의 후처리가 필요하다.
|
||||
*
|
||||
* 1. 코드받기(인증), 2. 액세스토큰(권한) 얻기, 3. 액세스 토큰으로 사용자 정보 얻기
|
||||
*
|
||||
* 구글과 페이스북 로그인의 경우 코드가 필요 없다.
|
||||
*
|
||||
* 구글과 페이스북 측에서 우리에게 보내는 Request에 액세스 토큰과 사용자 정보등의 OAUth2 정보가 모두 포함되어 있다.
|
||||
*
|
||||
* 하지만 네이버, 카카오는 스프링 부트에서 기본적인 정보를 제공하지 않기 때문에 따로 해당 정보를 제공하는 클래스를 작성해야 한다.
|
||||
*/
|
||||
@EnableWebSecurity // 스프링 시큐리티 필터가 스프링 필터체인에 등록되도록 해준다.
|
||||
@EnableGlobalMethodSecurity(prePostEnabled = true, securedEnabled = true) // 스프링 시큐리티 관련 특정 어노테이션에 대한 활성화 설정을 할 수 있다.
|
||||
class SecurityConfiguration(val userRepository: UserRepository) : WebSecurityConfigurerAdapter() {
|
||||
|
||||
@Bean // passwordEncoder() 메서드에서 리턴해주는 PasswordEncoder 를 스프링 빈으로 등록한다.
|
||||
fun passwordEncoder(): PasswordEncoder { // Security 로 로그인을 하려면 비밀번호는 암호화되어 있어야 하므로 PasswordEncoder 가 필요하다.
|
||||
return BCryptPasswordEncoder()
|
||||
}
|
||||
|
||||
/**
|
||||
* application.yml 의 spring.security.oauth2.client.registration 에 대한 설정이 없을 경우,
|
||||
*
|
||||
* 이 메서드를 통해 스프링 빈으로 등록된 OAuth2UserService 를 아래의 configure 메서드에 OAuth2UserService 로써 Security filter chain 에 등록하려고 하면 아래의 예외가 발생한다.
|
||||
*
|
||||
* 'Method springSecurityFilterChain in org.springframework.security.config.annotation.web.configuration.WebSecurityConfiguration required a bean of type 'org.springframework.security.oauth2.client.registration.ClientRegistrationRepository' that could not be found.'
|
||||
*
|
||||
* 따라서 application.yml 의 spring.security.oauth2.client.registration 에 대한 설정을 반드시 등록해주어야 한다.
|
||||
*
|
||||
* 아래는 그 예시다.
|
||||
*
|
||||
* application.yml
|
||||
*
|
||||
* ```
|
||||
* spring:
|
||||
* security:
|
||||
* oauth2:
|
||||
* client:
|
||||
* registration:
|
||||
* google:
|
||||
* client-id: my-client-id
|
||||
* client-secret: my-client-secret
|
||||
* ```
|
||||
*
|
||||
* 단, 네이버 카카오는 스프링 시큐리티에서 지원해주지 않으므로 따로 설정을 작성해주어야 한다.
|
||||
*/
|
||||
@Bean
|
||||
fun oauth2UserService(): OAuth2UserService<OAuth2UserRequest, OAuth2User> {
|
||||
return PrincipalOAuth2UserService(passwordEncoder(), userRepository)
|
||||
}
|
||||
|
||||
override fun configure(http: HttpSecurity) {
|
||||
http.csrf().disable()
|
||||
http.authorizeRequests() // 인증만 되면 들어갈 수 있는 주소 설정
|
||||
.antMatchers("/user/**").hasRole("USER")
|
||||
.antMatchers("/manager/**").hasAnyRole("MANAGER", "ADMIN")
|
||||
.antMatchers("/admin/**").hasRole("ADMIN")
|
||||
.anyRequest().permitAll() // 위에서 명시한 주소 외에는 모든 접근을 허용한다.
|
||||
.and()
|
||||
.formLogin()
|
||||
.loginPage("/loginPage")
|
||||
.usernameParameter("username") // 기본적으로 인증을 위해 사용자를 찾을 때 username 을 사용하는데, 이에 사용되는 파라미터 이름을 바꿔주고 싶을때 사용한다.
|
||||
.loginProcessingUrl("/login") // /login url이 호출되면 Security 가 요청을 낚아채서 대신 로그인을 진행해준다.
|
||||
.defaultSuccessUrl("/") // loginPage 의 url을 통해서 로그인을 하면 / 로 보내줄건데, 특정 페이지로 요청해서 로그인하게 되면 그 페이지를 그대로 보여주겠다는 의미.
|
||||
.and()
|
||||
.oauth2Login()
|
||||
.loginPage("/loginPage")
|
||||
.loginProcessingUrl("/login")
|
||||
.userInfoEndpoint()
|
||||
.userService(oauth2UserService())
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 시큐리티가 /login 주소 요청이 오면 낚아채서 로그인을 진행해준다.
|
||||
*
|
||||
* 로그인 진행이 완료되면 시큐리티 session을 만들어준다 (Security ContextHolder)
|
||||
*
|
||||
* Security ContextHolder에 들어갈 수 있는 객체 타입은 Authentication 이다.
|
||||
*
|
||||
* Authentication 객체 안에는 User 정보가 있어야 한다. 이때 User 객체 타입은 UserDetails 이다.
|
||||
*
|
||||
* Security Session -> Authentication -> UserDetails
|
||||
*
|
||||
* Security ContextHolder 내부에 Authentication이 있고, 그 속에 UserDetails가 있는 형태.
|
||||
*
|
||||
* ```kotlin
|
||||
* ex) 1. SecurityContextHolder.getContext().authentication.details
|
||||
* 2. SecurityContextHolder.getContext().authentication.principal
|
||||
* 3. SecurityContextHolder.getContext().authentication.authorities
|
||||
* 4. ...
|
||||
* ```
|
||||
*/
|
||||
class PrincipalDetails(
|
||||
val user: User // 컴포지션. 일반 로그인시 사용하는 생성자
|
||||
) : UserDetails, OAuth2User {
|
||||
|
||||
private var _attributes: MutableMap<String, Any> = mutableMapOf()
|
||||
|
||||
// OAuth2 로그인시 사용하는 생성자
|
||||
constructor(user: User, attributes: Map<String, Any>) : this(user) {
|
||||
this._attributes = attributes.toMutableMap()
|
||||
}
|
||||
|
||||
override fun getName(): String {
|
||||
return "someName" // 크게 중요하지 않다...
|
||||
}
|
||||
|
||||
override fun getAttributes(): Map<String, Any> {
|
||||
return _attributes.toMap()
|
||||
}
|
||||
|
||||
// 해당 User 의 권한을 반환하는 함수
|
||||
override fun getAuthorities(): Collection<out GrantedAuthority> {
|
||||
return listOf(GrantedAuthority { user.role })
|
||||
}
|
||||
|
||||
override fun getPassword(): String {
|
||||
return user.password
|
||||
}
|
||||
|
||||
override fun getUsername(): String {
|
||||
return user.username
|
||||
}
|
||||
|
||||
override fun isAccountNonExpired(): Boolean {
|
||||
return true
|
||||
}
|
||||
|
||||
override fun isAccountNonLocked(): Boolean {
|
||||
return true
|
||||
}
|
||||
|
||||
override fun isCredentialsNonExpired(): Boolean {
|
||||
return true
|
||||
}
|
||||
|
||||
override fun isEnabled(): Boolean {
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* ```
|
||||
* 스프링 시큐리티 설정에서 loginProcessingUrl("/login") 설정을 해주었기 때문에
|
||||
*
|
||||
* /login url로 요청이 오면 자동으로 시큐리티가 로그인 과정을 낚아챈다.
|
||||
*
|
||||
* 이때 UserDetailsService 타입으로 등록되어 있는 빈을 찾아서 해당 빈에 정의된 loadUserByUsername() 을 실행한다.
|
||||
* ```
|
||||
*
|
||||
* @see DaoAuthenticationProvider
|
||||
* @see AbstractUserDetailsAuthenticationProvider
|
||||
*/
|
||||
@Service
|
||||
class PrincipalDetailService(private val userRepository: UserRepository) : UserDetailsService {
|
||||
/**
|
||||
* ```
|
||||
* 스프링 시큐리티 세션 내부에 Authentication 객체를 넣어준다. 그리고 Authentication 객체 속에는 UserDetails 객체가 들어있다.
|
||||
*
|
||||
* 추가로, 이 함수가 종료될 때 @AuthenticationPrincipal 어노테이션이 만들어진다.
|
||||
* ```
|
||||
*/
|
||||
override fun loadUserByUsername(username: String): UserDetails {
|
||||
val user = (userRepository.findByUsername(username)
|
||||
?: throw UsernameNotFoundException("can not found user by username. username: $username"))
|
||||
return PrincipalDetails(user) // PrincipalDetails 객체가 스프링 시큐리티 세션 정보에 들어가게 된다.
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* ```
|
||||
* 구글, 페이스북 등등 OAuth2 를 이용해서 받은 userRequest 데이터에 대한 후처리를 해주는 함수를 정의하는 서비스
|
||||
*
|
||||
* 구글 로그인 버튼 클릭 -> 구글 로그인창 -> 로그인 완료 -> 구글에서 code 리턴 ->OAuth-Client 라이브러리가 받아서 AccessToken 요청
|
||||
*
|
||||
* OAuth2UserRequest 정보를 이용해서 loadUser 함수 호출 -> 구글로부터 회원프로필을 받아준다.
|
||||
* ```
|
||||
*
|
||||
* @see OAuth2UserService
|
||||
* @see DefaultOAuth2UserService
|
||||
* @see OAuth2UserRequest
|
||||
*/
|
||||
@Service
|
||||
class PrincipalOAuth2UserService(
|
||||
val passwordEncoder: PasswordEncoder,
|
||||
val userRepository: UserRepository
|
||||
) :
|
||||
DefaultOAuth2UserService() { // OAuth2 로그인의 후처리를 담당한다.
|
||||
|
||||
/**
|
||||
* ```
|
||||
* 구글, 페이스북 등으로부터 받은 userRequest 데이터에 대한 후처리를 진행해주는 함수
|
||||
*
|
||||
* 추가로, 이 함수가 종료될 때 @AuthenticationPrincipal 어노테이션이 만들어진다.
|
||||
* ```
|
||||
*/
|
||||
override fun loadUser(userRequest: OAuth2UserRequest): OAuth2User {
|
||||
println("${userRequest.clientRegistration}")
|
||||
println("${userRequest.accessToken}")
|
||||
// println("${userRequest.attributes}") // 5.1 버전 이전일 경우.
|
||||
println("${userRequest.additionalParameters}") // 5.1 버전 이후일 경우.
|
||||
|
||||
// 강제로 회원가입 진행
|
||||
val oAuth2User = super.loadUser(userRequest)
|
||||
val provider = userRequest.clientRegistration.clientId // google
|
||||
val providerId = oAuth2User.attributes["sub"] // googleId(PK)
|
||||
val username = "${provider}_${providerId}" // OAuth2 로 로그인시, 필요 없지만 그냥 만들어준다.
|
||||
val password = passwordEncoder.encode("비밀번호") // OAuth2 로 로그인시, 필요 없지만 그냥 만들어준다.
|
||||
val email = oAuth2User.attributes["email"]
|
||||
val role = "ROLE_USER"
|
||||
|
||||
// 회원가입 여부 확인 및 저장
|
||||
var user = userRepository.findByUsername(username)
|
||||
require(user != null) { "이미 자동으로 회원가입이 되어 있습니다." }
|
||||
user = User(
|
||||
username = username,
|
||||
password = password,
|
||||
email = email as String,
|
||||
role = role,
|
||||
provider = provider,
|
||||
providerId = providerId as String
|
||||
)
|
||||
userRepository.save(user) // 회원정보 저장
|
||||
|
||||
return PrincipalDetails(user, oAuth2User.attributes) // PrincipalDetails 객체가 스프링 시큐리티 세션 정보에 들어가게 된다.
|
||||
}
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.admin
|
||||
|
||||
import org.slf4j.LoggerFactory
|
||||
import org.springframework.stereotype.Service
|
||||
|
||||
@Service
|
||||
class AdminService {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
fun alarm(username: String) {
|
||||
log.info("어드민 서비스 : {}님이 가입했습니다.", username)
|
||||
}
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.admin
|
||||
|
||||
import org.slf4j.LoggerFactory
|
||||
import org.springframework.stereotype.Service
|
||||
|
||||
@Service
|
||||
class CouponService {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
fun registerCoupon(email: String) {
|
||||
log.info("쿠폰 등록 완료 : {}", email)
|
||||
}
|
||||
}
|
||||
@@ -1,30 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.user
|
||||
|
||||
import org.springframework.data.domain.AbstractAggregateRoot
|
||||
import javax.persistence.Entity
|
||||
import javax.persistence.GeneratedValue
|
||||
import javax.persistence.GenerationType
|
||||
import javax.persistence.Id
|
||||
|
||||
/**
|
||||
* ```
|
||||
* AbstractAggregateRoot<T> 를 이용하면 쉽게 이벤트를 구현할 수 있다.
|
||||
*
|
||||
* 단, 명시적으로 AggregateRootRepository<T, ID> 에서 save()가 호출되어야 이벤트가 발행된다.
|
||||
* ```
|
||||
* @see AbstractAggregateRoot
|
||||
*/
|
||||
@Entity
|
||||
class AggregateRootUser(
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
val id: Long = 0L
|
||||
) : AbstractAggregateRoot<AggregateRootUser>() {
|
||||
|
||||
// AggregateRootUser Entity를 사용하는 AggregateRootUserRepository 에서 명시적으로 save() 가 호출되면 이벤트가 발행된다.
|
||||
fun publishAggregateRootEvent() {
|
||||
super.registerEvent(AggregateRootEvent("colt"))
|
||||
}
|
||||
|
||||
data class AggregateRootEvent(val name: String)
|
||||
}
|
||||
@@ -1,164 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.event
|
||||
|
||||
import org.slf4j.LoggerFactory
|
||||
import org.springframework.context.event.EventListener
|
||||
import org.springframework.scheduling.annotation.Async
|
||||
import org.springframework.stereotype.Component
|
||||
import org.springframework.transaction.event.TransactionPhase
|
||||
import org.springframework.transaction.event.TransactionalEventListener
|
||||
|
||||
/**
|
||||
* ```
|
||||
* 기존에는 이벤트 리스너를 사용하기 위해서 ApplicationListener<T> 를 상속(또는 구현)해서 사용해야 했기에, 이벤트가 상속에 종속적이 되어 문제가 될 수 있었다.
|
||||
*
|
||||
* 하지만 스프링 4.2부터는 이벤트 리스너의 이벤트 처리를 어노테이션 기반으로 작성할 수 있도록 개선되었다.
|
||||
*
|
||||
* ApplicationListenerMethodAdapter 객체가 @EventListener 어노테이션을 찾아서 실행시켜준다.
|
||||
*
|
||||
* 빈 단위로 정의된 리스너(ApplicationListener<T> 를 상속하고 Component 로 등록된)에 대해서는 구현체로 SimpleApplicationEventMulticaster 를 사용한다. SimpleApplicationEventMulticaster 는 빈 단위로 정의된 작업을 실행시켜준다.
|
||||
*
|
||||
* 리스너는 메소드 단위로도 정의할 수 있다. 메소드에 @EventListener 어노테이션을 붙이면 이때는 구현체로 ApplicationListenerMethodAdapter 를 사용한다(구현체가 변경된다).
|
||||
* ```
|
||||
*
|
||||
* @see AbstractApplicationContext
|
||||
* @see ApplicationListenerMethodAdapter
|
||||
* @see SimpleApplicationEventMulticaster
|
||||
* @see ApplicationListenerMethodAdapter
|
||||
* @see EventListener(org.springframework.context.event)
|
||||
*/
|
||||
|
||||
@Component
|
||||
class AdminAnnotationEventListener {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
@EventListener
|
||||
fun onApplicationEvent(event: AdminAnnotationEvent) {
|
||||
log.info("어드민 서비스 : {}님이 가입했습니다.", event.username)
|
||||
}
|
||||
}
|
||||
|
||||
@Component
|
||||
class CouponAnnotationEventListener {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
@EventListener
|
||||
fun onApplicationEvent(event: CouponAnnotationEvent) {
|
||||
log.info("쿠폰 등록 완료 : {}", event.email)
|
||||
}
|
||||
}
|
||||
|
||||
@Component
|
||||
class SenderAnnotationEventListener {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
@EventListener
|
||||
fun handleEmail(event: SenderAnnotationEvent) {
|
||||
log.info("환영 이메일 발송 성공 : {}", event.email)
|
||||
}
|
||||
|
||||
@EventListener
|
||||
fun handleSMS(event: SenderAnnotationEvent) {
|
||||
log.info("환영 SMS 발송 성공 : {}", event.phoneNumber)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 트랜잭션 단위를 이벤트에서 관리(제어)하기 위해서 @TransactionalEventListener 를 사용할 수 있다.
|
||||
*
|
||||
* 기본 설정은 TransactionPhase.AFTER_COMMIT 이다. 이 외에도 여러 상태가 있으니 참고하여 설계하는데 사용하도록 하자.
|
||||
*
|
||||
* @see TransactionalEventListener
|
||||
*/
|
||||
|
||||
@Component
|
||||
class AdminTransactionalEventListener {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
@EventListener
|
||||
fun onApplicationEvent(event: AdminTransactionalEvent) {
|
||||
throw RuntimeException()
|
||||
// log.info("어드민 서비스 : {}님이 가입했습니다.", event.username)
|
||||
}
|
||||
}
|
||||
|
||||
@Component
|
||||
class CouponTransactionalEventListener {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
/**
|
||||
* 아래의 @TransactionalEventListener 로 인해
|
||||
*
|
||||
* 트랜잭션 커밋이 정상적으로 성공한 이후에 이벤트가 실행(처리)된다.
|
||||
*/
|
||||
@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
|
||||
fun onApplicationEvent(event: CouponTransactionalEvent) {
|
||||
log.info("쿠폰 등록 완료 : {}", event.email)
|
||||
}
|
||||
}
|
||||
|
||||
@Component
|
||||
class SenderTransactionalEventListener {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
@EventListener
|
||||
fun handleEmail(event: SenderTransactionalEvent) {
|
||||
log.info("환영 이메일 발송 성공 : {}", event.email)
|
||||
}
|
||||
|
||||
@EventListener
|
||||
fun handleSMS(event: SenderTransactionalEvent) {
|
||||
log.info("환영 SMS 발송 성공 : {}", event.phoneNumber)
|
||||
}
|
||||
}
|
||||
|
||||
@Component
|
||||
class AdminAsyncEventListener {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
@EventListener
|
||||
fun onApplicationEvent(event: AdminAsyncEvent) {
|
||||
log.info("어드민 서비스 : {}님이 가입했습니다.", event.username)
|
||||
}
|
||||
}
|
||||
|
||||
@Component
|
||||
class CouponAsyncEventListener {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
@EventListener
|
||||
fun onApplicationEvent(event: CouponAsyncEvent) {
|
||||
log.info("쿠폰 등록 완료 : {}", event.email)
|
||||
}
|
||||
}
|
||||
|
||||
@Component
|
||||
class SenderAsyncEventListener {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
/**
|
||||
* 비동기로 설정하기 위해 @Async 어노테이션을 붙였다.
|
||||
*
|
||||
* 비동기로 설정했기 때문에 다른 쓰레드에서 이벤트가 실행된다.
|
||||
*
|
||||
* 그에 따라 예외가 발생해도 나머지 로직(회원 저장, 이벤트)은 제대로 처리된다(다른 쓰레드에서 예외가 발생한 것이기 때문에).
|
||||
*
|
||||
*/
|
||||
@Async
|
||||
@EventListener
|
||||
fun handleEmail(event: SenderAsyncEvent) {
|
||||
throw RuntimeException()
|
||||
// log.info("환영 이메일 발송 성공 : {}", event.email)
|
||||
}
|
||||
|
||||
/**
|
||||
* 비동기로 설정하기 위해 @Async 어노테이션을 붙였다.
|
||||
*
|
||||
* 비동기로 설정했기 때문에 다른 쓰레드에서 이벤트가 실행된다.
|
||||
*/
|
||||
@Async
|
||||
@EventListener
|
||||
fun handleSMS(event: SenderAsyncEvent) {
|
||||
log.info("환영 SMS 발송 성공 : {}", event.phoneNumber)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.event
|
||||
|
||||
/**
|
||||
* 어노테이션을 사용한 이벤트
|
||||
*
|
||||
* 어노테이션을 사용하면 상속을 받지 않아도 되기 때문에 스프링에 대한 의존성이 제거된 순수한 자바 객체를 이벤트 객체로 사용할 수 있다.
|
||||
*
|
||||
* @see EventListener
|
||||
*/
|
||||
|
||||
class AdminAnnotationEvent(val username: String)
|
||||
|
||||
class CouponAnnotationEvent(val email: String)
|
||||
|
||||
class SenderAnnotationEvent(val email: String, val phoneNumber: String)
|
||||
|
||||
class AdminTransactionalEvent(val username: String)
|
||||
|
||||
class CouponTransactionalEvent(val email: String)
|
||||
|
||||
class SenderTransactionalEvent(val email: String, val phoneNumber: String)
|
||||
|
||||
class AdminAsyncEvent(val username: String)
|
||||
|
||||
class CouponAsyncEvent(val email: String)
|
||||
|
||||
class SenderAsyncEvent(val email: String, val phoneNumber: String)
|
||||
@@ -1,41 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.event
|
||||
|
||||
import org.slf4j.LoggerFactory
|
||||
import org.springframework.context.ApplicationListener
|
||||
import org.springframework.stereotype.Component
|
||||
|
||||
/**
|
||||
* 상속 기반 이벤트 리스너
|
||||
*
|
||||
* 스프링의 컨텍스트를 사용하기 때문에 빈으로 등록해줘야 사용할 수 있다
|
||||
*
|
||||
* @see ApplicationListener
|
||||
*/
|
||||
|
||||
@Component
|
||||
class AdminInheritanceEventListener : ApplicationListener<AdminInheritanceEvent> {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
override fun onApplicationEvent(event: AdminInheritanceEvent) {
|
||||
log.info("어드민 서비스 : {}님이 가입했습니다.", event.username)
|
||||
}
|
||||
}
|
||||
|
||||
@Component
|
||||
class CouponInheritanceEventListener : ApplicationListener<CouponInheritanceEvent> {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
override fun onApplicationEvent(event: CouponInheritanceEvent) {
|
||||
log.info("쿠폰 등록 완료 : {}", event.email)
|
||||
}
|
||||
}
|
||||
|
||||
@Component
|
||||
class SenderInheritanceEventListener : ApplicationListener<SenderInheritanceEvent> {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
override fun onApplicationEvent(event: SenderInheritanceEvent) {
|
||||
log.info("환영 이메일 발송 성공 : {}", event.email)
|
||||
log.info("환영 SMS 발송 성공 : {}", event.phoneNumber)
|
||||
}
|
||||
}
|
||||
@@ -1,17 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.event
|
||||
|
||||
import org.springframework.context.ApplicationEvent
|
||||
|
||||
/**
|
||||
* 상속 기반 이벤트
|
||||
*
|
||||
* ApplicationEvent 를 상속받아서 사용한다.
|
||||
*
|
||||
* @see ApplicationEvent
|
||||
*/
|
||||
|
||||
class AdminInheritanceEvent(source: Any, val username: String) : ApplicationEvent(source)
|
||||
|
||||
class CouponInheritanceEvent(source: Any, val email: String) : ApplicationEvent(source)
|
||||
|
||||
class SenderInheritanceEvent(source: Any, val email: String, val phoneNumber: String) : ApplicationEvent(source)
|
||||
@@ -1,47 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.event
|
||||
|
||||
import org.hibernate.SessionFactory
|
||||
import org.hibernate.event.service.spi.EventListenerRegistry
|
||||
import org.hibernate.event.spi.EventType
|
||||
import org.hibernate.event.spi.PostInsertEvent
|
||||
import org.hibernate.event.spi.PostInsertEventListener
|
||||
import org.hibernate.internal.SessionFactoryImpl
|
||||
import org.hibernate.persister.entity.EntityPersister
|
||||
import org.springframework.stereotype.Component
|
||||
|
||||
/**
|
||||
* ```
|
||||
* org.hibernate.event.spi.EventType 을 살펴보면, 다양한 이벤트 발행시점(상태)을 볼 수 있다.
|
||||
*
|
||||
* 다양한 이벤트 발행시점(상태)과 이벤트를 이용해서 비즈니스 로직을 처리할 수 있다.
|
||||
*
|
||||
* 이벤트를 심도있게, 더 잘 활용하고 싶다면 Hibernate Session Event (Hibernate Event Session) 를 공부하도록 하자.
|
||||
*
|
||||
* Hibernate Session 의 이벤트 인터셉트를 이용해서 다양하게 활용할 수 있다.
|
||||
* ```
|
||||
* @see EventType
|
||||
*/
|
||||
@Component
|
||||
class DomainEvent {
|
||||
|
||||
private lateinit var sessionFactory: SessionFactory
|
||||
|
||||
fun sample() {
|
||||
val registry = (sessionFactory as SessionFactoryImpl).serviceRegistry.getService(EventListenerRegistry::class.java)
|
||||
registry.getEventListenerGroup(EventType.POST_COMMIT_INSERT).appendListener(CustomEventListener())
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
@Component
|
||||
class CustomEventListener : PostInsertEventListener {
|
||||
override fun requiresPostCommitHanding(persister: EntityPersister?): Boolean {
|
||||
TODO("Not yet implemented")
|
||||
}
|
||||
|
||||
override fun onPostInsert(event: PostInsertEvent?) {
|
||||
TODO("Not yet implemented")
|
||||
}
|
||||
}
|
||||
@@ -1,17 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.sender
|
||||
|
||||
import org.slf4j.LoggerFactory
|
||||
import org.springframework.stereotype.Service
|
||||
|
||||
@Service
|
||||
class SenderService {
|
||||
private val log = LoggerFactory.getLogger(this::class.java)
|
||||
|
||||
fun sendEmail(email: String) {
|
||||
log.info("환영 이메일 발송 성공 : {}", email)
|
||||
}
|
||||
|
||||
fun sendSMS(phoneNumber: String) {
|
||||
log.info("환영 SMS 발송 성공 : {}", phoneNumber)
|
||||
}
|
||||
}
|
||||
@@ -1,19 +1,5 @@
|
||||
package com.banjjoknim.playground.domain.user
|
||||
|
||||
import com.banjjoknim.playground.domain.event.AdminAnnotationEvent
|
||||
import com.banjjoknim.playground.domain.event.AdminAsyncEvent
|
||||
import com.banjjoknim.playground.domain.event.AdminInheritanceEvent
|
||||
import com.banjjoknim.playground.domain.event.AdminTransactionalEvent
|
||||
import com.banjjoknim.playground.domain.event.CouponAnnotationEvent
|
||||
import com.banjjoknim.playground.domain.event.CouponAsyncEvent
|
||||
import com.banjjoknim.playground.domain.event.CouponInheritanceEvent
|
||||
import com.banjjoknim.playground.domain.event.CouponTransactionalEvent
|
||||
import com.banjjoknim.playground.domain.event.SenderAnnotationEvent
|
||||
import com.banjjoknim.playground.domain.event.SenderAsyncEvent
|
||||
import com.banjjoknim.playground.domain.event.SenderInheritanceEvent
|
||||
import com.banjjoknim.playground.domain.event.SenderTransactionalEvent
|
||||
import org.springframework.context.ApplicationEventPublisher
|
||||
import javax.persistence.Column
|
||||
import javax.persistence.Entity
|
||||
import javax.persistence.GeneratedValue
|
||||
import javax.persistence.GenerationType
|
||||
@@ -23,89 +9,11 @@ import javax.persistence.Id
|
||||
class User(
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
val id: Long? = 0L,
|
||||
|
||||
@Column(name = "name")
|
||||
val name: String = "",
|
||||
|
||||
@Column(name = "email")
|
||||
val email: String = "",
|
||||
|
||||
@Column(name = "phoneNumber")
|
||||
val phoneNumber: String = ""
|
||||
) {
|
||||
/**
|
||||
* 상속 기반의 이벤트 사용
|
||||
*/
|
||||
fun publishInheritanceEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
publishInheritanceAdminEvent(eventPublisher)
|
||||
publishInheritanceCouponEvent(eventPublisher)
|
||||
publishInheritanceSenderEvent(eventPublisher)
|
||||
}
|
||||
|
||||
private fun publishInheritanceAdminEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(AdminInheritanceEvent(this, name))
|
||||
}
|
||||
|
||||
private fun publishInheritanceCouponEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(CouponInheritanceEvent(this, email))
|
||||
}
|
||||
|
||||
private fun publishInheritanceSenderEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(SenderInheritanceEvent(this, email, phoneNumber))
|
||||
}
|
||||
|
||||
fun publishAnnotationEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
publishAnnotationAdminEvent(eventPublisher)
|
||||
publishAnnotationCouponEvent(eventPublisher)
|
||||
publishAnnotationSenderEvent(eventPublisher)
|
||||
}
|
||||
|
||||
private fun publishAnnotationAdminEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(AdminAnnotationEvent(name))
|
||||
}
|
||||
|
||||
private fun publishAnnotationCouponEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(CouponAnnotationEvent(email))
|
||||
}
|
||||
|
||||
private fun publishAnnotationSenderEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(SenderAnnotationEvent(email, phoneNumber))
|
||||
}
|
||||
|
||||
fun publishWithTransactionalEventListener(eventPublisher: ApplicationEventPublisher) {
|
||||
publishWithTransactionalCouponEvent(eventPublisher)
|
||||
publishWithTransactionalAdminEvent(eventPublisher)
|
||||
publishWithTransactionalSenderEvent(eventPublisher)
|
||||
}
|
||||
|
||||
private fun publishWithTransactionalAdminEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(AdminTransactionalEvent(name))
|
||||
}
|
||||
|
||||
private fun publishWithTransactionalCouponEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(CouponTransactionalEvent(email))
|
||||
}
|
||||
|
||||
private fun publishWithTransactionalSenderEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(SenderTransactionalEvent(email, phoneNumber))
|
||||
}
|
||||
|
||||
fun publishWithAsyncEventListener(eventPublisher: ApplicationEventPublisher) {
|
||||
publishWithAsyncCouponEvent(eventPublisher)
|
||||
publishWithAsyncAdminEvent(eventPublisher)
|
||||
publishWithAsyncSenderEvent(eventPublisher)
|
||||
}
|
||||
|
||||
private fun publishWithAsyncAdminEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(AdminAsyncEvent(name))
|
||||
}
|
||||
|
||||
private fun publishWithAsyncCouponEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(CouponAsyncEvent(email))
|
||||
}
|
||||
|
||||
private fun publishWithAsyncSenderEvent(eventPublisher: ApplicationEventPublisher) {
|
||||
eventPublisher.publishEvent(SenderAsyncEvent(email, phoneNumber))
|
||||
}
|
||||
}
|
||||
var id: Long = 0L,
|
||||
var username: String,
|
||||
var password: String,
|
||||
var email: String,
|
||||
var role: String, // ROLE_USER, ROLE_MANAGER, ROLE_ADMIN ...
|
||||
var provider: String,
|
||||
var providerId: String,
|
||||
)
|
||||
|
||||
@@ -1,69 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.user
|
||||
|
||||
import org.springframework.http.ResponseEntity
|
||||
import org.springframework.web.bind.annotation.GetMapping
|
||||
import org.springframework.web.bind.annotation.PathVariable
|
||||
import org.springframework.web.bind.annotation.PostMapping
|
||||
import org.springframework.web.bind.annotation.RequestBody
|
||||
import org.springframework.web.bind.annotation.RequestMapping
|
||||
import org.springframework.web.bind.annotation.RestController
|
||||
import javax.validation.Valid
|
||||
|
||||
@RequestMapping("/users")
|
||||
@RestController
|
||||
class UserApi(
|
||||
private val userService: UserService,
|
||||
private val userServiceBaseOnInheritanceEvent: UserServiceBaseOnInheritanceEvent,
|
||||
private val userServiceBaseOnAnnotationEvent: UserServiceBaseOnAnnotationEvent
|
||||
) {
|
||||
/**
|
||||
* 의존성을 모두 갖고 서비스 내에서 서비스를 호출하는 방식
|
||||
*/
|
||||
@PostMapping("")
|
||||
fun createUser(@RequestBody @Valid request: CreateUserRequest): ResponseEntity<Unit> {
|
||||
userService.createUser(request)
|
||||
return ResponseEntity.ok().build()
|
||||
}
|
||||
|
||||
/**
|
||||
* 상속 기반의 이벤트 사용 방식
|
||||
*/
|
||||
@PostMapping("/inheritance")
|
||||
fun createUserWithInheritanceEvent(@RequestBody @Valid request: CreateUserRequest): ResponseEntity<Unit> {
|
||||
userServiceBaseOnInheritanceEvent.createUser(request)
|
||||
return ResponseEntity.ok().build()
|
||||
}
|
||||
|
||||
/**
|
||||
* 어노테이션 기반의 이벤트 사용 방식
|
||||
*/
|
||||
@PostMapping("/annotation")
|
||||
fun createUserWithAnnotationEvent(@RequestBody @Valid request: CreateUserRequest): ResponseEntity<Unit> {
|
||||
userServiceBaseOnAnnotationEvent.createUser(request)
|
||||
return ResponseEntity.ok().build()
|
||||
}
|
||||
|
||||
/**
|
||||
* 트랜잭션 이벤트 리스너 어노테이션을 이용한 이벤트 사용 방식
|
||||
*/
|
||||
@PostMapping("/transactional")
|
||||
fun createUserWithTransactionalEventListener(@RequestBody @Valid request: CreateUserRequest): ResponseEntity<Unit> {
|
||||
userServiceBaseOnAnnotationEvent.createUserWithTransactionalEventListener(request)
|
||||
return ResponseEntity.ok().build()
|
||||
}
|
||||
|
||||
/**
|
||||
* 비동기 이벤트 리스너를 이용한 이벤트 사용 방식
|
||||
*/
|
||||
@PostMapping("/async")
|
||||
fun createUserWithAsyncEventListener(@RequestBody @Valid request: CreateUserRequest): ResponseEntity<Unit> {
|
||||
userServiceBaseOnAnnotationEvent.createUserWithAsyncEventListener(request)
|
||||
return ResponseEntity.ok().build()
|
||||
}
|
||||
|
||||
@GetMapping("/{userId}")
|
||||
fun retrieveUser(@PathVariable userId: Long): ResponseEntity<RetrieveUserResponse> {
|
||||
val response = userService.retrieveUser(userId)
|
||||
return ResponseEntity.ok(response)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
package com.banjjoknim.playground.domain.user
|
||||
|
||||
import com.banjjoknim.playground.config.security.PrincipalDetails
|
||||
import com.banjjoknim.playground.config.security.PrincipalOAuth2UserService
|
||||
import org.springframework.security.core.Authentication
|
||||
import org.springframework.security.core.annotation.AuthenticationPrincipal
|
||||
import org.springframework.security.core.userdetails.UserDetails
|
||||
import org.springframework.security.oauth2.core.user.OAuth2User
|
||||
import org.springframework.web.bind.annotation.GetMapping
|
||||
import org.springframework.web.bind.annotation.RestController
|
||||
|
||||
@RestController
|
||||
class UserController {
|
||||
|
||||
/**
|
||||
* ```
|
||||
* 스프링 시큐리티는 스프링 시큐리티 세션을 들고 있다.
|
||||
*
|
||||
* 그러면 원래 서버 세션 영역 안에 시큐리티가 관리하는 세션이 따로 존재하게 된다.
|
||||
*
|
||||
* 시큐리티 세션에는 무조건 Authentication 객체 만 들어갈 수 있다.
|
||||
*
|
||||
* Authentication 가 시큐리티세션 안에 들어가 있다는 것은 로그인된 상태라는 의미이다.
|
||||
*
|
||||
* Authentication 에는 2개의 타입이 들어갈 수 있는데 UserDetails, OAuth2User 이다.
|
||||
*
|
||||
* 문제점 :
|
||||
*
|
||||
* 이때 세션이 2개의 타입으로 나눠졌기 때문에 컨트롤러에서 처리하기 복잡해진다는 문제점이 발생한다!
|
||||
*
|
||||
* 왜냐하면 일반적인 로그인을 할 때엔 UserDetails 타입으로 Authentication 객체가 만들어지고,
|
||||
*
|
||||
* 구글 로그인처럼 OAuth 로그인을 할 때엔 OAuth2User 타입으로 Authentication 객체가 만들어지기 때문이다.
|
||||
*
|
||||
* 해결방법 :
|
||||
*
|
||||
* PrincipalDetails 에 UserDetails, OAuth2User 를 implements 한다.
|
||||
*
|
||||
* 그렇게 하면 PrincipalDetails 타입은 UserDetails, OAuth2User 타입이 되므로 우리는 오직 PrincipalDetails 만 활용하면 된다.
|
||||
*
|
||||
* 추가로, @AuthenticationPrincipal 어노테이션으로 세션 정보를 DI 받아서 바로 접근할 수 있다.
|
||||
*
|
||||
* 이는 스프링 시큐리티가 갖고 있는 세션에서 Authentication 객체를 갖고 있기 때문이다.
|
||||
*
|
||||
* 그에 따라 결과적으로는 시큐리티 세션에 존재하는 Authentication 객체를 PrincipalDetails 으로 다운 캐스팅 하지 않아도 된다.
|
||||
* ```
|
||||
*
|
||||
* ```
|
||||
* @AuthenticationPrincipal 어노테이션이 활성화되는 시점?
|
||||
*
|
||||
* PrincipalOAuth2UserService, PrincipalDetailService 를 만들지 않아도(오버라이드 하지 않아도)
|
||||
*
|
||||
* loadUser(), loadUserByUsername() 은 기본적으로 실행되어 대신 스프링 시큐리티가 로그인을 진행해준다.
|
||||
*
|
||||
* 하지만 굳이 오버라이드 하면서 PrincipalOAuth2UserService, PrincipalDetailService 를 만든 이유는 로그인시 PrincipalDetails 객체를 반환하기 위해서다.
|
||||
*
|
||||
* 이는 로그인시 반환되는 객체가 Authentication 객체 내부에 저장되기 때문이며, 이렇게 하는게 더 편하다.
|
||||
*
|
||||
* ```
|
||||
*
|
||||
* @see PrincipalDetails
|
||||
* @see AuthenticationPrincipal
|
||||
* @see PrincipalOAuth2UserService
|
||||
* @see PrincipalDetailsService
|
||||
*
|
||||
*/
|
||||
@GetMapping("/login") // OAuth2 로그인 및 일반 로그인 모두 principalDetails 로 세션 정보를 얻어올 수 있다.
|
||||
fun login(@AuthenticationPrincipal principalDetails: PrincipalDetails) { // DI(의존성 주입)
|
||||
println("principalDetailsUser : ${principalDetails.user}")
|
||||
}
|
||||
|
||||
@GetMapping("/test/login")
|
||||
fun testLogin(
|
||||
authentication: Authentication,
|
||||
@AuthenticationPrincipal userDetails: UserDetails
|
||||
) { // DI(의존성 주입)
|
||||
val principalDetailsFromAuthentication = authentication.principal as PrincipalDetails // 다운 캐스팅
|
||||
println("principalDetailsFromAuthentication : ${principalDetailsFromAuthentication.user}")
|
||||
println("principalDetailsFromAuthentication : ${principalDetailsFromAuthentication.username}")
|
||||
val principalDetailsFromUserDetails = userDetails as PrincipalDetails // 다운 캐스팅
|
||||
println("principalDetailsFromUserDetails : ${principalDetailsFromUserDetails.user}")
|
||||
println("principalDetailsFromUserDetails : ${principalDetailsFromUserDetails.username}")
|
||||
}
|
||||
|
||||
@GetMapping("/test/oauth2/login")
|
||||
fun testOAuth2Login(
|
||||
authentication: Authentication,
|
||||
@AuthenticationPrincipal oauth: OAuth2User
|
||||
) { // DI(의존성 주입)
|
||||
val oAuth2User = authentication.principal as OAuth2User // 다운 캐스팅
|
||||
println("authentication : ${oAuth2User.attributes}") // OAuth2Service 의 super.loadUser(userRequest).attributes 와 같다.
|
||||
println("oAuth2User : ${oauth.attributes}")
|
||||
}
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.user
|
||||
|
||||
import javax.validation.constraints.NotBlank
|
||||
|
||||
data class CreateUserRequest(
|
||||
@field:NotBlank(message = "이름을 입력해주세요")
|
||||
val name: String = "",
|
||||
@field:NotBlank(message = "이메일을 입력해주세요")
|
||||
val email: String = "",
|
||||
@field:NotBlank(message = "휴대폰 번호를 입력해주세요")
|
||||
val phoneNumber: String = ""
|
||||
) {
|
||||
fun toUser(): User {
|
||||
return User(name = name, email = email, phoneNumber = phoneNumber)
|
||||
}
|
||||
}
|
||||
|
||||
data class RetrieveUserResponse(
|
||||
val name: String,
|
||||
val email: String,
|
||||
val phoneNumber: String
|
||||
) {
|
||||
constructor(user: User) : this(user.name, user.email, user.phoneNumber)
|
||||
}
|
||||
@@ -3,4 +3,5 @@ package com.banjjoknim.playground.domain.user
|
||||
import org.springframework.data.jpa.repository.JpaRepository
|
||||
|
||||
interface UserRepository : JpaRepository<User, Long> {
|
||||
fun findByUsername(username: String): User?
|
||||
}
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.user
|
||||
|
||||
import com.banjjoknim.playground.domain.admin.AdminService
|
||||
import com.banjjoknim.playground.domain.admin.CouponService
|
||||
import com.banjjoknim.playground.domain.sender.SenderService
|
||||
import org.springframework.data.repository.findByIdOrNull
|
||||
import org.springframework.stereotype.Service
|
||||
import org.springframework.transaction.annotation.Transactional
|
||||
|
||||
/**
|
||||
* 의존성을 모두 갖고 서비스 내에서 서비스를 호출하는 방식
|
||||
*/
|
||||
@Transactional
|
||||
@Service
|
||||
class UserService(
|
||||
private val userRepository: UserRepository,
|
||||
private val adminService: AdminService,
|
||||
private val senderService: SenderService,
|
||||
private val couponService: CouponService
|
||||
) {
|
||||
fun createUser(request: CreateUserRequest) {
|
||||
val user = request.toUser()
|
||||
userRepository.save(user)
|
||||
adminService.alarm(user.name)
|
||||
couponService.registerCoupon(user.email)
|
||||
senderService.sendSMS(user.phoneNumber)
|
||||
senderService.sendEmail(user.email)
|
||||
}
|
||||
|
||||
fun retrieveUser(userId: Long): RetrieveUserResponse {
|
||||
val user = userRepository.findByIdOrNull(userId)
|
||||
?: throw NoSuchElementException("회원이 존재하지 않습니다. [userId: $userId]")
|
||||
return RetrieveUserResponse(user)
|
||||
}
|
||||
}
|
||||
@@ -1,30 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.user
|
||||
|
||||
import org.springframework.context.ApplicationEventPublisher
|
||||
import org.springframework.stereotype.Service
|
||||
import org.springframework.transaction.annotation.Transactional
|
||||
|
||||
@Transactional
|
||||
@Service
|
||||
class UserServiceBaseOnAnnotationEvent(
|
||||
private val userRepository: UserRepository,
|
||||
private val eventPublisher: ApplicationEventPublisher
|
||||
) {
|
||||
fun createUser(request: CreateUserRequest) {
|
||||
val user = request.toUser()
|
||||
userRepository.save(user)
|
||||
user.publishAnnotationEvent(eventPublisher)
|
||||
}
|
||||
|
||||
fun createUserWithTransactionalEventListener(request: CreateUserRequest) {
|
||||
val user = request.toUser()
|
||||
userRepository.save(user)
|
||||
user.publishWithTransactionalEventListener(eventPublisher)
|
||||
}
|
||||
|
||||
fun createUserWithAsyncEventListener(request: CreateUserRequest) {
|
||||
val user = request.toUser()
|
||||
userRepository.save(user)
|
||||
user.publishWithAsyncEventListener(eventPublisher)
|
||||
}
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.user
|
||||
|
||||
import org.springframework.context.ApplicationEventPublisher
|
||||
import org.springframework.stereotype.Service
|
||||
import org.springframework.transaction.annotation.Transactional
|
||||
|
||||
/**
|
||||
* 상속 기반의 이벤트를 사용하는 서비스
|
||||
*
|
||||
* @see BaseOnInheritanceEventListeners
|
||||
* @see BaseOnInheritanceEvents
|
||||
*/
|
||||
@Transactional
|
||||
@Service
|
||||
class UserServiceBaseOnInheritanceEvent(
|
||||
private val userRepository: UserRepository,
|
||||
private val eventPublisher: ApplicationEventPublisher
|
||||
) {
|
||||
fun createUser(request: CreateUserRequest) {
|
||||
val user = request.toUser()
|
||||
userRepository.save(user)
|
||||
user.publishInheritanceEvent(eventPublisher)
|
||||
}
|
||||
}
|
||||
@@ -1,52 +0,0 @@
|
||||
### 고전적인 방식
|
||||
POST http://localhost:8080/users
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "banjjoknim",
|
||||
"email": "banjjoknim@github.com",
|
||||
"phoneNumber": "010-1234-5678"
|
||||
}
|
||||
|
||||
### 상속 기반의 이벤트를 사용하는 방식
|
||||
POST http://localhost:8080/users/inheritance
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "banjjoknim",
|
||||
"email": "banjjoknim@github.com",
|
||||
"phoneNumber": "010-1234-5678"
|
||||
}
|
||||
|
||||
### 어노테이션 기반의 이벤트를 사용하는 방식
|
||||
POST http://localhost:8080/users/annotation
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "banjjoknim",
|
||||
"email": "banjjoknim@github.com",
|
||||
"phoneNumber": "010-1234-5678"
|
||||
}
|
||||
|
||||
### 트랜잭션 이벤트 리스너 어노테이션을 사용하는 방식
|
||||
POST http://localhost:8080/users/transactional
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "banjjoknim",
|
||||
"email": "banjjoknim@github.com",
|
||||
"phoneNumber": "010-1234-5678"
|
||||
}
|
||||
|
||||
### 비동기 이벤트 리스너 어노테이션을 사용하는 방식
|
||||
POST http://localhost:8080/users/async
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "banjjoknim",
|
||||
"email": "banjjoknim@github.com",
|
||||
"phoneNumber": "010-1234-5678"
|
||||
}
|
||||
|
||||
###
|
||||
GET http://localhost:8080/users/1
|
||||
@@ -1,19 +1,11 @@
|
||||
spring:
|
||||
|
||||
h2:
|
||||
console:
|
||||
enabled: true
|
||||
|
||||
datasource:
|
||||
driver-class-name: org.h2.Driver
|
||||
username: sa
|
||||
password:
|
||||
url: jdbc:h2:mem:testdb;MODE=MySQL;
|
||||
|
||||
jpa:
|
||||
hibernate:
|
||||
ddl-auto: create-drop
|
||||
show-sql: true
|
||||
properties:
|
||||
hibernate:
|
||||
format_sql: true
|
||||
security:
|
||||
oauth2:
|
||||
client:
|
||||
registration:
|
||||
google:
|
||||
client-id: my-google-client-id
|
||||
client-secret: my-google-client-secret
|
||||
facebook:
|
||||
client-id: my-facebook-client-id
|
||||
client-secret: my-facebook-client-secret
|
||||
|
||||
@@ -1,60 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.user
|
||||
|
||||
import com.banjjoknim.playground.domain.event.AdminAnnotationEvent
|
||||
import com.banjjoknim.playground.domain.event.CouponAnnotationEvent
|
||||
import com.banjjoknim.playground.domain.event.SenderAnnotationEvent
|
||||
import org.assertj.core.api.Assertions
|
||||
import org.junit.jupiter.api.BeforeEach
|
||||
import org.junit.jupiter.api.Test
|
||||
import org.junit.jupiter.api.extension.ExtendWith
|
||||
import org.mockito.ArgumentCaptor
|
||||
import org.mockito.BDDMockito
|
||||
import org.mockito.Captor
|
||||
import org.mockito.Mock
|
||||
import org.mockito.junit.jupiter.MockitoExtension
|
||||
import org.springframework.context.ApplicationEventPublisher
|
||||
|
||||
@ExtendWith(MockitoExtension::class)
|
||||
class UserServiceBaseOnAnnotationEventTest {
|
||||
|
||||
@Mock
|
||||
private lateinit var userRepository: UserRepository
|
||||
|
||||
@Mock
|
||||
private lateinit var eventPublisher: ApplicationEventPublisher
|
||||
|
||||
/**
|
||||
* 발행된 이벤트를 캡쳐해서 데이터를 저장할 수 있다.
|
||||
*
|
||||
* 이때, 순수한 자바 객체를 이벤트 객체로 사용하므로 ArgumentCaptor 의 제네릭을 제네릭을 Any(Object)로 지정한다.
|
||||
*/
|
||||
@Captor
|
||||
private lateinit var eventPublisherCaptor: ArgumentCaptor<Any>
|
||||
|
||||
private lateinit var userServiceBaseOnAnnotationEvent: UserServiceBaseOnAnnotationEvent
|
||||
|
||||
@BeforeEach
|
||||
fun setup() {
|
||||
userServiceBaseOnAnnotationEvent = UserServiceBaseOnAnnotationEvent(userRepository, eventPublisher)
|
||||
}
|
||||
|
||||
/**
|
||||
* 아래와 같이 테스트는 작성할 수 있지만, 통합테스트를 돌려야 실제로 이벤트가 발행되고 이벤트 리스너가 이벤트를 처리하는 것을 확인할 수 있다는 한계점이 있다.
|
||||
*/
|
||||
@Test
|
||||
fun `회원 생성시 이벤트의 총 발행 횟수와 각각의 이벤트의 타입을 검사한다`() {
|
||||
BDDMockito.given(userRepository.save(BDDMockito.any()))
|
||||
.willReturn(User(name = "banjjoknim", email = "banjjoknim@github.com", phoneNumber = "010-1234-5678"))
|
||||
val request =
|
||||
CreateUserRequest(name = "banjjoknim", email = "banjjoknim@github.com", phoneNumber = "010-1234-5678")
|
||||
|
||||
userServiceBaseOnAnnotationEvent.createUser(request)
|
||||
|
||||
BDDMockito.then(eventPublisher).should(BDDMockito.times(3)).publishEvent(eventPublisherCaptor.capture())
|
||||
// 캡쳐한 이벤트는 순차적으로 저장되므로 아래와 같이 검증할 수도 있다.
|
||||
val events = eventPublisherCaptor.allValues
|
||||
Assertions.assertThat(events[0]).isInstanceOf(AdminAnnotationEvent::class.java)
|
||||
Assertions.assertThat(events[1]).isInstanceOf(CouponAnnotationEvent::class.java)
|
||||
Assertions.assertThat(events[2]).isInstanceOf(SenderAnnotationEvent::class.java)
|
||||
}
|
||||
}
|
||||
@@ -1,64 +0,0 @@
|
||||
package com.banjjoknim.playground.domain.user
|
||||
|
||||
import com.banjjoknim.playground.domain.event.AdminInheritanceEvent
|
||||
import com.banjjoknim.playground.domain.event.CouponInheritanceEvent
|
||||
import com.banjjoknim.playground.domain.event.SenderInheritanceEvent
|
||||
import org.assertj.core.api.Assertions.assertThat
|
||||
import org.junit.jupiter.api.BeforeEach
|
||||
import org.junit.jupiter.api.Test
|
||||
import org.junit.jupiter.api.extension.ExtendWith
|
||||
import org.mockito.ArgumentCaptor
|
||||
import org.mockito.BDDMockito.any
|
||||
import org.mockito.BDDMockito.given
|
||||
import org.mockito.BDDMockito.then
|
||||
import org.mockito.BDDMockito.times
|
||||
import org.mockito.Captor
|
||||
import org.mockito.Mock
|
||||
import org.mockito.junit.jupiter.MockitoExtension
|
||||
import org.springframework.context.ApplicationEvent
|
||||
import org.springframework.context.ApplicationEventPublisher
|
||||
|
||||
@ExtendWith(MockitoExtension::class)
|
||||
class UserServiceBaseOnInheritanceEventTest {
|
||||
|
||||
@Mock
|
||||
private lateinit var userRepository: UserRepository
|
||||
|
||||
@Mock
|
||||
private lateinit var eventPublisher: ApplicationEventPublisher
|
||||
|
||||
/**
|
||||
* 발행된 이벤트를 캡쳐해서 데이터를 저장할 수 있다.
|
||||
*
|
||||
* 이때, ApplicationEvent 를 상속받은 객체를 이벤트 객체로 사용하므로 ArgumentCaptor 의 제네릭을 ApplicationEvent 로 지정한다.
|
||||
*/
|
||||
@Captor
|
||||
private lateinit var eventPublisherCaptor: ArgumentCaptor<ApplicationEvent>
|
||||
|
||||
private lateinit var userServiceBaseOnInheritanceEvent: UserServiceBaseOnInheritanceEvent
|
||||
|
||||
@BeforeEach
|
||||
fun setup() {
|
||||
userServiceBaseOnInheritanceEvent = UserServiceBaseOnInheritanceEvent(userRepository, eventPublisher)
|
||||
}
|
||||
|
||||
/**
|
||||
* 아래와 같이 테스트는 작성할 수 있지만, 통합테스트를 돌려야 실제로 이벤트가 발행되고 이벤트 리스너가 이벤트를 처리하는 것을 확인할 수 있다는 한계점이 있다.
|
||||
*/
|
||||
@Test
|
||||
fun `회원 생성시 이벤트의 총 발행 횟수와 각각의 이벤트의 타입을 검사한다`() {
|
||||
given(userRepository.save(any()))
|
||||
.willReturn(User(name = "banjjoknim", email = "banjjoknim@github.com", phoneNumber = "010-1234-5678"))
|
||||
val request =
|
||||
CreateUserRequest(name = "banjjoknim", email = "banjjoknim@github.com", phoneNumber = "010-1234-5678")
|
||||
|
||||
userServiceBaseOnInheritanceEvent.createUser(request)
|
||||
|
||||
then(eventPublisher).should(times(3)).publishEvent(eventPublisherCaptor.capture())
|
||||
// 캡쳐한 이벤트는 순차적으로 저장되므로 아래와 같이 검증할 수도 있다.
|
||||
val events = eventPublisherCaptor.allValues
|
||||
assertThat(events[0]).isInstanceOf(AdminInheritanceEvent::class.java)
|
||||
assertThat(events[1]).isInstanceOf(CouponInheritanceEvent::class.java)
|
||||
assertThat(events[2]).isInstanceOf(SenderInheritanceEvent::class.java)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user