[JAVA/웹] Annotation과 Reflections 라이브러리로 자바 빈 관리하기

[JAVA] Annotation과 Reflections 라이브러리로 자바 빈 관리하기

Java Annotation(자바 어노테이션)

어노테이션은 컴파일, 배포, 실행 시 참조할 수 있는 특별한 주석이라고 할 수 있다. 어노테이션을 사용하면 클래스, 필드, 메소드에 부가 정보를 등록할 수 있다.

어노테이션을 이용해서 웹 어플리케이션이 시작될 때 생성이 필요한 객체를 관리할 수 있도록 해보자.

 

어노테이션 정의

Component.java

/*어노테이션 유지 정책 - RetentionPolicy.RUNTIME:
* 클래스 파일에 기록됨
* 실행 시에 유지됨
* 실행 중 클래스에 기록된 어노테이션 값 참조 가능
* */
@Retention(RetentionPolicy.RUNTIME)
public @interface Component {
    String value() default "";
}

 

어노테이션은 위와 같이 정의한다.

어노테이션 문법은 인터페이스와 비슷하다.

interface 키워드 앞에 '@'가 붙는다.

인터페이스에서 메소드를 정의하는 것 처럼 어노테이션에서는 속성을 정의한다.

속성 중 value()는 속성 이름을 생략할 수 있다.

@Component(value="속성값") = @Component("속성값")

 

default 키워드로 속성의 기본값을 설정할 수 있다.

지금은 속성값을 지정하지 않으면 빈 문자열("")이 기본값이 되도록 하였다.

 

@Retention() - 어노테이션 유지 정책

어노테이션을 정의할때는 @Retention()으로 반드시 어노테이션의 유지 정책을 지정해야한다.

어노테이션 유지 정책은 어노테이션 정보를 언제까지 유지할것인지 설정하는 문법이다.

 

앞의 코드처럼 어노테이션 유지 정책을 RUNTIME으로 지정하면 실행 중에도 @Component 어노테이션의 속성값을 참조할 수 있다.

 

어노테이션 유지 정책	설명
Retention.SOURCE	소스 파일에서만 유지되고 컴파일 시 제거됨
Retention.CLASS (기본 정책)	클래스 파일에 기록되고 실행 시에는 유지되지 않음
Retention.RUNTIME	클래스 파일에 기록되고 실행 시에도 유지됨 실행 중 클래스에 기록된 어노테이션 값을 참조할 수 있음

 

어노테이션 적용

어플리케이션 시작 시 Component 어노테이션이 지정된 클래스의 객체를 준비하도록 할 것이다.

어플리케이션 시작 시 객체를 생성할 클래스에 어노테이션을 선언한다.

선언 방법은 클래스 선언부 위에 @어노테이션명("속성값")과 같이 작성해주면 된다.

 

@Component("/auth/login.do")
public class LogInController implements Controller, DataBinding {
...

 

컨트롤러에 서블릿 URL을 속성값으로 하여 어노테이션을 선언해주었다.

 

Reflections 라이브러리 준비

Reflections는 구글 코드 사이트에 등록된 오픈 소스 프로젝트이다. 이 라이브러리를 이용하면 자바 리플랙션 API보다 더 쉽고 편하게 클래스를 찾고 정보를 추출할 수 있다.

 

https://code.google.com/archive/p/reflections/downloads 에서 Reflections 라이브러리를 다운로드 받을 수 있다.

Downloads 페이지에서 reflections-0.9.9-RC1-uberjar.jar, reflections-0.9.9-RC1.jar 을 다운로드 받는다.

reflections-0.9.9-RC1.jar는 Reflections 라이브러리이고 reflections-0.9.9-RC1-uberjar.jar에는 의존 라이브러리들이 들어있다.

reflections-0.9.9-RC1.jar는 그대로 두고 reflections-0.9.9-RC1-uberjar.jar는 압축을 풀어둔다.

 

reflections-0.9.9-RC1.jar와 reflections-0.9.9-RC1-uberjar.jar 안의 jar파일들을 프로젝트에 추가해준다.

 

객체 생성 메소드 구현

웹 어플리케이션이 시작될 때 생성되는 클래스에 @Component 어노테이션이 붙은 클래스의 객체를 생성하는 메소드를 구현한다.

참고로 톰캣의 경우 웹 어플리케이션이 시작될 때 ServletContextListener 구현체의 contextInitialized() 메소드가 호출된다. 자세한 것은 아래 링크를 참고하자.

 

참고 : ServletContextListener로 DB 커넥션, DAO 공유 객체 관리하기

 

Map<String, Object> objTable = new Hashtable<>();
 
// 객체를 꺼낼 getter
public Object getBean(String key) {
    return objTable.get(key);
}
 
/**
 * classpath를 뒤져서 Component 어노테이션이 지정된 클래스를 찾은뒤 해당 클래스의 객체를 준비한다.
 * 생성된 객체는 객체 테이블에 담는다.
 * 오픈소스 라이브러리 Reflections 사용: 자바 리플랙션 API보다 사용하기 쉽고 편함
 * @throws Exception
 */
private void prepareAnnotationObjects() throws Exception {
    // Reflections 클래스는 원하는 클래스를 찾기 위해 사용
    // 파라미터값은 클래스를 찾을때 출발 패키지
    // "" -> classpath 모든 패키지 검색
    Reflections reflector = new Reflections("");
    // getTypesAnnotatedWith():
    // 파라미터값으로 넘긴 어노테이션이 붙은 클래스를 찾는다.
    // 반환값: @Component 어노테이션이 선언된 클래스 목록
    Set<Class<?>> list = reflector.getTypesAnnotatedWith(Component.class);
    String key = null;
    for(Class<?> clazz: list) {
        // getAnnotation(): 클래스로부터 어노테이션 추출
        key = clazz.getAnnotation(Component.class).value();
        objTable.put(key, clazz.getDeclaredConstructor().newInstance());
        System.out.println(clazz.getName() + "(" + key + ") -> 객체 준비 완료");
    }
}

결과 확인을 위해 출력문을 작성해두었다.

 

1) Reflections

Reflections 생성자에 넘겨주는 파라미터 값은 클래스를 찾을때의 출발 패키지이다. 파라미터 값이 "com.atoz_develop"이면 com.atoz_develop 패키지와 그 하위 패키지를 모두 찾는다. 빈 문자열을 넘기면 자바 classpath에 있는 모든 패키지를 찾는다.

 

2) getTypesAnnotatedWith()

이 메소드를 호출할때 어노테이션의 클래스를 파라미터로 넘겨 해당 어노테이션이 붙은 클래스를 찾을 수 있다.

getTypesAnnotatedWith(Component.class)와 같이 호출하면 @Component 어노테이션이 붙은 클래스를 찾는다.

반환값은 해당 어노테이션이 선언된 클래스 목록이다.

 

3) getAnnotation().value()

getAnnotation()을 통해 어노테이션을 추출한다.

어노테이션을 추출하면 해당 어노테이션에 정의된 메소드(속성)을 호출해서 속성 값을 꺼낼 수 있다.

Component 어노테이션에는 value() 속성이 정의되어 있으므로 value()를 호출해서 value()에 설정된 값을 꺼낼 수 있다.

이렇게 꺼낸 값을 key로 하여 필요한 곳에서 사용할 수 있도록 객체를 저장한다.

 

이제 톰캣을 구동하여 결과를 확인해보자.

 

위와 같이 톰캣 구동이 완료되면 Component 어노테이션을 선언한 클래스의 객체를 생성하는 메소드가 호출되며 객체가 준비된다.

 

이렇게 함으로써 웹 어플리케이션 시작 시 준비해야할 객체가 추가되면 @Component 어노테이션을 선언해주기만 하면 된다.