[java] Java Jersey에서 파일 압축을 위한 GZIP 미들웨어를 구현하는 방법은?

29 Nov 2023

java

Jersey는 Java를 기반으로 한 RESTful 웹 프레임워크로, 파일을 압축하여 네트워크 대역폭을 절약할 수 있습니다. GZIP은 파일 압축에 사용되는 알고리즘 중 하나입니다. Jersey를 사용하여 GZIP 압축 미들웨어를 구현하는 방법을 살펴보겠습니다.

Maven 종속성 설정하기 먼저 pom.xml 파일에 다음 종속성을 추가해야 합니다. 이를 통해 GZIP 압축 기능을 사용할 수 있습니다.

<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</artifactId>
    <version>${jersey.version}</version>
</dependency>
<dependency>
    <groupId>com.ning</groupId>
    <artifactId>compress-lzf</artifactId>
    <version>1.0.2</version>
</dependency>

GZIP 압축을 위한 미들웨어 구현하기 다음은 GZIP 압축을 위한 미들웨어 클래스를 구현하는 예시입니다.

import java.io.IOException;
import java.util.zip.GZIPOutputStream;

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.Provider;

import org.glassfish.jersey.message.MessageBodyWriter;

@Provider
public class GZIPWriter implements MessageBodyWriter<Object> {

    @Override
    public boolean isWriteable(Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) {
        // 압축 가능한 Content-Type인지 확인
        return mediaType.toString().matches(".*json.*|.*xml.*|.*plain.*");
    }

    @Override
    public long getSize(Object obj, Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) {
        // getSize 메소드는 -1을 반환하도록 구현합니다.
        return -1;
    }

    @Override
    public void writeTo(Object obj, Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, MultivaluedMap<String, Object> httpHeaders, java.io.OutputStream entityStream) 
            throws IOException, WebApplicationException {
        // GZIPOutputStream으로 출력 스트림을 감싸서 압축
        GZIPOutputStream gzipOutputStream = new GZIPOutputStream(entityStream);
        
        // 출력할 객체를 JSON 또는 XML 형식으로 변환 후 압축되는 출력 스트림에 작성
        // 예시에서는 JSON으로 변환하는 부분을 생략하였습니다.
        
        gzipOutputStream.close();
    }

}

위의 예시에서는 @Provider 어노테이션을 사용하여 해당 클래스가 Jersey에서 제공하는 미들웨어 프로바이더임을 나타냅니다. isWriteable 메소드에서는 압축 가능한 Content-Type인지 확인하고, writeTo 메소드에서는 출력 객체를 JSON 또는 XML 형식으로 변환한 후 GZIP 압축을 적용하여 출력 스트림에 작성합니다.

GZIPWriter를 등록하고 사용하기 Jersey Application을 구성하는 클래스에서 GZIPWriter를 등록하여 사용할 수 있습니다.

import org.glassfish.jersey.server.ResourceConfig;

public class MyApplication extends ResourceConfig {

    public MyApplication() {
        // GZIPWriter 등록하기
        register(GZIPWriter.class);
        
        // 리소스 등록하기
        packages("com.example.resources");
    }
}

위의 예시에서는 register 메소드를 사용하여 GZIPWriter 클래스를 등록했습니다. 이 클래스는 앞서 구현한 GZIPWriter를 사용하여 출력 스트림에 GZIP 압축을 적용합니다.

이제 Java Jersey에서 파일 압축을 위한 GZIP 미들웨어를 구현하는 방법을 알아보았습니다. 이를 통해 네트워크 대역폭을 절약하여 데이터 전송 속도를 향상시킬 수 있습니다.

참고 문서: