48.3. 애플리케이션의 응답 미세 조정

RESTful 서비스는 리소스 메서드가 일반 Java 구성을 반환할 때 허용되는 것보다 더 정확한 응답을 소비자에 더 정확하게 제어해야 하는 경우가 많습니다. Cryostat-RS Response 클래스를 사용하면 리소스 메서드가 소비자에게 전송된 반환 상태를 일부 제어하고 응답에서 HTTP 메시지 헤더 및 쿠키를 지정할 수 있습니다.

응답 오브젝트는 소비자로 반환되는 엔티티를 나타내는 오브젝트를 래핑합니다. Response 개체는 ResponseBuilder 클래스를 팩토리로 사용하여 인스턴스화됩니다.

ResponseBuilder 클래스에는 응답의 메타데이터를 조작하는 데 사용되는 많은 메서드도 있습니다. 예를 들어 ResonseBuilder 클래스에는 HTTP 헤더 및 캐시 제어 지시문을 설정하기 위한 메서드가 포함되어 있습니다.

Response 클래스에는 보호된 생성자가 있으므로 직접 인스턴스화할 수 없습니다. Response 클래스로 묶은 ResponseBuilder 클래스를 사용하여 생성됩니다. ResponseBuilder 클래스는 생성된 응답에 캡슐화될 모든 정보의 소유자입니다. ResponseBuilder 클래스에는 메시지에서 HTTP 헤더 속성을 설정하는 모든 메서드가 있습니다.

Response 클래스는 적절한 응답 코드를 쉽게 설정하고 엔터티를 래핑하는 몇 가지 메서드를 제공합니다. 공통 응답 상태 코드 각각에 대한 메서드가 있습니다. 엔터티 본문 또는 필수 메타데이터를 포함하는 상태에 해당하는 메서드에는 해당 정보를 연결된 응답 빌더로 직접 설정할 수 있는 버전이 포함됩니다.

ResponseBuilder 클래스의 build() 메서드는 메서드가 호출될 때 응답 빌더에 저장된 정보가 포함된 응답 오브젝트를 반환합니다. 응답 오브젝트가 반환되면 응답 빌더가 clean 상태로 반환됩니다.

응답 빌더를 가져오는 방법은 다음 두 가지가 있습니다.

Response 클래스에 대한 자세한 내용은 Response 클래스의 Javadoc 을 참조하십시오.

ResponseBuilder 클래스에 대한 자세한 내용은 ResponseBuilder 클래스의 Javadoc 을 참조하십시오.

Apache CXF ResponseBuilderIml 클래스에 대한 자세한 내용은 ResponseBuilderImpl Javadoc.

Response 클래스는 RESTful 서비스에 필요한 더 일반적인 응답을 처리하기 위한 바로 가기 메서드를 제공합니다. 이러한 메서드는 제공된 값 또는 기본값을 사용하여 적절한 헤더 설정을 처리합니다. 또한 적절한 경우 엔티티의 채우기를 처리합니다.

요청이 성공적으로 처리되면 애플리케이션은 요청이 충족되었음을 확인하는 응답을 보내야 합니다. 이 응답에는 엔티티가 포함될 수 있습니다.

응답을 성공적으로 완료할 때 가장 일반적인 응답은 OK 입니다. OK 응답에는 일반적으로 요청에 해당하는 엔티티가 포함됩니다. Response 클래스에는 응답 상태를 200 으로 설정하고 포함된 응답 빌더에 제공된 엔터티를 추가하는 오버로드된 ok() 메서드가 있습니다. ok() 메서드의 5 가지 버전이 있습니다. 가장 일반적으로 사용되는 변형은 다음과 같습니다.

200 응답으로 응답 생성 OK 상태로 응답을 생성하는 예를 보여줍니다.

import javax.ws.rs.core.Response;
import demo.jaxrs.server.Customer;
...

Customer customer = new Customer("Jane", 12);

return Response.ok(customer).build();

요청자가 엔티티 본문을 원하지 않는 경우 200 OK 상태 대신 204 No Content 상태를 보내는 것이 더 적합할 수 있습니다. Response.noContent() 메서드는 적절한 응답 오브젝트를 생성합니다.

204 status로 응답 생성 204 상태의 응답을 생성하는 예를 보여줍니다.

import javax.ws.rs.core.Response;

return Response.noContent().build();

Response 클래스는 리디렉션 응답 상태 세 개를 처리하기 위한 메서드를 제공합니다.

Cryostat 상태로 응답 생성 Cryostat 상태로 응답을 생성하는 예를 보여줍니다.

import javax.ws.rs.core.Response;

return Response.notModified().build();

Response 클래스는 두 가지 기본 처리 오류에 대한 응답을 생성하는 메서드를 제공합니다.

500 status로 응답 생성 500 상태의 응답을 생성하는 예를 보여줍니다.

import javax.ws.rs.core.Response;

return Response.serverError().build();

Response 클래스 메서드는 일반적인 사례에 대한 응답을 생성하기 위한 짧은 컷을 제공합니다. 캐시 제어 지시문을 지정하거나 사용자 지정 HTTP 헤더를 추가하거나 Response 클래스에서 처리되지 않은 상태를 보내는 등 더 복잡한 케이스를 처리해야 하는 경우 Response Builder 클래스 메서드를 사용하여 response () 메서드를 사용하여 응답 오브젝트를 생성하기 전에 응답을 채워야 합니다.

“응답 빌더 가져오기” 에서 설명한 대로 Apache CXF ResponseBuilderImpl 클래스를 사용하여 직접 조작할 수 있는 응답 빌더 인스턴스를 생성할 수 있습니다.

사용자 지정 헤더는 ResponseBuilder 클래스의 header() 메서드를 사용하여 응답에 추가됩니다. header() 메서드는 다음 두 매개변수를 사용합니다.

header() 메서드를 반복적으로 호출하여 메시지에 여러 헤더를 설정할 수 있습니다.

응답에 헤더 추가 응답에 헤더를 추가하기 위한 코드를 표시합니다.

import javax.ws.rs.core.Response;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.header("username", "joe");
Response r = builder.build();

사용자 지정 헤더는 ResponseBuilder 클래스의 cookie() 메서드를 사용하여 응답에 추가됩니다. cookie() 메서드는 하나 이상의 쿠키를 사용합니다. 각 쿠키는 javax.ws.rs.core.NewCookie 오브젝트에 저장됩니다. NewCookie 클래스의 컨트랙터 중 가장 쉬운에는 두 가지 매개변수가 필요합니다.

cookie() 메서드를 반복적으로 호출하여 여러 쿠키를 설정할 수 있습니다.

응답에 쿠키 추가 는 응답에 쿠키를 추가하기 위한 코드를 표시합니다.

import javax.ws.rs.core.Response;
import javax.ws.rs.core.NewCookie;

NewCookie cookie = new NewCookie("username", "joe");

Response r = Response.ok().cookie(cookie).build();

Response 클래스의 도우미 메서드에서 지원하는 상태 중 하나가 아닌 상태를 반환하려면 Response Builder 클래스의 status() 메서드를 사용하여 응답의 상태 코드를 설정할 수 있습니다. status() 메서드에는 두 가지 변형이 있습니다. 하나는 응답 코드를 지정하는 int 를 사용합니다. 다른 하나는 Response.Status 오브젝트를 사용하여 응답 코드를 지정합니다.

Response.Status 클래스는 Response 클래스로 묶은 열거입니다. 정의된 HTTP 응답 코드의 대부분에 대한 항목이 있습니다.

응답에 헤더 추가 404 Not Found 로 응답 상태를 설정하는 코드를 표시합니다.

import javax.ws.rs.core.Response;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.status(404);
Response r = builder.build();

ResponseBuilder 클래스의 cacheControl() 메서드를 사용하면 응답에서 캐시 제어 헤더를 설정할 수 있습니다. cacheControl() 메서드는 응답에 대한 캐시 제어 지시문을 지정하는 javax.ws.rs.CacheControl 개체를 사용합니다.

CacheControl 클래스에는 HTTP 사양에서 지원하는 모든 캐시 제어 지시문에 해당하는 메서드가 있습니다. 여기서 지시문은 setter 메서드에서 부울 값을 사용하는 단순한 값 또는 오프 값입니다. 지시문에 max-age 지시문과 같은 숫자 값이 필요한 경우 setter는 int 값을 사용합니다.

응답에 헤더 추가 no-store 캐시 제어 지시문을 설정하기 위한 코드를 표시합니다.

import javax.ws.rs.core.Response;
import javax.ws.rs.core.CacheControl;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

CacheControl cache = new CacheControl();
cache.setNoCache(true);

ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.cacheControl(cache);
Response r = builder.build();