레이블이 annotation인 게시물을 표시합니다. 모든 게시물 표시
레이블이 annotation인 게시물을 표시합니다. 모든 게시물 표시

2015-01-07

[Scala] 함수의 상속 가능성을 deprecated 시키기

 흠.... 블로거로 옮기고 나서 글을 쓰기 시작한 지 1년이 지나가는데, 이렇게 써도 되는지 고민되는 글은 처음이다. 사실 블로거로 옮기기 전에 폭파한 블로그가 2개인가 3개인가 있는데 당시에는 글을 써도 되는지 고민 없이 막 썼었다. 아는 게 없어 용감했었나 보다. 근데 어느 정도 아는 게 생기고 나니 혹시 나로 인해 잘못된 내용을 배워가는 사람이 있을까봐 최대한 정석에 가까운 내용만을 쓰려고 노력했다. 근데 이번에 쓸 글은 어떻게 봐도 편법에 해당하는 내용이다. 그래서 아래와 같은 경고로 글을 시작하겠다.

경고: 지금부터 설명할 방법은 권장되는 방법이 아닌 hacky한 방법입니다. 사용함으로 인해 생기는 문제는 책임지지 않습니다.

 지난번 글에서 deprecated annotation을 이용해서 API를 변경하는 방법을 설명했었다. 이번에 설명할 내용은 function prototype은 변경하지 않고 클래스의 상속 가능성을 deprecate 시키는 것에 관한 내용이다.

 Scala에는 sealed modifier나 final modifier를 이용해서 함수의 상속성을 제한하는 기능이 있다. 이 두 modifier에 대해서 간단하게 설명하면 sealed modifier는 다른 파일에서는 해당 클래스를 상속 못하게 막는 modifier이고, final modifier는 클래스를 상속 못하도록 하거나 함수의 override를 막아주는 modifier이다. 즉, API로 제공되던 클래스에 sealed나 final을 붙이거나 함수에 final을 붙이면 상속할 수 있던 클래스나 override할 수 있던 함수를 상속 불가능하게 만들게 된다. 이런 상황에서 쓰기 위해 설계되었던 것이 annotation이 deprecatedInheritance과 deprecatedOverriding이다.

 원래 deprecatedInheritance와 deprecatedOverriding는 Scala 2.10에 들어갈 예정이었다. 하지만 디자인 이슈를 결정하지 못하고 방황하는 사이에 2.10을 출시할 일정이 다가왔고 결국 구현체는 있지만, API로는 공개되지 않은 채 2.10이 출시되게 되었다. 따라서 정상적인 방법으로는 Scala 2.10이나 Scala 2.11에서 이 두 annotation을 사용할 방법은 없다.

 하지만 상속 가능성을 deprecate 시키는 기능은 라이브러리 제작자라면 포기하기 아까운 기능이다. 가장 좋은 것은 이 기능이 Scala 라이브러리에 정식으로 반영되기를 기다리는 것이지만, 만약 어떻게든 지금 당장 사용하길 원한다면 다음과 같은 비정상적인 방법을 써야 한다.

 현재 이 두 annotation은 scala package에 private으로 되어있다. 따라서 scala라는 이름의 package object를 만들고 그 안에서 DeprecatedInheritanceDeprecatedOverriding라는 public 한 새로운 type을 만드는 것으로 scala package 밖에서도 두 annotation을 사용할 수 있게 된다.

 하지만 시작부터 경고하며 시작했듯이 이는 hacky한 방식이다. 언제 이름이 바뀔지 모르고, 심지어 운이 없다면 언제 사라질지도 모르는 기능이다. 거의 편법에 한없이 가까운 방식이므로 사용할지 말지는 알아서 판단해서 선택해야 한다.

Scala annotation

2015-01-06

[Scala] deprecated annotation - 호환성을 보장하며 API 수정하기

 크게는 구조의 변경을 위해서부터, 작게는 오타 수정까지 API를 수정할 일은 많이 있다. 하지만 API를 변경하는 것은 복잡하고, 오래 걸리고, 어려운 일이다.

deprecated

 API를 변경한다고 해서, 전에 사용하던 API를 바로 지우면, 그전 API를 사용하는 사람들이 급격하게 코드를 바꿔야 한다. 반대로 지우지 않고 2개의 API를 둔다면, 전 API를 사용하던 사람이 코드를 고치지 않을 뿐 아니라, 새로 코드를 작성하는 코드에도 사용하지 않아야 하는 API를 사용하게 돼서 결국 2벌의 코드를 유지 보수해야 한다. 이런 상황에서 사용하는 것이 deprecated annotation이다.

 위의 예제와 같이 deprecated annotation을 붙이면 해당하는 함수를 호출하는 코드를 컴파일할 때, 컴파일은 되지만 경고 메시지를 출력해준다. 게다가 내부적으로 Java의 Deprecated annotation을 더해주기 때문에, 자바 코드에서 deprecated 된 스칼라 함수를 호출해도 경고 메시지가 출력된다.
 사실 Scala의 deprecated annotation은 Java의 Deprecated annotation과 에러 메시지와 version을 정해줄 수 있다는 것 외에는 큰 차이가 없다. 그렇기에 Scala는 다른 annotation을 더 지원한다.

deprecatedName

 함수의 type signature를 바꾸는 일만큼, 함수의 type signature는 그대로 두고, 함수 인자의 이름만 바꿔야 하는 일도 많이 생긴다. 그 이유는 다양한데 기존에 사용했던 이름이 부적절했기 때문일 수도 있고, 함수의 동작이 바뀌면서 넘겨야 하는 인자가 변했지만, 우연히 타입은 같은 경우였을 수도 있다.
 Java는 named parameter를 지원하지 않기 때문에 인자의 이름만 변경하는 경우가 문제 되지 않는다. 하지만 Scala처럼 named parameter를 지원하는 언어에서는 함수의 이름을 바꾸는 것도 문제가 될 수 있다. 이럴 때 사용하기 위한 것이 deprecatedName이라는 annotation이다.  deprecatedName을 이용하면 아래와 같이 새 이름과 deprecated 된 이름 모두 쓸 수 있다. deprecated 된 이름을 쓰면 컴파일 시 경고 메시지를 출력하지만, 성공적으로 컴파일 된다.


 처음 코드를 작성할 때 수정할 일이 없도록 코드를 작성하는 것이 가장 좋겠지만, 현실적으로 그런 것은 불가능하다. 그래서 Scala를 이용해 라이브러리를 작성할 때는 deprecated annotation을 이용해서 하위 호환성을 보장하며 코드를 수정하고 적당한 시기에 deprecated 된 코드를 지운다.
 deprecated 된 코드를 오래 들고 있을수록 라이브러리를 사용하는 사람에게는 변화를 반영할 여유를 주게 되지만, 라이브러리를 작성하는 입장에서는 쓸데없는 짐을 지고 가는 것이기도 하다. 그래서 일반적인 라이브러리 개발의 경우 major version up 혹은 minor version up에서 deprecated 된 부분을 지우는 것이 일반적이지만, in-house 개발일 경우 deprecated annotation을 사용하지 않고 바로 코드를 지우기도 한다. deprecated 된 코드를 언제 지우는가는 전적으로 개발자가 프로젝트의 성격을 보고, 라이브러리를 사용하는 목적을 보고 적절히 선택해야 한다.

Scala annotation