[이펙티브 자바] Item06 완벽공략. Deprecation

item06. 불필요한 객체 생성을 피하라. 

" p31. 사용 자제 API (Deprecation)"

 

 

Deprecation

자바 API에서 종종 메서드 위에 @Deprecated 가 표기된 코드들을 확인할 수 있다. 

이게 표기된 클래스나 메서드가 있다면 앞으로는 사용하지 않는게 좋은데

그 이유는 어떤 이유로든 앞으로 사라지게 될 메서드로 사용 자제하며 다른 메서드 사용을 권장하는 경우가 많은데 혹시 몰라서 삭제를 바로 하는게 아니라 @Deprecated 어노테이션을 통해서 예고?를 해준다고 할 수 있다. 

 

 

@Deprecated 

: 클라이언트가 사용하지 않길 바라는 코드 위에 이 어노테이션을 사용해주면 컴파일 시 경고 메시지를 통해 사용 자제를 권장하는 API라는 것을 클라이언트에게 알려줄 수 있다. 

 

public class Deprecation
{


   @Deprecated(forRemoval = true, since = "1.2")
   public Deprecation()
   {
   }
   
   private String name;
   
   public Deprecation(String name)
   {
      this.name = name;
   }
}

예제로 원래는 Deprecation 객체를 생성할 때 기본 생성자를 통해 객체 생성이 가능했다면 이제는 무조건 name을 받도록 하고 싶다면 

기본 생성자에 @Deprecated 어노테이션을 붙여서 사용자제할 수 있도록 한다. 

그러면 클라이언트에서 해당 코드를 사용하려고 하면 경고 메시지를 통해 사용 자제를 권장하는 API라고 알려준다. 

 

여기에 더해서 Java 9부터 등장한 것으로 forRemoval 옵션을 사용하면 더 강력하게 사용하지 말라고 알려줄 수 있는 옵션으로 이제 곧 사라질 메서드라고 알려준다! 

이  옵션을 사용하면 

이렇게 빨간줄로 표기되는 것을 알 수 있다. 

 

 

 

@deprecated 

: 문서화 javadoc 에 사용하는 어노테이션으로 왜 해당 API 사용을 지양하며, 그 대신 권장하는 API가 어떤 것인지 표기하여 다른 사람이 더 쉽게 알수 있도록 할 수도 있다. 

 

public class Deprecation
{
   /**
    * @deprecated in favor of
    * {@link #Deprecation(String)}
    */
   // TODO 애노테이션 프로세서
   // forRemoval 옵션을 사용하면 더 강력하게 알려주는 것!
   @Deprecated(forRemoval = true, since = "1.2")
   public Deprecation()
   {
   }
   
   private String name;
   
   public Deprecation(String name)
   {
      this.name = name;
   }
}

/** */ 주석안에 표기된 것처럼 나타내면 

 

javadoc에서 deprecated된 메서드를 바로 알 수 있고, 왜 해당 api를 사용하면 안되며, 대신 권장하는 api는 뭔지도 확인할 수 있다.