Quick start

git clone https://github.com/CodeIslet/spring-netty-websocket.gitcd spring-boot-netty-websocketmvn clean packagejava -jar service/target/*.jar

WebSocket Request & Response

Request

{    "mapper": "MAPPER_NAME",    "body": {        ... Request body    }}

Response

{    "stauts": "response status", // (OK, ERROR, BAD_REQUEST)    "identifier": "target identifier",    "message": "message",    "body": "response body",    "time": "response time"}

Annotations

WebSocketController

@WebSocketControllerpublic class Groupcontroller() {    ...}

WebSocketRequestMapping

@WebSocketControllerpublic class GroupController() {    /**     * Websocket request object     * {     *   "mapper": "join",     *   "body": {     *     "name": "Joe"     *   }     * }     */     @WebSocketRequestMapping(value = "join")     public void join(JoinRequest req, ChannelHandlerContext ctx, CompletableFuture<ResponseEntity> future) {        ...     }         /**     * Websocket request object     * {     *   "mapper": "leave",     *   "body": null (or pass)     * }      @WebSocketRequestMapping(value = "leave")     public void leave(ChannelHandlerContext ctx, CompletableFuture<ResponseEntity> future) {        ...     }}

WebSocketControllerAdvice, WebSocketExceptionHandler

@WebSocketControllerAdvicepublic class WebSocketExceptionAdvice {        @WebSocketExceptionHandler(throwables = { GroupProcessingException.class })    public ResponseEntity groupProcessingExceptionHandler(GroupProcessingException e) {        return new ResponseEntity(ResponseEntity.ResponseStatus.ERROR, e.getMessage());    }}

WebSocket template

channelType: GROUP(Channel group), SINGLE(Channel)destination: group name or channel idmessage: websocket message stringdata: websocket data body object

Single channel helper

Channel group helper

PubSub for multiple websocket server instances