只給你最值得的信息
小弟正在做的一個開源IM項目驼壶，目標是實現(xiàn)一個輕量級躏嚎、高效率的支持聊天與物聯(lián)網的通訊框架轧拄。昨天剛剛出的設計稿并再今天做了實現(xiàn)诅病。
項目是基于Netty的二次開發(fā)汰具，關于Netty我這里就不再介紹了卓鹿，懂的人自然都懂。我的預算是做一個所有企業(yè)或組織可以引用的Maven項目留荔，并且是基本上開箱即用吟孙，簡單實現(xiàn)對應的配置與重寫方法就可以搭建自己的IM項目（某Q、某信的效果）聚蝶。
本文著重介紹的是登錄接口的設計與實現(xiàn)杰妓。
設計信息
關于InChat統(tǒng)一登錄的接口設計，設計針對小程序碘勉、APP巷挥、Web端的登錄作用，所以將作為token的形式登錄InChat的WebSocket長連接验靡，用戶服務器做sso的認證登錄后得到token后直接發(fā)送login信息到InChat倍宾，用戶服務器需要重寫InChat中的verifyToken方法校驗自己的的Token信息是否有效雏节，正常則啟動長連接≡浔觯考慮到token失效問題矾屯，WebSocket長連接的登錄僅做初次登錄，接下來考慮以心跳形式保持鏈接狀態(tài)（pingpong）初厚，使用token認證是為保護InChat鏈接的常規(guī)化（目前暫時這樣設計后面根據(jù)使用情況更改設計）
[圖片上傳失敗...(image-29d656-1543988912603)]
由于目前大部分的Web項目或基于IM的項目登錄可能存在多端的單點登錄，所以我選用了Token的形式孙技，為什么登錄后還需要用token再來websocket這邊校驗一次呢产禾？
因為你登錄的是web應用程序端的，而websocket而言牵啦，只要別人知道你的地址亚情，那么就可以鏈接上，我們不希望存在過多的死鏈接（無效鏈接）哈雏，所以我們需要將token再次發(fā)給InChat登錄楞件，由InChat來檢驗是否是合法登錄鏈接，如果無效則關閉鏈接裳瘪。
代碼實現(xiàn)
由于是想要做給別人用的土浸，那么我們自己本身就要封裝的好一點，對于配置我選了足夠多的類型彭羹。
[圖片上傳失敗...(image-a24a6f-1543988912603)]
對于netty監(jiān)聽與初始化黄伊，我使用的方式是掃描與AspectJ，你可以在項目的auto包中看到掃描啟動派殷，這種啟動思路我也是參考了其他的開源項目（具體忘記了地址）还最。
@Bean
@ConditionalOnMissingBean(name = "sacnScheduled")
public ScanRunnable initRunable(@Autowired InitNetty serverBean){
long time =(serverBean==null || serverBean.getPeriod()<5)?10:serverBean.getPeriod();
ScanRunnable sacnScheduled = new SacnScheduled(time);
Thread scanRunnable = new Thread(sacnScheduled);
scanRunnable.setDaemon(true);
scanRunnable.start();
return sacnScheduled;
}
@Bean(initMethod = "open", destroyMethod = "close")
@ConditionalOnMissingBean
public InitServer initServer(InitNetty serverBean){
if(!ObjectUtils.allNotNull(serverBean.getWebport(),serverBean.getServerName())){
throw new NullPointerException("not set port");
}
if(serverBean.getBacklog()<1){
serverBean.setBacklog(_BLACKLOG);
}
if(serverBean.getBossThread()<1){
serverBean.setBossThread(CPU);
}
if(serverBean.getInitalDelay()<0){
serverBean.setInitalDelay(SEDU_DAY);
}
if(serverBean.getPeriod()<1){
serverBean.setPeriod(SEDU_DAY);
}
if(serverBean.getHeart()<1){
serverBean.setHeart(TIMEOUT);
}
if(serverBean.getRevbuf()<1){
serverBean.setRevbuf(BUF_SIZE);
}
if(serverBean.getWorkerThread()<1){
serverBean.setWorkerThread(CPU*2);
}
return new InitServer(serverBean);
}
在上圖中存在一個DefaultWebSocketHandler，這個是默認的netty啟動處理毡惜。
當然在執(zhí)行它之前拓轻，還需要執(zhí)行到一個抽象的類WebSocketHandler。
它將會為我做一些基本的功能操作经伙。
@Slf4j
public abstract class WebSocketHandler extends SimpleChannelInboundHandler<Object> {
WebSocketHandlerApi webSocketHandlerApi;
public WebSocketHandler(WebSocketHandlerApi webSocketHandlerApi){
this.webSocketHandlerApi = webSocketHandlerApi;
}
@Override
protected void channelRead0(ChannelHandlerContext ctx, Object msg) throws Exception {
if (msg instanceof TextWebSocketFrame){
textdoMessage(ctx,(TextWebSocketFrame)msg);
}else if (msg instanceof WebSocketFrame){
webdoMessage(ctx,(WebSocketFrame)msg);
}
}
protected abstract void webdoMessage(ChannelHandlerContext ctx, WebSocketFrame msg);
protected abstract void textdoMessage(ChannelHandlerContext ctx, TextWebSocketFrame msg);
@Override
public void channelInactive(ChannelHandlerContext ctx) throws Exception {
log.info("【DefaultWebSocketHandler：channelInactive】"+ctx.channel().localAddress().toString()+"關閉成功");
webSocketHandlerApi.close(ctx.channel());
}
@Override
public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
if(evt instanceof IdleStateEvent){
webSocketHandlerApi.doTimeOut(ctx.channel(),(IdleStateEvent)evt);
}
super.userEventTriggered(ctx, evt);
}
}
對于登錄接口扶叉，他是基于WebSocket的，且是TextWebSocketFrame類型的橱乱，WebSocketFrame是后期的圖片聊天功能辜梳，所以我們的DefaultWebSocketHandler暫時只需要實現(xiàn)textdoMessage。
對于websocket的傳輸我們推薦使用json形式泳叠，這對于前后端都是由好處的作瞄。
@Override
protected void textdoMessage(ChannelHandlerContext ctx, TextWebSocketFrame msg) {
Channel channel = ctx.channel();
ServerWebSocketHandlerService serverWebSocketHandlerService;
if (webSocketHandlerApi instanceof ServerWebSocketHandlerService){
serverWebSocketHandlerService = (ServerWebSocketHandlerService)webSocketHandlerApi;
}else{
throw new NoFindHandlerException("Server Handler 不匹配");
}
Map<String,String> maps = (Map) JSON.parse(msg.text());
switch (maps.get("type")){
case "login":
serverWebSocketHandlerService.login(channel,msg);
break;
default:
break;
}
}
由上面的代碼，你也許才想到了前端登錄的大致json內容危纫，沒錯是這樣的宗挥。
{
type: "login",
token: value
}
ServerWebSocketHandlerService是一個自己定義的后端WebSocket存在的接口實現(xiàn)服務乌庶，我們現(xiàn)在使用到他的登錄接口，讓我們來看看他的登錄實現(xiàn)方法契耿。
@Autowired
InChatVerifyService inChatVerifyService;
@Override
public boolean login(Channel channel, TextWebSocketFrame textWebSocketFrame) {
//校驗規(guī)則瞒大，自定義校驗規(guī)則
Map<String,String> maps = (Map<String, String>) JSON.parse(textWebSocketFrame.text());
System.out.println("login-"+textWebSocketFrame.text());
String token = maps.get("token");
Gson gson = new Gson();
Map<String,String> backMap = new HashMap<>();
if (inChatVerifyService.verifyToken(token)){
backMap.put("type","login");
backMap.put("success","true");
channel.writeAndFlush(new TextWebSocketFrame(gson.toJson(backMap)));
return true;
}
backMap.put("type","login");
backMap.put("success","false");
channel.writeAndFlush(new TextWebSocketFrame(gson.toJson(backMap)));
close(channel);
return false;
}
由以上可看出，我們會將token和inChatVerifyService.verifyToken做校驗搪桂，這是一個接口透敌，我并沒有寫實現(xiàn)，因為這個是用戶的事情了踢械，它需要實現(xiàn)并重寫我的verifyToken方法酗电，并返回給我一個值，如下是我測試的時候寫的模擬實現(xiàn)内列。
/**
* 不屬于項目代碼
* Created by MySelf on 2018/11/22.
*/
@Service
public class InChatVerifyServiceImpl implements InChatVerifyService {
@Override
public boolean verifyToken(String token) {
//與Redis中的Token做比較撵术，請用戶自己實現(xiàn),查找是否存在該Token值
System.out.println("verify---"+token);
if ("3333".equals(token)){
return true;
}
return false;
}
}
我僅僅做了普通的校驗，對于用戶可以注入RedisTemplate然后進行校驗等工作话瞧。到此我們的登錄接口就實現(xiàn)好了嫩与！
看看效果
GitHub
項目名：InChat
項目地址：https://github.com/UncleCatMySelf/InChat
項目簡介：A lightweight, efficient communication framework that supports chat and the Internet of Things（一個輕量級、高效率的支持聊天與物聯(lián)網的通訊框架）
Demo分支
原始項目核心演示, 您可以先運行了解, 模仿微聊天聊天應用程序, 逐步更新, 基于 springbot-web 套接字的一般框架, 結合 netty 聊天社交, 并記錄聊天日志, 異步存儲, 前端臨時 sui mobile, 添加實現(xiàn) tcp/后端通信端口 (mqtt 協(xié)議交排、實時和單片機等 tcp 硬件通信), 添加圖片處理流划滋、聊天實現(xiàn)文本和圖片發(fā)送功能,api 調用 netty 長鏈接執(zhí)行發(fā)送消息 (聯(lián)機、用戶列表的數(shù)量)
[圖片上傳失敗...(image-31008c-1543988912603)]
webrtc分支
基于Netty與web RTC實現(xiàn)語音與視頻通訊的分支項目
im-api分支
騰訊 im (云通信) 后端仿真項目, 以 api 的形式對接, 如果有前端想要透隽唬靠可以運行此分支, 預計該分支最終將為一個單一的服務并發(fā) 300, 000個用戶的 im 后臺項目
paho-mqtt分支
基于 paho. js 和 java mqtt 客戶端消息訂閱和通信的小型程序端或移動 web 端, 小程序物聯(lián)網演示目前支持 ws 格式
tcp-wechat分支
基于小程序端與單片機等硬件 tcp/ip 的主要通信, 將物聯(lián)網中心作為中轉, 本演示將充分實現(xiàn)具體功能
