problem spring web
0.29.1
Проблема Spring Web - это набор библиотек, которые позволяют легко создавать ответы application/problem+json из весеннего приложения. Он заполняет нишу, так как он соединяет библиотеку проблем и либо обработку исключений Spring Web MVC, либо обработку исключений Webflux Spring, чтобы они беспроводили вместе, требуя минимальных дополнительных усилий разработчика. При этом он стремится выполнить небольшую, но повторяющуюся задачу - раз и навсегда.
То, как работает эта библиотека, основано на том, что мы называем советы . Черта консультации - это небольшой, многоразовый @ExceptionHandler , реализованный как метод по умолчанию, размещенный в одном интерфейсе метода. Эти черты совета могут быть свободно объединены и не требуют использования общего базового класса для вашего @ControllerAdvice .
? Пожалуйста, ознакомьтесь с Baeldung: Руководство по проблеме Spring Spring Web Library для подробного введения!
Процесс решения проблемы, обеспечиваемый AdviceTrait , построен таким образом, чтобы допустить настройку, когда возникает необходимость. Все следующие аспекты (и больше) могут быть настроены путем реализации соответствующего интерфейса признаков консультации:
| Аспект | Метод (S) | По умолчанию |
|---|---|---|
| Создание | AdviceTrait.create(..) | |
| Регистрация | AdviceTrait.log(..) | 4xx as WARN , 5xx в качестве ERROR включая трассировку стека |
| Переговоры о контенте | AdviceTrait.negotiate(..) | application/json , application/*+json , application/problem+json и application/x.problem+json |
| Отступать | AdviceTrait.fallback(..) | application/problem+json |
| Пост-обработка | AdviceTrait.process(..) | n/a |
В следующем примере настраивает MissingServletRequestParameterAdviceTrait , добавив поле расширения parameter в Problem :
@ ControllerAdvice
public class MissingRequestParameterExceptionHandler implements MissingServletRequestParameterAdviceTrait {
@ Override
public ProblemBuilder prepare ( Throwable throwable , StatusType status , URI type ) {
var exception = ( MissingServletRequestParameterException ) throwable ;
return Problem . builder ()
. withTitle ( status . getReasonPhrase ())
. withStatus ( status )
. withDetail ( exception . getMessage ())
. with ( "parameter" , exception . getParameterName ());
}
}Предполагая, что есть такой контроллер:
@ RestController
@ RequestMapping ( "/products" )
class ProductsResource {
@ RequestMapping ( method = GET , value = "/{productId}" , produces = APPLICATION_JSON_VALUE )
public Product getProduct ( String productId ) {
// TODO implement
return null ;
}
@ RequestMapping ( method = PUT , value = "/{productId}" , consumes = APPLICATION_JSON_VALUE )
public Product updateProduct ( String productId , Product product ) {
// TODO implement
throw new UnsupportedOperationException ();
}
}Следующие HTTP -запросы дадут соответственно соответствующий ответ соответственно:
GET /products/123 HTTP/1.1
Accept: application/xml HTTP/1.1 406 Not Acceptable
Content-Type: application/problem+json
{
"title" : " Not Acceptable " ,
"status" : 406 ,
"detail" : " Could not find acceptable representation "
} POST /products/123 HTTP/1.1
Content-Type: application/json
{} HTTP/1.1 405 Method Not Allowed
Allow: GET
Content-Type: application/problem+json
{
"title" : " Method Not Allowed " ,
"status" : 405 ,
"detail" : " POST not supported "
}Прежде чем продолжить , прочитайте раздел о трассах стека и причинно -следственных цепях в Заландо/проблеме.
В случае, если вы хотите включить трассировки стека, пожалуйста, настройте свою ProblemModule следующим образом:
ObjectMapper mapper = new ObjectMapper ()
. registerModule ( new ProblemModule (). withStackTraces ());Причинные цепочки проблем отключены по умолчанию , но могут быть переопределены при желании:
@ ControllerAdvice
class ExceptionHandling implements ProblemHandling {
@ Override
public boolean isCausalChainsEnabled () {
return true ;
}
} Примечание. Поскольку у вас есть полный доступ к контексту приложения на этой точке, вы можете использовать конфигурацию в свое application.yml и даже решить повторно использовать свойство Spring server.error.include-stacktrace .
Включение обеих функций, причинно -следственных цепей и стектраксов, даст:
{
" title " : " Internal Server Error " ,
" status " : 500,
" detail " : " Illegal State " ,
" stacktrace " : [
" org.example.ExampleRestController.newIllegalState(ExampleRestController.java:96) " ,
" org.example.ExampleRestController.nestedThrowable(ExampleRestController.java:91) "
],
" cause " : {
" title " : " Internal Server Error " ,
" status " : 500,
" detail " : " Illegal Argument " ,
" stacktrace " : [
" org.example.ExampleRestController.newIllegalArgument(ExampleRestController.java:100) " ,
" org.example.ExampleRestController.nestedThrowable(ExampleRestController.java:88) "
],
" cause " : {
" title " : " Internal Server Error " ,
" status " : 500,
" detail " : " Null Pointer " ,
" stacktrace " : [
" org.example.ExampleRestController.newNullPointer(ExampleRestController.java:104) " ,
" org.example.ExampleRestController.nestedThrowable(ExampleRestController.java:86) " ,
" sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) " ,
" sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) " ,
" sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) " ,
" java.lang.reflect.Method.invoke(Method.java:483) " ,
" org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50) " ,
" org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12) " ,
" org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47) " ,
" org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17) " ,
" org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325) " ,
" org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78) " ,
" org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57) " ,
" org.junit.runners.ParentRunner$3.run(ParentRunner.java:290) " ,
" org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71) " ,
" org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288) " ,
" org.junit.runners.ParentRunner.access$000(ParentRunner.java:58) " ,
" org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268) " ,
" org.junit.runners.ParentRunner.run(ParentRunner.java:363) " ,
" org.junit.runner.JUnitCore.run(JUnitCore.java:137) " ,
" com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:117) " ,
" com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:234) " ,
" com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:74) "
]
}
}
} Пружина позволяет ограничить сферу охвата @ControllerAdvice определенной подмножностью контроллеров:
@ ControllerAdvice ( assignableTypes = ExampleController . class )
public final class ExceptionHandling implements ProblemHandlingДелая это, вы потеряете возможность обрабатывать определенные типы исключений, а именно:
HttpRequestMethodNotSupportedExceptionHttpMediaTypeNotAcceptableExceptionHttpMediaTypeNotSupportedExceptionNoHandlerFoundException Мы наследуем это ограничение от пружины и, следовательно, рекомендуем использовать неограниченную @ControllerAdvice .
Если у вас есть вопросы, проблемы, отчеты об ошибках и т. Д., Пожалуйста, подайте проблему в трекер этого репозитория.
Чтобы внести свой вклад, просто сделайте запрос на привлечение и добавьте краткое описание (1-2 предложения) вашего дополнения или изменения. Для получения более подробной информации проверьте руководящие принципы взноса.
