AI 助理
备案控制台
开发者社区 云计算 文章 正文

Netty基于Http协议的服务端入门开发

2021-12-02 169
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 通过学习搭建一个简单的文件服务器，使用http协议对外提供服务，当客户端通过浏览器访问文件服务器时，对访问路径进行检查，检查失败时返回403错误，该页无法访问，如果校验通过，以链接的方式打开当前文件目录，每个目录下是超链接，可以递归访问，如果是文件则下载。


 通过学习搭建一个简单的文件服务器，使用http协议对外提供服务，当客户端通过浏览器访问文件服务器时，对访问路径进行检查，检查失败时返回403错误，该页无法访问，如果校验通过，以链接的方式打开当前文件目录，每个目录下是超链接，可以递归访问，如果是文件则下载。

代码实现

package com.dpb.netty.http;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.codec.http.HttpObjectAggregator;
import io.netty.handler.codec.http.HttpRequestDecoder;
import io.netty.handler.codec.http.HttpResponseEncoder;
import io.netty.handler.stream.ChunkedWriteHandler;
public class HttpFileServer {
  private static final String DEFAULT_URL = "/src/main/java/com/dpb/netty/";
  public void run(final int port, final String url) throws Exception {
    EventLoopGroup bossGroup = new NioEventLoopGroup();
    EventLoopGroup workerGroup = new NioEventLoopGroup();
    try {
      ServerBootstrap b = new ServerBootstrap();
      b.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class)
          .childHandler(new ChannelInitializer<SocketChannel>() {
            @Override
            protected void initChannel(SocketChannel ch) throws Exception {
              // 添加请求消息解码器
              ch.pipeline().addLast("http-decoder", new HttpRequestDecoder());
              //HttpObjectAggregator的作用 将多个消息转换为单一的FullHttpRequest或者FullHttpResponse
              ch.pipeline().addLast("http-aggregator", new HttpObjectAggregator(65536));
              // 添加响应解码器
              ch.pipeline().addLast("http-encoder", new HttpResponseEncoder());
              // 支持异步发送大的码流(大的文件传输),但不占用过多的内存，防止java内存溢出
              ch.pipeline().addLast("http-chunked", new ChunkedWriteHandler());
              // 添加自定义handler 处理文件服务器业务逻辑
              ch.pipeline().addLast("fileServerHandler", new HttpFileServerHandler(url));
            }
          });
      ChannelFuture future = b.bind("127.0.0.1", port).sync();
      System.out.println("HTTP文件目录服务器启动，网址是 : " + "http://127.0.0.1:" + port + url);
      future.channel().closeFuture().sync();
    } finally {
      bossGroup.shutdownGracefully();
      workerGroup.shutdownGracefully();
    }
  }
  public static void main(String[] args) throws Exception {
    int port = 8080;
    if (args.length > 0) {
      try {
        port = Integer.parseInt(args[0]);
      } catch (NumberFormatException e) {
        e.printStackTrace();
      }
    }
    String url = DEFAULT_URL;
    if (args.length > 1)
      url = args[1];
    new HttpFileServer().run(port, url);
  }
}

HttpFileServerHandler

package com.dpb.netty.http;
import static io.netty.handler.codec.http.HttpHeaders.isKeepAlive;
import static io.netty.handler.codec.http.HttpHeaders.setContentLength;
import static io.netty.handler.codec.http.HttpHeaders.Names.CONNECTION;
import static io.netty.handler.codec.http.HttpHeaders.Names.CONTENT_TYPE;
import static io.netty.handler.codec.http.HttpHeaders.Names.LOCATION;
import static io.netty.handler.codec.http.HttpMethod.GET;
import static io.netty.handler.codec.http.HttpResponseStatus.BAD_REQUEST;
import static io.netty.handler.codec.http.HttpResponseStatus.FORBIDDEN;
import static io.netty.handler.codec.http.HttpResponseStatus.FOUND;
import static io.netty.handler.codec.http.HttpResponseStatus.INTERNAL_SERVER_ERROR;
import static io.netty.handler.codec.http.HttpResponseStatus.METHOD_NOT_ALLOWED;
import static io.netty.handler.codec.http.HttpResponseStatus.NOT_FOUND;
import static io.netty.handler.codec.http.HttpResponseStatus.OK;
import static io.netty.handler.codec.http.HttpVersion.HTTP_1_1;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.RandomAccessFile;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.util.regex.Pattern;
import javax.activation.MimetypesFileTypeMap;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelFutureListener;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelProgressiveFuture;
import io.netty.channel.ChannelProgressiveFutureListener;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.handler.codec.http.DefaultFullHttpResponse;
import io.netty.handler.codec.http.DefaultHttpResponse;
import io.netty.handler.codec.http.FullHttpRequest;
import io.netty.handler.codec.http.FullHttpResponse;
import io.netty.handler.codec.http.HttpHeaders;
import io.netty.handler.codec.http.HttpResponse;
import io.netty.handler.codec.http.HttpResponseStatus;
import io.netty.handler.codec.http.LastHttpContent;
import io.netty.handler.stream.ChunkedFile;
import io.netty.util.CharsetUtil;
public class HttpFileServerHandler extends SimpleChannelInboundHandler<FullHttpRequest> {
  private final String url;
  public HttpFileServerHandler(String url) {
    this.url = url;
  }
  @Override
  public void messageReceived(ChannelHandlerContext ctx, FullHttpRequest request) throws Exception {
    // 解码失败 400
    if (!request.getDecoderResult().isSuccess()) {
      sendError(ctx, BAD_REQUEST);
      return;
    }
    // 只支持get方法
    if (request.getMethod() != GET) {
      sendError(ctx, METHOD_NOT_ALLOWED);
      return;
    }
    // 
    final String uri = request.getUri();
    // 处理Uri地址
    final String path = sanitizeUri(uri);
    if (path == null) {
      sendError(ctx, FORBIDDEN);
      return;
    }
    File file = new File(path);
    // 如果文件不存在，或不可访问
    if (file.isHidden() || !file.exists()) {
      sendError(ctx, NOT_FOUND);
      return;
    }
    // 如果请求是文件夹
    if (file.isDirectory()) {
      // 请求以 '/'结尾，列出该文件夹下的所有内容
      if (uri.endsWith("/")) {
        sendListing(ctx, file);
      } else {
        // 否则自动补全'/' 然后再重定向访问
        sendRedirect(ctx, uri + '/');
      }
      return;
    }
    if (!file.isFile()) {
      sendError(ctx, FORBIDDEN);
      return;
    }
    RandomAccessFile randomAccessFile = null;
    try {
      randomAccessFile = new RandomAccessFile(file, "r");// 以只读的方式打开文件
    } catch (FileNotFoundException fnfe) {
      sendError(ctx, NOT_FOUND);
      return;
    }
    long fileLength = randomAccessFile.length();
    // 创建一个默认的Http响应
    HttpResponse response = new DefaultHttpResponse(HTTP_1_1, OK);
    // 设置响应文件大小
    setContentLength(response, fileLength);
    // 设置 content Type
    setContentTypeHeader(response, file);
    // 设置 keep alive
    if (isKeepAlive(request)) {
      response.headers().set(CONNECTION, HttpHeaders.Values.KEEP_ALIVE);
    }
    ctx.write(response);
    ChannelFuture sendFileFuture;
    //通过Netty的ChunkedFile对象直接将文件写入发送到缓冲区中
    sendFileFuture = ctx.write(new ChunkedFile(randomAccessFile, 0, fileLength, 8192), ctx.newProgressivePromise());
    sendFileFuture.addListener(new ChannelProgressiveFutureListener() {
      @Override
      public void operationProgressed(ChannelProgressiveFuture future, long progress, long total) {
        if (total < 0) { // total unknown
          System.err.println("Transfer progress: " + progress);
        } else {
          System.err.println("Transfer progress: " + progress + " / " + total);
        }
      }
      @Override
      public void operationComplete(ChannelProgressiveFuture future) throws Exception {
        System.out.println("Transfer complete.");
      }
    });
    ChannelFuture lastContentFuture = ctx.writeAndFlush(LastHttpContent.EMPTY_LAST_CONTENT);
    //如果不支持keep-Alive，服务器端主动关闭请求
    if (!isKeepAlive(request)) {
      lastContentFuture.addListener(ChannelFutureListener.CLOSE);
    }
  }
  @Override
  public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
    cause.printStackTrace();
    if (ctx.channel().isActive()) {
      sendError(ctx, INTERNAL_SERVER_ERROR);
    }
  }
  private static final Pattern INSECURE_URI = Pattern.compile(".*[<>&\"].*");
  /**
   * 格式化uri并且获取路径
   * @param uri
   * @return
   */
  private String sanitizeUri(String uri) {
    try {
      uri = URLDecoder.decode(uri, "UTF-8");
    } catch (UnsupportedEncodingException e) {
      try {
        uri = URLDecoder.decode(uri, "ISO-8859-1");
      } catch (UnsupportedEncodingException e1) {
        throw new Error();
      }
    }
    if (!uri.startsWith(url)) {
      return null;
    }
    if (!uri.startsWith("/")) {
      return null;
    }
    uri = uri.replace('/', File.separatorChar);
    if (uri.contains(File.separator + '.') || uri.contains('.' + File.separator) || uri.startsWith(".")
        || uri.endsWith(".") || INSECURE_URI.matcher(uri).matches()) {
      return null;
    }
    return System.getProperty("user.dir") + File.separator + uri;
  }
  private static final Pattern ALLOWED_FILE_NAME = Pattern.compile("[A-Za-z0-9][-_A-Za-z0-9\\.]*");
  private static void sendListing(ChannelHandlerContext ctx, File dir) {
    FullHttpResponse response = new DefaultFullHttpResponse(HTTP_1_1, OK);
    response.headers().set(CONTENT_TYPE, "text/html; charset=UTF-8");
    StringBuilder buf = new StringBuilder();
    String dirPath = dir.getPath();
    buf.append("<!DOCTYPE html>\r\n");
    buf.append("<html><head><title>");
    buf.append(dirPath);
    buf.append(" 目录：");
    buf.append("</title></head><body>\r\n");
    buf.append("<h3>");
    buf.append(dirPath).append(" 目录：");
    buf.append("</h3>\r\n");
    buf.append("<ul>");
    buf.append("<li>链接：<a href=\"../\">..</a></li>\r\n");
    for (File f : dir.listFiles()) {
      if (f.isHidden() || !f.canRead()) {
        continue;
      }
      String name = f.getName();
      if (!ALLOWED_FILE_NAME.matcher(name).matches()) {
        continue;
      }
      buf.append("<li>链接：<a href=\"");
      buf.append(name);
      buf.append("\">");
      buf.append(name);
      buf.append("</a></li>\r\n");
    }
    buf.append("</ul></body></html>\r\n");
    ByteBuf buffer = Unpooled.copiedBuffer(buf, CharsetUtil.UTF_8);
    response.content().writeBytes(buffer);
    buffer.release();
    ctx.writeAndFlush(response).addListener(ChannelFutureListener.CLOSE);
  }
  private static void sendRedirect(ChannelHandlerContext ctx, String newUri) {
    FullHttpResponse response = new DefaultFullHttpResponse(HTTP_1_1, FOUND);
    response.headers().set(LOCATION, newUri);
    ctx.writeAndFlush(response).addListener(ChannelFutureListener.CLOSE);
  }
  private static void sendError(ChannelHandlerContext ctx, HttpResponseStatus status) {
    FullHttpResponse response = new DefaultFullHttpResponse(HTTP_1_1, status,
        Unpooled.copiedBuffer("Failure: " + status.toString() + "\r\n", CharsetUtil.UTF_8));
    response.headers().set(CONTENT_TYPE, "text/plain; charset=UTF-8");
    ctx.writeAndFlush(response).addListener(ChannelFutureListener.CLOSE);
  }
  private static void setContentTypeHeader(HttpResponse response, File file) {
    MimetypesFileTypeMap mimeTypesMap = new MimetypesFileTypeMap();
    response.headers().set(CONTENT_TYPE, mimeTypesMap.getContentType(file.getPath()));
  }
}

测试效果

地址输出错的请求

image.png

访问成功

image.png

搭建很简单，可以跑下代码，关键多推敲下代码~


文章标签：
云数据库 ClickHouse
关键词：
HTTP协议
Netty入门
HTTPS协议
Netty服务端
Netty http
游客a74jvhcp7vclg
目录
相关文章
大树营养快线
|
11天前
|
算法 网络协议 安全
HTTP/2 协议的缺点是什么？
HTTP/2 协议的缺点是什么？
大树营养快线
59 13
众所周知
|
11天前
|
网络协议 网络安全 网络虚拟化
本文介绍了十个重要的网络技术术语，包括IP地址、子网掩码、域名系统（DNS）、防火墙、虚拟专用网络（VPN）、路由器、交换机、超文本传输协议（HTTP）、传输控制协议/网际协议（TCP/IP）和云计算
本文介绍了十个重要的网络技术术语，包括IP地址、子网掩码、域名系统（DNS）、防火墙、虚拟专用网络（VPN）、路由器、交换机、超文本传输协议（HTTP）、传输控制协议/网际协议（TCP/IP）和云计算。通过这些术语的详细解释，帮助读者更好地理解和应用网络技术，应对数字化时代的挑战和机遇。
众所周知
46 3
vohelon
|
22天前
|
网络协议 安全 Go
Go语言进行网络编程可以通过**使用TCP/IP协议栈、并发模型、HTTP协议等**方式
【10月更文挑战第28天】Go语言进行网络编程可以通过**使用TCP/IP协议栈、并发模型、HTTP协议等**方式
vohelon
49 13
喜欢猪猪
|
13天前
|
消息中间件 编解码 网络协议
Netty从入门到精通：高性能网络编程的进阶之路
【11月更文挑战第17天】Netty是一个基于Java NIO（Non-blocking I/O）的高性能、异步事件驱动的网络应用框架。使用Netty，开发者可以快速、高效地开发可扩展的网络服务器和客户端程序。本文将带您从Netty的背景、业务场景、功能点、解决问题的关键、底层原理实现，到编写一个详细的Java示例，全面了解Netty，帮助您从入门到精通。
喜欢猪猪
48 0
c的前世今生
|
15天前
|
传感器 缓存 网络协议
CoAP 协议与 HTTP 协议的区别
CoAP（Constrained Application Protocol）协议是为资源受限的设备设计的轻量级协议，适用于物联网场景。相比HTTP，CoAP具有低功耗、低带宽占用和简单易实现的特点，支持多播通信和无连接的交互模式。
c的前世今生
25 2
德国都芳最好
|
20天前
|
开发者
HTTP 协议请求方法的发展历程
【10月更文挑战第21天】
德国都芳最好
29 2
德国都芳最好
|
20天前
|
安全
HTTP 协议的请求方法
【10月更文挑战第21天】
德国都芳最好
33 2
大树营养快线
|
20天前
|
缓存 安全 前端开发
HTTP 协议的请求方法在实际应用中有哪些注意事项？
【10月更文挑战第29天】HTTP协议的请求方法在实际应用中需要根据具体的业务场景和需求，合理选择和使用，并注意各种方法的特点和限制，以确保网络通信的安全、高效和数据的一致性。
大树营养快线
32 1
qhhf_地道酬勤
|
22天前
|
存储 缓存 网络协议
计算机网络常见面试题（二）：浏览器中输入URL返回页面过程、HTTP协议特点，GET、POST的区别，Cookie与Session
计算机网络常见面试题（二）：浏览器中输入URL返回页面过程、HTTP协议特点、状态码、报文格式，GET、POST的区别，DNS的解析过程、数字证书、Cookie与Session，对称加密和非对称加密
qhhf_地道酬勤
81 2
大树营养快线
|
23天前
|
安全 前端开发 JavaScript
利用HTTP协议进行文件上传和下载的常见方法
【10月更文挑战第25天】可以利用HTTP协议方便地实现文件的上传和下载功能，满足不同应用场景下的需求。在实际应用中，还可以根据具体的业务需求和安全要求，对文件上传和下载的过程进行进一步的优化和安全处理。
大树营养快线
57 1