[Java] 자바 API 문서

API 문서

라이브러리

 

라이브러리의 사전적 의미는 도서관이다. 도서관은 다양한 책들이 모여있는 곳이고, 필요한 책이 있을 때마다 방문해서 꺼내어 본다. IT 분야에서 라이브러리도 비슷한 개념이다. 다양한 코드들이 모여있는 집합이고, 개발 중 필요한 기능이 있다면 라이브러리에서 얻을 수 있다. 세계에서 가장 큰 도서관인 미국의회 도서관과 같이 IT 분야의 라이브러리도 미국의회 도서관만큼이나 많다. 따라서 필요한 기능이 있을 때 라이브러리를 활용할 수 있어야 한다.

 

자바  API

자바도 라이브러리를 제공한다. 자바에서는 라이브러리나는 이름 대신 API(Application Programming Interface)란 용어를 사용한다. 자바 API는 자바 클래스 파일(*.class)들로 구성되어 있다. Java SE에서 제공하는 API는 자바 프로그램을 개발하기 위해 설치한 JDK에 포함되어 있다. Java SE의 API는 JDK 설치 폴더 하위의 jmods 폴더에 jmod 파일 형태로 저장되어 있다. jmod 파일은 자바 9에서 도입된 모듈 파일이다. 모듈은 관련 있는 여러 개의 자바 패키지를 하나로 묶어놓은 단위이다. 모듈을 구성하는 패키지들에는 여러 개의 자바 클래스 파일(*.class), 즉 API가 존재한다.

 

오라클에서는 자바에서 제공하는 API를 편하게 사용할 수 있도록 API 문서를 제공한다. 참조하려면 검색 사이트에서 'java11 api docs'와 같은 키워드로 검색한다. (JAVA11 API DOCS 링크) 자바 프로그램을 구현할 때 사용되는 기본적인 기능이 구현된 모듈은 java.base이다. java.base 모듈에서 자주 사용하는 패키지는 아래와 같다.

 

패키지 이름	기능
java.io	외부 데이터 입출력을 처리하는 기능이다.
java.lang	프로그램 개발 시 기본적으로 필요한 기능이다.
java.util	날짜, 시간, 컬렉션 처리에 관한 기능이다.

 

생성자

자바 API를 사용하려면 해당 클래스의 인스턴스를 생성해야 한다. 인스턴스를 생성하려면 해당 클래스에 어떤 생성자가 있는지를 알아야 한다. API문서에서 생성자를 확인하려면 문서의 상단메뉴에서 [CONSTR]를 선택한다. java.base 모듈에서 java.lang 패키지의 String 클래스 생성자를 봐보자. new String() 또는 new String("str") 등 여러 생성자 중 원하는 형식의 생성자를 사용하여 인스턴스를 생성할 수 있다. 

 

 

필드

자바 객체(클래스, 인터페이스)는 필드를 가질 수 있다. 객체의 필드를 확인하고 싶다면 메뉴에서 [FIELD]를 선택한다. java.lang 패키지의 Math 클래스를 봐보자. Math 클래스에는 static double 타입의 필드 E와 PI가 선언되어 있다. 필드 이름을 클릭하면 자세한 내용을 확인할 수 있다. E를 클릭해보면 public static final double로 선언되어 있다. public은 공개 멤버를 의미하며 static은 공유 멤버, final은 불면, double은 타입을 지정한 것이다.

 

 

메서드

일반적으로 프로그램을 개발하며 필요한 기능이 있을 때 무조건 새로 개발하는 것이 아니라, 먼저 내가 필요한 기능을 가진 API가 있는지를 살펴보고 있다면 가져다 사용한다. 자바 API는 기능 구현을 메서드로 하므로 API의 메서드를 자주 활용한다. 자바 API는 누군가가 만들어서 제공하므로 메서드를 사용하려면 메서드 정보를 충분히 알아야 한다. 이 때 참고하는 것이 API 문서다. 선택한 객체에 구현된 메서드를 확인하려면 메뉴에서 [METHOD]를 선택한다. 

 

 

메서드에 대한 자세한 설명을 원하면 메서드 이름을 클릭한다. 아래 사진을 참고하면 abs는 메서드 이름, 그 아래는 메서드 기능, parameters 부분은 매개변수, returns 부분은 반환값을 나타낸다. 메서드를 사용하려면 선언부의 형식에 맞게 사용하고 리턴값이 있을 땐 리턴값을 받아 처리해주어야 한다.