Merge pull request #55 from bugsnag/add-spring-handled-exception-example

Add Spring @ExceptionHandler example

Author: foygl

examples/spring-web/src/main/java/com/bugsnag/example/spring/web/ApplicationRestController.java

@@ -21,16 +21,12 @@ public class ApplicationRestController {
     @Autowired
     private ApplicationContext applicationContext;
 
-    private final String links =
-            "<a href=\"/send-handled-exception\">Send a handled exception to Bugsnag</a><br/>"
-            + "<a href=\"/send-handled-exception-info\">Send a handled exception to Bugsnag with INFO severity</a><br/>"
-            + "<a href=\"/send-handled-exception-with-metadata\">Send a handled exception to Bugsnag with custom MetaData</a><br/>"
-            + "<a href=\"/send-unhandled-exception\">Send an unhandled exception to Bugsnag</a><br/>"
-            + "<a href=\"/shutdown\">Shutdown the application</a><br/>";
+    @Autowired
+    private String exampleWebsiteLinks;
 
     @RequestMapping("/")
     public String index() {
-        return links;
+        return exampleWebsiteLinks;
     }
 
     @RequestMapping("/send-handled-exception")
@@ -42,7 +38,7 @@ public String sendHandledException() {
             bugsnag.notify(e);
         }
 
-        return links + "<br/>Sent a handled exception to Bugsnag";
+        return exampleWebsiteLinks + "<br/>Sent a handled exception to Bugsnag";
     }
 
     @RequestMapping("/send-handled-exception-info")
@@ -54,7 +50,7 @@ public String sendHandledExceptionInfo() {
             bugsnag.notify(e, Severity.INFO);
         }
 
-        return links + "<br/>Sent a handled exception to Bugsnag with INFO severity";
+        return exampleWebsiteLinks + "<br/>Sent a handled exception to Bugsnag with INFO severity";
     }
 
     @RequestMapping("/send-handled-exception-with-metadata")
@@ -70,7 +66,7 @@ public String sendHandledExceptionWithMetadata() {
             });
         }
 
-        return links + "<br/>Sent a handled exception to Bugsnag with custom MetaData";
+        return exampleWebsiteLinks + "<br/>Sent a handled exception to Bugsnag with custom MetaData";
     }
 
     @RequestMapping("/send-unhandled-exception")
@@ -90,11 +86,17 @@ public void run() {
         // Wait for unhandled exception thread to finish
         thread.join();
 
-        return links + "<br/>Sent an unhandled exception to Bugsnag";
+        return exampleWebsiteLinks + "<br/>Sent an unhandled exception to Bugsnag";
+    }
+
+    @RequestMapping("/send-spring-handled-exception")
+    public String sendSpringHandledException() {
+        LOGGER.info("Sending a Spring handled exception to Bugsnag");
+        throw new RuntimeException("Spring handled exception");
     }
 
     @RequestMapping("/shutdown")
-    public void shutdown() throws InterruptedException {
+    public void shutdown() {
         LOGGER.info("Shutting down application");
 
         SpringApplication.exit(applicationContext);

examples/spring-web/src/main/java/com/bugsnag/example/spring/web/Config.java

@@ -35,4 +35,15 @@ public Bugsnag bugsnag() {
 
         return bugsnag;
     }
+
+    // The entire code for the example website
+    @Bean
+    public String exampleWebsiteLinks() {
+        return "<a href=\"/send-handled-exception\">Send a handled exception to Bugsnag</a><br/>"
+                + "<a href=\"/send-handled-exception-info\">Send a handled exception to Bugsnag with INFO severity</a><br/>"
+                + "<a href=\"/send-handled-exception-with-metadata\">Send a handled exception to Bugsnag with custom MetaData</a><br/>"
+                + "<a href=\"/send-unhandled-exception\">Send an unhandled exception to Bugsnag</a><br/>"
+                + "<a href=\"/send-spring-handled-exception\">Send an exception handled by Spring @ExceptionHandler to Bugsnag</a><br/>"
+                + "<a href=\"/shutdown\">Shutdown the application</a><br/>";
+    }
 }

examples/spring-web/src/main/java/com/bugsnag/example/spring/web/ControllerExceptionHandler.java

@@ -0,0 +1,32 @@
+package com.bugsnag.example.spring.web;
+
+import com.bugsnag.Bugsnag;
+import com.bugsnag.Severity;
+import org.apache.log4j.Logger;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+// We can add an exception handler to a single controller or do it using a @ControllerAdvice across many controllers.
+@ControllerAdvice
+public class ControllerExceptionHandler {
+
+    private static final Logger LOGGER = Logger.getLogger(ControllerExceptionHandler.class);
+
+    @Autowired
+    private Bugsnag bugsnag;
+
+    @Autowired
+    private String exampleWebsiteLinks;
+
+    @ExceptionHandler(Exception.class)
+    @ResponseBody
+    public String handleException(Exception e) {
+        LOGGER.info("Handling exception with Spring ExceptionHandler");
+        bugsnag.notify(e, (report) -> {
+            report.setSeverity(Severity.ERROR);
+        });
+        return exampleWebsiteLinks + "<br/>Sent a Spring handled exception to Bugsnag";
+    }
+}