开箱即用的 Web 层解决方案:web-spring-boot-starter 助你统一返回体、异常处理与跨域配置

作者:ChildrenGreens

项目地址:github.com/ChildrenGre...

Maven Central: com.childrengreens:web-spring-boot-starter


一、为什么要做这个 Starter?

在日常 Java 开发中,Web 层的重复劳动非常多:

  • 每个项目都要写一套统一返回体;
  • 各种 Controller 需要统一异常处理;
  • 跨域、时间格式、JSON 序列化到处重复配置;
  • 日志打印、响应封装到处复制粘贴。

为了让 Spring Boot 项目做到 "一次配置,全局生效" ,我开发了一个轻量级的 Starter ------

👉 web-spring-boot-starter


二、项目简介

一个轻量级 Web 层 Starter,为 Spring Boot 提供:

  • 统一返回体封装
  • 全局异常处理
  • JSON 格式化配置
  • 全局拦截器与跨域支持
  • 响应包装与日志增强

📦 Maven 引入:

xml 复制代码
<dependency>
  <groupId>io.github.childrengreens</groupId>
  <artifactId>web-spring-boot-starter</artifactId>
  <version>0.0.1</version>
</dependency>

三、核心特性

✅ 统一返回体结构

json 复制代码
{
  "code": "BUSINESS_ERROR",
  "message": "Login required",
  "data": null,
  "traceId": "a8ad0b6ee5c84fab"
}

所有 Controller 返回数据自动包装,无需手写 Result.ok()

⚙️ 全局异常处理

捕获业务异常、参数校验异常、系统异常,让返回格式始终一致。

🌍 JSON 与 CORS 配置

默认开启跨域,支持覆盖。内置 Jackson 序列化配置:

  • Long → String(防止前端精度丢失)
  • 统一日期格式
  • 忽略 null 字段

🧩 拦截器与日志增强

提供可扩展的 Web 拦截器接口,可实现 traceId、header 校验、请求日志记录等。


四、快速上手

示例:

java 复制代码
@RestController
class StatusController {

    @GetMapping("/status")
    StatusPayload status() {
        return new StatusPayload("UP");
    }

    record StatusPayload(String state) { }
}

访问结果:

json 复制代码
{
  "code": "0",
  "message": "OK",
  "data": {
    "state": "UP"
  },
  "traceId": "a8ad0b6ee5c84fab"
}

无需额外封装,即可自动应用统一格式。


五、适用场景

  • 多模块 Spring Boot 项目;
  • 企业级 Web 层规范;
  • 微服务网关与后端交互接口统一;
  • 快速构建标准化 API 服务。

六、贡献与反馈

欢迎在 GitHub 提交 PR 或 Issue:

🌟 github.com/ChildrenGre...

相关推荐
用户3521802454751 天前
当 Prompt 学会"热更新":Spring Boot × Nacos3 AI 实战
java·spring boot·ai编程
昵称为空C1 天前
手撸一个动态 SQL 执行引擎:不重启服务,在线增删改查任意数据库
spring boot·后端
霸道流氓气质2 天前
领域驱动设计(DDD)在 Spring Boot 微服务中的实践指南
运维·spring boot·微服务
于先生吖2 天前
SpringBoot对接大模型开发AI命理测算系统:八字排盘与AI解析接口源码全解
人工智能·spring boot·后端
Flittly2 天前
【AgentScope Java新手村系列】(10)实战-多Agent天气助手
java·spring boot·spring
星落zx2 天前
Spring Boot 多模型集成:优雅调用全球主流大模型
人工智能·spring boot·chatgpt
一杯奶茶¥2 天前
水果销售网站 CRM客户信息管理系统 超市管理系 酒店管理系统 健身房管理系统 在线音乐网站 校园招聘系统
java·vue.js·spring boot·mysql·spring·java项目
进阶的小名2 天前
Spring Boot SSE + Nginx 配置:解决 EventSource 不实时返回、连接超时、流式响应被缓冲问题
spring boot·后端·nginx
我登哥MVP3 天前
SpringCloud Alibaba 核心组件解析:服务链路追踪
java·spring boot·后端·spring·spring cloud·java-ee·maven