2.12. RESTEasy 필터 및 인터셉터

RESTEasy는 Jakarta RESTful Web Services 호출을 인터셉터라는 리스너와 유사한 개체를 통해 라우팅할 수 있습니다.

필터는 요청 또는 응답 헤더를 수정하는 반면 인터셉터는 메시지 본문을 처리합니다. 인터셉터는 해당 리더 또는 작성자와 동일한 호출 스택에서 실행됩니다. ReaderInterceptors는 MessageBodyReaders 실행을 래핑합니다. WriterInterceptors는 MessageBodyWriters 실행을 래핑합니다. 특정 콘텐츠 인코딩을 구현하는 데 사용할 수 있습니다. 디지털 서명을 생성하거나 마샬링 전후에 Java 개체 모델을 게시하거나 사전 처리하는 데 사용할 수 있습니다.

ReaderInterceptors 및 WriterInterceptors 는 서버 또는 클라이언트 측에서 사용할 수 있습니다. 이 주석에는 @Provider와 @ ServerInterceptor 또는 @ClientInterceptor 가 주석이 추가되어 RESTEasy에서 인터셉터 목록에 추가할지 여부를 알 수 있습니다.

이러한 인터셉터는 MessageBodyReader.readFrom() 또는 MessageBodyWriter.writeTo() 의 호출을 중심으로 줄입니다. 출력 또는 입력 스트림을 래핑하는 데 사용할 수 있습니다.

@Provider
public class BookReaderInterceptor implements ReaderInterceptor {
    @Inject private Logger log;
    @Override
    @ReaderInterceptorBinding
    public Object aroundReadFrom(ReaderInterceptorContext context) throws IOException, WebApplicationException {
        log.info("*** Intercepting call in BookReaderInterceptor.aroundReadFrom()");
        VisitList.add(this);
        Object result = context.proceed();
        log.info("*** Back from intercepting call in BookReaderInterceptor.aroundReadFrom()"); return result;
    }
}

인터셉터와 MessageBodyReader 또는 Writer 는 하나의 큰 Java 호출 스택에서 호출됩니다. ReaderInterceptorContext.proceed() 또는 WriterInterceptorContext.proceed() 는 다음 인터셉터로 이동하기 위해 호출되거나 더 이상 호출할 인터셉터가 없는 경우 MessageBodyReader 또는 MessageBody Writer 의 readFrom() 또는 writeTo() 메서드입니다. 이 래핑을 사용하면 Reader 또는 Writer 로 돌아가기 전에 객체를 수정한 다음, proceed() 가 반환된 후 정리할 수 있습니다.

아래 예는 응답에 헤더 값을 추가하는 서버 측 인터셉터입니다.

@Provider
public class BookWriterInterceptor implements WriterInterceptor {
   @Inject private Logger log;

   @Override
   @WriterInterceptorBinding
   public void aroundWriteTo(WriterInterceptorContext context) throws IOException, WebApplicationException {
      log.info("*** Intercepting call in BookWriterInterceptor.aroundWriteTo()");
      VisitList.add(this);
      context.proceed();
      log.info("*** Back from intercepting call in BookWriterInterceptor.aroundWriteTo()");
   }
}

애플리케이션에 RESTEasy Jakarta RESTful Web Services 인터셉터를 등록하려면 context-param 요소의 resteasy .providers 매개변수 아래에 web. xml 파일에 나열하거나 클래스 또는 Application.getClasses() 또는 Application.getSingletons() 메서드의 개체로 반환합니다.

<context-param>
    <param-name>resteasy.providers</param-name>
    <param-value>my.app.CustomInterceptor</paramvalue>
</context-param>

package org.jboss.resteasy.example;

import javax.ws.rs.core.Application;
import java.util.HashSet;
import java.util.Set;

public class MyApp extends Application {

  public java.util.Set<java.lang.Class<?>> getClasses() {
    Set<Class<?>> resources = new HashSet<Class<?>>();
    resources.add(MyResource.class);
    resources.add(MyProvider.class);
    return resources;
  }
}

package org.jboss.resteasy.example;

import javax.ws.rs.core.Application;
import java.util.HashSet;
import java.util.Set;

public class MyApp extends Application {

    protected Set<Object> singletons = new HashSet<Object>();

    public MyApp() {
        singletons.add(new MyResource());
        singletons.add(new MyProvider());
    }

    @Override
    public Set<Object> getSingletons() {
        return singletons;
    }
}

GZIP 압축 및 압축 해제와 관련된 세 가지 인터셉터가 있습니다.

GZIP 압축 해제를 사용하면 GZIPDecodingInterceptor 가 압축된 메시지 본문에서 추출할 수 있는 바이트 수에 대한 상한을 설정합니다. 기본 제한은 10,000,000 입니다.

클래스 경로의 javax.ws.rs.ext.Providers 파일에 클래스 이름을 포함하여 인터셉터를 활성화할 수 있습니다. 삭제된 파일의 상한은 웹 애플리케이션 컨텍스트 매개 변수 resteasy.gzip.max.input 을 사용하여 설정됩니다. 서버 측에서 이 제한을 초과하는 경우 GZIPDecodingInterceptor 는 상태 413 - Request Entity Too Large 및 상한값을 지정하는 메시지를 반환합니다.

Client client = new ResteasyClientBuilder() // Activate gzip compression on client:
    .register(AcceptEncodingGZIPFilter.class)
    .register(GZIPDecodingInterceptor.class)
    .register(GZIPEncodingInterceptor.class)
    .build();

Client client = new ResteasyClientBuilder() // Activate gzip compression on client:
    .register(AcceptEncodingGZIPFilter.class)
    .register(new GZIPDecodingInterceptor(256))
    .register(GZIPEncodingInterceptor.class)
    .build();