摘要:當用戶注銷或退出時,釋放連接,清空對象中的登錄狀態。聊天管理模塊系統的核心模塊,這部分主要使用框架實現,功能包括信息文件的單條和多條發送,也支持表情發送。描述讀取完連接的消息后,對消息進行處理。
0.前言
最近一段時間在學習Netty網絡框架,又趁著計算機網絡的課程設計,決定以Netty為核心,以WebSocket為應用層通信協議做一個互聯網聊天系統,整體而言就像微信網頁版一樣,但考慮到這個聊天系統的功能非常多,因此只打算實現核心的聊天功能,包括單發、群發、文件發送,然后把項目與Spring整合做成開源、可拓展的方式,給大家參考、討論、使用,歡迎大家的指點。
關于Netty
Netty 是一個利用 Java 的高級網絡的能力,隱藏其背后的復雜性而提供一個易于使用的 API 的客戶端/服務器框架。
這里借用《Essential Netty In Action》的一句話來簡單介紹Netty,詳細的可參考閱讀該書的電子版
Essential Netty in Action 《Netty 實戰(精髓)》
關于WebSocket通信協議
簡單說一下WebSocket通信協議,WebSocket是為了解決HTTP協議中通信只能由客戶端發起這個弊端而出現的,WebSocket基于HTTP5協議,借用HTTP進行握手、升級,能夠做到輕量的、高效的、雙向的在客戶端和服務端之間傳輸文本數據。詳細可參考以下文章:
WebSocket 是什么原理?為什么可以實現持久連接?
WebSocket 教程 - 阮一峰的網絡日志
1. 技術準備操作平臺:Windows 7, 64bit 8G
IDE:MyEclipse 2016
JDK版本:1.8.0_121
瀏覽器:谷歌瀏覽器、360瀏覽器(極速模式)(涉及網頁前端設計,后端開發表示很苦悶)
涉及技術:
Netty 4
WebSocket + HTTP
Spring MVC + Spring
JQuery
Bootstrap 3 + Bootstrap-fileinput
Maven 3.5
Tomcat 8.0
2. 整體說明 2.1 設計思想整個通信系統以Tomcat作為核心服務器運行,其下另開一個線程運行Netty WebSocket服務器,Tomcat服務器主要處理客戶登錄、個人信息管理等的HTTP類型請求(通常的業務類型),端口為8080,Netty WebSockt服務器主要處理用戶消息通信的WebSocket類型請求,端口為3333。用戶通過瀏覽器登錄后,瀏覽器會維持一個Session對象(有效時間30分鐘)來保持登錄狀態,Tomcat服務器會返回用戶的個人信息,同時記錄在線用戶,根據用戶id建立一條WebSocket連接并保存在后端以便進行實時通信。當一個用戶向另一用戶發起通信,服務器會根據消息內容中的對話方用戶id,找到保存的WebSocket連接,通過該連接發送消息,對方就能夠收到即時收到消息。當用戶注銷或退出時,釋放WebSocket連接,清空Session對象中的登錄狀態。
事實上Netty也可以用作一個HTTP服務器,而這里使用Spring MVC處理HTTP請求是出于熟悉的緣故,也比較接近傳統開發的方式。
2.2 系統結構系統采用B/S(Browser/Server),即瀏覽器/服務器的結構,主要事務邏輯在服務器端(Server)實現。借鑒MVC模式的思想,從上至下具體又分為視圖層(View)、控制層(Controller)、業務層(Service)、模型層(Model)、數據訪問層(Data Access)
2.3 項目結構項目后端結構:
項目前端結構:
系統只包括兩個模塊:登錄模塊和聊天管理模塊。
登錄模塊:既然作為一個系統,那么登錄的角色認證是必不可少的,這里使用簡單、傳統的Session方式維持登錄狀態,當然也有對應的注銷功能,但這里的注銷除了清空Session對象,還要釋放WebSocket連接,否則造成內存泄露。
聊天管理模塊:系統的核心模塊,這部分主要使用Netty框架實現,功能包括信息、文件的單條和多條發送,也支持表情發送。
其他模塊:如好友管理模塊、聊天記錄管理、注冊模塊等,我并沒有實現,有興趣的話可以自行實現,與傳統的開發方式類似。
到這里,可能會有人出現疑問了,首先是前面的涉及技術中沒有ORM框架(Mybatis或Hibernate),這里又沒有實現好友管理的功能,那用戶如何確定自己的好友并發送信息呢?
其實,這里我在dao層的實現里并沒有連接數據庫,而是用硬編碼的方式固定好系統的用戶以及用戶的好友表、群組表,之所以這么做是因為當初考慮到這個課程設計要是連接數據庫就太麻煩了光是已有的模塊(包括前后端)就差不多3k行代碼了,時間上十分劃不來,于是就用了硬編碼的方式偷懶,后面會再說明系統用戶的情況。
由于本系統涉及多個用戶狀態,有必要進行說明,下面給出本系統的用戶狀態轉換圖。
系統聊天界面如下:
不得不說的是,當關閉Tomcat服務器時,也要釋放Netty相關資源,否則會造成內存泄漏,關閉方法如下面的close(),如果只是使用shutdownGracefully()方法的話,關閉時會報內存泄露Memory Leak異常(但IDE可能來不及輸出到控制臺)
/** * 描述: Netty WebSocket服務器 * 使用獨立的線程啟動 * @author Kanarien * @version 1.0 * @date 2018年5月18日 上午11:22:51 */ public class WebSocketServer implements Runnable{ private final Logger logger = LoggerFactory.getLogger(WebSocketServer.class); @Autowired private EventLoopGroup bossGroup; @Autowired private EventLoopGroup workerGroup; @Autowired private ServerBootstrap serverBootstrap; private int port; private ChannelHandler childChannelHandler; private ChannelFuture serverChannelFuture; // 構造方法少了會報錯 public WebSocketServer() {} @Override public void run() { build(); } /** * 描述:啟動Netty Websocket服務器 */ public void build() { try { long begin = System.currentTimeMillis(); serverBootstrap.group(bossGroup, workerGroup) //boss輔助客戶端的tcp連接請求 worker負責與客戶端之前的讀寫操作 .channel(NioServerSocketChannel.class) //配置客戶端的channel類型 .option(ChannelOption.SO_BACKLOG, 1024) //配置TCP參數,握手字符串長度設置 .option(ChannelOption.TCP_NODELAY, true) //TCP_NODELAY算法,盡可能發送大塊數據,減少充斥的小塊數據 .childOption(ChannelOption.SO_KEEPALIVE, true)//開啟心跳包活機制,就是客戶端、服務端建立連接處于ESTABLISHED狀態,超過2小時沒有交流,機制會被啟動 .childOption(ChannelOption.RCVBUF_ALLOCATOR, new FixedRecvByteBufAllocator(592048))//配置固定長度接收緩存區分配器 .childHandler(childChannelHandler); //綁定I/O事件的處理類,WebSocketChildChannelHandler中定義 long end = System.currentTimeMillis(); logger.info("Netty Websocket服務器啟動完成,耗時 " + (end - begin) + " ms,已綁定端口 " + port + " 阻塞式等候客戶端連接"); serverChannelFuture = serverBootstrap.bind(port).sync(); } catch (Exception e) { logger.info(e.getMessage()); bossGroup.shutdownGracefully(); workerGroup.shutdownGracefully(); e.printStackTrace(); } } /** * 描述:關閉Netty Websocket服務器,主要是釋放連接 * 連接包括:服務器連接serverChannel, * 客戶端TCP處理連接bossGroup, * 客戶端I/O操作連接workerGroup * * 若只使用 * bossGroupFuture = bossGroup.shutdownGracefully(); * workerGroupFuture = workerGroup.shutdownGracefully(); * 會造成內存泄漏。 */ public void close(){ serverChannelFuture.channel().close(); Future> bossGroupFuture = bossGroup.shutdownGracefully(); Future> workerGroupFuture = workerGroup.shutdownGracefully(); try { bossGroupFuture.await(); workerGroupFuture.await(); } catch (InterruptedException ignore) { ignore.printStackTrace(); } } public ChannelHandler getChildChannelHandler() { return childChannelHandler; } public void setChildChannelHandler(ChannelHandler childChannelHandler) { this.childChannelHandler = childChannelHandler; } public int getPort() { return port; } public void setPort(int port) { this.port = port; } }3.1.2 Netty服務器處理鏈
獨立出處理器鏈類,方便修改與注入,免得混在一起顯得混亂。
@Component public class WebSocketChildChannelHandler extends ChannelInitializer3.1.3 Netty服務器HTTP請求處理器{ @Resource(name = "webSocketServerHandler") private ChannelHandler webSocketServerHandler; @Resource(name = "httpRequestHandler") private ChannelHandler httpRequestHandler; @Override protected void initChannel(SocketChannel ch) throws Exception { ch.pipeline().addLast("http-codec", new HttpServerCodec()); // HTTP編碼解碼器 ch.pipeline().addLast("aggregator", new HttpObjectAggregator(65536)); // 把HTTP頭、HTTP體拼成完整的HTTP請求 ch.pipeline().addLast("http-chunked", new ChunkedWriteHandler()); // 分塊,方便大文件傳輸,不過實質上都是短的文本數據 ch.pipeline().addLast("http-handler", httpRequestHandler); ch.pipeline().addLast("websocket-handler",webSocketServerHandler); } }
值得一提的是,當在處理鏈中使用Spring注入處理器的bean的時候,如果處理器類不使用@Sharable標簽的話,會出現錯誤。如果不使用Spring注入bean的方式,那么應該new一個新的處理器對象,如ch.pipeline().addLast("http-handler", new HttpRequestHandler())。另外,判斷HTTP請求還是WebSocket請求的方式稍微不太優雅,但我按照《Essential Netty in Action》中的方法去試,結果有問題的,只好用下面的if語句判斷。
@Component @Sharable public class HttpRequestHandler extends SimpleChannelInboundHandler3.1.4 Netty服務器WebSocket請求處理器
考慮到規范性與可維護性,switch語句中的case常量應該放在常量類中聲明比較好。另外說下群發的邏輯(屬于業務邏輯,這里沒有給出代碼),群發也就是在一個群中發言,后端會掃描群中在線的用戶,逐一發送信息。用戶的WebSocket連接(即ChannelHandlerContext對象),會保存在全局變量onlineUserMap中,以用戶id作鍵,方便操作連接。關于表情的發送邏輯,與單發邏輯相同,不同的是發送內容為對應的img標簽字符串。
@Component @Sharable public class WebSocketServerHandler extends SimpleChannelInboundHandler3.1.5 文件上傳{ private static final Logger LOGGER = LoggerFactory.getLogger(WebSocketServerHandler.class); @Autowired private ChatService chatService; /** * 描述:讀取完連接的消息后,對消息進行處理。 * 這里主要是處理WebSocket請求 */ @Override protected void channelRead0(ChannelHandlerContext ctx, WebSocketFrame msg) throws Exception { handlerWebSocketFrame(ctx, msg); } /** * 描述:處理WebSocketFrame * @param ctx * @param frame * @throws Exception */ private void handlerWebSocketFrame(ChannelHandlerContext ctx, WebSocketFrame frame) throws Exception { // 關閉請求 if (frame instanceof CloseWebSocketFrame) { WebSocketServerHandshaker handshaker = Constant.webSocketHandshakerMap.get(ctx.channel().id().asLongText()); if (handshaker == null) { sendErrorMessage(ctx, "不存在的客戶端連接!"); } else { handshaker.close(ctx.channel(), (CloseWebSocketFrame) frame.retain()); } return; } // ping請求 if (frame instanceof PingWebSocketFrame) { ctx.channel().write(new PongWebSocketFrame(frame.content().retain())); return; } // 只支持文本格式,不支持二進制消息 if (!(frame instanceof TextWebSocketFrame)) { sendErrorMessage(ctx, "僅支持文本(Text)格式,不支持二進制消息"); } // 客服端發送過來的消息 String request = ((TextWebSocketFrame)frame).text(); LOGGER.info("服務端收到新信息:" + request); JSONObject param = null; try { param = JSONObject.parseObject(request); } catch (Exception e) { sendErrorMessage(ctx, "JSON字符串轉換出錯!"); e.printStackTrace(); } if (param == null) { sendErrorMessage(ctx, "參數為空!"); return; } String type = (String) param.get("type"); switch (type) { case "REGISTER": chatService.register(param, ctx); break; case "SINGLE_SENDING": chatService.singleSend(param, ctx); break; case "GROUP_SENDING": chatService.groupSend(param, ctx); break; case "FILE_MSG_SINGLE_SENDING": chatService.FileMsgSingleSend(param, ctx); break; case "FILE_MSG_GROUP_SENDING": chatService.FileMsgGroupSend(param, ctx); break; default: chatService.typeError(ctx); break; } } /** * 描述:客戶端斷開連接 */ @Override public void channelInactive(ChannelHandlerContext ctx) throws Exception { chatService.remove(ctx); } /** * 異常處理:關閉channel */ @Override public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception { cause.printStackTrace(); ctx.close(); } private void sendErrorMessage(ChannelHandlerContext ctx, String errorMsg) { String responseJson = new ResponseJson() .error(errorMsg) .toString(); ctx.channel().writeAndFlush(new TextWebSocketFrame(responseJson)); } }
文件上傳的思路是先把文件上傳到服務器上,再返回給對方文件的url以及相關信息。文件上傳并沒有使用WebSocket連接來上傳,而是直接使用HTTP連接結合Spring的接口簡單的實現了,可自行修改實現使用WebSocket連接來上傳文件。另外,文件保存的路徑是http://localhost:8080/WebSocket/UploadFile,如果Tomcat端口不是8080或者想改變存儲路徑的話,請注意修改常量。
@Service public class FileUploadServiceImpl implements FileUploadService{ private final static String SERVER_URL_PREFIX = "http://localhost:8080/WebSocket/"; private final static String FILE_STORE_PATH = "UploadFile"; @Override public ResponseJson upload(MultipartFile file, HttpServletRequest request) { // 重命名文件,防止重名 String filename = getRandomUUID(); String suffix = ""; String originalFilename = file.getOriginalFilename(); String fileSize = FileUtils.getFormatSize(file.getSize()); // 截取文件的后綴名 if (originalFilename.contains(".")) { suffix = originalFilename.substring(originalFilename.lastIndexOf(".")); } filename = filename + suffix; String prefix = request.getSession().getServletContext().getRealPath("/") + FILE_STORE_PATH; System.out.println("存儲路徑為:" + prefix + "" + filename); Path filePath = Paths.get(prefix, filename); try { Files.copy(file.getInputStream(), filePath); } catch (IOException e) { e.printStackTrace(); return new ResponseJson().error("文件上傳發生錯誤!"); } return new ResponseJson().success() .setData("originalFilename", originalFilename) .setData("fileSize", fileSize) .setData("fileUrl", SERVER_URL_PREFIX + FILE_STORE_PATH + "" + filename); } private String getRandomUUID() { return UUID.randomUUID().toString().replace("-", ""); } }3.2 WebSocket客戶端 3.2.1 瀏覽器客戶端代碼
下面只展示核心的websocket連接代碼。補充說明:考慮到瀏覽器的兼容性,經測試,建議使用谷歌瀏覽器和360瀏覽器(極速模式),火狐瀏覽器和IE11的界面有點問題。也說明一下,UI設計的排版是從網上找的,由修改了下,自己嘔心瀝血的用JS補充了動態功能,包括:
新消息紅標簽提醒
新消息置頂
客戶端保存已發聊天記錄
用戶己方聊天信息靠左,接收信息靠右
聊天信息框的寬度動態計算
詳細可見chatroom.js文件
4. 效果及操作演示 4.1 登錄操作登錄入口為:http://localhost:8080/WebSocket/login 或 http://localhost:8080/WebSocket/
當前系統用戶固定為9個,群組1個,包括9人用戶。
用戶1 用戶名:Member001 密碼:001
用戶2 用戶名:Member002 密碼:002
······
用戶9 用戶名:Member009 密碼:009
4.2 聊天演示 4.3 文件上傳演示 5.補充為了使項目具有更好的可拓展性、可讀性、可維護性,很多地方都使用Spring的Bean進行注入,也運用了面向接口編程的思想,當運用上Mybatis等ORM框架的時候,直接修改dao層實現即可,無需改動其他地方,同時也在適當的地方加上了注釋。
最后附上git源碼地址:Kanarien GitHub
Copyright ? 2018, GDUT CSCW back-end Kanarien, All Rights Reserved
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/71654.html
摘要:是一個持久化的協議,相對于這種非持久的協議來說。最大的特點就是實現全雙工通信客戶端能夠實時推送消息給服務端,服務端也能夠實時推送消息給客戶端。參考鏈接知乎問題原理原理知乎問題編碼什么用如果文章有錯的地方歡迎指正,大家互相交流。 前言 今天在慕課網上看到了Java的新教程(Netty入門之WebSocket初體驗):https://www.imooc.com/learn/941 WebS...
摘要:廣播這是最簡單的集群通訊解決方案。實現方法在治理中心監聽集群服務事件,并及時更新哈希環。 問題起因 最近做項目時遇到了需要多用戶之間通信的問題,涉及到了WebSocket握手請求,以及集群中WebSocket Session共享的問題。 期間我經過了幾天的研究,總結出了幾個實現分布式WebSocket集群的辦法,從zuul到spring cloud gateway的不同嘗試,總結出了...
摘要:大家明天一起去唱吧關于數據庫設計當前一版不會固定大家的數據庫設計,大家可以自己自由設計,同時搭上自己的項目,構建一個附帶的自項目。 InChat 一個IM通訊框架 一個輕量級、高效率的支持多端(應用與硬件Iot)的異步網絡應用通訊框架。(核心底層Netty) Github:InChat 版本目標:完成基本的消息通訊(僅支持文本消息),離線消息存儲,歷史消息查詢,一對一聊天、自我聊天、群...
閱讀 854·2021-11-19 11:29
閱讀 3349·2021-09-26 10:15
閱讀 2854·2021-09-22 10:02
閱讀 2433·2021-09-02 15:15
閱讀 1970·2019-08-30 15:56
閱讀 2408·2019-08-30 15:54
閱讀 2903·2019-08-29 16:59
閱讀 635·2019-08-29 16:20