WebSocket 作用域

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

@Controller
public class MyController {

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

您可以在 websocket 作用域中声明一个 Spring 管理的 bean。您可以将 WebSocket 作用域的 bean 注入到控制器以及 clientInboundChannel 上注册的任何 channel interceptor 中。这些通常是单例,并且比任何单个 WebSocket 会话的生命周期更长。因此,您需要为 WebSocket 作用域的 bean 使用作用域代理模式,示例如下

@Component
@Scope(scopeName = "websocket", proxyMode = ScopedProxyMode.TARGET_CLASS)
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 生命周期方法,如前面的示例所示。