{"id":17315,"date":"2024-03-15T14:46:11","date_gmt":"2024-03-15T14:46:11","guid":{"rendered":"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/"},"modified":"2025-08-07T10:18:22","modified_gmt":"2025-08-07T10:18:22","slug":"how-to-standardize-response-format-in-springboot","status":"publish","type":"post","link":"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/","title":{"rendered":"How to standardize response format in SpringBoot?"},"content":{"rendered":"<p>With Spring Boot, you can achieve a uniform response format by customizing a global exception handler and result wrapping class.<\/p>\n<ol>\n<li>@ControllerAdvice is used in Spring framework to handle exceptions globally in all controllers.<\/li>\n<li>Handler for exceptions<\/li>\n<\/ol>\n<p>The sample code is shown below:<\/p>\n<pre class=\"post-pre\"><code><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-meta\">@ResponseBody<\/span>\r\n    <span class=\"hljs-keyword\">public<\/span> Result <span class=\"hljs-title function_\">handleException<\/span><span class=\"hljs-params\">(Exception e)<\/span> {\r\n        <span class=\"hljs-comment\">\/\/ \u5904\u7406\u5f02\u5e38\u903b\u8f91\uff0c\u53ef\u4ee5\u6839\u636e\u4e0d\u540c\u7684\u5f02\u5e38\u7c7b\u578b\u8fd4\u56de\u4e0d\u540c\u7684\u9519\u8bef\u7801\u548c\u9519\u8bef\u4fe1\u606f<\/span>\r\n        <span class=\"hljs-keyword\">return<\/span> Result.error(<span class=\"hljs-number\">500<\/span>, e.getMessage());\r\n    }\r\n}\r\n<\/code><\/pre>\n<ol>\n<li>Return Result Encapsulation Class:<br \/>\nCreate a class to encapsulate the format of the return result, including status code and message content, and other information.<\/li>\n<\/ol>\n<p>The sample code is shown below:<\/p>\n<pre class=\"post-pre\"><code><span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-keyword\">class<\/span> <span class=\"hljs-title class_\">Result<\/span>&lt;T&gt; {\r\n\r\n    <span class=\"hljs-keyword\">private<\/span> <span class=\"hljs-type\">int<\/span> code;\r\n    <span class=\"hljs-keyword\">private<\/span> String message;\r\n    <span class=\"hljs-keyword\">private<\/span> T data;\r\n\r\n    <span class=\"hljs-comment\">\/\/ getter\u548csetter\u65b9\u6cd5<\/span>\r\n\r\n    <span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-keyword\">static<\/span> &lt;T&gt; Result&lt;T&gt; <span class=\"hljs-title function_\">success<\/span><span class=\"hljs-params\">(T data)<\/span> {\r\n        Result&lt;T&gt; result = <span class=\"hljs-keyword\">new<\/span> <span class=\"hljs-title class_\">Result<\/span>&lt;&gt;();\r\n        result.setCode(<span class=\"hljs-number\">200<\/span>);\r\n        result.setMessage(<span class=\"hljs-string\">\"\u64cd\u4f5c\u6210\u529f\"<\/span>);\r\n        result.setData(data);\r\n        <span class=\"hljs-keyword\">return<\/span> result;\r\n    }\r\n\r\n    <span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-keyword\">static<\/span> &lt;T&gt; Result&lt;T&gt; <span class=\"hljs-title function_\">error<\/span><span class=\"hljs-params\">(<span class=\"hljs-type\">int<\/span> code, String message)<\/span> {\r\n        Result&lt;T&gt; result = <span class=\"hljs-keyword\">new<\/span> <span class=\"hljs-title class_\">Result<\/span>&lt;&gt;();\r\n        result.setCode(code);\r\n        result.setMessage(message);\r\n        <span class=\"hljs-keyword\">return<\/span> result;\r\n    }\r\n}\r\n<\/code><\/pre>\n<p>After configuration is complete, the global exception handler will handle any exceptions that occur and return custom error codes and messages. In normal cases, a successful response can be returned using the Result.success() method, where the data parameter is the data that needs to be returned. This way, a unified response format can be achieved.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>With Spring Boot, you can achieve a uniform response format by customizing a global exception handler and result wrapping class. @ControllerAdvice is used in Spring framework to handle exceptions globally in all controllers. Handler for exceptions The sample code is shown below: @ControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(Exception.class) @ResponseBody public Result handleException(Exception e) { \/\/ [&hellip;]<\/p>\n","protected":false},"author":12,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_import_markdown_pro_load_document_selector":0,"_import_markdown_pro_submit_text_textarea":"","footnotes":""},"categories":[1],"tags":[453,1402,299,1404,1403],"class_list":["post-17315","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-development","tag-guide","tag-programming","tag-technology","tag-tutorial"],"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 standardize response format in SpringBoot? - Blog - Silicon Cloud<\/title>\n<meta name=\"description\" content=\"Learn about how to standardize response format in springboot?. Comprehensive guide with examples and best practices.\" \/>\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-standardize-response-format-in-springboot\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to standardize response format in SpringBoot?\" \/>\n<meta property=\"og:description\" content=\"Learn about how to standardize response format in springboot?. Comprehensive guide with examples and best practices.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/\" \/>\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-15T14:46:11+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-08-07T10:18:22+00:00\" \/>\n<meta name=\"author\" content=\"Liam\" \/>\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=\"Liam\" \/>\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-standardize-response-format-in-springboot\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/\"},\"author\":{\"name\":\"Liam\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/23786905eb7b377f45ddb01c17da7671\"},\"headline\":\"How to standardize response format in SpringBoot?\",\"datePublished\":\"2024-03-15T14:46:11+00:00\",\"dateModified\":\"2025-08-07T10:18:22+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/\"},\"wordCount\":135,\"publisher\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\"},\"keywords\":[\"Development\",\"guide\",\"programming\",\"technology\",\"tutorial\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/\",\"url\":\"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/\",\"name\":\"How to standardize response format in SpringBoot? - Blog - Silicon Cloud\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#website\"},\"datePublished\":\"2024-03-15T14:46:11+00:00\",\"dateModified\":\"2025-08-07T10:18:22+00:00\",\"description\":\"Learn about how to standardize response format in springboot?. Comprehensive guide with examples and best practices.\",\"breadcrumb\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.silicloud.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to standardize response format in SpringBoot?\"}]},{\"@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\/23786905eb7b377f45ddb01c17da7671\",\"name\":\"Liam\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/8d37ed3e7f770dde8bf069ba0b4298688028c3abaacf1131742fc1352d174ebd?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/8d37ed3e7f770dde8bf069ba0b4298688028c3abaacf1131742fc1352d174ebd?s=96&d=mm&r=g\",\"caption\":\"Liam\"},\"sameAs\":[\"http:\/\/Wilson\"],\"url\":\"https:\/\/www.silicloud.com\/blog\/author\/liamwilson\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"How to standardize response format in SpringBoot? - Blog - Silicon Cloud","description":"Learn about how to standardize response format in springboot?. Comprehensive guide with examples and best practices.","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-standardize-response-format-in-springboot\/","og_locale":"en_US","og_type":"article","og_title":"How to standardize response format in SpringBoot?","og_description":"Learn about how to standardize response format in springboot?. Comprehensive guide with examples and best practices.","og_url":"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/","og_site_name":"Blog - Silicon Cloud","article_publisher":"https:\/\/www.facebook.com\/SiliCloudGlobal\/","article_published_time":"2024-03-15T14:46:11+00:00","article_modified_time":"2025-08-07T10:18:22+00:00","author":"Liam","twitter_card":"summary_large_image","twitter_creator":"@SiliCloudGlobal","twitter_site":"@SiliCloudGlobal","twitter_misc":{"Written by":"Liam","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/#article","isPartOf":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/"},"author":{"name":"Liam","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/23786905eb7b377f45ddb01c17da7671"},"headline":"How to standardize response format in SpringBoot?","datePublished":"2024-03-15T14:46:11+00:00","dateModified":"2025-08-07T10:18:22+00:00","mainEntityOfPage":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/"},"wordCount":135,"publisher":{"@id":"https:\/\/www.silicloud.com\/blog\/#organization"},"keywords":["Development","guide","programming","technology","tutorial"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/","url":"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/","name":"How to standardize response format in SpringBoot? - Blog - Silicon Cloud","isPartOf":{"@id":"https:\/\/www.silicloud.com\/blog\/#website"},"datePublished":"2024-03-15T14:46:11+00:00","dateModified":"2025-08-07T10:18:22+00:00","description":"Learn about how to standardize response format in springboot?. Comprehensive guide with examples and best practices.","breadcrumb":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.silicloud.com\/blog\/how-to-standardize-response-format-in-springboot\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.silicloud.com\/blog\/"},{"@type":"ListItem","position":2,"name":"How to standardize response format in SpringBoot?"}]},{"@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\/23786905eb7b377f45ddb01c17da7671","name":"Liam","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/8d37ed3e7f770dde8bf069ba0b4298688028c3abaacf1131742fc1352d174ebd?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/8d37ed3e7f770dde8bf069ba0b4298688028c3abaacf1131742fc1352d174ebd?s=96&d=mm&r=g","caption":"Liam"},"sameAs":["http:\/\/Wilson"],"url":"https:\/\/www.silicloud.com\/blog\/author\/liamwilson\/"}]}},"_links":{"self":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/17315","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\/12"}],"replies":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/comments?post=17315"}],"version-history":[{"count":1,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/17315\/revisions"}],"predecessor-version":[{"id":50918,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/17315\/revisions\/50918"}],"wp:attachment":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/media?parent=17315"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/categories?post=17315"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/tags?post=17315"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}