28장 - API 안정성을 확인하라

표준과 안정성

세상의 자동차의 운전법이 모두 다르다면 운전하기 전에 운전 방법을 계속 배워야 합니다.

이처럼 일시적으로 사용되는 인터페이스를 배우는 일은 귀찮은 일입니다.

따라서 운전 방법은 안정적이면서 표준적인 것이 좋습니다.

 

프로그래밍에서도

최대한 안정적이고 표준적인 API를 선호합니다.

하지만 좋은 API를 한 번에 설계할 순 없습니다.

API 제작자는 이를 계속해서 개선해나가기 원합니다.

 

보통은 이에대한 해결책으로 버저닝을 통해 관리합니다.

 

또한 사용자에게 API에 대한 정보를 제공하는 것도 중요합니다.

예를 들어 Experimental 메타 어노테이션을 붙이면 해당 요소가 안정적이지 않다는 것을 알려줍니다.

또한 Deprecated 어노테이션을 활용하여 해당 API를 통해 변경될 것을 미리 알려줍니다.

이때 직접적인 대안이 있다면, IDE가 자동으로 전환해 줄 수 있도록 RelaceWith를 붙여 주는 것도 좋습니다.

 

이제 사용자는 변경에 대응할 시간이 존재합니다.

널리 사용되는 API는 이런 적응 시간을 몇 년으로 잡기도 합니다.