一个简单的UDP回显服务器

Posted 2022-05-12 z啵唧啵唧

一个简单的UDP回显服务器

• 客户端给服务器发送一个字符串，服务器把这个字符串原封不动的返回(回显到服务器echo server) 相当于服务器开发当中的"hello world".
• 通过整个代码书写过程了解UDP的协议格式和发送数据的基本原理
• 服务端代码

package com.zb.network.test;

import java.io.IOException;
import java.net.DatagramPacket;
import java.net.DatagramSocket;
import java.net.SocketException;

/**
 * @Description: 最简单的客户端服务器
 * @Author:啵啵啵啵啵啵唧~~~
 * @Date:2022/5/3
 */
public class UdpEchoServer 

    public static void main(String[] args) throws IOException 
        UdpEchoServer server = new UdpEchoServer(9090);
        server.start();
    

    /**
     * 对于一个服务器程序来说，核心流程也要分成两步
     * 1、进行初始化操作(实例化Socket对象)
     * 2、进入主循环接收并处理请求。(主循环就是一个"死循环"，因为服务器一般都是7*24小时工作的没有意外情况不能退出)
     *   a.读取数据并解析
     *   b.根据请求计算响应
     *   c.把结果写回到客户端
     */

    /**
     * 初始化一个socket对象，本质上是一个文件，这个文件是网卡的抽象，"体现了一切皆文件"
     */
    private DatagramSocket socket = null;

    /**
     *
     * @param port 端口号，这参数这块没有写ip，ip默认是0.0.0.0(特殊ip)
     * 0.0.0.0这个特殊的ip会关联到这个主机所有的网卡ip，一台主机可能存在多个网卡
     * 在写服务器的时候一般都是使用这个全0的ip
     * @throws SocketException
     */
    public UdpEchoServer(int port) throws SocketException 
        //new 这个Socket对象的时候，就会让当前的socket对象和一个IP地址以及一个端口号关联起来(绑定端口)
        //未来客户端就按照这个IP+端口号来访问服务器
        socket = new DatagramSocket(port);
    

    /**
     * 用于启动服务器
     */
    public void start() throws IOException 
        System.out.println("服务器启动");
        //主循环
        while(true)
            //a.读取请求并解析
            //DatagramPacket -> UDP socket 发送接收数据的基本单位
            //new byte[4096] 设定数据接收的缓冲区
            DatagramPacket requestPacket = new DatagramPacket(new byte[4096], 4096);
            //程序执行之后会马上执行到这个receive方法，服务器虽然启动了，但是客户端啥时候发送请求，无法确定
            //大概率的情况是，调用receive方法之后，客户端还没有谱呢，没有发送任何的数据(此处阻塞时间完全不可预计)
            //此时receive方法就会一直阻塞到这真的有数据发送过来
            //当真的有客户端的数据过来之后，此时receive就会把收到的数据放到DatagramPacket对象的缓冲区中~
            socket.receive(requestPacket);
            //获取缓冲区数据
            //此处是要将请求数据转换成为String(本来是一个byte[])
            //用户发送的数据可能<<4096，而此处getLength的长度就是4096，使用trim方法可以干掉不必要的空白字符
            String request = new String(requestPacket.getData(),
                    0, requestPacket.getLength()).trim();

            //b.根据请求计算响应
            String response = process(request);

            //c.把响应写回到客户端,响应数据就是 response 需要包装成为一个 Packet 对象
            //因为我们要发送的话只能发送这个byte数组，现在response是一个字符串，所以先包装成为这个Packet对象
            //requestPacket.getSocketAddress() 表示指定你这个包要发送给谁(目的IP和端口号是谁
            // 此处的地址就是客户端的地址和端口号，这两个信息包含在requestPacket内部)
            DatagramPacket responsePacket = new DatagramPacket(response.getBytes(),
                    response.getBytes().length, requestPacket.getSocketAddress());
            socket.send(responsePacket);
            //打印一条请求日志
            System.out.printf("[%s:%d] req: %s; resp: %s\\n", requestPacket.getAddress().toString(),
                    requestPacket.getPort(), request, response);
        
    

    /**
     * 根据请求计算响应
     * @param request
     * @return
     */
    private String process(String request) 
        // 由于此处是一个 echo server，请求内容是啥，相应内容就是啥
        // 如果是一个更复杂的服务器，此处就需要包含很多的业务逻辑来进行具体的计算
        return request;
    

• 客户端代码

package com.zb.network.test;

import java.io.IOException;
import java.net.*;
import java.util.Scanner;

/**
 * @Description: 客户端
 * @Author:啵啵啵啵啵啵唧~~~
 * @Date:2022/5/4
 */
public class UdpEchoClient 
    /**
     * 客户端主要流程分为4步
     * 1、从用户这里读取输入数据
     * 2、构造请求发给服务器
     * 3、从服务器读取响应
     * 4、把响应写回给客户端
     */

    DatagramSocket socket = null;
    /**
     * 服务器ip
     */
    String serverIp;
    /**
     * 服务器端口号
     */
    int serverPort;

    /**
     * 需要在客户端启动的时候来指定需要连接哪个服务器
     * @param serverIp
     * @param serverPort
     * @throws SocketException
     */
    public UdpEchoClient(String serverIp, int serverPort) throws SocketException 
        //客户端的socket不需要指定端口号，如果客户端绑定了端口号
        //一个主机只能启动一个客户端了(客户端的端口号由操作系统自动分配)
        //但是服务器必须绑定端口号，这样客户端才能访问
        socket = new DatagramSocket();
        this.serverIp = serverIp;
        this.serverPort = serverPort;
    

    /**
     * 客户端启动方法
     * @throws IOException
     */
    public void start() throws IOException 
        Scanner sc = new Scanner(System.in);
        while (true)
            //1.读取用户输入的数据
            System.out.print("-> ");
            String request = sc.nextLine();
            if (request.equals("exit"))
                break;
            
            //2.构造请求发送给服务器
            DatagramPacket requestPacket = new DatagramPacket(request.getBytes(),
                    request.getBytes().length, InetAddress.getByName(serverIp), serverPort);
            socket.send(requestPacket);
            //3.从服务器读取响应
            DatagramPacket responsePacket = new DatagramPacket(new byte[4096], 4096);
            socket.receive(responsePacket);
            String response = new String(responsePacket.getData(), 0, responsePacket.getLength()).trim();
            //4.显示响应的数据
            System.out.println(response);
        
    

    public static void main(String[] args) throws IOException 
        //"127.0.0.1"是一个特殊的环回ip，自己访问自己
        //服务器和客户端都在同一台主机上，客户端写的服务器ip就是环回ip
        //如果不在同一台主机上，此处ip就要写成服务器的ip
        UdpEchoClient client = new UdpEchoClient("127.0.0.1",9090);
        client.start();
    

• 效果展示
  
  
• 日志分析
  
• 客户端端口号是由操作系统自动生成的，每次启动都有可能不一样
• 当晚我们还可以将我们的服务器部署到云服务器上，让别的小伙伴也能够访问到
• 部署方式也很简单，将我们写好的服务器代码打成jar包放在服务器跑即可，记得开放云服务器安全组对应的协议端口号，像这个就需要开放安全组的UDP协议的9090端口