无法在SpringBoot中使用ControllerAdvice返回rest api响应

Question

Unable to Return Rest ApiResponse using Controller Advice.

Solution implemented

** My Approach**

1)I created a Controller that throw an exception.

2)Global Exception Handler will catch the exception using @ControllerAdvice.

3)particular method will return response as APIResponse.

Output Shown

{
"timestamp": 1519377824339,
"status": 404,
"error": "Not Found",
"exception": "java.lang.Exception",
"message": "No message available",
"path": "/test"
}

And Output from Console says

System.out.println(" Request Received Here for Exception ");

Output Expected

{
"success": false,
"message": "null Your Exception ",
"object": null
}  

Below is my Code

@RequestMapping("/test")
@RestController
public class TestController  {

@Autowired
private UserService userService;

@PostMapping
ApiResponse<User> post(@RequestBody User user) throws Exception {
    if(true)
        throw new Exception();
    return ApiResponse.success().object(userService.post(user));
}
}

@ControllerAdvice
public class GlobalExceptionHandlerController {

@ExceptionHandler(value = Exception.class)
public ApiResponse<Void> handleDefaultException(Exception exception) {
    System.out.println(" Request Received Here for Exception ");
    return ApiResponse.failure().message(exception.getMessage() + "Please check your Response").build();
}
}
public class ApiResponse<T> {
private boolean success;
private String message;
private T object;

public static class ResponseBuilder {
    private boolean success;
    private String message;

    private ResponseBuilder(boolean success) {
        this.success = success;
        this.message = "";
    }

    public ResponseBuilder message(String message) {
        this.message = message;
        return this;
    }

    public <C> ApiResponse<C> object(C object) {
        return new ApiResponse<C>(success, message, object);
    }

    public <C> ApiResponse<C> build() {
        return new ApiResponse<>(success, message, null);
    }
}

public static ResponseBuilder success() {
    return new ResponseBuilder(true);
}

public static ResponseBuilder failure() {
    return new ResponseBuilder(false);
}

private ApiResponse(boolean success, String message, T object) {
    this.success = success;
    this.message = message;
    this.object = object;
}

public boolean isSuccess() {
    return success;
}

public void setSuccess(boolean success) {
    this.success = success;
}

public String getMessage() {
    return message;
}

public void setMessage(String message) {
    this.message = message;
}

public T getObject() {
    return object;
}

public void setObject(T object) {
    this.object = object;
}
}

Request url

localhost:6005/test

User Body contains

{
 "name":"jalaj"
}

Below is my pom.xml

 <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.10.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
 </parent>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-mongodb</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

I can only judge from the output that my controller is not executing.

You can download the code from my bitbucket profile to see my code.

https://bitbucket.org/JalajChawla/

Can anyone guide me if I am missing anything?

Answer 1

Just extend from GlobalExceptionHandlerController from TestController

@RequestMapping("/test")
@RestController
public class TestController extends GlobalExceptionHandlerController