从原理层面掌握@SessionAttributes的使用【享学Spring MVC】（上）

// @since 2.5   它只能标注在类上
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface SessionAttributes {
  // 只有名称匹配上了的  Model上的属性会向session里放置一份~~~
  @AliasFor("names")
  String[] value() default {};
  @AliasFor("value")
  String[] names() default {};
  // 也可以拿类型来约束
  Class<?>[] types() default {};
}

@Controller
@RequestMapping("/sessionattr/demo")
@SessionAttributes(value = {"book", "description"}, types = {Double.class})
public class RedirectController {
    @RequestMapping("/index")
    public String index(Model model, HttpSession httpSession) {
        model.addAttribute("book", "天龙八部");
        model.addAttribute("description", "我乔峰是个契丹人");
        model.addAttribute("price", new Double("1000.00"));
        // 通过Sesson API手动放一个进去
        httpSession.setAttribute("hero", "fsx");
        //跳转之前将数据保存到Model中，因为注解@SessionAttributes中有，所以book和description应该都会保存到SessionAttributes里（注意：不是session里）
        return "redirect:get";
    }
    // 关于@ModelAttribute 下文会讲
    @RequestMapping("/get")
    public String get(@ModelAttribute("book") String book, ModelMap model, HttpSession httpSession, SessionStatus sessionStatus) {
        //可以从model中获得book、description和price的参数
        System.out.println(model.get("book") + ";" + model.get("description") + ";" + model.get("price"));
        // 从sesson中也能拿到值
        System.out.println(httpSession.getAttribute("book"));
        System.out.println("API方式手动放进去的：" + httpSession.getAttribute("hero"));
        // 使用@ModelAttribute也能拿到值
        System.out.println(book);
        // 手动清除SessionAttributes
        sessionStatus.setComplete();
        return "redirect:complete";
    }
    @RequestMapping("/complete")
    @ResponseBody
    public String complete(ModelMap modelMap, HttpSession httpSession) {
        //已经被清除，无法获取book的值
        System.out.println(modelMap.get("book"));
        System.out.println("API方式手动放进去的：" + httpSession.getAttribute("hero"));
        return "sessionAttributes";
    }
}

天龙八部;我乔峰是个契丹人;1000.0
天龙八部
API方式手动放进去的：fsx
天龙八部
null
API方式手动放进去的：fsx

// @since 3.1
public class SessionAttributesHandler {
  private final Set<String> attributeNames = new HashSet<>();
  private final Set<Class<?>> attributeTypes = new HashSet<>();
  // 注意这个重要性：它是注解方式放入session和API方式放入session的关键（它只会记录注解方式放进去的session属性~~）
  private final Set<String> knownAttributeNames = Collections.newSetFromMap(new ConcurrentHashMap<>(4));
  // sessonAttr存储器：它最终存储到的是WebRequest的session域里面去（对httpSession是进行了包装的）
  // 因为有WebRequest的处理，所以达到我们上面看到的效果。complete只会清楚注解放进去的，并不清除API放进去的~~~
  // 它的唯一实现类DefaultSessionAttributeStore实现也简单。（特点：能够制定特殊的前缀，这个有时候还是有用的）
  // 前缀attributeNamePrefix在构造器里传入进来  默认是“”
  private final SessionAttributeStore sessionAttributeStore;
  // 唯一的构造器 handlerType：控制器类型  SessionAttributeStore 是由调用者上层传进来的
  public SessionAttributesHandler(Class<?> handlerType, SessionAttributeStore sessionAttributeStore) {
    Assert.notNull(sessionAttributeStore, "SessionAttributeStore may not be null");
    this.sessionAttributeStore = sessionAttributeStore;
    // 父类上、接口上、注解上的注解标注了这个注解都算
    SessionAttributes ann = AnnotatedElementUtils.findMergedAnnotation(handlerType, SessionAttributes.class);
    if (ann != null) {
      Collections.addAll(this.attributeNames, ann.names());
      Collections.addAll(this.attributeTypes, ann.types());
    }
    this.knownAttributeNames.addAll(this.attributeNames);
  }
  // 既没有指定Name 也没有指定type  这个注解标上了也没啥用
  public boolean hasSessionAttributes() {
    return (!this.attributeNames.isEmpty() || !this.attributeTypes.isEmpty());
  }
  // 看看指定的attributeName或者type是否在包含里面
  // 请注意：name和type都是或者的关系，只要有一个符合条件就成
  public boolean isHandlerSessionAttribute(String attributeName, Class<?> attributeType) {
    Assert.notNull(attributeName, "Attribute name must not be null");
    if (this.attributeNames.contains(attributeName) || this.attributeTypes.contains(attributeType)) {
      this.knownAttributeNames.add(attributeName);
      return true;
    } else {
      return false;
    }
  }
  // 把attributes属性们存储起来  进到WebRequest 里
  public void storeAttributes(WebRequest request, Map<String, ?> attributes) {
    attributes.forEach((name, value) -> {
      if (value != null && isHandlerSessionAttribute(name, value.getClass())) {
        this.sessionAttributeStore.storeAttribute(request, name, value);
      }
    });
  }
  // 检索所有的属性们  用的是knownAttributeNames哦~~~~
  // 也就是说手动API放进Session的 此处不会被检索出来的
  public Map<String, Object> retrieveAttributes(WebRequest request) {
    Map<String, Object> attributes = new HashMap<>();
    for (String name : this.knownAttributeNames) {
      Object value = this.sessionAttributeStore.retrieveAttribute(request, name);
      if (value != null) {
        attributes.put(name, value);
      }
    }
    return attributes;
  }
  // 同样的 只会清除knownAttributeNames
  public void cleanupAttributes(WebRequest request) {
    for (String attributeName : this.knownAttributeNames) {
      this.sessionAttributeStore.cleanupAttribute(request, attributeName);
    }
  }
  // 对底层sessionAttributeStore的一个传递调用~~~~~
  // 毕竟可以拼比一下sessionAttributeStore的实现~~~~
  @Nullable
  Object retrieveAttribute(WebRequest request, String attributeName) {
    return this.sessionAttributeStore.retrieveAttribute(request, attributeName);
  }
}