当前位置：首页 > news >正文

graceful-response配置详解：自定义响应格式与国际化支持全攻略

news 2026/3/27 1:56:27

graceful-response配置详解：自定义响应格式与国际化支持全攻略

【免费下载链接】graceful-responseSpring Boot接口优雅响应处理器，提供统一返回值封装、全局异常处理、自定义异常错误码、参数校验增强、断言增强等功能项目地址: https://gitcode.com/gh_mirrors/gr/graceful-response

graceful-response是一款Spring Boot接口优雅响应处理器，提供统一返回值封装、全局异常处理、自定义异常错误码、参数校验增强、断言增强等功能，帮助开发者快速构建规范的API接口。

为什么需要统一响应格式？

在传统开发中，开发者需要手动处理接口响应格式，包括状态码、消息和数据封装，代码冗余且容易出错。

使用graceful-response后，代码变得简洁优雅，无需手动处理响应格式：

自定义响应格式配置

实现ResponseFactory接口

要自定义响应格式，首先需要实现ResponseFactory接口，该接口定义了创建响应对象的各种方法。

public interface ResponseFactory { Response newEmptyInstance(); Response newInstance(ResponseStatus statusLine); Response newInstance(ResponseStatus statusLine, Object data); Response newSuccessInstance(); Response newSuccessInstance(Object data); Response newFailInstance(); }

自定义响应实现类

创建自定义的响应实现类，例如：

public class CustomResponse implements Response { private int code; private String message; private Object data; // getter和setter方法 }

配置自定义ResponseFactory

在Spring Boot配置类中注册自定义的ResponseFactory：

@Configuration public class GracefulResponseConfig { @Bean public ResponseFactory customResponseFactory() { return new CustomResponseFactory(); } }

国际化支持配置

开启国际化支持

在application.properties中添加以下配置：

graceful-response.i18n=true

创建国际化资源文件

在src/main/resources目录下创建i18n文件夹，并添加以下文件：

i18n/graceful-response_zh_CN.properties
i18n/graceful-response_en_US.properties

例如，在graceful-response_zh_CN.properties中添加：

200=操作成功 400=请求参数错误 500=服务器内部错误

国际化原理

graceful-response通过GrI18nResponseBodyAdvice类实现国际化支持，当开启国际化后，会根据请求的Locale信息自动替换响应消息。

核心代码如下：

@ConditionalOnProperty(prefix = "graceful-response", name = "i18n", havingValue = "true") public class GrI18nResponseBodyAdvice extends AbstractResponseBodyAdvice implements ResponseBodyAdvicePredicate, ResponseBodyAdviceProcessor { @Override public Object process(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) { if (body instanceof Response res) { Locale locale = LocaleContextHolder.getLocale(); ResponseStatus bodyStatus = res.getStatus(); String code = bodyStatus.getCode(); String renderMsg = grMessageSource.getMessage(code, EMPTY_ARRAY, null, locale); if (StringUtils.hasText(renderMsg)) { bodyStatus.setMsg(renderMsg); } } return body; } }