WebSocket 作用域

每个 WebSocket 会话都有一组属性映射。该映射作为标头附加到入站客户端消息,并且可以从控制器方法访问,如以下示例所示:

@Controller
public class MyController {

	@MessageMapping("/action")
	public void handle(SimpMessageHeaderAccessor headerAccessor) {
		Map<String, Object> attrs = headerAccessor.getSessionAttributes();
		// ...
	}
}

你可以在 websocket 作用域中声明一个由 Spring 管理的 bean。 你可以将 WebSocket 作用域的 bean 注入到控制器和注册在 clientInboundChannel 上的任何通道拦截器中。这些通常是单例,并且比任何单个 WebSocket 会话的生命周期都要长。因此,你需要以代理模式使用 WebSocket 作用域的 bean,这可以通过 @WebSocketScope 方便地定义:

@Component
@WebSocketScope
public class MyBean {

	@PostConstruct
	public void init() {
		// Invoked after dependencies injected
	}

	// ...

	@PreDestroy
	public void destroy() {
		// Invoked when the WebSocket session ends
	}
}

@Controller
public class MyController {

	private final MyBean myBean;

	@Autowired
	public MyController(MyBean myBean) {
		this.myBean = myBean;
	}

	@MessageMapping("/action")
	public void handle() {
		// this.myBean from the current WebSocket session
	}
}

与任何自定义作用域一样,Spring 在首次从控制器访问 MyBean 实例时对其进行初始化,并将该实例存储在 WebSocket 会话属性中。此后,直到会话结束,都会返回相同的实例。WebSocket 作用域的 bean 会调用所有 Spring 生命周期方法,如前面的示例所示。