API 도큐먼트 읽는 방법

목표 

• API 도큐먼트를 보고 활용할 수 있다.
• 자바에서 자주 사용하는 클래스를 알고 사용할수 있다. 

java.lang 패키지

java.lang 패키지는 자바 프로그램의 기본적인 클래스를 담고 있는 패키지이다. 그래서 java.lang 패키지에 있는 클래스와 인터페이스는 import 없이 사용할 수 있다.(대박적) 지금까지 사용한 String과 System 클래스도 사실 java.lang 패키지에 포함되어 있기 때문에 import 하지 않고 사용한 것이다. java.lang 패키지에 속하는 주요 클래스에 대해 알아보자.

 

java.lang 패키지에 속하는 주요 클래스와 간략한 용도를 먼저 살펴보면 다음과 같다.

 

 

클래스와 그 클래스에 소속된 메소드들을 무작정 외우려고 하지 말고 API 도큐먼트에서 찾아보고, 어떤 기능을 제공하는지 내용을 읽고 이해하는 것이 더 중요하다. 자바에서 제공하는 API는 무척 방대하기 때문에 모두 다룰 순 없다. API 도큐먼트를 잘 읽게 되면 언급하지 않았던 기능들도 알 수 있게 된다. API 도큐먼트를 잘 활용하는 것도 중요한 개발 능력이라고 수업때 선생님이 하신 말씀이 기억난다.

 

자바 API 도큐먼트

먼저, API(application Programming Interface)에 대해 알아보자. API는 라이브러리Library라고 부르기도 하는데, 프로그램 개발에 자주 사용되는 클래스 및 인터페이스의 모음을 말한다. 우리가 사용해왔던 String 클래스와 System 클래스도 모두 API에 속하는 클래스다.

 

방대한 자바 표준 API 중에서 우리가 원하는 API를 쉽게 찾아 이용할 수 있도록 도와주는 API 도큐먼트가 있다. API 도큐먼트는 HTML 페이지로 작성되어 있고, 오라클 DOCS를 방문하면 버전별로 볼 수 있다. (나의 경우엔 8버전을 보았다)

 

https://docs.oracle.com/javase/8/docs/api/index.html

Java Platform SE 8

 

 

보는 법은 왼쪽 상단의 패키지에서 java.lang 선택 후 하단에 클래스에서 String 등 원하는 클래스 명을 찾아서 눌러준다.

 

API 도큐먼트에서 클래스 페이지 읽는 방법

그렇다면 API 도큐먼트에서 발견한 클래스 페이지는 어떻게 읽을까?

 

최상단에 SUMMARY: NESTED | FIELD | CONSTR | METHOD 가 있는데, SUMMARY는 클래스 내에 선언된 멤버가 무엇이 있는지 알려준다. 링크가 있으면 해당 멤버가 있다는 것. 링크가 없으면 해당 멤버가 없다는 것이다.

 

가령, 스트링의 경우엔 NESTED를 제외한 멤버들의 링크가 존재했다. 

1. String 클래스는 NESTED에 링크가 없으므로 중첩 클래스나 중첩 인터페이스가 없다는 뜻이다. 반면에 FIELD, CONSTR, METHOD는 모두 링크가 있으므로 public 또는 protected로 선언된 필드, 생성자, 메소드는 있다는 뜻이다. 

 

2. 노란색으로 하이라이트된 1번 부분은 클래스의 선언부 이다. 클래스가 final 또는 abstract 키워드가 있는지 확인한다. String 클래스는 final 키워드가 있으므로 부모 클래스로는 사용할 수 없다는 것을 알 수 있다. 

 

 

그리고 extends 뒤에 언급된 부모 클래스가 무엇인지 보자. String 클래스는 Object를 상속받고 있다. 상속 관계에 있는 모든 클래스를 보려면 2번 부분의 상속 계층도를 보면 된다. 

 

마지막으로 implements 키워드 뒤에 언급된 인터페이스가 무엇인지 보자. String 클래스는 Serializable, Comparable<String>, CharSequence와 같이 3개의 이터페이스를 구현하고 있다. 

 

3. 클래스에 선언된 필드 목록을 본다. 1번에서 설명한 SUMMARY: NESTED | FIELD | CONSTR | METHOD에서 FIELD 링크를 클릭하면 필드 목록으로 이동한다. String 클래스에서 선언된 필드 목록은 아래와 같다.

 

Modifier and Type 컬럼에는 static 또는 protected 여부와 타입이 표시된다. Field와 Description 컬럼에는 필드 이름이 굵은 글씨로 표시되어 있고, 아래에는 필드에 대한 간단한 설명이 있다. 필드 이름을 클릭하면 상세 설명 페이지로 이동한다. 

 

4. 클래스에 선언된 생성자 목록을 본다. SUMMARY: NESTED | FIELD | CONSTR | METHOD 에서 CONSTR 링크를 클릭하면 생성자 목록으로 이동한다. String 클래스에서 선언된 메소드 목록은 아래와 같다.