Javascript/Node.js

커스텀 에러와 에러 확장

Frankie 2021. 9. 27. 15:46

개발을 하다 보면 자체 에러 클래스가 필요한 경우가 종종 있다. 네트워크 관련 작업 중 에러는 HttpError, 데이터베이스 관련 작업 중 에러는 DbError, 검색 관련 작업 중 에러가 발생했다면 NotFoundError를 사용하는 것이 직관적이다.

 

직접 에러 클래스를 만든 경우, 이 에러들은 message나 name, 가능하다면 stack 프로퍼티를 지원해야 한다.

HttpError 클래스의 객체에 statusCode 프로퍼티를 만들고 404나 403, 500 같은 숫자를 값으로 지정할 수 있을 것이다.

 

Error를 상속받아 커스텀 에러 클래스를 만들게 되면 obj instanceof Error를 사용해서 에러 객체를 식별할 수 있다는 장점이 있다.

애플리케이션 크기가 점점 커지면 우리가 만들게 될 커스텀 에러 클래스들은 자연스레 계층 구조를 형성하게 된다.

HttpTimeoutError가 HttpError를 상속받는 식으로

 

에러 확장하기

사용자 데이터가 저장된 JSON을 읽는 함수 readUser(json)가 있다고 하면

유효한 json은

let json = `{ "name": "John", "age": 30}`;

readUser 내부에선 JSON.parse를 이용하게 된다. 따라서 잘못된 형식의 json이 들어오면 SyntaxError가 발생한다. 그런데 인수로 받은 데이터가 JSON 형식이긴 하지만, 유효한 사용자일거라는 보장은 없다. 사용자 데이터라면 필수적으로 있어야 할 name이나 age가 누락되었을 수 있다.

 

따라서 readUser(json)은 JSON 형식의 데이터를 읽을 수 있을 뿐만 아니라, 데이터를 '검증'할 수 있어야 한다. 필수 프로퍼티가 없거나, 위 형식에 맞지 않으면 에러를 발생시킬 수 있어야 한다. 그런데 이때 발생하는 에러는 SyntaxError가 아니다. JSON 형식은 맞지만, 자체 기준에 맞지 않기 때문에 발생한 에러이므로 전혀 다른 종류의 에러이다. -> ValidationError

 

ValidationError 클래스엔 문제가 되는 필드 정보가 저장되어야 한다. 내장 클래스 Error를 상속받아 ValidationError 클래스를 만들어보자. 그 전에 수도 코드로 Error 클래스를 보면

// 자바스크립트 자체 내장 에러 클래스 Error의 수도 코드
class Error {
	constructor(message) {
    	this.message = message;
        this.name = "Error"; // (name은 내장 에러 클래스마다 다르다)
        this.stack = <call stack>; // stack은 표준은 아니지만, 대다수 환경이 지원한다.
    }
}

이제 ValidationError에서 Error를 상속받으면

class ValidationError extends Error {
	constructor(message) {
    	super(message); // (1)
        this.name = "ValidationError"; // (2)
    }
}

function test() {
	throw new ValidationError("에러 발생");
}

try {
	test();
} catch(err) {
	alert(err.message); // 에러 발생
    alert(err.name); // ValidationError
    alert(err.stack); // 각 행 번호가 있는 중첩된 호출들의 목록
}

(1) 에서 부모 생성자를 호출하고 있고 message 프로퍼티는 부모 생성자에서 설정된다.

 

부모 생성자에선 message 뿐만 아니라 name 프로퍼티도 설정("Error")하기 때문에, (2) 에서 원하는 값으로 재설정했다.

 

이제 readUser(json) 안에서 ValidationError를 사용해보면

class ValidationError extends Error {
	constructor(message) {
    	super(message);
        this.name = "ValidationError";
    }
}

// 사용법
function readUser(json) {
	let user = JSON.parse(json);
    
    if (!user.age) {
    	throw new ValidationError("No field: age");
    }
    if (!user.name) {
    	throw new ValidationError("No field: name");
    }
    return User;
}

// try..catch와 readUser를 함께 사용한 예시

try {
	let user = readUser('{ "age": 25 }');
} catch (err) {
	if (err instanceof ValidationError) {
    	alert("Invalid data: " + err.message);
    } else if (err instanceof SyntaxError) { // (*)
    	alert("JSON Syntax Error: " + err.message);
    } else {
    	throw err; // 알려지지 않은 에러는 재던지기 한다. (**)
    }
}

이제 try..catch 블록에서 커스텀 에러 ValidationError와 JSON.parse에서 발생하는 SyntaxError 둘 다를 처리할 수 있게 되었다.

이 과정에서 instanceof로 에러 유형을 확인하였고 (*) 에러 유형 확인은 instanceof 말고 err.name 을 사용해도 가능하다.

 

catch 에 알려지지 않은 에러가 있을 때 이 에러는 재 던지기 (**) 된다는 것도 주목해서 봐야 한다. catch 블록에선 유효성 검사와 문법 오류만 처리하고, 다른 종류의 에러는 밖으로 던져야 한다.

 

더 깊게 상속하기

앞서 만든 ValidationError 클래스는 너무 포괄적이어서 뭔가 잘못될 확률이 있다. 꼭 필요한 프로퍼티가 누락되거나 age에 문자열 값이 들어가는 것처럼 형식이 잘못된 경우를 처리할 수 없다. 필수 프로퍼티가 없는 경우에 대응할 수 있도록 좀 더 구체적인 클래스 PropertyRequiredError를 만들어보자. PropertyRequiredError엔 누락된 프로퍼티에 대한 추가 정보가 담겨야 한다.

class ValidationError extends Error {
	constructor(message) {
    	super(message);
        this.name = "ValidationError";
    }
}

class PropertyRequiredError extends ValidationError {
	constructor(property) {
    	super("No property: " + property);
        this.name = "PropertyRequiredError";
        this.property = property;
    }
}

// 사용법
function readUser(json) {
	let user = JSON.parse(json);
    
    if (!user.age) {
    	throw new PropertyRequiredError("age");
    }
    if (!user.name) {
    	throw new PropertyRequiredError("name");
    }
    
    return user;
 }
 
 // try..catch와 readUser를 함께 사용하면 다음과 같다.
 
try {
 	let user = readUser('{ "age": 25 }');
} catch (err) {
	if (err instanceof ValidationError) {
    	alert("Invalid data: " + err.message); // Invalid data: No property: name
        alert(err.name); //PropertyRequiredError
        alert(err.property); // name
    } else if (err instanceof SyntaxError) {
    	alert("JSON Syntax Error: " + err.message);
    } else {
    	throw err; // 알려지지 않은 에러는 재던지기 한다.
    }
}

새롭게 만든 클래스 PropertyRequiredError는 사용하기 쉽습니다. new PropertyRequiredError(property) 처럼 프로퍼티 이름을 전달하기만 하면 된다. 사람이 읽을 수 있는 message는 생성자가 알아서 만들어준다.

 

여기서 주목할 점은 PropertyRequiredError 생성자 안에서 this.name 을 수동으로 할당해 주었다는 점이다. 그런데 이렇게 매번 커스텀 에러 클래스의 생성자 안에서 this.name을 할당해 주는 것은 귀찮은 작업이다.

 

이런 번거로운 작업은 '기본 에러' 클래스를 만들고 커스텀 에러들이 이 클래스를 상속받게 하면 피할 수 있다. 기본 에러의 생성자에 this.name = this.constructor.name 를 추가하면 된다.

 

기본 에러 클래스를 MyError라고 부르고 MyError를 사용하면 다음과 같이 커스텀 에러 클래스를 간결하게 할 수 있다.

class MyError extends Error {
	constructor(message) {
    	super(message);
        this.name = this.contructor.name;
    }
}

class ValidationError extends MyError { }

class PropertyRequiredError extends ValidationError {
	constructor(property) {
    	super("No property: " + property);
        this.property = property;
    }
}

// 제대로 된 이름이 출력된다.
alert(new PropertyRequiredError("field").name); // PropertyRequiredError

"this.name = ..."이 사라졌기 때문에 ValidationError 같은 커스텀 에러의 생성자가 더 깔끔해진 것을 확인할 수 있다.

 

예외 감싸기

함수 readUser는 '사용자 데이터를 읽기' 위한 용도로 만들어졌다. 그런데 사용자 데이터를 읽는 과정에서 다른 오류가 발생할 수 있다. 지금 당장은 SyntaxError와 ValidationError를 사용해 에러를 처리하고 있는데, 앞으로 readUser가 더 커지면 다른 커스텀 에러 클래스를 만들어야 한다.

 

readUser를 호출하는 곳에선 새롭게 만들어질 커스텀 에러들을 처리할 수 있어야 한다. 그런데 지금은 catch 블록 안에 if문 여러 개를 넣어 종류를 알 수 있는 에러를 처리하고, 그렇지 않은 에러는 다시 던지기를 해 처리하고 있는 실정이다.

 

현재 에러 처리 스키마를 보면

try{
	...
    readUser() // 잠재적 에러 발생처
    ...
}catch(err){
	if(err instanceof ValidationError){
    	// validation 에러 처리
    }else if(err instanceof SyntaxError){
    	// 문법 에러 처리
    }else{
    	throw err; // 알 수 없는 에러는 다시 던지기 함
    }
}

위 예시에는 두 종류의 에러만 나와있지만 에러의 종류는 더 추가될 수 있다.

이쯤 되면 미래에 readUser 기능이 커지면서 에러 종류가 많아질텐데 그때마다 에러 종류에 따라서 에러 처리 분기문을 매번 추가해줘야 하는 의문이 들 수 있다.

 

보통은 그렇지 않다. 실제 우리가 필요로 하는 정보는 데이터를 읽을 때 에러가 발생했는지에 대한 여부이다. 왜 에러가 발생했는지와 자세한 설명은 대부분의 경우 필요하지 않다. 필요할 때 에러 세부사항에 대한 정보를 얻을 수 있는 방법이 있다면 더 좋지만

 

이런 에러 처리 기술은 '예외 감싸기(wrapping exception)'라고 부른다. 예외 감싸기는 다음 순서로 진행된다.

1. '데이터 읽기'와 같은 포괄적인 에러를 대변하는 새로운 클래스 ReadError를 만든다.

2. 함수 readUser 발생한 ValidationError, SyntaxError 등의 에러는 readUser 내부에서 잡고 이때 ReadError를 생성한다.

3. ReadError 객체의 cause 프로퍼티엔 실제 에러에 대한 참조가 저장된다.

 

이렇게 예외 감싸기 기술을 써 스키마를 변경하면 readUser를 호출하는 코드에선 ReadError만 확인하면 된다. 데이터를 읽을 때 발생하는 에러 종류 전체를 확인하지 않아도 된다. 추가 정보가 필요한 경우엔 cause 프로퍼티를 확인하면 된다.

 

실제로 ReadError를 사용해보면

class ReadError extends Error {
	constructor(message, cause){
    	super(message);
        this.cause = cause;
        this.name = 'ReadError';
    }
}

class ValidationError extends Error { /* ... */ }
class PropertyRequiredError extends ValidationError { /* ... */ }

function validateUser(user){
	if(!user.age){
    	throw new PropertyRequiredError("age");
    }
    if(!user.name){
    	throw new PropertyRequiredError("name");
    }
}

function readUser(json){
	let user;
    
    try{
    	user = JSON.parse(json);
    }catch(err){
    	if(err instanceof SyntaxError){
        	throw new ReadError("Syntax Error", err);
       	}else{
        	throw err;
        }
    }
}

try{
	readUser('{잘못된 형식의 json}');
}catch(e){
	if(e instanceof ReadError){
    	alert(e);
        //Original error: SyntaxError: Unexpected token b in JSON at position 1
        alert("Original error: " + e.cause):
    }else{
    	throw e;
    }
}

Syntax 에러나 Validation 에러가 발생한 경우 해당 에러 자체를 다시 던지기 하지 않고 ReadError를 던지게 된다.

이렇게 되면 readUser를 호출하는 바깥 코드에선 instanceof ReadError 딱 하나만 확인하면 된다. 에러 처리 분기문을 여러 개 만들 필요가 없어진다.

'예외 감싸기'란 이름은 종류별 에러를 좀 더 추상적인 에러, ReadError에 하나로 모아(wrap) 처리하기 때문에 붙여졌다. 이런 기법은 객체 지향 프로그래밍에서 널리 쓰이는 패턴이다.

 

저작자표시

'Javascript > Node.js' 카테고리의 다른 글

promise API  (0) 2021.09.28
콜백  (0) 2021.09.27
try..catch와 에러 핸들링  (2) 2021.09.27
메서드와 this  (0) 2021.09.27
ESLint  (0) 2021.09.13

'Javascript/Node.js'의 다른글

  • 현재글커스텀 에러와 에러 확장

관련글

티스토리툴바