Historial de página

try{
.....
throw new TestException( HttpStatus.BAD_REQUEST,"2. ResponseStatusException con FundeWebJSErrorAttributtes" );
.....

} catch ( final TestException e2 ) {
    //Se captura una excepción existente y se lanza una nueva ResponseStatusException
	log.error( "Test de prueba de ResponseStatusException con custom FundeWebJSErrorAttributtes: {}",e2.getMessage() );
	throw new ResponseStatusException( HttpStatus.INTERNAL_SERVER_ERROR, e2.getMessage(),e2.getCause() );

} ....

https://fundewebjsshowcasedesa.um.es/api/v1.0/public/handleError/5

{
    "fecha": "05/10/2021 10:31:27",
    "estado": "INTERNAL_SERVER_ERROR",
    "mensaje": "2. ResponseStatusException con FundeWebJSErrorAttributtes",
    "tipoRespuesta": "CUSTOM_DefaultErrorAttributes"
}

...
@ResponseStatus( code = HttpStatus.BAD_REQUEST, reason = "Reason en ResponseStatus", value = HttpStatus.INTERNAL_SERVER_ERROR )
public class TestResponseStatusException extends RuntimeException
....
/
try{
...   
	throw new TestResponseStatusException( HttpStatus.BAD_REQUEST, "1. Notación ResponseStatus con FundeWebJSErrorAttributtes" );
...
} catch ( final TestResponseStatusException e1 ) {
	log.error( "Test de prueba de notación @ResponseStatus con custom FundeWebJSErrorAttributtes: {}",e1.getMessage() );
	throw e1;
}
...

https://fundewebjsshowcasedesa.um.es/api/v1.0/public/handleError/1

{
    "fecha": "05/10/2021 10:45:25",
    "estado": "BAD_REQUEST",
    "mensaje": "1. Notación ResponseStatus con FundeWebJSErrorAttributtes",
    "tipoRespuesta": "CUSTOM_DefaultErrorAttributes"
}

@Component
public class FundeWebJSErrorAttributes extends DefaultErrorAttributes {

	private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager
			.getLogger( FundeWebJSErrorAttributes.class );

	public static final String TIPO_RESPUESTA = "CUSTOM_DefaultErrorAttributes";

	@Override
	public Map<String, Object> getErrorAttributes( WebRequest webRequest, boolean includeStackTrace ) {
		final Map<String, Object> allErrorAttributes = super.getErrorAttributes( webRequest, includeStackTrace );
		final Map<String, Object> errorAttributes = new HashMap<>();

		final int statusCode = ( int ) allErrorAttributes.get( "status" );
		errorAttributes.put( "tipoRespuesta", TIPO_RESPUESTA );
		errorAttributes.put( "estado", HttpStatus.valueOf( statusCode ) );
		errorAttributes.put( "fecha",
				LocalDateTime.now().format( DateTimeFormatter.ofPattern( "dd/MM/yyyy HH:mm:ss" ) ) );

		String mensaje = "";

		final Throwable throwable = getError( webRequest );

		if ( throwable instanceof ResponseStatusException ) {
			final ResponseStatusException responseStatusException = ( ResponseStatusException ) throwable;
			mensaje = responseStatusException.getReason() == null ? "" : responseStatusException.getReason();

		} else if ( throwable instanceof ConstraintViolationException ) {
			webRequest.setAttribute( "status", HttpStatus.BAD_REQUEST.value(), 1 );
			errorAttributes.put( "estado", HttpStatus.BAD_REQUEST.toString() );
			mensaje = throwable.getMessage() == null ? "" : throwable.getMessage();
		} else {

			if ( ( throwable != null ) && ( throwable.getMessage() != null ) ) {
				mensaje = throwable.getMessage() == null ? "" : throwable.getMessage();
			}

		}

		errorAttributes.put( "mensaje", mensaje );

		return errorAttributes;
	}

}

No se recomienda desarrollar modelos propios de respuesta estándar hasta que se complete la integración con el RFC 7807 Problem Details for HTTP APIs por parte de MNCS.

@Data
@RequiredArgsConstructor
@AllArgsConstructor
@Builder
public class TestLocalHandlerError {
	
	@NonNull
	private HttpStatus estado;
	@JsonFormat(shape = Shape.STRING, pattern = "dd/MM/yyyy hh:mm:ss")
	private LocalDateTime fecha;
	@NonNull
	private String mensaje;
	@Builder.Default
	private String tipoRespuesta = "CUSTOM_LocalHandler";

}

@ExceptionHandler( TestLocalHandlerException.class )
public ResponseEntity<TestLocalHandlerError> handleTestLocalHandler( TestLocalHandlerException ex ) {

	final TestLocalHandlerError error = TestLocalHandlerError.builder()
			.estado( HttpStatus.INTERNAL_SERVER_ERROR ).fecha( LocalDateTime.now() )
			.mensaje( ex.getMessage() ).build();

	return ResponseEntity.status( HttpStatus.INTERNAL_SERVER_ERROR ).body( error );
}

...
try{
   throw new TestLocalHandlerException("3. Excepción con handler local y modelo custom TestLocalHandlerError" );
} catch ( final TestLocalHandlerException e3 ) {
   log.error( "Test de prueba de excepción con handler en el propio controller y modelo TestLocalHandlerError: {}", e3.getMessage() );
   throw e3;
}
...

https://fundewebjsshowcasedesa.um.es/api/v1.0/public/handleError/3

{
    "estado": "INTERNAL_SERVER_ERROR",
    "fecha": "05/10/2021 12:37:46",
    "mensaje": "3. Excepción con handler local y modelo custom TestLocalHandlerError",
    "tipoRespuesta": "CUSTOM_LocalHandler"
}

La notación RestControllerAdvice engloba las notaciones ControllerAdvice (que registra la clase en el contexto de Spring para que pueda acceder a todos los controllers) y ResponseBody (para que los pojos enviados en la respuesta se interpreten como JSON).

Es posible declarar varios RestControllerAdvice para dividir el manejo de excepciones por paquetes, clases, anotaciones, etc. 
Por defecto, si no se pasan parámetros en la declaración de la notación @RestControllerAdvice, los manejadores serán comunes a toda la aplicación.

public class TestControllerAdviceException extends RuntimeException {

	private static final long serialVersionUID = 1L;

	public TestControllerAdviceException( String msg ) {
		super( msg );
	}
}

@Data
@RequiredArgsConstructor
@AllArgsConstructor
@Builder
public class TestControllerAdviceError {
	
	@Nonnull
	private HttpStatus estado;
	@JsonFormat(shape = Shape.STRING, pattern = "dd/MM/yyyy hh:mm:ss")
	private LocalDateTime fecha;
	@Nonnull
	private String mensaje;
	@Builder.Default
	private String tipoRespuesta = "CUSTOM_ControllerAdvice";
    private List<String> erroresValidacion;
}

@RestControllerAdvice( basePackages = "es.um.atica.fundewebjsshowcasebackend" )
public class TestControllerAdvice {

	/**
	 * Handler de TestControllerAdviceException
	 *
	 * @param ex
	 * @return
	 * @see TestControllerAdviceException
	 * @see RestTestImpl
	 */
	@ExceptionHandler( TestControllerAdviceException.class )
	public ResponseEntity<TestControllerAdviceError> handleTestControllerAdvice( TestControllerAdviceException ex ) {

		final TestControllerAdviceError error = TestControllerAdviceError.builder()
				.estado( HttpStatus.INTERNAL_SERVER_ERROR ).fecha( LocalDateTime.now() ).mensaje( ex.getMessage() )
				.build();

		return ResponseEntity.status( HttpStatus.INTERNAL_SERVER_ERROR ).body( error );
	}}

try{
...
throw new TestControllerAdviceException("4. Excepción con ControllerAdvice y modelo custom TestControllerAdviceError" );
...
} catch ( final TestControllerAdviceException e4 ) {
	log.error("Test de prueba de excepción con handler en el ControllerAdvice y modelo TestControllerAdviceError: {}", e4.getMessage() );
	throw e4;
}

https://fundewebjsshowcasedesa.um.es/api/v1.0/public/handleError/4

{
    "estado": "INTERNAL_SERVER_ERROR",
    "fecha": "05/10/2021 01:37:25",
    "mensaje": "4. Excepción con ControllerAdvice y modelo custom TestControllerAdviceError",
    "tipoRespuesta": "CUSTOM_ControllerAdvice",
    "erroresValidacion": null
}

@RestControllerAdvice( basePackages = "es.um.atica.fundewebjsshowcasebackend" )
public class TestControllerAdvice extends ResponseEntityExceptionHandler {

	/**
	 * Handler de TestControllerAdviceException
	 *
	 * @param ex
	 * @return
	 * @see TestControllerAdviceException
	 * @see RestTestImpl
	 */
	@ExceptionHandler( TestControllerAdviceException.class )
	public ResponseEntity<TestControllerAdviceError> handleTestControllerAdvice( TestControllerAdviceException ex ) {

		final TestControllerAdviceError error = TestControllerAdviceError.builder()
				.estado( HttpStatus.INTERNAL_SERVER_ERROR ).fecha( LocalDateTime.now() ).mensaje( ex.getMessage() )
				.build();

		return ResponseEntity.status( HttpStatus.INTERNAL_SERVER_ERROR ).body( error );

	}

	@Override
	protected ResponseEntity<Object> handleExceptionInternal( Exception ex, @Nullable Object body, HttpHeaders headers,
			HttpStatus status, WebRequest request ) {

		if ( HttpStatus.INTERNAL_SERVER_ERROR.equals( status ) ) {
			request.setAttribute( WebUtils.ERROR_EXCEPTION_ATTRIBUTE, ex, RequestAttributes.SCOPE_REQUEST );
		}
		return new ResponseEntity<>( body, headers, status );
	}

}