NIO框架入门(一)：服务端基于Netty4的UDP双向通信Demo演示 [附件下载]

JackJiang · 8 年前

1、前言

NIO框架的流行，使得开发大并发、高性能的互联网服务端成为可能。这其中最流行的无非就是MINA和Netty了，MINA目前的主要版本是MINA2、而Netty的主要版本是Netty3和Netty4（Netty5已经被取消开发了：详见此文）。

本文将演示的是一个基于Netty4的UDP服务端和一个标准UDP客户端（Java实现）双向通信的完整例子。实际上，Netty4的UDP例子非常难找（恕我愚钝，找遍全网也没有有价值的代码，有也是Netty3，而Netty3和Netty4的风格差的不是一点点，参考意义不大），官方的代码演示里只有一个简单的UDP广播例子，不足以用于演示Netty4的UDP通信最佳实践。

重要说明：限于篇幅原因，文中所列代码并非完整，完整代码（Eclipse工程）请从文末 “11、完整源码工程下载” 处下载所有代码！

2、《NIO框架入门》系列文章

有关MINA和Netty的入门文章很多，但多数都是复制、粘贴的未经证实的来路不明内容，对于初次接触的人来说，一个可以运行且编码规范的Demo，显然要比各种“详解”、“深入分析”之类的要来的直接和有意义。本系列入门文章正是基于此种考虑而写，虽无精深内容，但至少希望对初次接触MINA、Netty的人有所启发，起到抛砖引玉的作用。

本文是《NIO框架入门》系列文章中的第1篇，目录如下：

3、本文亮点

Netty4的UDP例子太难找：
Netty4的完整双向UDP通信例子很难找（官方没有），本文就是要用代码来演示这个；
本例中客户端UDP实现无需第3方依赖：
通常MINA或Netty的例子里，客户端也都是用的MINA或Netty的客户端lib，本文将直接使用标准UDP代码（便于跨平台实现，比如iOS平台），不依赖于第3方包；
完整可执行源码、方便学习：
完整的Demo源码，适合新手直接运行，便于学习和研究。
生产环境下的进阶学习：
如果您觉得本Demo过于浅显，您可继续研究轻量级开源即时通讯框架MobileIMSDK，本文的Demo正是其极度简化版。

4、题外话

社区里经常在争论到底该用MINA还是Netty，比如这几篇文章：《开源NIO框架八卦——到底是先有MINA还是先有Netty?》、《有关“为何选择Netty”的11个疑问及解答》、《选Netty还是Mina：深入研究与对比（一）》，哈哈这确实挺难抉择的。不过，个人观点是，对那个熟悉就用哪个吧，没什么好纠结的，必竟二者并比本质区别，也都是出自同一作者之手。

写个什么样的Demo？

言归正传，本文要演示的Demo包含两部分，Java UDP客户端和Netty4 UDP服务端，客户端将每隔3秒向服务端发送一条消息，而服务端在收到消息后马上回复一条消息给客户端。

也就是说，服务端和客户端都要实现消息的发送和接收，这也就实现了双向通信。如果有心的话，稍加改造，也就很容易实现一个简陋的聊天程序了。下节将将给出真正的实现代码。

5、Netty4服务端准备工作

1第一步：下载Netty4

Netty4的官方网站是：http://netty.io/，直接下最新的Netty 4.1吧，如下图：

NIO框架入门(一)：服务端基于Netty4的UDP双向通信Demo演示 [附件下载]_QQ20160615-0.png

2第二步：找到Netty4的核心库文件

直接用这个all in one的jar包吧，反正用在服务端，2M大小的东西无所谓，方便管理，见下图：

NIO框架入门(一)：服务端基于Netty4的UDP双向通信Demo演示 [附件下载]_QQ20160615-1.png

3第三步：建好Java工程准备准备开撸

我个人习惯用Eclipse，你用NetBeans或InteliJ也都没问题，具体建立过程不熟练的衣自行百度吧，唯一注意的是把Netty4的lib包引用进来就行了，我的见下图：

NIO框架入门(一)：服务端基于Netty4的UDP双向通信Demo演示 [附件下载]_QQ20160615-2.png

NIO框架入门(一)：服务端基于Netty4的UDP双向通信Demo演示 [附件下载]_QQ20160615-2.png

6、服务端代码

1服务端主类 EchoServer.java

public class EchoServer
{
        public static void main(String[] args) throws InterruptedException
        {
                Bootstrap b = new Bootstrap();
                EventLoopGroup group = new NioEventLoopGroup();
                b.group(group)
                        .channel(NioDatagramChannel.class)
                        .handler(new EchoSeverHandler());
                
                // 服务端监听在9999端口
                b.bind(9999).sync().channel().closeFuture().await();
        }
}

如上述代码所示：不得不说，Netty4的UDP服务端代码实现起来确实很简单，一个 Bootstrap、一个 EventLoopGroup、外加一个 SimpleChannelInboundHandler，就这么被Netty4轻松搞定（准确地说Netty4是在Java NIO上的封装而已，但最终API对开发者来说确实很友好）。

吐个槽：话说Netty4的代码跟MINA相比，风格确实大不相同，虽说两者有很深的源源，但经过Netty3、Netty4的进化，两者的差异（至少代码看起来是这样）还是很明显的。另外，b.bind(9999).sync().channel().closeFuture().await() 这一大串的连续方法调用，看起来很诡异，不小心调错的话，服务器会不会爆炸？

2服务端Handler类 EchoSeverHandler

public class EchoSeverHandler extends SimpleChannelInboundHandler<DatagramPacket> 
{
        @Override
        protected void channelRead0(ChannelHandlerContext ctx, DatagramPacket packet)
                        throws Exception
        {
                // 读取收到的数据
                ByteBuf buf = (ByteBuf) packet.copy().content();
                byte[] req = new byte[buf.readableBytes()];
                buf.readBytes(req);
                String body = new String(req, CharsetUtil.UTF_8);
                System.out.println("【NOTE】>>>>>> 收到客户端的数据："+body); 
                
                // 回复一条信息给客户端
                ctx.writeAndFlush(new DatagramPacket(
                Unpooled.copiedBuffer("Hello，我是Server，我的时间戳是"+System.currentTimeMillis()
                                , CharsetUtil.UTF_8)
                                , packet.sender())).sync();
        }
}

如上所示，这个Handler看起来比MINA的类似实现，要简洁不少。

7、客户端代码

为了让客户端代码看起来更简洁，我把Socket管理代码提炼到 LocalUDPSocketProvider类、把UDP数据监听和接收提炼到了 LocalUDPDataReciever类（实际上这两个同名类是简化自MobileIMSDK工程哦）。

1客户端主类 EchoClient.java

public class EchoClient
{
        public static void main(String[] args) throws Exception
        {
                // 初始化本地UDP的Socket
                LocalUDPSocketProvider.getInstance().initSocket();
                // 启动本地UDP监听（接收数据用的）
                LocalUDPDataReciever.getInstance().startup();
                
                // 循环发送数据给服务端
                while(true)
                {
                        // 要发送的数据
                        String toServer = "Hi，我是客户端，我的时间戳"+System.currentTimeMillis();
                        byte[] soServerBytes = toServer.getBytes("UTF-8");
                        
                        // 开始发送
                        boolean ok = UDPUtils.send(soServerBytes, soServerBytes.length);
                        if(ok)
                                Log.d("EchoClient", "发往服务端的信息已送出.");
                        else
                                Log.e("EchoClient", "发往服务端的信息没有成功发出！！！");
                        
                        // 3000秒后进入下一次循环
                        Thread.sleep(3000);
                }
        }
}

补充说明：客户端代码没有使用任何依赖，纯Java UDP代码实现（如果是Andriod平台，代码也几乎不用改就能用），部分代码修改自开源即时通讯框架 MobileIMSDK（去掉了很多保证健壮性代码，现在看起来要简洁的多，便于初学者学习）。

2Socket操作类 LocalUDPSocketProvider.java

public class LocalUDPSocketProvider
{
        private static final String TAG = LocalUDPSocketProvider.class.getSimpleName();
        private static LocalUDPSocketProvider instance = null;
        private DatagramSocket localUDPSocket = null;

        public static LocalUDPSocketProvider getInstance()
        {
                if (instance == null)
                        instance = new LocalUDPSocketProvider();
                return instance;
        }
        
        public void initSocket()
        {
                try
                {
                        // UDP本地监听端口（如果为0将表示由系统分配，否则使用指定端口）
                        this.localUDPSocket = new DatagramSocket(ConfigEntity.localUDPPort);
                        // 调用connect之后，每次send时DatagramPacket就不需要设计目标主机的ip和port了
                        // * 注意：connect方法一定要在DatagramSocket.receive()方法之前调用，
                        // * 不然整send数据将会被错误地阻塞。这或许是官方API的bug，也或许是调
                        // * 用规范就应该这样，但没有找到官方明确的说明
                        this.localUDPSocket.connect(
                                        InetAddress.getByName(ConfigEntity.serverIP), ConfigEntity.serverUDPPort);
                        this.localUDPSocket.setReuseAddress(true);
                        Log.d(TAG, "new DatagramSocket()已成功完成.");
                }
                catch (Exception e)
                {
                        Log.w(TAG, "localUDPSocket创建时出错，原因是：" + e.getMessage(), e);
                }
        }

        public DatagramSocket getLocalUDPSocket()
        {
                return this.localUDPSocket;
        }
}

3数据接收类 LocalUDPDataReciever.java

public class LocalUDPDataReciever
{
        private static final String TAG = LocalUDPDataReciever.class.getSimpleName();
        private static LocalUDPDataReciever instance = null;
        private Thread thread = null;

        public static LocalUDPDataReciever getInstance()
        {
                if (instance == null)
                        instance = new LocalUDPDataReciever();
                return instance;
        }

        public void startup()
        {
                this.thread = new Thread(new Runnable()
                {
                        public void run()
                        {
                                try
                                {
                                        Log.d(LocalUDPDataReciever.TAG, "本地UDP端口侦听中，端口=" + ConfigEntity.localUDPPort + "...");

                                        //开始侦听
                                        LocalUDPDataReciever.this.udpListeningImpl();
                                }
                                catch (Exception eee)
                                {
                                        Log.w(LocalUDPDataReciever.TAG, "本地UDP监听停止了(socket被关闭了?)," + eee.getMessage(), eee);
                                }
                        }
                });
                this.thread.start();
        }

        private void udpListeningImpl() throws Exception
        {
                while (true)
                {
                        byte[] data = new byte[1024];
                        // 接收数据报的包
                        DatagramPacket packet = new DatagramPacket(data, data.length);

                        DatagramSocket localUDPSocket = LocalUDPSocketProvider.getInstance().getLocalUDPSocket();
                        if ((localUDPSocket == null) || (localUDPSocket.isClosed()))
                                continue;
                        
                        // 阻塞直到收到数据
                        localUDPSocket.receive(packet);
                        
                        // 解析服务端发过来的数据
                        String pFromServer = new String(packet.getData(), 0 , packet.getLength(), "UTF-8");
                        Log.w(LocalUDPDataReciever.TAG, "【NOTE】>>>>>> 收到服务端的消息："+pFromServer);
                }
        }
}

8、运行效果

客户端运行结果：
NIO框架入门(一)：服务端基于Netty4的UDP双向通信Demo演示 [附件下载]_QQ20160615-3.png

服务端运行结果：
NIO框架入门(一)：服务端基于Netty4的UDP双向通信Demo演示 [附件下载]_QQ20160615-4.png

9、补充说明

客户端代码没什么特别，就是标准的Java UDP代码，看起来跟其它例子不一样的原因只是我把它提炼了一下，没本质区别。同样的代码改改也可以很好的用在Android端。实际上，上面的客户端代码就是从开源 MobileIMSDK 的Java端扒出来的，有兴趣的也可以看看它的Android端、Server端、iOS端，简化一下可以用作你自已的各种用途。

10、更多学习资源

[1] MINA和Netty的源码在线学习和查阅：
MINA-2.x地址是：http://docs.52im.net/extend/docs/src/mina2/
MINA-1.x地址是：http://docs.52im.net/extend/docs/src/mina1/
Netty-4.x地址是：http://docs.52im.net/extend/docs/src/netty4/
Netty-3.x地址是：http://docs.52im.net/extend/docs/src/netty3/

[2] MINA和Netty的API文档在线查阅：
MINA-2.x API文档(在线版)：http://docs.52im.net/extend/docs/api/mina2/
MINA-1.x API文档(在线版)：http://docs.52im.net/extend/docs/api/mina1/
Netty-4.x API文档(在线版)：http://docs.52im.net/extend/docs/api/netty4/
Netty-3.x API文档(在线版)：http://docs.52im.net/extend/docs/api/netty3/

[3] 更多有关NIO编程的资料：
请进入精华资料专辑：http://www.52im.net/forum.php?mod=collection&action=view&ctid=9

[4] 有关IM聊天应用、消息推送技术的资料：
请进入精华资料专辑：http://www.52im.net/forum.php?mod=collection&op=all

[5] 技术交流和学习：
可直接进入即时通讯开发者社区讨论和学习网络编程、IM聊天应用、消息推送应用的开发。

11、完整源码工程下载

客户端_echo_client_udp.rar (16.08 KB , 下载次数: 893 , 售价: 2 金币)

服务端_netty4_echo_server_udp.rar (2.87 MB , 下载次数: 14010 , 售价: 2 金币)

附录1：全站精品资源下载

附录2：全站即时通讯技术资料分类

113 楼: transportmass · 6 个月前

感谢分享！确实对新手很有用！

112 楼: transportmass · 6 个月前

感谢分享，学习了！

111 楼: SolarPower · 2 年前

感谢分享！！！

110 楼: grsg · 2 年前

非常棒，学习了

109 楼: fuvidy · 2 年前

谢谢

108 楼: wx_j1ccvotZ · 3 年前

谢谢

107 楼: liuybaby · 3 年前

谢谢，项目要用，学习一下，谢谢

106 楼: fcs_our2010 · 3 年前

很好的demo 赞

105 楼: 18665362808 · 4 年前

感谢，学习了

104 楼: JackJiang · 4 年前

引用：老白发表于 2020-10-06 13:37
基础的入门文章，可以了解下基本原理，支持！

103 楼: 老白 · 4 年前

基础的入门文章，可以了解下基本原理，支持！

102 楼: lijinkai_2008 · 4 年前

这是个好帖子，我也在学习udp，学习一下。

101 楼: wangfengcool · 4 年前

太强悍了

100 楼: ShineDanan · 4 年前

非常好

99 楼: 淘米 · 4 年前

感谢分享、学习了

98 楼: zhouzhe · 4 年前

感谢分享

97 楼: 超超超 · 4 年前

攒点金币下载源码

96 楼: JackJiang · 4 年前

引用：njakdnjljqlwjd 发表于 2019-12-23 16:21
额，代码是有读了，主要我自己本身对Netty的基础使用还不是很了解。虽然代码都能看懂大致是什么执行流程 ...

你不用着急，netty其实是有点复杂的框架，你找本教程或书，把netty基础系统的学习一下，就不会有什么了

95 楼: njakdnjljqlwjd · 4 年前

引用：JackJiang 发表于 2019-12-23 15:54
是的。代码总共也没几行，你读一下

额，代码是有读了，主要我自己本身对Netty的基础使用还不是很了解。虽然代码都能看懂大致是什么执行流程，但是还是没弄懂为啥ChannelRead0没执行.今天3点多最后挣扎了一次，自己又多写了个ChannelRead方法，里面判断类型再调用ChannelRead0，可惜的是这2个方法都没有被调用。我依旧没有解决问题。我想我需要先把基础的东西学一学再继续尝试这个UDP的代码。谢谢楼主了

94 楼: JackJiang · 4 年前

引用：njakdnjljqlwjd 发表于 2019-12-23 02:10
后来我试了下，Linux抓包能抓到客户端发来的UDP包了。但是后端不能执行接收包和发送包的步骤（对应channe ...

是的。代码总共也没几行，你读一下

本文目录

1、前言

2、《NIO框架入门》系列文章

3、本文亮点

4、题外话

写个什么样的Demo？

5、Netty4服务端准备工作

1第一步：下载Netty4

2第二步：找到Netty4的核心库文件

3第三步：建好Java工程准备准备开撸

6、服务端代码

1服务端主类 EchoServer.java

2服务端Handler类 EchoSeverHandler

7、客户端代码

1客户端主类 EchoClient.java

2Socket操作类 LocalUDPSocketProvider.java

3数据接收类 LocalUDPDataReciever.java

8、运行效果

9、补充说明

10、更多学习资源

11、完整源码工程下载

附录1：全站精品资源下载

附录2：全站即时通讯技术资料分类

评分

本帖已收录至以下技术专辑

MobileIMSDK (v6.5精编版)

MobileIMSDK-Web (有偿开源)

RainbowAVnew (有偿开源)

RainbowChat (技术转让)

RainbowChat-Web (技术转让)

精华之王

白金版主

终身成就

即时通讯网

友情链接[友链交换]

关于

微信公众号new

本文目录

1、前言

2、《NIO框架入门》系列文章

3、本文亮点

4、题外话

写个什么样的Demo？

5、Netty4服务端准备工作

1第一步：下载Netty4

2第二步：找到Netty4的核心库文件

3第三步：建好Java工程准备准备开撸

6、服务端代码

1服务端主类 EchoServer.java

2服务端Handler类 EchoSeverHandler

7、客户端代码

1客户端主类 EchoClient.java

2Socket操作类 LocalUDPSocketProvider.java

3数据接收类 LocalUDPDataReciever.java

8、运行效果

9、补充说明

10、更多学习资源

11、完整源码工程下载

附录1：全站精品资源下载

附录2：全站即时通讯技术资料分类

评分

本帖已收录至以下技术专辑

MobileIMSDK(v6.5精编版)

MobileIMSDK-Web(有偿开源)

RainbowAVnew(有偿开源)

RainbowChat(技术转让)

RainbowChat-Web(技术转让)

精华之王

白金版主

终身成就

即时通讯网

友情链接[友链交换]

关于

微信公众号new

MobileIMSDK (v6.5精编版)

MobileIMSDK-Web (有偿开源)

RainbowAVnew (有偿开源)

RainbowChat (技术转让)

RainbowChat-Web (技术转让)

即时通讯网　