Esta página es la equivalente FundeWebJS a la Wiki Manejo de errores en servicios REST de FundeWeb. 

No es necesario conocer ni utilizar todos los códigos de estado HTTP.

    //EJEMPLO ResponseEntity con éxito
	public ResponseEntity<String> simpleAsyncTask( @RequestParam( defaultValue = "60" ) long t,
			@RequestParam( defaultValue = "1" ) long sleep ) throws InterruptedException {

		String result = "";
		log.info( "Entro en simpleAsyncTask {} - {}", t, sleep );

		final CompletableFuture<String> asyncStatus = service.asyncMethod( sleep * 1000, t );
		result = asyncStatus.getNow( "ko" );
		log.info( "Salgo de simpleAsyncTask" );

		return ResponseEntity.ok( result );
	}

    //EJEMPLO ResponseEntity con error
	@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 );

	}

El término "modelo de respuesta" empleado en esta guía se refiere al formato de JSON (los campos) devuelto cuando sucede una situación de error.

La integración con el estándar  RFC 7807 Problem con Spring Boot está en desarrollo. Cuando esté terminada dicha integración se modificará el modelo de respuesta estándar para contener los campos del RFC Problem (ver wiki manejo de errores en FundeWeb).

Ante cualquier duda póngase en contacto con MNCS.

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() );

} ....

Se recomienda usar Postman para realizar todas las pruebas de peticiones con FundeWebJS.

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

{
    "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;
}
...

Se recomienda usar Postman para realizar todas las pruebas de peticiones con FundeWebJS.

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;
}
...

Se recomienda usar Postman para realizar todas las pruebas de peticiones con FundeWebJS.

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;
}

Se recomienda usar Postman para realizar todas las pruebas de peticiones con FundeWebJS.

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 );
	}

}

/**
* Anotaciones Min y Max para validar el párametro Path de entrada "ex".
*/ 
public ResponseEntity<Object> handleError( HttpServletRequest request, HttpSession session,
			@PathVariable( required = true ) @Min( 1 ) @Max( 4 ) Integer ex ) {...
}

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

/**
* Handler para la excepción raíz para validaciones javax.validation.ValidationException
*/
    @ExceptionHandler( ValidationException.class )
	public ResponseEntity<Object> handle( ValidationException ex ) {

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

		final List<String> errorList = new ArrayList<>();

		if ( ex instanceof ConstraintViolationException ) {
			final Set<ConstraintViolation<?>> constraintViolations = ( ( ConstraintViolationException ) ex )
					.getConstraintViolations();

			errorList.addAll( constraintViolations.stream()
					.map( constraintViolation -> String.format( "%s value '%s' %s",
							constraintViolation.getPropertyPath(), constraintViolation.getInvalidValue(),
							constraintViolation.getMessage() ) )
					.collect( Collectors.toList() ) );
		} else {
			errorList.add( ex.getMessage() );
		}

		error.setErroresValidacion( errorList );

		return ResponseEntity.badRequest().body( error );
	}
}

Se recomienda usar Postman para realizar todas las pruebas de peticiones con FundeWebJS.

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

{
    "estado": "BAD_REQUEST",
    "fecha": "13/10/2021 05:26:36",
    "mensaje": "handleError.ex: must be less than or equal to 4",
    "tipoRespuesta": "CUSTOM_ControllerAdvice",
    "erroresValidacion": [
        "handleError.ex value '5' must be less than or equal to 4"
    ]
}

La configuración y uso de Bean Validation queda como objetivo de la página de confluence: [EN CONSTRUCCIÓN]. Ante cualquier duda contacte con MNCS o revise las fuentes del proyecto de ejemplo fundewebjsshowcase-api.

Próximamente estará disponible la integración con el RFC Problem, por lo que no se recomienda elaborar muchos modelos de respuesta propios.

Estará disponible un modelo de respuesta común para las aplicaciones FundeWebJS y se indicará cómo manejar las excepciones de forma más ágil.