회원가입   로그인
IMG-LOGO
공지사항 :

자바 API(Application Programming Interface)

lmkfox - 2025-07-20 06:47:34 18 Views 0 Comment

1. 자바 API란?

  • API는 애플리케이션 개발에 필요한 기능을 모듈화한 것

  • 자바 API는 자바 표준 라이브러리에 포함된 클래스, 메서드, 패키지, 인터페이스 등의 집합

  • 예: java.lang.String, java.util.ArrayList, java.io.File 등

자바 개발자는 이미 만들어진 API를 호출하여 쉽게 프로그램을 개발할 수 있습니다.

2. 자바 API 문서(JavaDoc)란?

  • 공식 문서로 제공되는 자바 클래스/인터페이스/메서드의 설명서

  • Oracle에서 제공하며, 각 클래스의 용도, 생성자, 메서드 사용법 등을 자세히 설명

  • URL 예시 (Java 17 기준):

    https://docs.oracle.com/en/java/javase/17/docs/api/

3. API 문서 보는 법

JavaDoc 문서는 일반적으로 다음과 같은 구조로 되어 있습니다.

예: 

java.util.ArrayList

 API 페이지

(Oracle 공식 사이트에서 검색하거나 IDE에서 연결 가능)

주요 영역 설명

구역

설명

패키지(package)

클래스가 포함된 패키지 이름 (java.util)

클래스 설명

클래스가 어떤 기능을 하는지 간략 설명

상속 관계

어떤 클래스를 상속받았는지 (extends)

구현 인터페이스

어떤 인터페이스를 구현했는지 (implements)

생성자(Constructor)

객체를 생성하는 방법과 매개변수

메서드(Method)

사용 가능한 메서드 목록, 각 메서드의 반환 타입, 매개변수, 설명

필드(Field)

클래스에 정의된 상수나 변수

4. API 문서 예제: 

java.util.ArrayList

  • 클래스 선언:

public class ArrayList<E> extends AbstractList<E>
    implements List<E>, RandomAccess, Cloneable, Serializable

  • 생성자 예:

public ArrayList()
public ArrayList(Collection<? extends E> c)

  • 주요 메서드:

메서드

설명

add(E e)

요소 추가

get(int index)

특정 인덱스의 요소 반환

size()

요소 개수 반환

clear()

모든 요소 제거

remove(int index)

인덱스로 요소 삭제

  • 상속 및 인터페이스:

    • AbstractList를 상속받음

    • List, RandomAccess, Cloneable, Serializable 구현

5. Java API 문서 보는 팁

  • All Classes 또는 Class Index에서 찾고자 하는 클래스를 빠르게 검색 가능

  • 버전에 따라 메서드가 다를 수 있으므로, 자신이 사용하는 자바 버전의 API 문서를 참조하는 것이 중요

  • JavaDoc에서 제공하는 예제 코드를 잘 참고하면 메서드 활용법을 쉽게 익힐 수 있음

6. 자주 쓰는 주요 패키지

패키지 이름

설명

java.lang

기본 클래스 (String, Object, Math 등)

java.util

컬렉션, 날짜, 유틸리티 클래스

java.io

파일 및 입출력 처리

java.net

네트워크 관련

java.sql

데이터베이스 연동

javax.swing

GUI 구성 요소 (Swing)

7. IDE에서 API 문서 보는 법

IntelliJ IDEA:

  • 클래스 이름 위에 커서를 올리면 Javadoc 간략 정보 표시

  • Ctrl + Q (Windows) 또는 F1 (Mac) → 상세 JavaDoc 보기

Eclipse:

  • 클래스/메서드 위에 마우스를 올리면 툴팁으로 설명 제공

  • F2 → 자세한 문서 보기

8. 사용자 정의 JavaDoc 만들기

개발자가 직접 만든 클래스에도 JavaDoc을 작성할 수 있습니다.

/**
 * 이 클래스는 학생 정보를 담고 있습니다.
 * 이름과 나이를 저장할 수 있습니다.
 */
public class Student {
    private String name;
    private int age;

    /**
     * 이름을 반환합니다.
     * @return 학생의 이름
     */
    public String getName() {
        return name;
    }
}

  • javadoc 명령어로 HTML 문서 생성 가능:

javadoc -d doc Student.java

결론

자바 API와 그 문서는 자바 프로그래밍에서 가장 중요한 참조 자료입니다. 문서를 읽는 능력을 기르면 자바 표준 라이브러리를 더 효과적으로 활용할 수 있습니다.

실전에서는 JavaDoc을 적극 활용하여 클래스의 정확한 사용법과 메서드 기능을 이해하고 활용하는 것이 중요합니다.


댓글