Merge pull request #6791 from initialcommit-io/BAEL-2892

BAEL-2892: Spring Boot - Rendering Exceptions in JSON

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/.gitignore

@@ -0,0 +1,29 @@
+HELP.md
+/target/
+!.mvn/wrapper/maven-wrapper.jar
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+/build/
+
+### VS Code ###
+.vscode/

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/pom.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-parent</artifactId>
+		<version>2.1.4.RELEASE</version>
+		<relativePath/> <!-- lookup parent from repository -->
+	</parent>
+	<groupId>com.baeldung</groupId>
+	<artifactId>pass-exception-to-client-json-spring-boot</artifactId>
+	<version>0.0.4-SNAPSHOT</version>
+	<name>pass-exception-to-client-json-spring-boot</name>
+	<description>Baeldung article code on how to pass exceptions to client in JSON format using Spring Boot</description>
+
+	<properties>
+		<java.version>1.8</java.version>
+	</properties>
+
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-maven-plugin</artifactId>
+			</plugin>
+		</plugins>
+	</build>
+
+</project>

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/src/main/java/com/baeldung/passexceptiontoclientjsonspringboot/CustomException.java

@@ -0,0 +1,11 @@
+package com.baeldung.passexceptiontoclientjsonspringboot;
+
+public class CustomException extends RuntimeException {
+
+    private static final long serialVersionUID = 1L;
+
+    public CustomException() {
+        super("Custom exception message.");
+    }
+
+}

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/src/main/java/com/baeldung/passexceptiontoclientjsonspringboot/ErrorHandler.java

@@ -0,0 +1,19 @@
+package com.baeldung.passexceptiontoclientjsonspringboot;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ControllerAdvice
+@ResponseBody
+public class ErrorHandler {
+
+    @ExceptionHandler(CustomException.class)
+    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
+    public CustomException handleCustomException(CustomException ce) {
+        return ce;
+    }
+
+}

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/src/main/java/com/baeldung/passexceptiontoclientjsonspringboot/MainController.java

@@ -0,0 +1,14 @@
+package com.baeldung.passexceptiontoclientjsonspringboot;
+
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.GetMapping;
+
+@Controller
+public class MainController {
+
+    @GetMapping("/")
+    public void index() throws CustomException {
+        throw new CustomException();
+    }
+
+}

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/src/main/java/com/baeldung/passexceptiontoclientjsonspringboot/PassExceptionToClientJsonSpringBootApplication.java

@@ -0,0 +1,13 @@
+package com.baeldung.passexceptiontoclientjsonspringboot;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class PassExceptionToClientJsonSpringBootApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(PassExceptionToClientJsonSpringBootApplication.class, args);
+    }
+
+}

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/src/main/resources/application.properties

@@ -0,0 +1 @@
+

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/src/main/resources/static/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/src/main/resources/templates/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/src/test/java/com/baeldung/passexceptiontoclientjsonspringboot/MainControllerIntegrationTest.java

@@ -0,0 +1,16 @@
+package com.baeldung.passexceptiontoclientjsonspringboot;
+
+import org.junit.Test;
+
+public class MainControllerIntegrationTest {
+
+	@Test(expected = CustomException.class)
+	public void givenIndex_thenCustomException() throws CustomException {
+	    
+		MainController mainController = new MainController();
+		
+		mainController.index();
+		
+	}
+
+}

spring-boot-exceptions/pass-exception-to-client-json-spring-boot/src/test/java/com/baeldung/passexceptiontoclientjsonspringboot/PassExceptionToClientJsonSpringBootApplicationTests.java

@@ -0,0 +1,16 @@
+package com.baeldung.passexceptiontoclientjsonspringboot;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.junit4.SpringRunner;
+
+@RunWith(SpringRunner.class)
+@SpringBootTest
+public class PassExceptionToClientJsonSpringBootApplicationTests {
+
+	@Test
+	public void contextLoads() {
+	}
+
+}