ProtoBuf和Netty的简单使用

快来打我* 2021-09-16 13:26 565阅读 0赞

1096904-20170308110123406-541003583.png

1.pom.xml:

当然，也可建立个java工程把jar包放进去

  1. 1 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.  2     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3.  3     <modelVersion>4.0.0</modelVersion>
  4.  4     <groupId>netty-demo</groupId>
  5.  5     <artifactId>com.kingdee</artifactId>
  6.  6     <version>0.0.1-SNAPSHOT</version>
  7.  7     <properties>
  8.  8         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  9.  9         <spring.version>3.2.5.RELEASE</spring.version>
  10. 10         <spring.rabbit.version>1.3.5.RELEASE</spring.rabbit.version>
  11. 11     </properties>
  12. 12     <dependencies>
  13. 13         <dependency>
  14. 14             <groupId>org.springframework</groupId>
  15. 15             <artifactId>spring-context</artifactId>
  16. 16             <version>${spring.version}</version>
  17. 17         </dependency>
  18. 18 
  19. 19         <!-- https://mvnrepository.com/artifact/io.netty/netty-all -->
  20. 20         <dependency>
  21. 21             <groupId>io.netty</groupId>
  22. 22             <artifactId>netty-all</artifactId>
  23. 23             <version>4.0.23.Final</version>
  24. 24         </dependency>
  25. 25 
  26. 26         <!-- https://mvnrepository.com/artifact/log4j/log4j -->
  27. 27         <dependency>
  28. 28             <groupId>log4j</groupId>
  29. 29             <artifactId>log4j</artifactId>
  30. 30             <version>1.2.17</version>
  31. 31         </dependency>
  32. 32 
  33. 33         <!-- https://mvnrepository.com/artifact/commons-logging/commons-logging -->
  34. 34         <dependency>
  35. 35             <groupId>commons-logging</groupId>
  36. 36             <artifactId>commons-logging</artifactId>
  37. 37             <version>1.1.1</version>
  38. 38         </dependency>
  39. 39 
  40. 40         <dependency>
  41. 41             <groupId>com.google.protobuf</groupId>
  42. 42             <artifactId>protobuf-java</artifactId>
  43. 43             <version>3.0.0</version>
  44. 44         </dependency>
  45. 45     </dependencies>
  46. 46 </project>

2.msg.proto,把它转换成java代码,再拷贝到对应的包下,利用proto.exe工具生成

mgs.proto:

它是传输的实体类，有两个部分，client和service

传输数据时可以直接.来选择调用哪个对象

  1. package com.netty.demo;
  2. message Client {  
  3.     required string head = 1;  
  4.     required string body = 2;  
  5. }
  7. message Server {
  8.     required int32 code=1;
  9.     required string message=2;
  10. }

在protoc.exe下面放proto文件，通过命令生成这个传输实体类

1096904-20170308110543531-959890641.png

3.客户端代码：

Client.java:

  1. package com.netty.demo.client;
  3. import io.netty.bootstrap.Bootstrap;
  4. import io.netty.channel.ChannelFuture;
  5. import io.netty.channel.EventLoopGroup;
  6. import io.netty.channel.nio.NioEventLoopGroup;
  7. import io.netty.channel.socket.nio.NioSocketChannel;
  9. public class Client {
  10.     public static String host = "127.0.0.1";
  11.     public static int port = 8787;
  13.     public static void main(String[] args) {
  14.         EventLoopGroup worker = new NioEventLoopGroup();
  15.         Bootstrap b = new Bootstrap();
  16.         b.group(worker);
  17.         b.channel(NioSocketChannel.class);
  18.         b.handler(new ClientInitializer());
  19.         try {
  20.             ChannelFuture f = b.connect(host, port).sync();
  21.             f.channel().closeFuture().sync();
  22.         } catch (InterruptedException e) {
  24.             e.printStackTrace();
  25.         } finally {
  26.             worker.shutdownGracefully();
  27.         }
  29.     }
  30. }

复制代码

ClientHandler.java(处理客户端消息发送和收到服务端消息的处理,但一般情况下是不会在这里写发送消息的逻辑的，只是为了写demo，所以把发消息写在这里面)

  1. package com.netty.demo.client;
  3. import io.netty.channel.ChannelHandlerContext;
  4. import io.netty.channel.SimpleChannelInboundHandler;
  6. import com.google.protobuf.Message;
  7. import com.netty.demo.Msg;
  9. public class ClientHandler extends SimpleChannelInboundHandler<Message> {
  11.     /**
  12.      * 
  13.      */
  14.     protected void channelRead0(ChannelHandlerContext ctx, Message msg) throws Exception {
  16.         System.out.println("Server say : " + msg.toString());
  17.     }
  19.     /**
  20.      * 
  21.      */
  22.     public void channelActive(ChannelHandlerContext ctx) throws Exception {
  23.         System.out.println("Client active ");
  24.         Msg.Client msg = Msg.Client.newBuilder().setHead("Content-Type:application/json;charset=UTF-8").setBody("hello world!").build();
  25.         ctx.writeAndFlush(msg);
  26.         super.channelActive(ctx);
  27.     }
  29.     @Override
  30.     public void channelInactive(ChannelHandlerContext ctx) throws Exception {
  31.         System.out.println("Client close ");
  32.         super.channelInactive(ctx);
  33.     }
  35. }

ClientInitializer.java（初始化Chanel，如解码，加密等），最早的netty传protobuf，是需要手动toByteArrary()把传输对象序列化成二进制流发出去，接收端再手动反序列化还原成传输对象。

但是后来通过设置protubuf编码解码器，就可以自动实现序列化和反序列化，传输时只需要把实体发出去就行了。

  1. package com.netty.demo.client;
  3. import com.netty.demo.Msg;
  5. import io.netty.channel.ChannelInitializer;
  6. import io.netty.channel.socket.SocketChannel;
  7. import io.netty.handler.codec.LengthFieldBasedFrameDecoder;
  8. import io.netty.handler.codec.LengthFieldPrepender;
  9. import io.netty.handler.codec.protobuf.ProtobufDecoder;
  10. import io.netty.handler.codec.protobuf.ProtobufEncoder;
  12. public class ClientInitializer extends ChannelInitializer<SocketChannel> {
  14.     protected void initChannel(SocketChannel ch) throws Exception {
  15.         // decoded
  16.         ch.pipeline().addLast(new LengthFieldBasedFrameDecoder(1024, 0, 4, 0, 4));
  17.         //这里是收到服务端发过来的消息,所以是对服务端的response解码
  18.         ch.pipeline().addLast(new ProtobufDecoder(Msg.Server.getDefaultInstance()));
  19.         // encoded
  20.         ch.pipeline().addLast(new LengthFieldPrepender(4));
  21.         ch.pipeline().addLast(new ProtobufEncoder());
  22.         // 注册handler
  23.         ch.pipeline().addLast(new ClientHandler());
  24.     }
  26. }

复制代码

4.Server端代码：

Server.java

  1. package com.netty.demo.server;
  3. import io.netty.bootstrap.ServerBootstrap;
  4. import io.netty.channel.ChannelFuture;
  5. import io.netty.channel.ChannelOption;
  6. import io.netty.channel.EventLoopGroup;
  7. import io.netty.channel.nio.NioEventLoopGroup;
  8. import io.netty.channel.socket.nio.NioServerSocketChannel;
  10. public class Server {
  11.     private static int port = 8787;
  12.     public static void main(String[] args) {
  13.         EventLoopGroup boss = new NioEventLoopGroup();
  14.         EventLoopGroup worker = new NioEventLoopGroup();
  15.         ServerBootstrap server = new ServerBootstrap();
  16.         server.group(boss, worker);
  17.         server.channel(NioServerSocketChannel.class);
  18.         server.childHandler(new ServerInitializer());
  19.         server.option(ChannelOption.SO_BACKLOG, 128);
  20.         server.childOption(ChannelOption.SO_KEEPALIVE, true);
  22.         try {
  23.             //绑定端口 同步等待成功
  24.             ChannelFuture f = server.bind(port).sync();
  25.             //等待服务端监听端口关闭
  26.             f.channel().closeFuture().sync();
  27.         } catch (InterruptedException e) {
  29.             e.printStackTrace();
  30.         } finally {
  31.             worker.shutdownGracefully();
  32.             boss.shutdownGracefully();
  33.         }
  34.     }
  35. }

复制代码

ServerHandler.java:

  1. package com.netty.demo.server;
  3. import java.net.InetAddress;
  5. import com.google.protobuf.Message;
  6. import com.netty.demo.Msg;
  7. import com.netty.demo.Msg.Client;
  9. import io.netty.channel.ChannelHandlerContext;
  10. import io.netty.channel.SimpleChannelInboundHandler;
  12. /**
  13.  * 处理客户端连接时的handler
  14.  * 
  15.  * @author shizhengchao32677
  16.  * 
  17.  */
  18. public class ServerHandler extends SimpleChannelInboundHandler<Message> {
  20.     /**
  21.      * 收到客户端发过来的消息
  22.      */
  23.     protected void channelRead0(ChannelHandlerContext ctx, Message msg) throws Exception {
  24.         // 收到消息直接打印输出
  25.         System.out.println(msg.getClass());
  26.         Msg.Server response = null;
  27.         if(msg instanceof Msg.Client) {
  28.             Msg.Client clientMsg = (Client) msg;
  29.             System.out.println(ctx.channel().remoteAddress() + " Say : " + clientMsg.getBody());
  30.             response = Msg.Server.newBuilder().setCode(0).setMessage("Received client message success").build();
  31.         } else {
  32.             response = Msg.Server.newBuilder().setCode(-1).setMessage("client message is illegal").build();
  33.             System.out.println("client message is illegal");
  34.         }
  35.         // 返回客户端消息 - 我已经接收到了你的消息
  36.         ctx.writeAndFlush(response);
  37.     }
  39.     /*
  40.      * 覆盖 channelActive 方法 在channel被启用的时候触发 (在建立连接的时候)
  41.      */
  42.     public void channelActive(ChannelHandlerContext ctx) throws Exception {
  43.         System.out.println("RamoteAddress : " + ctx.channel().remoteAddress() + " active !");
  44.         String welcome = "Welcome to " + InetAddress.getLocalHost().getHostName() + " service!";
  45.         Msg.Server response = Msg.Server.newBuilder().setCode(101).setMessage(welcome).build();
  46.         ctx.writeAndFlush(response);
  47.         super.channelActive(ctx);
  48.     }
  50. }

ServerInitializer.java

  1. package com.netty.demo.server;
  3. import io.netty.channel.ChannelInitializer;
  4. import io.netty.channel.socket.SocketChannel;
  5. import io.netty.handler.codec.LengthFieldBasedFrameDecoder;
  6. import io.netty.handler.codec.LengthFieldPrepender;
  7. import io.netty.handler.codec.protobuf.ProtobufDecoder;
  8. import io.netty.handler.codec.protobuf.ProtobufEncoder;
  10. import com.netty.demo.Msg;
  12. public class ServerInitializer extends ChannelInitializer<SocketChannel> {
  14.     protected void initChannel(SocketChannel ch) throws Exception {
  15.         // decoded
  16.         ch.pipeline().addLast(new LengthFieldBasedFrameDecoder(1024, 0, 4, 0, 4));
  17.         //解码客户端发过来的消息
  18.         ch.pipeline().addLast(new ProtobufDecoder(Msg.Client.getDefaultInstance()));
  19.         // encoded
  20.         ch.pipeline().addLast(new LengthFieldPrepender(4));
  21.         ch.pipeline().addLast(new ProtobufEncoder());
  22.         // 注册handler
  23.         ch.pipeline().addLast(new ServerHandler());
  24.     }
  26. }

运行Server.java和Client.java:

  1. Server输出：
  3. RamoteAddress : /127.0.0.1:59693 active !
  4. class com.netty.demo.Msg$Client
  5. /127.0.0.1:59693 Say : hello world!
  9. Clientl输出：
  11. Client active 
  12. Server say : code: 101
  13. message: "Welcome to H4UOJJQSF23HQ91 service!"
  15. Server say : code: 0
  16. message: "Received client message success"

发表评论

表情：
评论列表 （有 0 条评论，565人围观）

还没有评论，来说两句吧...

相关阅读

    相关 protobuf简单使用

    一、介绍         首先，protobuf是一个开源项目，而且是后台很硬的开源项目。网上现有的大部分（至少80%）开源项目，要么是某人单干、要么是几个闲杂人等合伙搞。而

    ╰半橙微兮°╰半橙微兮°/ 0 赞/ 346 阅读