다듬거나 나누거나

UsernamePasswordFilter 사용자 정의와 세션

수니모스 — Tue, 2 Mar 2021 19:58:48 +0900

Spring Security를 적용하다보면 제공되는 메소드만을 이용하는 프로젝트도 많지만 몇몇은 사용자 정의가 필요한 프로젝트가 있죠. 이번 글에는 UsernamePasswordFilter를 사용자 정의하며 겪었던 이슈사항에 대하여 작성하였습니다.

블로그에 작성된 코드는 샘플로 작성되어 내용 정리에 필요한 내용만 추려 담았습니다.

[이슈 사항]

세션을 1개로 유지하기 위해 sessionManagement().maximumSessions(1) 설정을 하였으나 제대로 적용되지 않는 현상 발생.

1. 설정을 위한 SecurityConfig 클래스 생성

Spring Security를 이용하기 위해 @EnableWebSecurity, @Configuration 어노테이션을 추가하여 클래스를 작성하였습니다. protected void configure(HttpSecurity) throws Exception 메소드의 내용은 추후 작성하기로 하고 테스트를 위해 inMemoryAuthentication()에 사용자를 추가하였습니다.

PasswordEncoder는 다른 설정에 추가하여 @Bean으로 선언한 상태입니다. 코드 간소화를 위해 Lombok을 사용합니다.

@Profile("security")
@RequiredArgsConstructor
@EnableWebSecurity
@Configuration
@Slf4j
public class SecurityConfig extends WebSecurityConfigurerAdapter {
  private final PasswordEncoder passwordEncoder;

  @Override
  protected void configure(HttpSecurity http) throws Exception {
    // TODO something...
  }
  
  @Override
  protected void configure(AuthenticationManagerBuilder auth) throws Exception {
    auth.inMemoryAuthentication()
      .withUser(new LoginUser("user1", passwordEncoder.encode("password1")))
      .withUser(new LoginUser("user2", passwordEncoder.encode("password2")));
  }
}

2. CustomUsernamePasswordFilter 클래스 생성

UsernamePasswordAuthenticationFilter를 확장한 CustomUsernamePasswordFilter를 작성합니다. 해당 클래스에는 내용은 없고 잘 들어왔는지 확인하기 위한 로그를 표시했습니다.

  public static class CustomUsernamePasswordFilter extends UsernamePasswordAuthenticationFilter {
    
    @Override
    public Authentication attemptAuthentication(HttpServletRequest request, HttpServletResponse response)
        throws AuthenticationException {
      
      // TODO something...
      log.info("checked");
      
      return super.attemptAuthentication(request, response);
    }
  }

3. CustomUsernamePasswordFilter 객체 생성

WebSecurityConfigurerAdapter에서 제공하는 authenticationManager() 메소드를 통해 AuthenticationManager를 할당하고 로그인 URL, 파라미터명 등을 설정했습니다. 성공 / 실패의 경우도 SimpleUrlAuthentication... 으로 생성하여 URL로 돌아갈 수 있도록 처리하였습니다.

  @Bean
  public UsernamePasswordAuthenticationFilter authenticationFilter() throws Exception {
    CustomUsernamePasswordFilter filter = new CustomUsernamePasswordFilter();
    filter.setAuthenticationManager(authenticationManager());
    filter.setRequiresAuthenticationRequestMatcher(new AntPathRequestMatcher(SecurityConstant.LOGIN_URL, "POST"));
    filter.setUsernameParameter("username");
    filter.setPasswordParameter("password");
    filter.setAuthenticationSuccessHandler(new SimpleUrlAuthenticationSuccessHandler(SecurityConstant.LOGIN_SUCCESS_URL));
    filter.setAuthenticationFailureHandler(new SimpleUrlAuthenticationFailureHandler(SecurityConstant.LOGIN_URL));
    
    return filter;
  }

4. configure 내용 추가

1. 에서 만들어 두었던 SecurityConfig 클래스의 protected void configure(HttpSecurity)에 아래 내용을 추가합니다. LOGIN_URL(GET)에는 단순히 username, password를 입력할 수 있는 페이지고 LOGIN_SUCCESS_URL은 권한이 있는 사용자만 접근할 수 있습니다. 세션은 하나만 유지되도록 maximumSessions(1)을 추가하였고 사용자 정의한 UsernamePasswordAuthenticationFilter를 등록하였습니다.

    final UsernamePasswordAuthenticationFilter authenticationFilter = authenticationFilter();
    
    http
      .addFilterAt(authenticationFilter, UsernamePasswordAuthenticationFilter.class)
      .exceptionHandling()
        .authenticationEntryPoint(new LoginUrlAuthenticationEntryPoint(SecurityConstant.LOGIN_URL))
        .and()
      .authorizeRequests()
        .antMatchers(SecurityConstant.LOGIN_SUCCESS_URL).hasRole(SecurityConstant.ROLE_USER)
        .and()
      .sessionManagement()
        .maximumSessions(1)
        .maxSessionsPreventsLogin(true)
    ;

5. 이슈의 발생

위와 같이 등록하고 프로젝트를 실행한 뒤 서로 다른 브라우저 2개를 열어 같은 아이디로 로그인을 시도하였습니다. 서로 다른 브라우저에서는 쿠키를 공유하지 않기 때문에 기본적으로 설정되어 있는 쿠키 기반 세션은 서로 다른 세션으로 인식할 것입니다. 당연히 MaximumSessions를 1로 설정하였기 때문에 뒤에 접속한 브라우저는 접속이 차단될 것으로 예상했으나 동작하지 않았습니다.

원하는 동작은 세션이 1개만 생성되고 다른 접근은 차단하는 것이기 때문에 수정이 필요한 상황입니다. 수정을 하기 위해 위의 현상이 왜 발생하는지 확인할 필요가 있습니다.

6. 이슈 원인 파악

6-1. Spring에서 제공하는 기본 동작 확인

우선 Spring에서 제공하는 formLogin() 설정을 하여 동작을 확인하였습니다. 아래의 코드를 protected void configure(HttpSecurity)에 추가하고 등록했던 CustomUsernamePasswordFilter를 주석으로 막고 실행해 보았습니다.

      .formLogin()
        .loginPage(SecurityConstant.LOGIN_URL)
        .loginProcessingUrl(SecurityConstant.LOGIN_URL)
        .defaultSuccessUrl(SecurityConstant.LOGIN_SUCCESS_URL)
        .failureUrl(SecurityConstant.LOGIN_SUCCESS_URL)
        .and()

2개의 브라우저에서 로그인 시 정상적으로 하나의 브라우저에서 로그인되고 다른 브라우저에서 로그인이 차단되는 것을 확인할 수 있습니다.

6-2. 내부에서 사용하는 UsernamePasswordFilter 설정 확인

formLogin() 메소드를 사용 시 FormLoginConfigurer 객체를 등록합니다. 그 안을 살펴보면 FormLoginConfigurer가 확장한 추상 클래스인 AbstractAuthenticationFilterConfigurer에서 내부에서 등록하는 UnsernamePasswordFilter의 설정이 있습니다. 아래의 코드에서 authFilter는 UsernamePasswordFilter 객체이며 setSessionAuthenticationStrategy(SessionAuthenticationStrategy) 메소드를 통해 세션 정책을 설정하는 것을 확인할 수 있습니다.

	@Override
	public void configure(B http) throws Exception {
		PortMapper portMapper = http.getSharedObject(PortMapper.class);
		if (portMapper != null) {
			authenticationEntryPoint.setPortMapper(portMapper);
		}

		RequestCache requestCache = http.getSharedObject(RequestCache.class);
		if (requestCache != null) {
			this.defaultSuccessHandler.setRequestCache(requestCache);
		}

		authFilter.setAuthenticationManager(http
				.getSharedObject(AuthenticationManager.class));
		authFilter.setAuthenticationSuccessHandler(successHandler);
		authFilter.setAuthenticationFailureHandler(failureHandler);
		if (authenticationDetailsSource != null) {
			authFilter.setAuthenticationDetailsSource(authenticationDetailsSource);
		}
		SessionAuthenticationStrategy sessionAuthenticationStrategy = http
				.getSharedObject(SessionAuthenticationStrategy.class);
		if (sessionAuthenticationStrategy != null) {
			authFilter.setSessionAuthenticationStrategy(sessionAuthenticationStrategy);
		}
		RememberMeServices rememberMeServices = http
				.getSharedObject(RememberMeServices.class);
		if (rememberMeServices != null) {
			authFilter.setRememberMeServices(rememberMeServices);
		}
		F filter = postProcess(authFilter);
		http.addFilter(filter);
	}

위의 내용을 통해 CustomUsernamePasswordFilter 객체에도 setSessionAuthenticationStrategy를 등록하면 세션 처리를 할 수 있는 것을 확인할 수 있었습니다. 'UsernamePasswordFilter에서 제공하는 메소드를 조금만 더 잘 살펴봤다면 내부의 내용을 확인하지 않고도 알 수 있었을텐데' 하는 아쉬움은 있었지만 이슈의 원인을 확인하여 이슈를 해결하기 위한 발판을 마련했습니다.

7. 이슈의 해결

7-1. 이슈 해결을 위한 고민

위의 내용대로 setSessionAuthenticationStrategy를 설정하면 되지만 언제나 그렇듯 이슈를 해결하기 위해 여러가지 고민이 생기게 됩니다.

SessionAuthenticationStrategy interface를 구현했을 때 들어가는 비용
SessionAuthenticationStrategy interface를 구현했을 때 누락할 수 있는 기능
protected void configure(HttpSecurity)에 설정한 내용의 활용성

우선 SessionAuthenticationStrategy interface를 구현할 경우, 소스 작성 시간 + 기본적으로 필요한 기능들에 대한 사전 조사 + 코드 검증 등이 필요할 것입니다. 또한, sessionManagement()에서 기본적으로 제공하는 안정적인 코드를 포기해야하는 이슈가 있습니다.

UsernamePasswordFilter은 새로운 기능을 추가하기 위해 확장했다고 하지만 기존에 제공하는 기능까지 새로 구현해야 하는지에 대한 의문이 드는게 당연하겠죠. SpringSecurity와 어플리케이션 통합이 원활하지 않을 것 같은 ~~느낌적인~~ 느낌이 드는 것도 있겠습니다.

7-2. 이슈 해결 방안

위처럼 많은 비용이 필요한 직접 구현 대신, SpringSecurity와 안정적인 통합을 할 수 있는 방안을 확인하기 위해 내부의 코드를 조금 더 살펴보기로 합니다. sessionManagement()에서 생성되는 SessionManagementConfigurer를 보면 아래와 같은 코드를 확인할 수 있습니다.

	private SessionAuthenticationStrategy getSessionAuthenticationStrategy(H http) {
		if (this.sessionAuthenticationStrategy != null) {
			return this.sessionAuthenticationStrategy;
		}
		List<SessionAuthenticationStrategy> delegateStrategies = this.sessionAuthenticationStrategies;
		SessionAuthenticationStrategy defaultSessionAuthenticationStrategy;
		if (this.providedSessionAuthenticationStrategy == null) {
			// If the user did not provide a SessionAuthenticationStrategy
			// then default to sessionFixationAuthenticationStrategy
			defaultSessionAuthenticationStrategy = postProcess(
					this.sessionFixationAuthenticationStrategy);
		}
		else {
			defaultSessionAuthenticationStrategy = this.providedSessionAuthenticationStrategy;
		}
		if (isConcurrentSessionControlEnabled()) {
			SessionRegistry sessionRegistry = getSessionRegistry(http);
			ConcurrentSessionControlAuthenticationStrategy concurrentSessionControlStrategy = new ConcurrentSessionControlAuthenticationStrategy(
					sessionRegistry);
			concurrentSessionControlStrategy.setMaximumSessions(this.maximumSessions);
			concurrentSessionControlStrategy
					.setExceptionIfMaximumExceeded(this.maxSessionsPreventsLogin);
			concurrentSessionControlStrategy = postProcess(
					concurrentSessionControlStrategy);

			RegisterSessionAuthenticationStrategy registerSessionStrategy = new RegisterSessionAuthenticationStrategy(
					sessionRegistry);
			registerSessionStrategy = postProcess(registerSessionStrategy);

			delegateStrategies.addAll(Arrays.asList(concurrentSessionControlStrategy,
					defaultSessionAuthenticationStrategy, registerSessionStrategy));
		}
		else {
			delegateStrategies.add(defaultSessionAuthenticationStrategy);
		}
		this.sessionAuthenticationStrategy = postProcess(
				new CompositeSessionAuthenticationStrategy(delegateStrategies));
		return this.sessionAuthenticationStrategy;
	}

위의 private SessionAuthenticationStrategy getSessionAuthenticationStrategy(H) 메소드는 public void init(H) 메소드에서 객체를 SharedObject로 등록하는데 사용됩니다. 이것을 이용하면 Spring Security와 자연스럽게 통합할 수 있다는 생각이 듭니다.

다행스럽게도 postProcess() 메소드를 호출하고 있습니다. postProcess() 메소드는 호출 시점에 등록되어 있는 모든 ObjectPostProcessor의 postProcess 메소드를 호출하게 됩니다. 다시 우리가 작성했던 SecurityConfig로 돌아와서 configure 메소드를 아래와 같이 수정합니다. addObjectPostProcessor() 메소드에 ObjectPostProcessor interface를 구현하여 우리가 생성한 filter에 Spring Security 내부에서 생성한 CompositeSessionAuthenticationStrategy를 할당합니다.

    final UsernamePasswordAuthenticationFilter authenticationFilter = authenticationFilter();
    
    http
//  formLogin() 동작 확인용
//      .formLogin()
//        .loginPage(SecurityConstant.LOGIN_URL)
//        .loginProcessingUrl(SecurityConstant.LOGIN_URL)
//        .defaultSuccessUrl(SecurityConstant.LOGIN_SUCCESS_URL)
//        .failureUrl(SecurityConstant.LOGIN_SUCCESS_URL)
//        .and()
      .addFilterAt(authenticationFilter, UsernamePasswordAuthenticationFilter.class)
      .exceptionHandling()
        .authenticationEntryPoint(new LoginUrlAuthenticationEntryPoint(SecurityConstant.LOGIN_URL))
        .and()
      .authorizeRequests()
        .antMatchers(SecurityConstant.LOGIN_SUCCESS_URL).hasRole(SecurityConstant.ROLE_USER)
        .and()
      .sessionManagement()
        .maximumSessions(1)
        .maxSessionsPreventsLogin(true)
        .and()
      .addObjectPostProcessor(new ObjectPostProcessor<CompositeSessionAuthenticationStrategy>() {
        @Override
        public <O extends CompositeSessionAuthenticationStrategy> O postProcess(O object) {
          CompositeSessionAuthenticationStrategy strategy = (CompositeSessionAuthenticationStrategy) object;
          
          authenticationFilter.setSessionAuthenticationStrategy(strategy);
          
          return object;
        }
      })
    ;

8. 결과 확인 및 정리

위의 환경과 동일하게 각각 다른 브라우저를 2개 올린 상태에서 로그인 시도 시 하나만 로그인이 되어 원하는 결과가 나타난 것을 확인하였습니다.

이번 이슈를 해결하며 빠른 해결을 위해 ObjectPostProcessor를 구현하여 등록하는 방향으로 수정했지만 HttpSecurity.apply(C) 메소드로 사용자 정의한 설정을 하는 방법도 있는 것 같습니다.

다음에 기회가 된다면 해당 코드를 통해 통합하는 방향을 확인해야겠어요.

개인적인 경험을 바탕으로 작성한 내용이기 때문에 내용 중 이상한 점이나 오류가 있을 경우 댓글 달아주시면 수정하도록 하겠습니다.

값 전달 방식(Call by value, Call by reference)

수니모스 — Thu, 30 Nov 2017 17:52:08 +0900

안녕하세요. 이번에 작성한 내용은 값 전달 방식(Call by value, Call by reference)에 대한 내용입니다.

코드를 작성하다보면 여러가지 메소드나 변수를 통해서 값을 주고 받으며 사용하게 됩니다. 그 때 메소드나 변수에 값이 전달되는 방식이 나뉘게 됩니다. 흔히 Call by value, Call by reference라고 부르는 것들이 그것이죠. 쉽게 설명하자면 Call by value는 값 자체를 전달하는 것이고 Call by reference는 참조해서 사용하도록 연결해주는 것입니다.

자바에서는 이 부분이 매우 쉽게 되어있습니다. 기본 형식(primitive type)으로 된 변수는 Call by value, 객체(Object)로 되어있는 것들은 Call by reference로 동작합니다. 아래의 코드를 보시죠.

1. ReferenceObject 형식 정의

package com.tistory.sunimohs;

public class ReferenceObject {
  public int value = 0;
}

2. 화면을 표시할 MainClass 정의

package com.tistory.sunimohs;

public class MainClass {
  public static void main(String[] args) {
    printStudy1();
    
    printStudy2();
  }
  
  public static void printStudy1() {
    int value1 = 0;
    int value2 = value1;
    
    ReferenceObject object1 = new ReferenceObject();
    ReferenceObject object2 = object1;
    
    value1 = 5;
    object1.value = 5;
    
    System.out.println("print study1 start");
    
    System.out.println("value1 : " + value1);
    System.out.println("value2 : " + value2);
    
    System.out.println("object1.value : " + object1.value);
    System.out.println("object2.value : " + object2.value);
    
    System.out.println();
  }
  
  public static void printStudy2() {
    int value = 0;
    ReferenceObject ro = new ReferenceObject();
    
    System.out.println("print study2 start");
    
    System.out.println("value : " + value);
    System.out.println("reference object value : " + ro.value);
    callByValue(value);
    callByReference(ro);
    System.out.println("value : " + value);
    System.out.println("reference object value : " + ro.value);
  }
  
  public static void callByValue(int value) {
    value = 5;
    
    System.out.println("callByValue value : " + value);
  }
  
  public static void callByReference(ReferenceObject referenceObject) {
    referenceObject.value = 5;
    
    System.out.println("callByReference value : " + referenceObject.value);
  }
}

위의 코드에서 printStudy1 메소드부터 살펴보도록 하죠. printStudy1 메소드에서 int 형 value1에 0값을 할당하고 value2에 value1을 할당합니다. 이 때 값 전달 방식은 기본 형식(primitive type)이기 때문에 Call by value와 같이 동작합니다. 값만 전달되는 방식이죠. 그 다음 ReferenceObject 형식 object1을 생성합니다. object2에 object1을 할당합니다. 이 때 전달 방식은 Call by reference와 같이 동작합니다. 아래는 printStudy1의 결과입니다.

print study1 start
value1 : 5
value2 : 0
object1.value : 5
object2.value : 5

순서대로 value1, value2, object1의 value, object2의 value를 출력하였습니다. 여기서 이상한 것을 보실 수 있는데요. value1과 value2가 값이 다르다는 것입니다. value2에는 value1을 할당하였으나 값만 전달되었기 때문에 value1에 5를 할당하여도 value2에는 변화가 없고 object2에는 동일한 방식으로 object1을 할당하였으나 값 참조로 전달하였기 때문에 같이 바뀌게 된 것입니다.

엄밀하게 말하면 '같이 바뀌었다.'라는 것은 맞지 않고 object1.value만 바뀌고 object2.value는 object1.value를 바라본다고 할 수 있겠네요. 값 참조라고 하면 뭔가 어려운 말로 들릴 수 있는데요. 이렇게 생각하시면 쉽습니다. object1에만 new ReferenceObject()를 통해 새로운 객체를 생성하였고 object2는 그 객체를 빌려서 사용하고 있다고요.

마찬가지로 printStudy2도 동작 방식이 비슷합니다. 바뀐건 변수에 전달하느냐 메소드의 인자로 전달하느냐의 차이입니다. printStudy2의 결과를 보시죠.

print study2 start
value : 0
reference object value : 0
callByValue value : 5
callByReference value : 5
value : 0
reference object value : 5

int 형 value를 callByValue 메소드의 인자로 보내고 메소드 내부에서 value에 5를 할당합니다. 결과 화면에서도 보이듯이 메소드 내부에서는 5가 표시됩니다. ReferenceObject 형 ro를 callByReference 메소드의 인자로 보내고 메소드 내부에서 인자로 온 ReferenceObject형 객체에 값을 할당합니다. 2개의 메소드 실행 후 메소드에 인자로 보냈던 값을 각각 출력하였습니다. 여기서도 위와 비슷한 현상을 보실 수 있습니다. callByValue 메소드의 인자로 보내진 value는 값만 전달되었기 때문에 메소드 내부에서 변경된 값이 밖까지 적용되지 않습니다. 이와 반대로 ro 객체는 참조로 전달되었기 때문에 메소드 실행 후에도 값이 그대로 남아있는 것을 보실 수 있습니다.

ReferenceStudy.zip

자바 제네릭(Generics)과 컬렉션(Collections)

수니모스 — Mon, 27 Nov 2017 10:17:00 +0900

안녕하세요. 이번 글은 자바의 제네릭과 컬렉션에 대하여 간결하게 작성하였습니다.

1. 자바 컬렉션(Java Collections Framework)

자바 컬렉션(Java Collections Framework)은 자료 구조를 사용하기 편하게 작성해놓은 클래스들의 집합이라고 보시면됩니다. 자료 구조를 배우려면 FIFO(First In First Out), LIFO(Last In First Out) 등으로 시작해서 여러가지 알고리즘과 head, body(data), tail 등으로 구성된 그림들을 많이 접해보셔야 할 것입니다. 자바에서는 이 모든 것을 간단하고 쉽게 사용할 수 있도록 구현되어 있습니다. 물론 위의 내용들이 필요없다는 것은 절대 아닙니다.^[각주:1] 많이 알수록 편한건 어딜가나 마찬가지죠. 자바 컬렉션에는 여러가지 인터페이스와 그를 구현한 클래스, 알고리즘 등이 포함됩니다.

2. 제네릭 (Generics)

제네릭은 자바 1.5버전에서 추가된 내용입니다. 현재는 1.5 미만의 버전을 쓰는 곳은 없을테니(있을리가...?) 무조건 포함된다고 보시면 되겠네요. 제네릭은 특정 형식 옆에 꺽쇠 기호(<>)로 추가되며 꺽쇠 기호 안에 특정 형식(type)을 지정하여 사용합니다. 제네릭으로 형식을 지정하면 지정한 형식의 데이터밖에 입력받을 수 없습니다. 왜 자바 컬렉션과 제네릭을 같이 설명하는지는 아래의 예제를 통해 살펴보도록 하겠습니다.

package com.tistory.sunimohs.study;

import java.util.ArrayList;
import java.util.List;

public class MainClass {
  public static void main(String[] args) {
    List noGenericsList = new ArrayList();
    List<String> strList = new ArrayList<>();
    
    noGenericsList.add("aaaaaa");
    noGenericsList.add(1111);
    
    strList.add("문자다");
    strList.add("알기쉬운 문장이다");
    
    try {
      for (int i = 0; i < noGenericsList.size(); i++) {
        // 제네릭을 지정하지 않아 어떤 데이터 형식인지 판단하려면 입력된 곳을 찾아가야 알 수 있다.
        String str = (String) noGenericsList.get(i);
        System.out.println("index [" + i + "] 데이터 : " + str);
      }
    } catch (Exception e) {
      System.out.println("오류가 발생하였다네..");
    }
    
    for (int i = 0; i < strList.size(); i++) {
      String str = strList.get(i);
      System.out.println("index [" + i + "] 데이터 : " + str);
    }
  }
}

위의 예제를 보면 제네릭을 지정하지 않은 List와 제네릭으로 String형식을 지정한 List를 각각 만들었습니다. 실행해보면 아래와 같은 결과가 나오며 제네릭을 사용하지 않은 곳은 오류가 발생함을 알 수 있습니다. 물론 예외를 발생시키기 위해 명시적으로 String 형식으로 타입 캐스팅을 하였지만 말이죠. 예제는 바로 위에 값을 저장하는 구문이 있어서 한 눈에 보이지만 코드가 길어지면 찾는 것도 많은 일이 될 것이 자명합니다(암요, 그렇고 말고요 ㅋㅋ).

index [0] 데이터 : aaaaaa
오류가 발생하였다네..
index [0] 데이터 : 문자다
index [1] 데이터 : 알기쉬운 문장이다

제네릭을 사용하면 위와 같은 불상사를 최소화할 수 있겠죠. 제네릭은 형식 선언부에는 꺽쇠(<>)안에 특정 형식을 넣고 객체 생성시에는 꺽쇠(<>)를 비워놓아도 됩니다. 꺽쇠를 비워두면 형식 선언에서 입력된 형식이 자동으로 할당되죠. 동일한 형식을 입력하는 불필요한 반복 동작을 자바에서 최소화 시켜줍니다.

ex) ArrayList<String> arrayList = new ArrayList<>();

3. Collections 클래스

지난 블로그 중 배열과 관련된 글에서 Arrays 클래스를 소개한 적이 있습니다. Collections 클래스도 자바에서 제공되는 유틸리티 클래스 중 하나인데요. 마찬가지로 다양한 기능들을 제공하고 있습니다. 제 블로그에서는 역순 정렬을 하는 메소드만 실행해보도록 하겠습니다. 기타 다른 기능은 자바 docs^[각주:2]에서 확인하실 수 있습니다.

package com.tistory.sunimohs.study;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class CollectionsStudy {
  private List<String> strings = new ArrayList<>();
  
  public CollectionsStudy() {
    strings.add("a");
    strings.add("b");
    strings.add("c");
    strings.add("d");
    strings.add("e");
    strings.add("f");
    strings.add("g");
  }
  
  public void printWithComma() {
    printWithComma(strings);
  }
  
  private void printWithComma(List<String> list) {
    System.out.print("print result : ");
    
    for(int i = 0; i < list.size(); i++) {
      String str = list.get(i);
      
      System.out.print(str);
      
      if (i + 1 < list.size()) {
        System.out.print(", ");
      }
    }
    
    System.out.println();
  }
  
  public void printReverse() {
    List<String> copyList = new ArrayList<>();
    
    for(String str : strings) {
      copyList.add(str);
    }
    
    Collections.reverse(copyList);
    
    printWithComma(copyList);
  }
}

위의 내용처럼 CollectionsStudy 클래스를 정의하고 MainClass에 아래와 같이 코드를 입력하여 실행해 보았습니다.

    CollectionsStudy cs = new CollectionsStudy();
    
    cs.printWithComma();
    cs.printReverse();

결과 화면은 아래와 같습니다.

print result : a, b, c, d, e, f, g
print result : g, f, e, d, c, b, a

Collections.reverse() 메소드를 통해 매우 간단하게 역순 정렬되는 것을 확인할 수 있었습니다.

소스가 필요하신 분은 링크를 클릭하여 다운 받으실 수 있습니다.

CollectionsStudy.zip

배움의 길은 끝이 없고 ... 쏼라쏼라... 하기 때문입니다. ^^; [본문으로]
https://docs.oracle.com/javase/8/docs/api/ [본문으로]

어노테이션(Annotation)

수니모스 — Fri, 13 Oct 2017 13:37:39 +0900

안녕하세요. 이번 글은 자바의 어노테이션에 관한 내용입니다.

자바의 코드를 보다보면 @가 붙은 내용들이 간혹 눈에 보이실텐데요. 이것이 어노테이션입니다.

어노테이션의 기본적인 목적은 자바의 메타데이터^[각주:1]로 사용하기 위함입니다. 어노테이션 작성법은 '접근 제한자 @interface 어노테이션명 { 내용 }'입니다. 다른 용도로도 많이 사용합니다만 예제에서는 메타데이터 용도만 살펴보겠습니다. 이제 예제로 만든 어노테이션을 통해 사용법을 알아보도록 하죠.

1. CustomAnnotation

package com.tistory.sunimohs.study;  import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target;  /**  * 커스텀 어노테이션<br/>  * Documented : javadoc으로 문서 생성 시 현재 어노테이션 설명 추가 <br/>  * Retention : 어노테이션을 유지하는 정책 설정<br/>  * Target : 어노테이션 적용 위치  *   * @author sunimohs  */ @Documented @Retention(RetentionPolicy.SOURCE) @Target(ElementType.FIELD) public @interface CustomAnnotation {   /**    * 어노테이션 기본 값 value()로 설정된 데이터는 '@어노테이션명(파라메터 값)'로 설정 가능하다.<br/>    * 그 외의 데이터는 '@어노테이션(파라메터 명 = 파라메터 값)'으로 사용    */   String value();      /**    * 'default 파라메터 기본 값'의 형식으로 작성 시 입력하지 않을 경우 기본 값 적용<br/>    * default를 지정하지 않을 경우는 무조건 입력받아야 함.    */   String comment() default ""; }

여기서 살펴보면 작성한 CustomAnnotation위로 @Documented, @Retention, @Target 이라는 어노테이션이 보이는데요. 이 어노테이션들은 자바에 포함되어있는 기본 어노테이션에 속해 있습니다.

하나씩 설명을 드리면 @Documented는 javadoc^[각주:2]으로 api 문서를 만들 때 어노테이션에 대한 설명도 포함하도록 지정해주는 것입니다.

@Retention은 어노테이션의 유지 정책을 설정하는 것인데요. 괄호 안에 RetentionPolicy 형식의 값을 할당할 수 있습니다. RetentionPolicy는 열거형(enum)^[각주:3]으로 되어있습니다. 선택할 수 있는 내용은 SOURCE, CLASS, RUNTIME 세 가지로 SOURCE는 말 그대로 소스까지 유지됩니다. 컴파일 시 사라지는 구조입니다. CLASS는 컴파일까지만 유지됩니다. 컴파일 후 생성되는 class 파일에는 남아있지만 자바가 실행되는 동안(runtime)에는 사용할 수 없습니다. RUNTIME은 자바가 VM에서 실행되는 동안에도 유지되는 것입니다.

@Target은 어노테이션을 적용할 수 있는 위치라고 보시면 됩니다. 배열로 입력할 수도, 하나만 입력할 수도 있습니다. 입력할 수 있는 형식은 enum ElementType입니다. TYPE은 클래스, 인터페이스, enum에 적용할 수 있습니다. FIELD는 말 그대로 필드(인스턴스 변수)나 enum의 상수에 적용할 수 있습니다. METHOD는 메소드에 적용가능합니다. PARAMETER는 파라메터에, CONSTRUCTOR는 생성자에, LOCAL_VARIABLE은 지역 변수에 적용 가능합니다. ANNOTATION_TYPE은 어노테이션에만 적용할 수 있게됩니다. PACKAGE는 패키지에만 적용됩니다. 너무 당연한 설명이라 제외해도 될 뻔 했네요 ^^;

이제 어노테이션의 내용을 어떻게 작성하는가에 대해 확인해보죠. 앞에 Retention등의 어노테이션을 사용하며 확인하셨을테지만 어노테이션을 특정한 곳에 사용할 경우에 받는 값들은 괄호 안에 작성하게 되어있습니다. 괄호안에 받는 값들은 어노테이션 내용에 메소드 정의만 작성하여 표기하죠. 위의 코드를 보시면 String value(); String comment() default "";가 보이네요. 위와 같이 작성할 경우 @CustomAnnotation을 사용할 때 @CustomAnnotation(value = "값", comment = "값")의 형식으로 입력받을 수 있습니다. 메소드 명이 어노테이션 괄호 안에 입력할 수 있는 변수 명이 되는 것이죠.

2. CustomAnnotation2

package com.tistory.sunimohs.study;  import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target;  /**  * default 지정하지 않은 어노테이션  */ @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface CustomAnnotation2 {   String value();   String comment(); }

이 어노테이션은 @Retention을 RUNTIME으로 잡고 String comment()의 default를 제외했습니다. 위의 어노테이션과 다른 점은 아래에 작성하도록 하겠습니다.

3. CustomAnnotation3

package com.tistory.sunimohs.study;  /**  * value() 사용 안 한 어노테이션  */ public @interface CustomAnnotation3 {   String[] values(); }

간단하게 작성해 보았습니다. 이 어노테이션에는 @Retention, @Target을 지정하지 않았습니다. @Retention은 지정하지 않을 경우 CLASS가 디폴트로 적용됩니다. 내용에는 String[] values();가 있네요.

4. AnnotationClass

어노테이션을 적용해보기 위해 생성한 클래스입니다.

package com.tistory.sunimohs.study;  /**  * 어노테이션을 적용한 변수들만 있는 클래스.  *   * @author sunimohs  */ public class AnnotationClass {   @CustomAnnotation("a")   private String a = "a";      @CustomAnnotation2(value = "b", comment = "설명을 쓰세요.")   private String b = "b";      @CustomAnnotation3(values = "")   private String c = "c";      @CustomAnnotation3(values = { "" })   private String d = "d"; }

여기보면 재미있는 것이 보이는데요. 이전에 @Retention, @Target의 괄호에 값을 입력할 때는 아무런 변수명을 입력하지 않고 바로 값만 넣었었죠? 여기에도 그런게 보이네요 a 변수를 보시면 @CustomAnnotation("a")라고 입력되어 있습니다. 이런게 가능한 것은 약속된 메소드를 사용하였기 때문인데요. String value()로 정의한게 바로 이 부분입니다. value()로 정의하게 되면 기본 입력으로 설정되어 아무런 변수명을 입력하지 않고도 입력이 가능합니다. 그리고 @CustomAnnotation에 정의했던 comment()는 default를 선언해 놓았기 때문에 아무런 값도 입력하지 않아도 됩니다. default에 입력했던 값이 적용되어 value = "a", comment = ""와 같은 의미가 됩니다.
@CustomAnnotation2는 comment()에 default를 정의하지 않았기 때문에 2개의 항목을 다 입력해야합니다.
@CustomAnnotation3는 values()로 value()를 사용하지 않았기 때문에 하나만 입력해도 변수명을 적어야하네요.
d 변수를 보면 @CustomAnnotation3의 values에 배열을 담았습니다. String[] values()가 배열을 입력받을 수 있기 때문인데요. 배열일 경우 하나만 입력할 때는 {} 중괄호를 제외하여 표시하여도 관계없습니다.

5. MainClass

어노테이션이 컴파일 시 어떻게 되는지 알아볼 메인 클래스입니다.

package com.tistory.sunimohs.study;  import java.lang.reflect.Field;  /**  * 어노테이션 테스트 메인 클래스  *   * @author sunimohs  * @since 2017. 10. 10.  */ @CustomAnnotation3(values = "") public class MainClass {   public static void main(String[] args) {     AnnotationClass ac = new AnnotationClass();          try {       Class<? extends AnnotationClass> acCls = ac.getClass();              Field a = acCls.getDeclaredField("a");       Field b = acCls.getDeclaredField("b");       Field c = acCls.getDeclaredField("c");       Field d = acCls.getDeclaredField("d");              if (a.isAnnotationPresent(CustomAnnotation.class)) {         System.out.println("a 필드 어노테이션 확인");       } else if (b.isAnnotationPresent(CustomAnnotation2.class)) {         System.out.println("b 필드 어노테이션 확인");       } else if (c.isAnnotationPresent(CustomAnnotation3.class) || d.isAnnotationPresent(CustomAnnotation3.class)) {         System.out.println("c 혹은 d 필드 어노테이션 확인");       }     } catch (Exception e) {       e.printStackTrace();     }   } }

AnnotationClass객체에서 class를 가져와 a, b, c, d 필드 객체를 가져옵니다. 각각 a, b, c, d 필드 객체에 CustomAnnotation, CustomAnnotation2, CustomAnnotation3이 적용되어있는지 확인하고 System.out.println() 메소드를 통해 표시합니다. 결과는 아래와 같습니다. 위에서 말한 바와 같이 Retention이 RUNTIME으로 지정된 CustomAnnotation2만 확인이 되네요.

b 필드 어노테이션 확인

첨부파일

0.00MB

https://ko.wikipedia.org/wiki/%EB%A9%94%ED%83%80%EB%8D%B0%EC%9D%B4%ED%84%B0 [본문으로]
http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html, 자바에서 지정한 형태의 주석들을 인식하여 html로 된 api 문서 형태로 만들어주는 도구입니다. [본문으로]
https://docs.oracle.com/javase/tutorial/java/javaOO/enum.html, 같은 의미로 사용되는 상수를 여러개 묶어서 사용할 수 있도록 정의하는 형식. 예) 요일은 월, 화, 수, 목, 금, 토, 일로 일정하기 때문에 고정 값인 상수로 지정해서 사용하면 편하다. [본문으로]