開源IM項目-InChat登錄接口設計與實現（基於Netty）

只給你最值得的信息

小弟正在做的一個開源IM項目，目標是實現一個輕量級、高效率的支持聊天與物聯網的通訊框架。昨天剛剛出的設計稿並再今天做了實現。

項目是基於Netty的二次開發，關於Netty我這裏就不再介紹了，懂的人自然都懂。我的預算是做一個所有企業或組織可以引用的Maven項目，並且是基本上開箱即用，簡單實現對應的配置與重寫方法就可以搭建自己的IM項目（某Q、某信的效果）。

本文着重介紹的是登錄接口的設計與實現。

設計信息

關於InChat統一登錄的接口設計，設計針對小程序、APP、Web端的登錄作用，所以將作爲token的形式登錄InChat的WebSocket長連接，用戶服務器做sso的認證登錄後得到token後直接發送login信息到InChat，用戶服務器需要重寫InChat中的verifyToken方法校驗自己的的Token信息是否有效，正常則啓動長連接。考慮到token失效問題，WebSocket長連接的登錄僅做初次登錄，接下來考慮以心跳形式保持鏈接狀態（pingpong），使用token認證是爲保護InChat鏈接的常規化（目前暫時這樣設計後面根據使用情況更改設計）

由於目前大部分的Web項目或基於IM的項目登錄可能存在多端的單點登錄，所以我選用了Token的形式，爲什麼登錄後還需要用token再來websocket這邊校驗一次呢？

因爲你登錄的是web應用程序端的，而websocket而言，只要別人知道你的地址，那麼就可以鏈接上，我們不希望存在過多的死鏈接（無效鏈接），所以我們需要將token再次發給InChat登錄，由InChat來檢驗是否是合法登錄鏈接，如果無效則關閉鏈接。

代碼實現

由於是想要做給別人用的，那麼我們自己本身就要封裝的好一點，對於配置我選了足夠多的類型。

對於netty監聽與初始化，我使用的方式是掃描與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啓動處理。

當然在執行它之前，還需要執行到一個抽象的類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暫時只需要實現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存在的接口實現服務，我們現在使用到他的登錄接口，讓我們來看看他的登錄實現方法。

    
    @Autowired
    InChatVerifyService inChatVerifyService;
    
    @Override
    public boolean login(Channel channel, TextWebSocketFrame textWebSocketFrame) {
        //校驗規則，自定義校驗規則
        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做校驗，這是一個接口，我並沒有寫實現，因爲這個是用戶的事情了，它需要實現並重寫我的verifyToken方法，並返回給我一個值，如下是我測試的時候寫的模擬實現。

/**
 * 不屬於項目代碼
 * Created by MySelf on 2018/11/22.
 */
@Service
public class InChatVerifyServiceImpl implements InChatVerifyService {

    @Override
    public boolean verifyToken(String token) {
        //與Redis中的Token做比較，請用戶自己實現,查找是否存在該Token值
        System.out.println("verify---"+token);
        if ("3333".equals(token)){
            return true;
        }
        return false;
    }
}

我僅僅做了普通的校驗，對於用戶可以注入RedisTemplate然後進行校驗等工作。到此我們的登錄接口就實現好了！

看看效果

GitHub

項目名：InChat
項目地址：https://github.com/UncleCatMy...
項目簡介：A lightweight, efficient communication framework that supports chat and the Internet of Things（一個輕量級、高效率的支持聊天與物聯網的通訊框架）

Demo分支

原始項目核心演示, 您可以先運行了解, 模仿微聊天聊天應用程序, 逐步更新, 基於 springbot-web 套接字的一般框架, 結合 netty 聊天社交, 並記錄聊天日誌, 異步存儲, 前端臨時 sui mobile, 添加實現 tcp/後端通信端口 (mqtt 協議、實時和單片機等 tcp 硬件通信), 添加圖片處理流、聊天實現文本和圖片發送功能,api 調用 netty 長鏈接執行發送消息 (聯機、用戶列表的數量)

webrtc分支

基於Netty與web RTC實現語音與視頻通訊的分支項目

im-api分支

騰訊 im (雲通信) 後端仿真項目, 以 api 的形式對接, 如果有前端想要停靠可以運行此分支, 預計該分支最終將爲一個單一的服務併發 300, 000個用戶的 im 後臺項目

paho-mqtt分支

基於 paho. js 和 java mqtt 客戶端消息訂閱和通信的小型程序端或移動 web 端, 小程序物聯網演示目前支持 ws 格式

tcp-wechat分支

基於小程序端與單片機等硬件 tcp/ip 的主要通信, 將物聯網中心作爲中轉, 本演示將充分實現具體功能

---