Spring MVC 实战:响应字段默认值设置

简介: 前言到今天为止,相信大家开发 Web 项目应该都是前后端分离了吧?前后端分离中一般会使用 json 作为前后端的数据交换格式。json 中可以包含数值、字符串、json 对象、数组等等。

前言


到今天为止,相信大家开发 Web 项目应该都是前后端分离了吧?前后端分离中一般会使用 json 作为前后端的数据交换格式。json 中可以包含数值、字符串、json 对象、数组等等。


由于 json 可以转换为 JavaScript 对象,取对象的字段时需要保证对象不能为 null,因此前端同学通常期望后端接口返回对象或数组类型的字段时设置一个默认值。如果每个接口单独设置默认值将会异常繁琐,我们尝试来进行一个全局性的处理。


分析


提到全局设置默认字段值,首先想到的就是使用 AOP 拦截 Controller 方法的执行,方法执行后设置返回值字段的默认值。不过对于将 Controller 方法返回值作为 json 类型的响应体这种情况,还有更好的处理方式。


在上篇《Spring MVC @RequestBody @ResponseBody 序列化反序列化实现》中我们也提到过,@ResponseBody 注解是由 HttpMessageConverter 处理的,Spring MVC 使用 HttpMessageConverter 将方法返回值写入响应体前事实上是有预留给用户的回调的。


image.png

回调的接口如下。


public interface ResponseBodyAdvice<T> {
  // 是否支持给定的返回类型
  boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType);
  // HttpMessageConverter 写响应前回调
  @Nullable
  T beforeBodyWrite(@Nullable T body, MethodParameter returnType, MediaType selectedContentType,
            Class<? extends HttpMessageConverter<?>> selectedConverterType,
            ServerHttpRequest request, ServerHttpResponse response);
}


Spring 会从 ControllerAdviceBean 中查找这个接口的实现,并回调符合条件的接口方法。为了将一个 bean 设置为 ControllerAdviceBean,可以在类上直接添加 @ControllerAdvice 注解。


实现


因此,我们直接定义一个实现 ResponseBodyAdvice 接口的类作为 ControllerAdviceBean 在将 Controller 方法返回值写入响应体前设置字段的默认值就可以了。


这里还是拿前面文章中使用的 User 类做测试,该类定义如下。


@Data
@Accessors(chain = true)
public class User {
    private String username;
    private String password;
    private Address address;
    private List<String> interests;
    private Map<String, Object> extra;
}
@Data
public class Address {
    private String province;
    private String city;
}


注意我们的 User 类字段包括普通的 String 类型,自定义的类型、List 类型 及 Map 类型。

接口返回的通用格式使用 Result 类表示。


@Data
public class Result<T> {
    private Integer code;
    private String message;
    private T data;
    public static <T> Result<T> ok(T data) {
        Result<T> result = new Result<>();
        result.setCode(200);
        result.setMessage("OK");
        result.setData(data);
        return result;
    }
}


我们定义一个测试接口如下。


@RestController
public class UserController {
    @GetMapping("/login")
    public Result<User> login() {
        User user = new User();
        Result<User> result = Result.ok(user);
        return result;
    }
}


为了将 login 方法返回的 Result<User> 写入到响应体前设置默认字段值,我们可以定义 ResponseBodyAdvice 实现如下。


@ControllerAdvice
public class ResponseBodyDefaultValueAdvice implements ResponseBodyAdvice<Result<?>> {
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
      // 仅处理 Result 类型
        return returnType.getParameterType() == Result.class;
    }
    @Override
    public Result<?> beforeBodyWrite(Result<?> body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        Object data = body.getData();
        if (data == null) {
            data = BeanUtils.instantiateClass(ReflectionUtils.findField(body.getClass(), "data").getType());
        }
        setDefault(data);
        return body;
    }
    private void setDefault(Object obj) {
        ReflectionUtils.doWithFields(obj.getClass(), field -> {
            ReflectionUtils.makeAccessible(field);
            Object val = ReflectionUtils.getField(field, obj);
            if (val != null) {
                return;
            }
            // 字段默认值
            Object defaultValue = null;
            if (field.getType() == String.class) {
                defaultValue = "";
            } else if (field.getType() == List.class) {
                defaultValue = Collections.emptyList();
            } else if (field.getType() == Map.class) {
                defaultValue = Collections.emptyMap();
            } else if (field.getType().getPackage().getName().startsWith("com.zzuhkp")) {
                defaultValue = BeanUtils.instantiateClass(field.getType());
                setDefault(defaultValue);
            }
            // 设置字段默认值
            ReflectionUtils.setField(field, obj, defaultValue);
        });
    }
}


这里我们只处理 Result 类型的 Controller 方法返回值,返回值写入响应前,如果字段值为 null 则进行处理,并将 String 类型的值设置为空字符串、List 类型的值设置为空列表、Map 类型的值设置为空 Map 值,以及递归处理了自定义的类型。


测试接口返回内容如下。


{
    "code": 200,
    "message": "OK",
    "data": {
        "username": "",
        "password": "",
        "address": {
            "province": "",
            "city": ""
        },
        "interests": [],
        "extra": {}
    }
}


String、List、Map 以及自定义的 Address 类型都进行了处理,前端同学再也不会吐槽后端接口返回 null 了。

目录
相关文章
SpringMVC入门到实战------5、域对象共享数据 Request、Session、Application、Model、ModelAndView、Map、ModelMap的详细使用及代码实例
这篇文章详细解释了在IntelliJ IDEA中如何使用Mute Breakpoints功能来快速跳过程序中的后续断点,并展示了如何一键清空所有设置的断点。
SpringMVC入门到实战------5、域对象共享数据 Request、Session、Application、Model、ModelAndView、Map、ModelMap的详细使用及代码实例
|
22天前
|
JSON 前端开发 Java
Spring MVC——获取参数和响应
本文介绍了如何在Spring框架中通过不同的注解和方法获取URL参数、上传文件、处理cookie和session、以及响应不同类型的数据。具体内容包括使用`@PathVariable`获取URL中的参数,使用`MultipartFile`上传文件,通过`HttpServletRequest`和`@CookieValue`获取cookie,通过`HttpSession`和`@SessionAttribute`获取session,以及如何返回静态页面、HTML代码片段、JSON数据,并设置HTTP状态码和响应头。
41 1
Spring MVC——获取参数和响应
|
26天前
|
JSON 前端开发 Java
SSM:SpringMVC
本文介绍了SpringMVC的依赖配置、请求参数处理、注解开发、JSON处理、拦截器、文件上传下载以及相关注意事项。首先,需要在`pom.xml`中添加必要的依赖,包括Servlet、JSTL、Spring Web MVC等。接着,在`web.xml`中配置DispatcherServlet,并设置Spring MVC的相关配置,如组件扫描、默认Servlet处理器等。然后,通过`@RequestMapping`等注解处理请求参数,使用`@ResponseBody`返回JSON数据。此外,还介绍了如何创建和配置拦截器、文件上传下载的功能,并强调了JSP文件的放置位置,避免404错误。
|
30天前
|
JSON 前端开发 Java
Spring Boot框架中的响应与分层解耦架构
在Spring Boot框架中,响应与分层解耦架构是两个核心概念,它们共同促进了应用程序的高效性、可维护性和可扩展性。
45 3
|
1月前
|
前端开发 Java 应用服务中间件
【Spring】Spring MVC的项目准备和连接建立
【Spring】Spring MVC的项目准备和连接建立
52 2
|
1月前
|
XML Java 应用服务中间件
【Spring】运行Spring Boot项目,请求响应流程分析以及404和500报错
【Spring】运行Spring Boot项目,请求响应流程分析以及404和500报错
137 2
|
2月前
|
缓存 前端开发 Java
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
Soring Boot的起步依赖、启动流程、自动装配、常用的注解、Spring MVC的执行流程、对MVC的理解、RestFull风格、为什么service层要写接口、MyBatis的缓存机制、$和#有什么区别、resultType和resultMap区别、cookie和session的区别是什么?session的工作原理
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
|
1月前
|
XML 前端开发 Java
Spring,SpringBoot和SpringMVC的关系以及区别 —— 超准确,可当面试题!!!也可供零基础学习
本文阐述了Spring、Spring Boot和Spring MVC的关系与区别,指出Spring是一个轻量级、一站式、模块化的应用程序开发框架,Spring MVC是Spring的一个子框架,专注于Web应用和网络接口开发,而Spring Boot则是对Spring的封装,用于简化Spring应用的开发。
90 0
Spring,SpringBoot和SpringMVC的关系以及区别 —— 超准确,可当面试题!!!也可供零基础学习
|
2月前
|
XML 缓存 前端开发
springMVC02,restful风格,请求转发和重定向
文章介绍了RESTful风格的基本概念和特点,并展示了如何使用SpringMVC实现RESTful风格的请求处理。同时,文章还讨论了SpringMVC中的请求转发和重定向的实现方式,并通过具体代码示例进行了说明。
springMVC02,restful风格,请求转发和重定向
SpringMVC入门到实战------ 十一 拦截器的使用
这篇文章介绍了SpringMVC中拦截器的使用,包括拦截器的配置、拦截器的三个抽象方法`preHandle`、`postHandle`和`afterCompletion`的作用,以及多个拦截器的执行顺序和规则。
SpringMVC入门到实战------ 十一 拦截器的使用