{"id":24783,"date":"2024-03-16T03:51:04","date_gmt":"2024-03-16T03:51:04","guid":{"rendered":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/"},"modified":"2024-03-22T04:34:54","modified_gmt":"2024-03-22T04:34:54","slug":"how-to-catch-global-exceptions-in-spring-boot","status":"publish","type":"post","link":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/","title":{"rendered":"How to catch global exceptions in Spring Boot?"},"content":{"rendered":"<p>In Spring Boot, you can capture global exceptions by either implementing the ErrorController interface or using the @ControllerAdvice annotation.<\/p>\n<p>Option 1:<br \/>\nOption 1: Implementing the ErrorController interface.<\/p>\n<ol>\n<li>Controller for managing errors<\/li>\n<li>retrieveErrorPath<\/li>\n<\/ol>\n<pre class=\"post-pre\"><code><span class=\"hljs-keyword\">import<\/span> org.springframework.boot.web.servlet.error.ErrorController;\r\n<span class=\"hljs-keyword\">import<\/span> org.springframework.stereotype.Controller;\r\n<span class=\"hljs-keyword\">import<\/span> org.springframework.web.bind.annotation.RequestMapping;\r\n\r\n<span class=\"hljs-meta\">@Controller<\/span>\r\n<span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-keyword\">class<\/span> <span class=\"hljs-title class_\">CustomErrorController<\/span> <span class=\"hljs-keyword\">implements<\/span> <span class=\"hljs-title class_\">ErrorController<\/span> {\r\n\r\n    <span class=\"hljs-meta\">@Override<\/span>\r\n    <span class=\"hljs-keyword\">public<\/span> String <span class=\"hljs-title function_\">getErrorPath<\/span><span class=\"hljs-params\">()<\/span> {\r\n        <span class=\"hljs-keyword\">return<\/span> <span class=\"hljs-string\">\"\/error\"<\/span>; <span class=\"hljs-comment\">\/\/ \u5b9a\u4e49\u9519\u8bef\u9875\u9762\u7684\u8def\u5f84<\/span>\r\n    }\r\n\r\n    <span class=\"hljs-meta\">@RequestMapping(\"\/error\")<\/span>\r\n    <span class=\"hljs-keyword\">public<\/span> String <span class=\"hljs-title function_\">handleError<\/span><span class=\"hljs-params\">()<\/span> {\r\n        <span class=\"hljs-comment\">\/\/ \u5904\u7406\u5f02\u5e38\u7684\u903b\u8f91<\/span>\r\n        <span class=\"hljs-keyword\">return<\/span> <span class=\"hljs-string\">\"error\"<\/span>; <span class=\"hljs-comment\">\/\/ \u8fd4\u56de\u9519\u8bef\u9875\u9762<\/span>\r\n    }\r\n}\r\n<\/code><\/pre>\n<ol>\n<li>properties file for an application<\/li>\n<li>YAML file for the application<\/li>\n<\/ol>\n<p>Option 2: Utilize the @ControllerAdvice annotation.<\/p>\n<ol>\n<li>@ControllerAdvice is an annotation in Spring Framework used for global exception handling and applying common behavior to multiple controllers.<\/li>\n<li>When an exception is caught\/not handled<\/li>\n<\/ol>\n<pre class=\"post-pre\"><code><span class=\"hljs-keyword\">import<\/span> org.springframework.web.bind.annotation.ControllerAdvice;\r\n<span class=\"hljs-keyword\">import<\/span> org.springframework.web.bind.annotation.ExceptionHandler;\r\n<span class=\"hljs-keyword\">import<\/span> org.springframework.web.servlet.ModelAndView;\r\n\r\n<span class=\"hljs-meta\">@ControllerAdvice<\/span>\r\n<span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-keyword\">class<\/span> <span class=\"hljs-title class_\">GlobalExceptionHandler<\/span> {\r\n\r\n    <span class=\"hljs-meta\">@ExceptionHandler(Exception.class)<\/span>\r\n    <span class=\"hljs-keyword\">public<\/span> ModelAndView <span class=\"hljs-title function_\">handleException<\/span><span class=\"hljs-params\">(Exception e)<\/span> {\r\n        <span class=\"hljs-comment\">\/\/ \u5904\u7406\u5f02\u5e38\u7684\u903b\u8f91<\/span>\r\n        <span class=\"hljs-type\">ModelAndView<\/span> <span class=\"hljs-variable\">mav<\/span> <span class=\"hljs-operator\">=<\/span> <span class=\"hljs-keyword\">new<\/span> <span class=\"hljs-title class_\">ModelAndView<\/span>();\r\n        mav.addObject(<span class=\"hljs-string\">\"errorMsg\"<\/span>, e.getMessage());\r\n        mav.setViewName(<span class=\"hljs-string\">\"error\"<\/span>); <span class=\"hljs-comment\">\/\/ \u8fd4\u56de\u9519\u8bef\u9875\u9762<\/span>\r\n        <span class=\"hljs-keyword\">return<\/span> mav;\r\n    }\r\n}\r\n<\/code><\/pre>\n<ol>\n<li>properties file for the application<\/li>\n<li>configuration file for an application<\/li>\n<\/ol>\n<p>Both methods mentioned above can capture global exceptions and return custom error pages or error messages.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>In Spring Boot, you can capture global exceptions by either implementing the ErrorController interface or using the @ControllerAdvice annotation. Option 1: Option 1: Implementing the ErrorController interface. Controller for managing errors retrieveErrorPath import org.springframework.boot.web.servlet.error.ErrorController; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; @Controller public class CustomErrorController implements ErrorController { @Override public String getErrorPath() { return &#8220;\/error&#8221;; \/\/ \u5b9a\u4e49\u9519\u8bef\u9875\u9762\u7684\u8def\u5f84 } [&hellip;]<\/p>\n","protected":false},"author":14,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_import_markdown_pro_load_document_selector":0,"_import_markdown_pro_submit_text_textarea":"","footnotes":""},"categories":[1],"tags":[],"class_list":["post-24783","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v21.5 (Yoast SEO v21.5) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>How to catch global exceptions in Spring Boot? - Blog - Silicon Cloud<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to catch global exceptions in Spring Boot?\" \/>\n<meta property=\"og:description\" content=\"In Spring Boot, you can capture global exceptions by either implementing the ErrorController interface or using the @ControllerAdvice annotation. Option 1: Option 1: Implementing the ErrorController interface. Controller for managing errors retrieveErrorPath import org.springframework.boot.web.servlet.error.ErrorController; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; @Controller public class CustomErrorController implements ErrorController { @Override public String getErrorPath() { return &quot;\/error&quot;; \/\/ \u5b9a\u4e49\u9519\u8bef\u9875\u9762\u7684\u8def\u5f84 } [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/\" \/>\n<meta property=\"og:site_name\" content=\"Blog - Silicon Cloud\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/SiliCloudGlobal\/\" \/>\n<meta property=\"article:published_time\" content=\"2024-03-16T03:51:04+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-03-22T04:34:54+00:00\" \/>\n<meta name=\"author\" content=\"Noah Thompson\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@SiliCloudGlobal\" \/>\n<meta name=\"twitter:site\" content=\"@SiliCloudGlobal\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Noah Thompson\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/\"},\"author\":{\"name\":\"Noah Thompson\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/2e83cc6ab9f60d36921c2d0f9f280f4a\"},\"headline\":\"How to catch global exceptions in Spring Boot?\",\"datePublished\":\"2024-03-16T03:51:04+00:00\",\"dateModified\":\"2024-03-22T04:34:54+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/\"},\"wordCount\":105,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\"},\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/\",\"url\":\"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/\",\"name\":\"How to catch global exceptions in Spring Boot? - Blog - Silicon Cloud\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#website\"},\"datePublished\":\"2024-03-16T03:51:04+00:00\",\"dateModified\":\"2024-03-22T04:34:54+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.silicloud.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to catch global exceptions in Spring Boot?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#website\",\"url\":\"https:\/\/www.silicloud.com\/blog\/\",\"name\":\"Silicon Cloud Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\"},\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\",\"name\":\"Silicon Cloud Blog\",\"url\":\"https:\/\/www.silicloud.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png\",\"contentUrl\":\"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png\",\"width\":1024,\"height\":1024,\"caption\":\"Silicon Cloud Blog\"},\"image\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/SiliCloudGlobal\/\",\"https:\/\/twitter.com\/SiliCloudGlobal\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/2e83cc6ab9f60d36921c2d0f9f280f4a\",\"name\":\"Noah Thompson\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/350e537e1530ede2762ee0237e877d6693f4f7163ab4f303202cc9a6b27b6cb4?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/350e537e1530ede2762ee0237e877d6693f4f7163ab4f303202cc9a6b27b6cb4?s=96&d=mm&r=g\",\"caption\":\"Noah Thompson\"},\"url\":\"https:\/\/www.silicloud.com\/blog\/author\/noahthompson\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"How to catch global exceptions in Spring Boot? - Blog - Silicon Cloud","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/","og_locale":"en_US","og_type":"article","og_title":"How to catch global exceptions in Spring Boot?","og_description":"In Spring Boot, you can capture global exceptions by either implementing the ErrorController interface or using the @ControllerAdvice annotation. Option 1: Option 1: Implementing the ErrorController interface. Controller for managing errors retrieveErrorPath import org.springframework.boot.web.servlet.error.ErrorController; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; @Controller public class CustomErrorController implements ErrorController { @Override public String getErrorPath() { return \"\/error\"; \/\/ \u5b9a\u4e49\u9519\u8bef\u9875\u9762\u7684\u8def\u5f84 } [&hellip;]","og_url":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/","og_site_name":"Blog - Silicon Cloud","article_publisher":"https:\/\/www.facebook.com\/SiliCloudGlobal\/","article_published_time":"2024-03-16T03:51:04+00:00","article_modified_time":"2024-03-22T04:34:54+00:00","author":"Noah Thompson","twitter_card":"summary_large_image","twitter_creator":"@SiliCloudGlobal","twitter_site":"@SiliCloudGlobal","twitter_misc":{"Written by":"Noah Thompson","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/#article","isPartOf":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/"},"author":{"name":"Noah Thompson","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/2e83cc6ab9f60d36921c2d0f9f280f4a"},"headline":"How to catch global exceptions in Spring Boot?","datePublished":"2024-03-16T03:51:04+00:00","dateModified":"2024-03-22T04:34:54+00:00","mainEntityOfPage":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/"},"wordCount":105,"commentCount":0,"publisher":{"@id":"https:\/\/www.silicloud.com\/blog\/#organization"},"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/","url":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/","name":"How to catch global exceptions in Spring Boot? - Blog - Silicon Cloud","isPartOf":{"@id":"https:\/\/www.silicloud.com\/blog\/#website"},"datePublished":"2024-03-16T03:51:04+00:00","dateModified":"2024-03-22T04:34:54+00:00","breadcrumb":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.silicloud.com\/blog\/how-to-catch-global-exceptions-in-spring-boot\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.silicloud.com\/blog\/"},{"@type":"ListItem","position":2,"name":"How to catch global exceptions in Spring Boot?"}]},{"@type":"WebSite","@id":"https:\/\/www.silicloud.com\/blog\/#website","url":"https:\/\/www.silicloud.com\/blog\/","name":"Silicon Cloud Blog","description":"","publisher":{"@id":"https:\/\/www.silicloud.com\/blog\/#organization"},"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.silicloud.com\/blog\/#organization","name":"Silicon Cloud Blog","url":"https:\/\/www.silicloud.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png","contentUrl":"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png","width":1024,"height":1024,"caption":"Silicon Cloud Blog"},"image":{"@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/SiliCloudGlobal\/","https:\/\/twitter.com\/SiliCloudGlobal"]},{"@type":"Person","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/2e83cc6ab9f60d36921c2d0f9f280f4a","name":"Noah Thompson","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/350e537e1530ede2762ee0237e877d6693f4f7163ab4f303202cc9a6b27b6cb4?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/350e537e1530ede2762ee0237e877d6693f4f7163ab4f303202cc9a6b27b6cb4?s=96&d=mm&r=g","caption":"Noah Thompson"},"url":"https:\/\/www.silicloud.com\/blog\/author\/noahthompson\/"}]}},"_links":{"self":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/24783","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/users\/14"}],"replies":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/comments?post=24783"}],"version-history":[{"count":1,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/24783\/revisions"}],"predecessor-version":[{"id":58839,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/24783\/revisions\/58839"}],"wp:attachment":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/media?parent=24783"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/categories?post=24783"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/tags?post=24783"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}