SpringMvc-response

1. @RestController

默认用 MappingJacksonHttpMessageConverter 对 json 数据进行转换

2. 序列化JSON 注解

2.1. 返回值 忽略空或null

@JsonInclude(value = JsonInclude.Include.NON_EMPTY, content = JsonInclude.Include.NON_NULL)

3. 统一响应

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface IgnoreResponseAdvice {
}

@RestControllerAdvice
@RequiredArgsConstructor
public class CommonResponseDataAdvice implements ResponseBodyAdvice<Object> {
  private final ResultUtils resultUtils;
  @Override
  public boolean supports(MethodParameter methodParameter,
                          Class<? extends HttpMessageConverter<?>> aClass) {

    if (methodParameter.getDeclaringClass().isAnnotationPresent(IgnoreResponseAdvice.class)) {
      return false;
    }
    if (Objects.requireNonNull(methodParameter.getMethod()).isAnnotationPresent(IgnoreResponseAdvice.class)) {
      return false;
    }

    return true;
  }

  /**
     * 响应返回之前的处理
     */
  @Nullable
  @Override
  @SuppressWarnings("All")
  public Object beforeBodyWrite(@Nullable Object o,
                                MethodParameter methodParameter,
                                MediaType mediaType,
                                Class<? extends HttpMessageConverter<?>> aClass,
                                ServerHttpRequest serverHttpRequest,
                                ServerHttpResponse serverHttpResponse) {

    ResultVO<Object> objectResultVO = resultUtils.resultSuccess(ResultEnumsInfo.SUCCESS);
    if (null == o) {
      return objectResultVO;
    } else if (o instanceof ResultVO) {
      objectResultVO = (ResultVO<Object>) o;
    } else {
      objectResultVO.setData(o);
    }
    return objectResultVO;
  }
}

4. 输出模型数据

提供了以下几种途径输出模型数据：

ModelAndView: 处理方法返回值类型为 ModelAndView 时, 方法体即可通过该对象添加模型数据

Map 及 Model: 入参为 org.springframework.ui.Model org.springframework.ui.ModelMap java.uti.Map 时，处理方法返回时，Map 中的数据会自动添加到模型中。

@SessionAttributes: 将模型中的某个属性暂存到 HttpSession 中，以便多个请求之间可以共享这个属性

@ModelAttribute: 方法入参标注该注解后, 入参的对象就会放到数据模型中

4.1. ModelAndView

控制器处理方法的返回值如果为 ModelAndView, 则其既包含视图信息，也包含模型数据信息

MoelAndView addObject(String attributeName, Object attributeValue)
ModelAndView addAllObject(Map<String, ?> modelMap)

void setView(View view)
void setViewName(String viewName)

@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView(){
  System.out.println("testModelAndView");
  String viewName = "success";
  ModelAndView mv = new ModelAndView(viewName );
  mv.addObject("time",new Date().toString()); //实质上存放到request域中 
  return mv;
}

4.2. Map

Spring MVC 在内部使用了一个 org.springframework.ui.Model 接口存储模型数据

Spring MVC 在调用方法前会创建一个隐含的模型对象作为模型数据的存储容器

如果方法的入参为 Map 或 Model 类型，Spring MVC 会将隐含模型的引用传递给这些入参

在方法体内，开发者可以通过这个入参对象访问到模型中所有数据，也可以向模型中添加新属性数据

注意事项：

注意问题：Map集合的泛型，key为String,Value为Object,而不是String

@RequestMapping("/testMap")
public String testMap(Map<String,Object> map){ 
   System.out.println(map.getClass().getName());
  //org.springframework.validation.support.BindingAwareModelMap
   map.put("names", Arrays.asList("Tom","Jerry","Kite"));
   return "success";
}

目标方法的返回类型也可以是一个Map类型参数（也可以是Model,或ModelMap类型）

@RequestMapping("/testMap2")
public String testMap2(Map<String,Object> map,Model model,ModelMap modelMap){
    System.out.println(map.getClass().getName());
    map.put("names", Arrays.asList("Tom","Jerry","Kite"));
    model.addAttribute("model", "org.springframework.ui.Model");
    modelMap.put("modelMap", "org.springframework.ui.ModelMap");
    System.out.println(map == model);
    System.out.println(map == modelMap);
    System.out.println(model == modelMap);
 
    System.out.println(map.getClass().getName());//true
    System.out.println(model.getClass().getName());//true
    System.out.println(modelMap.getClass().getName());//true 
    return "success";
}

4.3. SessionAttributes

若希望在多个请求之间共用某个模型属性数据，则可以在控制器类上标注一个 @SessionAttributes, Spring MVC 将在模型中对应的属性暂存到 HttpSession 中。

@SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外，还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中例如：

①@SessionAttributes(types=User.class) 会将隐含模型中所有类型为 User.class 的属性添加到会话中。
②@SessionAttributes(value={“user1”, “user2”})
③@SessionAttributes(types={User.class, Dept.class})
④@SessionAttributes(value={“user1”, “user2”}, types={Dept.class})

@Controller
//@SessionAttributes("user")
@SessionAttributes(value={"user"},types={String.class})
public class SpringMVCController {
/**
 @SessionAttributes
    * 除了可以通过属性名指定需要放到会话中的属性外(实际上是通过value指定key值)，
    * 还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中(实际上是通过types指定类型)
    * 注意：只能放在类的上面，不能修饰方法
*/
   @RequestMapping("/testSessionAttributes")
   public String testSessionAttributes(Map<String,Object> map){
   User user = new User("Tom","123","tom@atguigu.com",22);                
   map.put("user", user);
   map.put("school", "atguigu");  
   //默认是被存放到request 域，如果设置了@SessionAttribute注解，就同时存放到session域中
   return "success";
     }
 }

常见问题

1. Long类型精度丢失的问题

前后端ID不一致

@JsonSerialize(using = ToStringSerializer.class)
private Long id;