주석문, 예외처리, enum

주석문

 

프로그래밍 실행과는 상관 없는 문장으로 프로그램에 설명을 붙이기 위해 사용한다.

 

자바의 주석문

주석기호	설명
//	//부터 시작해서 줄 끝까지 주석처리
/* ... */	/*와 */ 사이의 내용이 모두 주석처리
/** ... */	/**와 */사이의 내용이 모두 주석처리 JavaDoc 주석문

 

JavaDoc 주석문에서 사용하는 태그들

annotation	설명
@version	클래스나 메소드의 버전
@author	작성자
@deprecated	더이상 사용되지 않거나, 삭제될 예정
@since	언제 생성, 추가, 수정되었는가?
@see	외부 링크나 텍스트, 다른 필드나 메소드 링크시 사용
@link	see와 동일 기능. 링크 제공
@exception	발생할 수 있는 Exception 정의

 

IntelliJ에서 JavaDoc 생성하는 방법

1. shif키를 2번 연속 누른다.

2. generate javaDoc을 입력한다.

3. custom scope를 선택한 후 JavaDoc을 생성할 패키지, 클래스, 인터페이스 등을 선택한다.

4. output directory에서 JavaDoc이 생성할 경로를 지정한다.

5. other command line arguments에는 다음을 입력한다

-encoding UTF-8 -charset UTF-8 -docencoding UTF-8

6. OK 버튼을 클릭한다.

 

주석문을 잘 작성하는 방법은?

 

주석문이 없어도 이해할 수 있는 클래스, 메소드, 변수를 작성한다.

주석문은 최소로 작성하고, javaDoc주석문을 잘 작성하면 된다.

 

---

예외처리

 

Error의 종류

컴파일 에러: 컴파일시 발생하는 에러

런타임 에러: 실행시 발생하는 에러

 

자바에서는 실행시 2가지 형태의 오류가 발생할 수 있다.

Error: 수습할 수 없는 심각한 오류

Exception: 예외 처리를 통해 수습할 수 있는 덜 심각한 오류

메모리 부족, 스택오버플로우 등이 발생하여 프로그램이 죽는 것은 프로그래머가 제어할 수 없다.

 

예외처리란?

public class Exception1 {
    public static void main(String[] args) {
        ExceptionObj1 exobj = new ExceptionObj1();
        int value = exobj.divide(10,0);
        System.out.println(value);
    }
}

class ExceptionObj1{
    public int divide(int i, int k ){
        int value =0;
        value= i/k;
        return value;
    }
}

0으로 나눌 수 없으므로 ArithmeticException 오류가 발생한다. 이때, 예외처리를 해줘야한다.

try{
      코드1
      코드2
      .....
}catch(Exception클래스명1 변수명1){
		Ecception 처리 코드
}

class ExceptionObj1{
    public int divide(int i, int k ){
        int value =0;
        try {
            value = i / k;
        }catch(ArithmeticException ex){
            System.out.println("0으로 나눌수 없다.");
            System.out.println(ex.toString());

        }
        return value;
    }
}

실행결과
0으로 나눌수 없다.
java.lang.ArithmeticException: / by zero
0

이때, 2가지 문제가 있다.

실제로 0으로 나눌 수 없는데, 0을 return 해줬다. 잘못된 결과를 나타낸 것이므로 이것은 에러발생 보다 못한 결과라고 볼 수 있다. 

사용자가 원하지 않는 메소드를 출력하고 있다.

"0으로 나눌수 없다.
java.lang.ArithmeticException: / by zero" 

이 두 줄은 사용자가 원하는 결과가 아닐 것이다.

---

예외 떠넘기기(throws)

 

리턴타입 메소드명(아규먼트 리스트) throws Exception클래스명1, Exception클래스명2...{
	코드1
        코드2
        ....
}

public class Exception1 {
    public static void main(String[] args) {
        ExceptionObj1 exobj = new ExceptionObj1();
        try {
            int value = exobj.divide(10, 0);
            System.out.println(value);
        }catch (ArithmeticException ex){
            System.out.println("0으로 나눌 수 없습니다.");
        }

    }
}

class ExceptionObj1{
    public int divide(int i, int k ) throws ArithmeticException{
        int value =0;
        value= i/k;
        return value;
    }
}

실행결과
0으로 나눌 수 없습니다.

0으로 나눌 수 없다는 것은 value에 값이 들어가면 안된다는 말이다.

System.out.println(value); 이부분이 실행되지 않은것이고, 클래스를 사용하는 쪽에서 Exception처리를 함으로써

앞 예제보다 문제 없는 코드라고 할 수 있다.

 

RuntimeException: RuntimeException 클래스를 상속받으면 다  RuntimeException이다. 예외처리를 하지 않아도 컴파일 된다.

CheckedException:RuntimeException클래스를 상속받지 않는 나머지는 다 CheckedException이다. 반드시 예외처리를 해줘야 한다.

 

Tip

Exception클래스를 만든다면 RuntimeException 클래스를 상속받는게 좋다. CheckedException이 많아지면 처리할 것이 너무 많아지고, 사용자가 불편하다.

 

상속관계에 RuntimeException 없으므로 CheckedException

main메소드에 떠넘기기를 하면 종료된다. 즉, 무책임한 행동! main메소드에 떠넘기기는 지양하자!

import java.io.FileInputStream;
import java.io.FileNotFoundException;

public class Exception4 {
    public static void main(String[] args) throws FileNotFoundException{
            FileInputStream fis = new FileInputStream("Exception4.java");

    }
}

---

 

public class Exception6 {
    public static void main(String[] args) {
        int[] array = {4,2};
        int[] value = null;
        try{
            value[0] = array[0] / array[1];
        }catch (ArrayIndexOutOfBoundsException aiob){
            System.out.println(aiob.toString());
        }catch (ArithmeticException ae){
            System.out.println(ae.toString());
        }catch (Exception ex){
            System.out.println(ex);
        }
    }
}

실행 결과
java.lang.NullPointerException

value는 크기 0인 배열인데, 여기에 값을 넣을 수 없으므로 NullPointerError발생

catch문이 여러개가 있는데, Exception은 모든 예외처리의 최상위 조상이기에 마지막 catch문에서 걸려

NullPointerException도 Exception ex 변수가 가리킬 수 있다.(조상 타입으로 후손 인스턴스 참조가능)

 

---

사용자 정의 Exception과 throw

 

일반 예외로 선언할 경우 Exception을 상속받아 구현

실행 예외로 선언할 경우에는 RuntimeException을 상속받아 구현

public class MyException extends  RuntimeException{
    //오류 메시지나, 발생한 Exception을 감싼 결과로 내가 만든 Exception을 사용하고 싶을 때가 많다.


    public MyException(String message) {
        super(message);
    }

    public MyException(Throwable cause) {
        super(cause);
    }
}