[java] Java Jersey에서 예외 처리하는 방법은?

29 Nov 2023

java

Java Jersey는 웹 서비스 개발을 위한 프레임워크로, RESTful 웹 서비스를 구축하는 데 사용됩니다. 예외 처리는 중요한 측면이며, 클라이언트 요청을 처리하는 동안 발생할 수 있는 예외 상황에 대응하는 방법을 제공해야합니다. 이 문서에서는 Java Jersey에서 예외 처리하는 방법을 설명하겠습니다.

Jersey에서 예외 처리를 구현하기 위해 다음과 같은 단계를 따릅니다:

1. ExceptionMapper 인터페이스 구현

Jersey는 ExceptionMapper 인터페이스를 제공하여 예외를 처리할 수 있도록 합니다. 따라서 사용자는 ExceptionMapper 인터페이스를 구현하여 예외를 처리할 수 있습니다.

import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;

@Provider
public class CustomExceptionMapper implements ExceptionMapper<CustomException> {

    @Override
    public Response toResponse(CustomException exception) {
        // 예외 처리 로직 작성
        return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity("예외가 발생했습니다.").build();
    }
}

위의 예제에서는 CustomExceptionMapper라는 사용자 정의 예외 매퍼를 구현했습니다. toResponse() 메소드에서는 CustomException을 전달받아 처리하고, Response 객체를 반환합니다.

2. web.xml에 ExceptionMapper 등록

ExceptionMapper는 web.xml 파일에서 등록되어야 합니다. 다음과 같이 등록할 수 있습니다:

<servlet>
    <servlet-name>yourJerseyServlet</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
    <!-- 생략 -->
    <init-param>
        <param-name>jersey.config.server.provider.packages</param-name>
        <param-value>com.your.package</param-value>
    </init-param>
    <init-param>
        <param-name>jersey.config.server.provider.classnames</param-name>
        <param-value>com.your.package.CustomExceptionMapper</param-value>
    </init-param>
    <!-- 생략 -->
</servlet>

위 예제에서 <servlet> 요소 안에 <init-param> 요소를 추가하여 CustomExceptionMapper를 등록합니다. jersey.config.server.provider.classnames 속성에 매퍼의 패키지 경로를 지정합니다.

3. 예외 발생시 매퍼 호출

마지막으로, 예외가 발생한 시점에서 ExceptionMapper가 호출되도록 설정해야 합니다. 예를 들어, 다음과 같이 CustomException이 발생하는 메소드에서 예외를 던지면 매퍼가 호출됩니다:

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

@Path("/example")
public class ExampleResource {

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String exampleMethod() throws CustomException {
        // 예외 발생
        throw new CustomException("예외가 발생했습니다.");
    }
}

위의 예시에서는 ExampleResource 클래스의 exampleMethod()에서 CustomException을 발생시킵니다.

위의 예제를 사용하여 Java Jersey에서 예외 처리를 구현할 수 있습니다. 예외 처리는 클라이언트에게 더 나은 사용자 경험을 제공하고 웹 서비스의 신뢰성을 향상시키는 데 중요한 역할을 합니다.

1. ExceptionMapper 인터페이스 구현

2. web.xml에 ExceptionMapper 등록

3. 예외 발생시 매퍼 호출

참고자료