냉장고 가계부 프로젝트 35

Spring security 프레임워크에서 form login 방식으로 인증할 경우 Remember-Me 서비스를 제공할 수 있다. Remember-Me 서비스를 이용하면 쿠키에 인증토큰을 저장해두고 일정기간동안(default: 2주) 쿠키에 토큰이 있다면 인증처리를 해준다.
기본적으로 별도의 설정이 없다면 세션은 30분 만료시간으로 정해져있다.(WAS 마다 틀리다.)
세션 시간이 만료되면 세션에 저장된 정보가 날라가므로 다시 로그인을 해야한다.
Remeber-Me 기능을 이용하면, form login에서 인증을 성공적으로 진행하는 경우 임의의 인증토큰을 생성해서 쿠키에 저장해두고 쿠키가 만료되기 전까지 쿠키값을 확인해서 인증을 진행한다.
별도의 설정을 하지 않으면 in-memory 기반의 쿠키저장소를 이용해서 쿠키 토큰인증을 하며, JDBC같은 저장소를 별도로 사용할 수도 있다.
WebSecurityConfig 클래스에 다음과 같이 간단한 설정만으로 remember-me 기능을 추가할 수 있다.

@Configuration
@EnableWebSecurity
@RequiredArgsConstructor
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
    private final MemberUserDetailsService userDetailsService;
    
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/", "/signup").permitAll()
                .requestMatchers(PathRequest.toStaticResources().atCommonLocations()).permitAll()
                .anyRequest().authenticated()
                .and()
            .formLogin()
                .loginPage("/signin")
                .permitAll()
                .and()
            .logout()
                .logoutUrl("/signout")
                .permitAll()
                .and()
            .rememberMe()
                .and()
            .httpBasic();
    }
    
    ...
    
}

변경된 부분은 logout() 다음의 rememberMe() 메서드가 추가되었다는 점이다.
좀 더 디테일한 설정을 추가할 수 있지만, 일단 디폴트 설정으로 진행한다.
login Form 뷰에서 checkbox 태그를 작성하고 tag name값에 remember-me 를 입력한다.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" 
    xmlns:th="http://www.thymeleaf.org">
<head>
    <!-- Required meta tags -->
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />

    <!-- Bootstrap CSS -->
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous" />
    <!-- Font Awesome -->
    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css" integrity="sha384-mzrmE5qonljUremFsqc01SB46JvROS7bZs3IO2EmfFsd15uHvIt+Y8vEf7N7fWAU" crossorigin="anonymous" />
    <!-- Custom styles for this template -->
    <link th:href="@{/css/signin.css}" rel="stylesheet" />
    <title>Login</title>
</head>
<body class="text-center">
    <form class="form-signin" th:action="@{/signin}" th:method="POST">
      <h1 class="h3 mb-3 font-weight-normal">로그인</h1>
      <div class="alert alert-danger" role="alert" th:if="${param.error}">아이디 또는 비밀번호가 잘못되었습니다.</div>
      <div class="alert alert-danger" role="alert" th:if="${param.logout}">로그아웃되었습니다.</div>
      <label for="username" class="sr-only">이메일</label>
      <input type="email" id="username" name="username" class="form-control" placeholder="이메일를 입력하세요." required autofocus />
      <label for="password" class="sr-only">비밀번호</label>
      <input type="password" id="password" name="password" class="form-control" placeholder="비밀번호를 입력하세요." required />
      <div class="checkbox mb-3">
        <label>
          <input type="checkbox" name="remember-me" /> Remember me
        </label>
      </div>
      <button class="btn btn-lg btn-primary btn-block" type="submit">로그인</button>
      <p class="mt-5 mb-3 text-muted">&copy; 2018</p>
    </form>
</body>
</html>

checkbox 태그만 추가해주면 remember-me 폼파라미터 값으로 true가 전달될 경우 remember-me 서비스를 제공한다.

Remember me 체크박스를 체크한 후에 쿠키값을 확인하면 다음과 같이 remember-me 쿠키가 생성된것을 확인할 수 있다.

쿠키이름은 remember-me, value는 임의의 문자열해시값이다. 이 해쉬값은 아이디, 쿠키 만료시간을 문자열로 합쳐서 Base64로 인코딩한 문자열이다. 별도의 토큰 Key값을 주면 md5 해쉬로 아이디, 쿠키만료시간, 비밀번호, 키값으로 생성한다.
디폴트 설정이므로 쿠키 만료시간은 14Days(2주) 이다. 만료시간은 별도로 설정가능하다.

지금까지 fridge-web 프로젝트는 UI서버의 역할을 하며 fridge-service, fridge-member 서버와 Eureka 서비스를 이용해서 RestTemplate으로 통신했다.
RestTemplate 통신을 위해서는 RestTemplate 객체를 Application.class 파일에서 빌드해주고, restTemplate API를 이용해서 통신함으로 단순하지가 않다.

그렇다고 API클라이언트를 위한 RPC 모듈을 만드는것은 간단한 API통신을 위한 복잡성이 커지게 되기에 적합하지 않다.

Netflix Feign은 인터페이스와 간단한 설정만으로 다운스트림 서비스 클라이언트를 쉽게 생성할 수 있다.
(출처: O'REILLY - 클라우드 네이티브 자바[책만])

spring cloud 의 feign 의존성을 추가하기 위해 pom.xml 파일을 수정한다.

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

Application.class 파일에서 FeignClient를 사용하기 위한 @EnableFeignClients 애너테이션을 추가한다.

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class Application {
    
   ...

}

FeignClient는 Eureka를 통한 서비스 ID를 사용할 수 있고, 내부적으로 Netflix Ribbon 라이브러리로 로드밸런싱을 한다.
FeignClient를 작성하기위해서 다운스트림 서비스의 API 인터페이스를 작성한다. 먼저, fridge-member API부터 FeignClient로 작성한다.

@FeignClient(name="fridge-member")
@RequestMapping("/members")
public interface MemberClient {
    
    @GetMapping("/{username}")
    MemberRequest loadByUsername(@PathVariable("username") String username) throws MemberNotFoundException;
    
    @PostMapping
    MemberRequest register(MemberRequest memberRequest);
    
    @PutMapping("/{id}")
    MemberRequest changePassword(@PathVariable("id") long id, MemberRequest memberRequest);
    
    @DeleteMapping("/{id}")
    void withdraw(@PathVariable("id") long id);
    
}

MemberClient 이름의 자바 인터페이스를 생성하고, 클래스 선언부에 @FeignClient 애너테이션을 선언한다. name 값으로 fridge-member 서비스 ID를 대입한다.
나머지는 마치 fridge-member 프로젝트의 MemberController 클래스와 같이 컨트롤러 메서드의 시그니쳐들만 작성한다. 클래스 선언부에 @RequestMapping("/members") 애너테이션은 MemberClient 인터페이스 내부의 메서드들의 매핑 URL이 /members 로 동작함을 나타낸다.

loadByUsername 메서드는 MemberRequest 객체를 리턴타입으로 가지며, Get방식으로 통신하며 /members/{username} URL에 매핑되는 메서드이다. 메서드 파라미터로 PathVariable 문자열 username이 있다. 예외 MemberNotFoundException 을 던지는데, Member API 서비스에서 404 NotFound Exception 이 발생할 경우 MemberNotFoundException 이 발생하도록 설정한다.

나머지 메서드들도 MemberRestService 에서 RestTemplate으로 통신하던 것과 비교하면 매우 간단함을 알 수 있다.

FeignClient를 통해서 통신할 경우 에러 핸들링을 위해서 별도의 설정이 조금 필요하다.
우선 MemberNotFoundException 클래스는 다음과 같이 간단하게 구현한다.

public class MemberNotFoundException extends RuntimeException {
    private static final long serialVersionUID = 1L;

    public MemberNotFoundException(int status, String reason) {
        super(String.format("status %s reason %s", status, reason));
    }
    
}

RuntimeException 을 상속받고, 생성자로 int status, String reason 파라미터를 전달받는다.
status 변수는 HttpStatus 정수값을 나타내며, reason 변수는 에러 reason이 있는 경우 문자열로 전달받는다. 두 변수를 사용해서 간단한 에러 메시지를 부모 생성자에 전달한다.

Feign Client의 에러 핸들링을 위해서 feign.codec.ErrorDecoder 인터페이스를 구현한 구현클래스를 작성한다.

public class MemberFeignErrorDecoder implements ErrorDecoder {

    @Override
    public Exception decode(String methodKey, Response response) {
        if(response.status() == 404) {
            return new MemberNotFoundException(response.status(), response.reason());
        }
        return errorStatus(methodKey, response);
    }

}

MemberFeignErrorDecoder 클래스는 ErrorDecoder 인터페이스를 구현한다. 추상메서드 decode 메서드는 response.status 메서드를 이용해서 ResponseStatus HttpStatus 정수값을 바탕으로 error를 핸들링한다.
디폴트 설정으로 FeignException이 던져지는데, 여기서는 404에러일 경우에만 MemberNotFoundException 예외를 리턴하도록 한다.

Feign 에러 핸들링 클래스를 작성한 후 해당 설정을 위해서 application.yml 파일에 설정을 추가한다.

feign:
  client:
    config:
      fridge-member:
        errorDecoder: com.poseidon.config.MemberFeignErrorDecoder

fridge-member 부분은 각각의 FeignClient의 서비스 ID를 대입한다. ErrorDecoder 인터페이스를 구현한 구현클래스의 패키지 전체와 클래스명을 입력하면 된다.

이제 MemberRestService 를 사용하던 클래스들을 MemberClient를 이용하도록 모든 클래스에서 수정한다. MemberUserDetailsService 클래스는 다음과 같이 수정한다.

@Component
@RequiredArgsConstructor
public class MemberUserDetailsService implements UserDetailsService {
    private final MemberClient client;

    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        try {
            return client.loadByUsername(username).toMember();
        } catch(MemberNotFoundException ex) {
            throw new UsernameNotFoundException("could not found user by username: " + username);
        }
    }

}

기존의 MemberRestService 의존성은 MemberClient로 대체되고, client.loadByUsername 메서드가 호출되고 toMember메서드로 Member 객체로 반환한다.
client.loadByUsername 메서드는 MemberNotFoundException 예외가 발생할 수 있으므로, try-catch구문으로 감싸서 익셉션 발생시 UsernameNotFoundException 예외를 던지도록 처리한다.

MemberController 도 마찬가지로 MemberRestService 를 사용해서 통신하던것을 MemberClient로 대체한다.

@Controller
@RequiredArgsConstructor
@Slf4j
public class MemberController {
    private final PasswordEncoder passwordEncoder;
    private final MemberClient client;
    
    @GetMapping("/signup")
    public String signupForm(MemberRequest memberRequest, Model model) {
        model.addAttribute("memberRequest", memberRequest);
        return "members/signup";
    }
    
    ...
    
}

MemberClient를 의존성을 추가한뒤에 모든 MemberRestService 메서드 호출 부분을 FeignClient 인터페이스 메서드를 호출하도록 수정한다. 나머지 컨트롤러 메서드들도 전부 수정한다.

이런 방식으로 FridgeRestService, FoodRestService 클래스도 FeignClient를 이용하도록 인터페이스를 작성하고 수정한다.
전부 수정하고 나면 Application.class 파일에 RestTemplate Bean 설정부분은 사라진다.

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class Application {
    
    @Bean
    public LayoutDialect layoutDialect() {
        return new LayoutDialect();
    }
    
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

기존의 RestTemplate 을 사용하던것보다 코드의 양도 줄고 직관적으로 다운스트림 서비스를 호출할 수 있도록 변경되었다.

이전글: 냉장고 가계부 프로젝트 34
다음글: 냉장고 가계부 프로젝트 36

Developer K

이 블로그 검색

냉장고 가계부 프로젝트 35

태그

이 블로그의 인기 게시물

Dolphin 3

레거시 코드 활용 전략 - 마이클 C. 페더스

Dolphin 2