day03-程式碼實現02

多用戶即時通訊系統03

4.編碼實現02

4.2功能實現-拉取在線用戶

image-20220922182116066

4.2.1思路分析

客戶端想要知道在線用戶列表,就要向伺服器發送請求(Message),因為只有伺服器端保持著所有與客戶端相連接的socket和uid資訊。

整個流程大致為:對Message的種類進行擴展,然後客戶端向伺服器發送一個Message,服務端向客戶端返回數據,客戶端接收資訊(Message),在接收的這個Message資訊裡面包含了在線的用戶列表。

4.2.2程式碼實現

1.客戶端:
1.修改:MessageType介面

拓展了一些Message消息類型

package qqcommon;

/**
 * @author 李
 * @version 1.0
 * 表示消息類型
 */
public interface MessageType {
    //在介面中定義類一些常量,不同的常量的表示不同的消息類型
    String MESSAGE_LOGIN_SUCCEED = "1";//表示登錄成功
    String MESSAGE_LOGIN_FAIL = "2";//表示登錄失敗
    String MESSAGE_COMM_MES = "3";//表示普通訊息包
    String MESSAGE_GET_ONLINE_FRIEND = "4";//要求返回在線用戶列表
    String MESSAGE_RET_ONLINE_FRIEND = "5";//返回的在線用戶列表
    String MESSAGE_CLIENT_EXIT = "6";//客戶端請求退出

}
2.修改:UserClientService類

在該類中添加onlineFriendList()方法,該方法向伺服器發送要求,請求在線用戶列表

    //先伺服器端請求在線用戶列表
    public void onlineFriendList() {
        //向伺服器發送一個Message,類型MESSAGE_GET_ONLINE_FRIEND,要求返回在線用戶列表
        Message message = new Message();
        message.setMesType(MessageType.MESSAGE_GET_ONLINE_FRIEND);
         message.setSender(u.getUserId());

        //發送給伺服器
        try {
            //從管理執行緒的集合裡面,通過userId,得到這個執行緒對象
            ClientConnectServerThread clientConnectServerThread =
                    ManageClientConnectServerThread.getClientConnectServerThread(u.getUserId());
            //通過這個執行緒中獲取關聯的socket
            Socket socket = clientConnectServerThread.getSocket();
            //得到當前執行緒的Socket對應的ObjectOutputStream對象
            ObjectOutputStream oos = new ObjectOutputStream(socket.getOutputStream());
            oos.writeObject(message);//發送一個Message對象向伺服器,要求在線用戶列表
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
3.修改:ClientConnectServerThread類

在該類中的run方法中,增加判斷Message的類型,然後做相應的業務處理

@Override
public void run() {
    //因為Thread需要在後台和伺服器通訊,因此我們使用while循環
    while (true) {
        try {
            System.out.println("客戶端執行緒,等待讀取從服務端發送的消息");
            ObjectInputStream ois = new ObjectInputStream(socket.getInputStream());

            //如果伺服器沒有發送Message對象,執行緒會阻塞在這裡
            Message message = (Message) ois.readObject();

            //判斷Message的類型,然後做相應的業務處理
            //如果讀取到的是 服務端返回的在線用戶列表(MESSAGE_RET_ONLINE_FRIEND)
            if (message.getMesType().equals(MessageType.MESSAGE_RET_ONLINE_FRIEND)) {
                //取出在線用戶列表資訊,並展示
                //這裡假定返回的用戶列表是用空格隔開的id名(如:100 200 紫霞仙子 至尊寶 唐僧)
                String[] onlineUsers = message.getContent().split(" ");
                System.out.println("\n=======當前在線用戶列表=======");
                for (int i = 0; i < onlineUsers.length; i++) {
                    System.out.println("用戶:" + onlineUsers[i]);
                }

            } else {
                System.out.println("讀取到的是其他類型的message,暫時不處理");
            }

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
4.修改QQView類

修改該類中的第54行

使用上述編寫的方法,完成拉取在線用戶列表的操作

//這裡寫一個拉取用戶在線列表的方法
userClientService.onlineFriendList();

image-20220922180741819


2.服務端

大致思路為:前面我們在服務端的執行緒的run方法中,使用for循環在不停地請求讀取數據,這裡我們可以在run方法裡面拓展功能,讀取客戶端發送過來的拉取用戶的Message對象,返回在線用戶列表

1.修改:MessageType介面

和客戶端一樣,拓展Message消息類型

package qqcommon;

/**
 * @author 李
 * @version 1.0
 * 表示消息類型
 */
public interface MessageType {
    //在介面中定義類一些常量
    //不同的常量的表示不同的消息類型
    String MESSAGE_LOGIN_SUCCEED = "1";//表示登錄成功
    String MESSAGE_LOGIN_FAIL = "2";//表示登錄失敗
    String MESSAGE_COMM_MES = "3";//表示普通訊息包
    String MESSAGE_GET_ONLINE_FRIEND = "4";//要求返回在線用戶列表
    String MESSAGE_RET_ONLINE_FRIEND = "5";//返回的在線用戶列表
    String MESSAGE_CLIENT_EXIT = "6";//客戶端請求退出
}
2.修改:ServerConnectClientThread類

在該類中的run方法添加了客戶請求拉取在線用戶列表 的業務操作

package qqserver.server;

import qqcommon.Message;
import qqcommon.MessageType;

import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.net.Socket;

/**
 * @author 李
 * @version 1.0
 * 該類的一個對象和某個客戶端保持通訊
 */
public class ServerConnectClientThread extends Thread {
    private Socket socket;
    private String userId;//連接到服務端的用戶id


    public ServerConnectClientThread(Socket socket, String userId) {
        this.socket = socket;
        this.userId = userId;
    }

    @Override
    public void run() {//這裡執行緒處於run的狀態,可以發送/接收消息

        while (true) {
            try {
                System.out.println("服務端和客戶端" + userId + "保持通訊,讀取數據...");
                ObjectInputStream ois = new ObjectInputStream(socket.getInputStream());
                Message message = (Message) ois.readObject();

                //後面會使用message,根據message的類型,做相應的業務處理

                //業務-:客戶請求拉取在線用戶列表
                if (message.getMesType().equals(MessageType.MESSAGE_GET_ONLINE_FRIEND)) {
                    //客戶請求拉取在線用戶列表
                    //假定返回的用戶列表是用空格隔開的id名(如:100 200 紫霞仙子 至尊寶 唐僧)
                    System.out.println(message.getSender()+" 要在線用戶列表");
                    String onlineUser = ManageClientThreads.getOnlineUser();
                    
                    //返回message
                    //構建一個Message對象(這個Message對象包含了在線用戶列表資訊),返回給客戶端
                    Message message2 = new Message();
                    //設置消息類型--返回的在線用戶列表類型-客戶端會根據返回的消息類型來進行相應的業務處理
                    message2.setMesType(MessageType.MESSAGE_RET_ONLINE_FRIEND);
                    message2.setContent(onlineUser);//返回用戶消息列表
                    //伺服器發送的消息的接收者Getter 就是伺服器接收的資訊 的發送者Sender
                    message2.setGetter(message.getSender());
                    
                    //返回給客戶端
                    ObjectOutputStream oos = new ObjectOutputStream(socket.getOutputStream());
                    oos.writeObject(message2);

                }else{
                    System.out.println("其他類型的message,暫時不處理");
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}
3.修改:ManageClientThreads類

在該類中增加了getOnlineUser()方法,用來遍歷取出userId,並在上面的ServerConnectClientThread的run方法中使用。

//這裡編寫方法,可以返回在線用戶列表
public static String getOnlineUser() {
    //遍歷集合,遍歷 hashmap 的 key
    Iterator<String> iterator = hm.keySet().iterator();//獲取hm集合的ketSet集合的迭代器(這裡的ketSet就是userId)
    String onlineUserList = "";
    while (iterator.hasNext()) {//遍歷
        onlineUserList += iterator.next().toString() + " ";//遍歷所有的userId,用空格拼接起來
    }
    return onlineUserList;
}

運行:

  1. 運行服務端:

image-20220922182247168

  1. 分別運行三個客戶端,並進行登錄,拉取在線用戶:

    ​ 用戶1:

image-20220922182621787 image-20220922183010340


​ 用戶2:

image-20220922182643944 image-20220922182828114


​ 用戶3:

image-20220922182701298 image-20220922182911274

此時服務端顯示:

image-20220922183325135

4.3功能實現-無異常退出系統

4.3.1思路分析

image-20220922191529799

上述程式碼運行時,在客戶端選擇退出系統的時候,可以發現程式並沒有停止運行,原因是:

退出時,程式將循環標誌loop設為false,退出了內層循環,而外層循環因為也用了loop來作為循環條件,外層循環也同樣退出。此時在客戶端 類QQView中的主執行緒已經結束,但是在循環過程中,因為與服務端連接而產生的執行緒並沒有結束,整個進程也就沒有結束,因此程式仍在運行中。

解決方法:

客戶端:在main執行緒中調用方法,給服務端發送一個退出系統的message對象,然後調用System.exit(0)指令,正常退出。這樣整個進程就可以關閉。

伺服器端:在伺服器這邊,接收到一個退出系統的message對象後,把這個客戶端對應的執行緒所持有的socket關閉,然後退出該執行緒

image-20220922193057065

4.3.2程式碼實現

1.客戶端:
1.修改:UserClientService類

在該類中增加logout()方法

//編寫方法,退出客戶端,並給伺服器端發送一個退出系統的message對象
public void logout(){
    Message message = new Message();
    message.setMesType(MessageType.MESSAGE_CLIENT_EXIT);
    message.setSender(u.getUserId());//一定要指定是那個客戶端,服務端要根據這個userId移除集合中的執行緒

    //發送message
    try {
        //從管理執行緒的集合裡面,通過userId,得到這個執行緒對象
        ClientConnectServerThread clientConnectServerThread =
                ManageClientConnectServerThread.getClientConnectServerThread(u.getUserId());
        //通過這個執行緒中獲取關聯的socket
        Socket socket = clientConnectServerThread.getSocket();
        //得到當前執行緒的Socket對應的ObjectOutputStream對象
        ObjectOutputStream oos = new ObjectOutputStream(socket.getOutputStream());
        oos.writeObject(message);
        System.out.println(u.getUserId()+"退出系統");
        System.exit(0);
    } catch (IOException e) {
        e.printStackTrace();
    }
}
2.修改:QQView類

在該類中的內層循環中,調用logout方法:

//調用方法,給伺服器發送一個退出系統的message
userClientService.logout();

image-20220922200240425

2.服務端:
1.修改:ManageClientThreads類

在該類中增加removeServerConnectClientThread()方法

//增加一個方法,從集合中移除某個對象
public static void removeServerConnectClientThread(String userId){
    hm.remove(userId);
}
2.修改:ServerConnectClientThread類

在該類的run方法中增加業務二操作:

public void run() {//這裡執行緒處於run的狀態,可以發送/接收消息

    while (true) {
        try {
            System.out.println("服務端和客戶端" + userId + "保持通訊,讀取數據...");
            ObjectInputStream ois = new ObjectInputStream(socket.getInputStream());
            Message message = (Message) ois.readObject();

            //後面會使用message,根據message的類型,做相應的業務處理

            //業務一:客戶請求拉取在線用戶列表
            if (message.getMesType().equals(MessageType.MESSAGE_GET_ONLINE_FRIEND)) {
                //客戶請求拉取在線用戶列表
                //假定返回的用戶列表是用空格隔開的id名(如:100 200 紫霞仙子 至尊寶 唐僧)
                System.out.println(message.getSender() + " 要在線用戶列表");
                String onlineUser = ManageClientThreads.getOnlineUser();

                //返回message
                //構建一個Message對象(這個Message對象包含了在線用戶列表資訊),返回給客戶端
                Message message2 = new Message();
                //設置消息類型--返回的在線用戶列表類型-客戶端會根據返回的消息類型來進行相應的業務處理
                message2.setMesType(MessageType.MESSAGE_RET_ONLINE_FRIEND);
                message2.setContent(onlineUser);//返回用戶消息列表
                //伺服器發送的消息的接收者Getter 就是伺服器接收的資訊 的發送者Sender
                message2.setGetter(message.getSender());

                //返回給客戶端
                ObjectOutputStream oos = new ObjectOutputStream(socket.getOutputStream());
                oos.writeObject(message2);

            } else if (message.getMesType().equals(MessageType.MESSAGE_CLIENT_EXIT)) {
                //業務二:客戶請求退出系統
                System.out.println(message.getSender() + " 退出");
                //將客戶端對應的執行緒從集合中刪除
                ManageClientThreads.removeServerConnectClientThread(message.getSender());
                socket.close();//關閉的是當前的執行緒持有的socket屬性
                //退出執行緒的循環
                break;
            } else {
                System.out.println("其他類型的message,暫時不處理");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

運行:

1.運行服務端:

image-20220922200701524

2.運行客戶端,登錄兩個用戶:

image-20220922200802600
image-20220922201246653

3.查看當前用戶列表,可以看到有兩個用戶:

image-20220922201404318

3.其中一個用戶選擇退出系統,可以看到用戶正確退出,程式結束運行:

image-20220922201011864

4.在另一個用戶中查看當前用戶列表,可以看到只剩下一個用戶,說明服務端已經成功將退出的用戶的執行緒從集合中刪除

image-20220922201649953

4.服務端這邊顯示該用戶正確退出:

image-20220922201736838