Spring MVC中@SessionAttributes注解使用详解

【1】基础定义

@SessionAttributes用于在请求之间的HTTP Servlet session中存储模型属性。它是一个类型级注解，用于声明特定控制器使用的会话属性。这通常会列出model属性的名称或model属性的类型，这些属性应显示地存储在会话中，以供后续请求访问。

下面实例展示了@SessionAttributes注解使用：

@Controller
@SessionAttributes("pet") 
public class EditPetForm {
    // ...
}

在第一个请求中，当一个名为pet的model属性被添加到model中时，它会自动升级到HTTP Servlet session并保存在该会话中。

在另一个控制器方法使用SessionStatus方法参数清除存储之前，它将一直保留，如下例所示：

@Controller
@SessionAttributes("pet") 
public class EditPetForm {

    // ...
    @ModelAttribute
    public void addPet(Model model){
    	model.addAttribute("pet",new Pet());
    }

    @PostMapping("/pets/{id}")
    public String handle(Pet pet, BindingResult errors, SessionStatus status) {
        if (errors.hasErrors) {
            // ...
        }
            status.setComplete(); 
            // ...
        }
    }
}

• 在Servlet session中存储Pet
• 从Servlet session中清除Pet

什么时候清除sessionAttributesHandler中的属性呢？在调用目标方法后获取ModelAndView时，会调用ModelFactory.updateModel方法。如下所示，如果判断当前请求被处理那么就会尝试清理sessionAttributesHandler中的属性-如上面示例的pet。

public void updateModel(NativeWebRequest request, ModelAndViewContainer container) throws Exception {
	ModelMap defaultModel = container.getDefaultModel();
	if (container.getSessionStatus().isComplete()){
		this.sessionAttributesHandler.cleanupAttributes(request);
	}
	else {
		this.sessionAttributesHandler.storeAttributes(request, defaultModel);
	}
	if (!container.isRequestHandled() && container.getModel() == defaultModel) {
		updateBindingResult(request, defaultModel);
	}
}

• 除了可以通过属性名指定需要放到会话中的属性外(实际上使用的是 value 属性值)；

• 还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中(实际上使用的是 types 属性值)

• 注意: 该注解只能放在类的上面. 而不能修饰放方法

如下所示如果controller上面标注了@SessionAttributes(value={"user"}, types={String.class})，那么map中的两个属性都会放到会话中。

@RequestMapping("/testSessionAttributes")
public String testSessionAttributes(Map<String, Object> map){
	User user = new User("Tom", "123456", "tom@atguigu.com", 15);
	map.put("user", user);
	map.put("school", "atguigu");
	return SUCCESS;
}

如上，则请求域和session域都会有user和school对象。

---

【2】SessionAttributes异常

开发中有时候会遇到由@SessionAttributes引起的异常，如下所示：

其实也就是想要从session中获取user，但是没有找到。

后台测试代码：

@SessionAttributes(value={"user"}, types={String.class})
@Controller
public class SpringMVCTest {
	@RequestMapping("/testModelAttribute")
	public String testModelAttribute(@ModelAttribute("user") User user){
		//同时会在map中放入("user",user)
		System.out.println("修改: " + user);
		return SUCCESS;
	}
}

解释如下：

当SpringMVC向目标方法传参过程中，由于@ModelAttribute("user")value值与类注解@SessionAttributes(value={"user"}, types={String.class}) 的value值匹配 ，将会从session域中寻找对应的对象。但是session域中无key为user对应的对象，那么将会抛出上述异常 ！

解决办法，在执行目标方法前，首先执行public void getUser( )方法，在其中放入{"user",user}对象 。

@ModelAttribute
public void getUser(Map<String, Object> map){
	//模拟从数据库中获取对象
	User user = new User(1, "Tom", "123456", "tom@baidu.com", 12);
	map.put("abc", user);//默认放入请求域中
}

点击查看@ModelAttribute注解详解：
@ModelAttribute注解详解
SpringMVC常见组件之HandlerMethodArgumentResolver解析