SpringBoot+Netty+WebSocket實作訊息發送

SpringBoot搭建Netty實作訊息發送

一.匯入Netty依賴

<dependency>
            <groupId>io.netty</groupId>
            <artifactId>netty-all</artifactId>
            <version>4.1.25.Final</version>
        </dependency>

二.搭建websocket服務器

@Component
public class WebSocketServer {

    /**
     * 主執行緒池
     */
    private EventLoopGroup bossGroup;
    /**
     * 作業執行緒池
     */
    private EventLoopGroup workerGroup;
    /**
     * 服務器
     */
    private ServerBootstrap server;
    /**
     *  回呼
     */
    private ChannelFuture future;

    public void start() {
        future = server.bind(9001);
        System.out.println("netty server - 啟動成功");
    }

    public WebSocketServer() {
        bossGroup = new NioEventLoopGroup();
        workerGroup = new NioEventLoopGroup();

        server = new ServerBootstrap();
        server.group(bossGroup, workerGroup)
                .channel(NioServerSocketChannel.class)
                .childHandler(new WebsocketInitializer());
    }
}

三.初始化Websocket

public class WebsocketInitializer extends ChannelInitializer<SocketChannel> {
  
    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        // ------------------
        // 用于支持Http協議
        // ------------------
        // websocket基于http協議，需要有http的編解碼器
        pipeline.addLast(new HttpServerCodec());
        // 對寫大資料流的支持
        pipeline.addLast(new ChunkedWriteHandler());
        // 添加對HTTP請求和回應的聚合器:只要使用Netty進行Http編程都需要使用
        //設定單次請求的檔案的大小
        pipeline.addLast(new HttpObjectAggregator(1024 * 64));
        //webSocket 服務器處理的協議，用于指定給客戶端連接訪問的路由 :/ws
        pipeline.addLast(new WebSocketServerProtocolHandler("/ws"));
        // 添加Netty空閑超時檢查的支持
        // 1. 讀空閑超時（超過一定的時間會發送對應的事件訊息）
        // 2. 寫空閑超時
        // 3. 讀寫空閑超時
        pipeline.addLast(new IdleStateHandler(4, 8, 12));
        //添加心跳處理
        pipeline.addLast(new HearBeatHandler());
        // 添加自定義的handler
        pipeline.addLast(new ChatHandler());

    }
}

四.創建Netty監聽器

@Component
public class NettyListener implements ApplicationListener<ContextRefreshedEvent> {

    @Resource
    private WebSocketServer websocketServer;

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        if(event.getApplicationContext().getParent() == null) {
            try {
                websocketServer.start();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

五.建立訊息通道

public class UserChannelMap {
    /**
     * 用戶保存用戶id與通道的Map物件
     */
//    private static Map<String, Channel> userChannelMap;

   /* static {
        userChannelMap = new HashMap<String, Channel>();
    }*/

    /**
     * 定義一個channel組，管理所有的channel
     * GlobalEventExecutor.INSTANCE 是全域的事件執行器，是一個單例
     */
    private static ChannelGroup channelGroup = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);

    /**
     * 存放用戶與Chanel的對應資訊，用于給指定用戶發送訊息
     */
    private static ConcurrentHashMap<String,Channel> userChannelMap = new ConcurrentHashMap<>();

    private UserChannelMap(){}
    /**
     * 添加用戶id與channel的關聯
     * @param userNum
     * @param channel
     */
    public static void put(String userNum, Channel channel) {
        userChannelMap.put(userNum, channel);
    }

    /**
     * 根據用戶id移除用戶id與channel的關聯
     * @param userNum
     */
    public static void remove(String userNum) {
        userChannelMap.remove(userNum);
    }

    /**
     * 根據通道id移除用戶與channel的關聯
     * @param channelId 通道的id
     */
    public static void removeByChannelId(String channelId) {
        if(!StringUtils.isNotBlank(channelId)) {
            return;
        }
        for (String s : userChannelMap.keySet()) {
            Channel channel = userChannelMap.get(s);
            if(channelId.equals(channel.id().asLongText())) {
                System.out.println("客戶端連接斷開,取消用戶" + s + "與通道" + channelId + "的關聯");
                userChannelMap.remove(s);
                UserService userService = SpringUtil.getBean(UserService.class);
                userService.logout(s);
                break;
            }
        }
    }

    /**
     * 列印所有的用戶與通道的關聯資料
     */
    public static void print() {
        for (String s : userChannelMap.keySet()) {
            System.out.println("用戶id:" + s + " 通道:" + userChannelMap.get(s).id());
        }
    }

    /**
     * 根據好友id獲取對應的通道
     * @param receiverNum 接收人編號
     * @return Netty通道
     */
    public static Channel get(String receiverNum) {
        return userChannelMap.get(receiverNum);
    }

    /**
     * 獲取channel組
     * @return
     */
    public static ChannelGroup getChannelGroup() {
        return channelGroup;
    }

    /**
     * 獲取用戶channel map
     * @return
     */
    public static ConcurrentHashMap<String,Channel> getUserChannelMap(){
        return userChannelMap;
    }
}

六.自定義訊息型別

public class Message {
    /**
     * 訊息型別
     */
    private Integer type;
    /**
     * 聊天訊息
     */
    private String message;
    /**
     * 擴展訊息欄位
     */
    private Object ext;
    public Integer getType() {
        return type;
    }

    public void setType(Integer type) {
        this.type = type;
    }

    public MarketChatRecord getChatRecord() {
        return marketChatRecord;
    }
    public void setChatRecord(MarketChatRecord chatRecord) {
        this.marketChatRecord = chatRecord;
    }

    public Object getExt() {
        return ext;
    }

    public void setExt(Object ext) {
        this.ext = ext;
    }

    @Override
    public String toString() {
        return "Message{" +
                "type=" + type +
                ", marketChatRecord=" + marketChatRecord +
                ", ext=" + ext +
                '}';
    }

}

七.創建處理訊息的handler

public class ChatHandler extends SimpleChannelInboundHandler<TextWebSocketFrame> {
    private static final Logger log = LoggerFactory.getLogger(WebSocketServer.class);


    /**
     * 用來保存所有的客戶端連接
     */
    private static ChannelGroup clients = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);

    /**
     *當Channel中有新的事件訊息會自動呼叫
     */
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, TextWebSocketFrame msg) throws Exception {
        // 當接收到資料后會自動呼叫
        // 獲取客戶端發送過來的文本訊息
        Gson gson = new Gson();
        log.info("服務器收到訊息：{}",msg.text());
        System.out.println("接收到訊息資料為：" + msg.text());
        Message message = gson.fromJson(msg.text(), Message.class);    
//根據業務要求進行訊息處理
        switch (message.getType()) {
            // 處理客戶端連接的訊息
            case 0:
                // 建立用戶與通道的關聯
            // 處理客戶端發送好友訊息
             break;
            case 1:
            // 處理客戶端的簽收訊息
             break;
            case 2:
                // 將訊息記錄設定為已讀
                break;
            case 3:
                // 接收心跳訊息
                break;
            default:
                break;
        }

    }

    // 當有新的客戶端連接服務器之后，會自動呼叫這個方法
    @Override
    public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
        log.info("handlerAdded 被呼叫"+ctx.channel().id().asLongText());
        // 添加到channelGroup 通道組
        UserChannelMap.getChannelGroup().add(ctx.channel());
//        clients.add(ctx.channel());
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        log.info("{例外:}"+cause.getMessage());
        // 洗掉通道
        UserChannelMap.getChannelGroup().remove(ctx.channel());
        UserChannelMap.removeByChannelId(ctx.channel().id().asLongText());
        ctx.channel().close();
    }

    @Override
    public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
        log.info("handlerRemoved 被呼叫"+ctx.channel().id().asLongText());
        //洗掉通道
        UserChannelMap.getChannelGroup().remove(ctx.channel());
        UserChannelMap.removeByChannelId(ctx.channel().id().asLongText());
        UserChannelMap.print();
    }

}

八.處理心跳

public class HearBeatHandler extends ChannelInboundHandlerAdapter {

    @Override
    public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
        if(evt instanceof IdleStateEvent) {
            IdleStateEvent idleStateEvent = (IdleStateEvent)evt;

            if(idleStateEvent.state() == IdleState.READER_IDLE) {
                System.out.println("讀空閑事件觸發...");
            }
            else if(idleStateEvent.state() == IdleState.WRITER_IDLE) {
                System.out.println("寫空閑事件觸發...");
            }
            else if(idleStateEvent.state() == IdleState.ALL_IDLE) {
                System.out.println("---------------");
                System.out.println("讀寫空閑事件觸發");
                System.out.println("關閉通道資源");
                ctx.channel().close();
            }
        }
    }
}

搭建完成后呼叫測驗

1.頁面訪問http://localhost:9001/ws
2.埠號9001和訪問路徑ws都是我們在上邊配置的，然后傳入我們自定義的訊息message型別，
3.大概流程：訊息發送 ：用戶1先連接通道，然后發送訊息給用戶2，用戶2若是在線直接可以發送給用戶，若沒在線可以將訊息暫存在redis或者通道里，用戶2鏈接通道的話，兩者可以直接通訊，
訊息推送 ：用戶1連接通道，根據通道id查詢要推送的人是否在線，或者推送給所有人，這里我只推送給指定的人，
#todo