jax-rs配置_具有MicroProfile配置的可配置JAX-RS ExceptionMapper
jax-rs配置
當使用JAX-RS創建REST服務時,通常不返回任何內容(例如HTTP 201/2/4等)或某些數據(可能采用JSON格式(因此HTTP 200),或者返回某些異常/錯誤(因此HTTP 4xx或5xx) )。
我們通常將運行時異常轉換為某些HTTP 5xx,將已檢查異常轉換為某些4xx。
因為我們要保持邊界整潔,所以當我們將Exception轉換為HTTP響應時,我們不會在響應的主體中包含完整的Java stacktrace。 我們通常只在HTTP 5xx(有時是4xx)響應中添加“ REASON”標頭。 但是,這意味著我們的大多數ExceptionMappers看起來都差不多(類似這樣):
@Providerpublic class SomeExceptionMapper implements ExceptionMapper<SomeException> {@Overridepublic Response toResponse(SomeException exception) {return Response.status(500).header("reason", exception.getMessage()).build();}}使用MicroProfile Config API
我們可以使用MicroProfile Config API創建可配置的異常映射器,從而使使用者可以將異常配置為HTTP響應代碼映射。
我們的@Provider將處理所有運行時異常:
@Providerpublic class RuntimeExceptionMapper implements ExceptionMapper<RuntimeException> {// ...}我們同時@Inject配置和提供者:
@Injectprivate Config config;@Context private Providers providers;當我們實現toResponse方法時,我們會在配置中查看此Exception類的映射:
@Override@Produces({MediaType.APPLICATION_JSON,MediaType.APPLICATION_XML})public Response toResponse(RuntimeException exception) {return handleThrowable(exception);}private Response handleThrowable(Throwable exception) {if(exception instanceof WebApplicationException) {return ((WebApplicationException) exception).getResponse();}if(exception!=null){String configkey = exception.getClass().getName() + STATUS_CODE_KEY;Optional<Integer> possibleDynamicMapperValue = config.getOptionalValue(configkey,Integer.class);if(possibleDynamicMapperValue.isPresent()){int status = possibleDynamicMapperValue.get();// You switched it offif(status<0)return handleNotMapped(exception);String reason = getReason(exception);log.log(Level.FINEST, reason, exception);return Response.status(status).header(REASON, reason).build();} else if(exception.getCause()!=null && exception.getCause()!=null && providers!=null){final Throwable cause = exception.getCause();return handleThrowable(cause);} else {return handleNotMapped(exception);}}return handleNullException();}( 這里有完整的示例)
我們還將向上處理異常鏈,直到獲得映射,或者默認為正常的500錯誤。
因此,我們可以為映射添加配置,如下所示:
## 503 Service Unavailable: The server is currently unavailable (because it is overloaded or down for maintenance). Generally, this is a temporary state.org.eclipse.microprofile.faulttolerance.exceptions.CircuitBreakerOpenException/mp-jaxrs-ext/statuscode=503## 401 Unauthorized (RFC 7235): Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided.javax.ws.rs.NotAuthorizedException/mp-jaxrs-ext/statuscode=401在上面的示例中,我們將CircuitBreakerOpenException(來自MicroProfile容錯API)映射到503,將NotAuthorizedException映射到401。
屏幕截圖示例
用作庫。
您還可以將所有這些捆綁在一個jar文件中,以供您的任何項目使用。 我在maven Central和github中提供了上述內容,因此您也可以直接使用它。
只需將其添加到您的pom.xml
<dependency><groupId>com.github.phillip-kruger.microprofile-extensions</groupId><artifactId>jaxrs-ext</artifactId><version>1.0.9</version></dependency>它帶有一些預定義的映射,但是您可以在配置中覆蓋它。
翻譯自: https://www.javacodegeeks.com/2018/08/jax-rs-exceptionmapper-config.html
jax-rs配置
總結
以上是生活随笔為你收集整理的jax-rs配置_具有MicroProfile配置的可配置JAX-RS ExceptionMapper的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: jakarta ee_MicroProf
- 下一篇: ps怎么制作文字logo(ps怎么制作文