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

Netty实战: HTTP文件列表服务器

2024-03-27 62
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Netty实战: HTTP文件列表服务器

Netty:HTTP模拟文件列表服务器

了解简单开发流程

作为netty的一个小练习demo，在编写之前我们需要短暂的对netty的开发模式做一个复习

首先就是netty服务端的开发步骤：

  • 声明 主从两个事件循环组
  • 创建链接对象 : serverBootstrap
  • 设置组的参数
  • 使用通道
  • 处理器
  • 子线程的处理器，管道设置，定义处理器执行顺序和需要的编解码器
  • 启动服务器，异步 阻塞，优雅的关闭两个事件循环组

服务端启动代码

其实服务端的启动代码是十分的相似的 唯一变化的就是设置子循环组的处理器是我们自定义处理器的区别

//通过 HTTP 请求 返回访问指定目录的文件列表
public class FileServer {
    public static void main(String[] args) {
        NioEventLoopGroup bossGroup = new NioEventLoopGroup();
        NioEventLoopGroup workerGroup = new NioEventLoopGroup();
        //连接指引对象
        ServerBootstrap serverBootstrap = new ServerBootstrap();
        //链式编程
        serverBootstrap.group(bossGroup, workerGroup)
                .channel(NioServerSocketChannel.class)
                .handler(new LoggingHandler())
                .childHandler(new ChannelInitializer<SocketChannel>() {
                    @Override
                    protected void initChannel(SocketChannel socketChannel) throws Exception {
                        ChannelPipeline pipeline = socketChannel.pipeline();
                        //设定编解码器 Netty提供的http 编解码器
                        pipeline.addLast(new HttpServerCodec());
                        //数据聚合器 因为是分段传输 处理Http消息的聚合器
                        pipeline.addLast(new HttpObjectAggregator(512 * 1024));
                        //支持大数据的文件传输 控制对内存的使用
                        pipeline.addLast(new ChunkedWriteHandler());
                        // 添加自定义处理器
                        pipeline.addLast(new FileServerHandler());
                    }
                });
        // 启动服务器
        try {
            ChannelFuture future = serverBootstrap.bind(9090).sync();
            // 阻塞关闭
            future.channel().closeFuture().sync();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            workerGroup.shutdownGracefully();
            bossGroup.shutdownGracefully();
        }
    }
}

处理器的编写思路

  • 首先是格式化请求的路径
  • 将文件夹遍历成html的i形式返回
  • 处理点击进入文件夹，只要还没有到底 就重发请求继续向下请求文件夹
  • 异常处理
  • 整合方法 验证路径真实性

格式化方法

  • 先确定编码格式
  • 判断正确性
  • 替换格式 之后返回格式化好的uri
private String sanitizeUri(String uri) {
        try {
            uri = URLDecoder.decode(uri, "UTF-8");
        } catch (UnsupportedEncodingException e) {
            //用utf-8解码出现错误时，就换种解码方式
            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;
        }
        System.out.println(System.getProperty("user.dir"));
        //
        return System.getProperty("user.dir") + File.separator + uri;
    }

将文件遍历 html形式

  1. 这个思路其实就很简单了，用stringbuilder来拼接html
  2. 设置字符集，避免乱码
  3. 以buf的形式返回页面
  4. 释放资源
private static void sendListing(ChannelHandlerContext ctx, File dir) {
        FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.OK);
        response.headers().set(HttpHeaderNames.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("使用netty做下载文件服务器");
        buf.append("</title></head><body>\r\n");
        buf.append("<h3>");
        buf.append("当前文件夹位置：");
        buf.append(dirPath);
        buf.append("</h3>\r\n");
        buf.append("<h4>");
        buf.append("文件列表");
        buf.append("</h4>\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(HttpVersion.HTTP_1_1, HttpResponseStatus.FOUND);
        //设置访问的url路径为新的文件夹路径
        response.headers().set(HttpHeaderNames.LOCATION, newUri);
        ctx.writeAndFlush(response).addListener(ChannelFutureListener.CLOSE);
    }

异常处理

显示错误信息

private static void sendError(ChannelHandlerContext ctx, HttpResponseStatus status) {
        FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, status,       Unpooled.copiedBuffer("Failure: " + status.toString() + "\r\n", CharsetUtil.UTF_8));
        response.headers().set(HttpHeaderNames.CONTENT_TYPE, "text/plain; charset=UTF-8");
        ctx.writeAndFlush(response).addListener(ChannelFutureListener.CLOSE);
    }

异常处理

public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        if (ctx.channel().isActive()) {
            sendError(ctx, HttpResponseStatus.INTERNAL_SERVER_ERROR);
        }
    }

请求入口代码

  • 判断解码和请求
  • 格式化 url
  • 验证地址真实性
  • 如果是没有文件夹了 显示文件，如果还有就重新请求下级目录
  • 如果不是文件夹也不是文件就报错，展示错误信息
@Override
    protected void channelRead0(ChannelHandlerContext ctx, FullHttpRequest request) throws Exception {
        // 如果无法解码,返回400
        if (!request.decoderResult().isSuccess()) {
            sendError(ctx, HttpResponseStatus.BAD_REQUEST);
            return;
        }
        //只支持GET方法,其他方法返回
        if (request.method() != HttpMethod.GET) {
            sendError(ctx, HttpResponseStatus.METHOD_NOT_ALLOWED);
            return;
        }
        //获取文件路径
        final String uri = request.uri();
        // 格式化URL，并且获取文件的磁盘路径
        final String path = sanitizeUri(uri);
        System.out.println(path);
        if (path == null) {
            sendError(ctx, HttpResponseStatus.FORBIDDEN);
            return;
        }
        File file = new File(path);
        // 如果文件隐藏不可访问或者文件不存在
        if (file.isHidden() || !file.exists()) {
            sendError(ctx, HttpResponseStatus.NOT_FOUND);
            return;
        }
        //如果是文件目录
        if (file.isDirectory()) {
            //以/结尾时，就列出文件夹下的所有文件
            if (uri.endsWith("/")) {
                sendListing(ctx, file);
            } else {
                //否则进行重定向，打开文件夹，继续深入
                sendRedirect(ctx, uri + '/');
            }
            return;
        }
        //既不是文件夹，也不是文件
        if (!file.isFile()) {
            sendError(ctx, HttpResponseStatus.FORBIDDEN);
            return;
        }
    }

完整代码

/**
 * @projectName: gchatsystem
 * @package: com.hyc.gchatsystem.file
 * @className: FileServerHandler
 * @author: 冷环渊 doomwatcher
 * @description: TODO
 * @date: 2022/4/13 17:36
 * @version: 1.0
 */
//文件服务器处理器
public class FileServerHandler extends SimpleChannelInboundHandler<FullHttpRequest> {
    private static final Pattern INSECURE_URI = Pattern.compile(".*[<>&\"].*");
    //文件名称匹配规则，必须是英文、数字下划线、中划线
    private static final Pattern ALLOWED_FILE_NAME = Pattern.compile("[A-Za-z0-9][-_A-Za-z0-9\\.]*");
    //文件路徑
    private final String url;
    public FileServerHandler() {
        this.url = "/";
    }
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, FullHttpRequest request) throws Exception {
        // 如果无法解码,返回400
        if (!request.decoderResult().isSuccess()) {
            sendError(ctx, HttpResponseStatus.BAD_REQUEST);
            return;
        }
        //只支持GET方法,其他方法返回
        if (request.method() != HttpMethod.GET) {
            sendError(ctx, HttpResponseStatus.METHOD_NOT_ALLOWED);
            return;
        }
        //获取文件路径
        final String uri = request.uri();
        // 格式化URL，并且获取文件的磁盘路径
        final String path = sanitizeUri(uri);
        System.out.println(path);
        if (path == null) {
            sendError(ctx, HttpResponseStatus.FORBIDDEN);
            return;
        }
        File file = new File(path);
        // 如果文件隐藏不可访问或者文件不存在
        if (file.isHidden() || !file.exists()) {
            sendError(ctx, HttpResponseStatus.NOT_FOUND);
            return;
        }
        //如果是文件目录
        if (file.isDirectory()) {
            //以/结尾时，就列出文件夹下的所有文件
            if (uri.endsWith("/")) {
                sendListing(ctx, file);
            } else {
                //否则进行重定向，打开文件夹，继续深入
                sendRedirect(ctx, uri + '/');
            }
            return;
        }
        //既不是文件夹，也不是文件
        if (!file.isFile()) {
            sendError(ctx, HttpResponseStatus.FORBIDDEN);
            return;
        }
    }
    /**
     * 异常处理
     */
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        if (ctx.channel().isActive()) {
            sendError(ctx, HttpResponseStatus.INTERNAL_SERVER_ERROR);
        }
    }
    /**
     * 格式化uri，返回文件的磁盘路径
     * @param uri
     * @return
     *
     */
    private String sanitizeUri(String uri) {
        try {
            uri = URLDecoder.decode(uri, "UTF-8");
        } catch (UnsupportedEncodingException e) {
            //用utf-8解码出现错误时，就换种解码方式
            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;
        }
        System.out.println(System.getProperty("user.dir"));
        //
        return System.getProperty("user.dir") + File.separator + uri;
    }
    /**
     * 展示文件列表
     * @param ctx
     * @param dir
     *
     */
    private static void sendListing(ChannelHandlerContext ctx, File dir) {
        FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.OK);
        response.headers().set(HttpHeaderNames.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("使用netty做下载文件服务器");
        buf.append("</title></head><body>\r\n");
        buf.append("<h3>");
        buf.append("当前文件夹位置：");
        buf.append(dirPath);
        buf.append("</h3>\r\n");
        buf.append("<h4>");
        buf.append("文件列表");
        buf.append("</h4>\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);
    }
    /**
     * 发送重定向
     * @param ctx
     * @param newUri
     *
     */
    private static void sendRedirect(ChannelHandlerContext ctx, String newUri) {
        FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.FOUND);
        //设置访问的url路径为新的文件夹路径
        response.headers().set(HttpHeaderNames.LOCATION, newUri);
        ctx.writeAndFlush(response).addListener(ChannelFutureListener.CLOSE);
    }
    /**
     * 显示错误信息
     * @param ctx
     * @param status
     *
     */
    private static void sendError(ChannelHandlerContext ctx, HttpResponseStatus status) {
        FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, status, Unpooled.copiedBuffer("Failure: " + status.toString() + "\r\n", CharsetUtil.UTF_8));
        response.headers().set(HttpHeaderNames.CONTENT_TYPE, "text/plain; charset=UTF-8");
        ctx.writeAndFlush(response).addListener(ChannelFutureListener.CLOSE);
    }
}

启动效果

关键词：
Netty服务器
http云服务器 ECS
netty HTTP服务器
HTTP服务器
Netty http
Cool架构
目录
相关文章
nanshaws
|
17天前
使用Netty实现文件传输的HTTP服务器和客户端
本文通过详细的代码示例，展示了如何使用Netty框架实现一个文件传输的HTTP服务器和客户端，包括服务端的文件处理和客户端的文件请求与接收。
nanshaws
29 1
使用Netty实现文件传输的HTTP服务器和客户端
尹正杰
|
1月前
|
网络协议
keepalived对后端服务器的监测方式实战案例
关于使用keepalived进行后端服务器TCP监测的实战案例，包括配置文件的编辑和keepalived服务的重启，以确保配置生效。
尹正杰
44 1
keepalived对后端服务器的监测方式实战案例
东方睿赢
|
1月前
|
机器学习/深度学习 JSON API
HTTP协议实战演练场：Python requests库助你成为网络数据抓取大师
在数据驱动的时代，网络数据抓取对于数据分析、机器学习等至关重要。HTTP协议作为互联网通信的基石，其重要性不言而喻。Python的`requests`库凭借简洁的API和强大的功能，成为网络数据抓取的利器。本文将通过实战演练展示如何使用`requests`库进行数据抓取，包括发送GET/POST请求、处理JSON响应及添加自定义请求头等。首先，请确保已安装`requests`库，可通过`pip install requests`进行安装。接下来，我们将逐一介绍如何利用`requests`库探索网络世界，助你成为数据抓取大师。在实践过程中，务必遵守相关法律法规和网站使用条款，做到技术与道德并重。
东方睿赢
41 2
众所周知
|
1月前
|
数据采集 网络协议 API
HTTP协议大揭秘！Python requests库实战，让网络请求变得简单高效
【9月更文挑战第13天】在数字化时代，互联网成为信息传输的核心平台，HTTP协议作为基石，定义了客户端与服务器间的数据传输规则。直接处理HTTP请求复杂繁琐，但Python的`requests`库提供了一个简洁强大的接口，简化了这一过程。HTTP协议采用请求与响应模式，无状态且结构化设计，使其能灵活处理各种数据交换。
众所周知
67 8
vohelon
|
1月前
|
开发者
HTTP状态码是由网页服务器返回的三位数字响应代码，用于表示请求的处理结果和状态
HTTP状态码是由网页服务器返回的三位数字响应代码，用于表示请求的处理结果和状态
vohelon
28 1
1288912195458132
|
2月前
|
运维 数据安全/隐私保护 数据库管理
企业实战项目之服务器用户权限集中管理
企业实战项目之服务器用户权限集中管理
1288912195458132
21 1
众所周知
|
1月前
|
Python
HTTP协议不再是迷！Python网络请求实战，带你走进网络世界的奥秘
本文介绍了HTTP协议，它是互联网信息传递的核心。作为客户端与服务器通信的基础，HTTP请求包括请求行、头和体三部分。通过Python的`requests`库，我们可以轻松实现HTTP请求。本文将指导你安装`requests`库，并通过实战示例演示如何发送GET和POST请求。无论你是想获取网页内容还是提交表单数据，都能通过简单的代码实现。希望本文能帮助你在Python网络请求的道路上迈出坚实的一步。
众所周知
43 0
cz游客
|
2月前
|
移动开发 网络协议 编译器
实战案例3：C语言实现的HTTP服务器
实战案例3：C语言实现的HTTP服务器
cz游客
92 0
弹性计算小冉
|
6天前
|
存储 弹性计算 安全
阿里云第七代云服务器ECS性能、适用场景与价格参考
阿里云第七代云服务器ECS（Elastic Compute Service）作为阿里云最新一代的高性能计算产品，凭借其基于最新硬件架构和虚拟化技术的全面升级，在计算能力、存储性能、网络传输速度以及灵活性等多个方面实现了显著提升。这一代云服务器旨在为用户提供更为强大、稳定且可定制的云端基础设施服务，广泛适用于从基础的Web托管到复杂的高性能计算等多种应用场景。
弹性计算小冉
47 2
lsug6eziqmdfk1111
|
5天前
|
弹性计算 网络安全
阿里云国际OpenAPI多接口快速管理ECS服务器教程
阿里云国际OpenAPI多接口快速管理ECS服务器教程
lsug6eziqmdfk1111
16 0

热门文章

最新文章

  • 1
    记一次8小时惊心动魄的服务器+网站升级
  • 2
    ECS 打造云端开发/协同办公 “军火库”
  • 3
    阿里云服务器更换公网IP地址教程（两种情况）
  • 4
    [自定义服务器控件] 第二步：下拉列表框。
  • 5
    perl批量更改服务器密码
  • 6
    svn服务器备份命令
  • 7
    yum repo升级服务器快速安装手册 zz from baoz
  • 8
    云服务器ESC好处，及搭建博客方法
  • 9
    解决FTP服务器命令好使，工具不好使。
  • 10
    一例IBM服务器Raid磁盘阵列故障
  • 1
    Springboot+Netty+WebSocket搭建简单的消息通知
    144
  • 2
    Netty的基础入门（上）
    206
  • 3
    Netty的基础入门（下）
    103
  • 4
    Spring Boot与Netty打造TCP服务端(解决粘包问题)
    876
  • 5
    通信密码学：探秘Netty中解码器的神奇力量
    163
  • 6
    配置之道：深入研究Netty中的Option选项
    256
  • 7
    网络编程的魔法师：探索Netty中Handler的奇妙世界
    61
  • 8
    事件驱动的奇迹：深入理解Netty中的EventLoop
    253
  • 9
    阿里内部Netty实战小册，值得拥有
    122
  • 10
    Netty网络框架（一）
    468

    • 相关课程

    更多
  • Java Web开发-Web应用、Tomcat、HTTP请求与响应
  • Linux Web服务器Nginx搭建与配置
  • 云安全基础课- HTTP协议基础
  • 7天玩转云服务器
  • 云服务器选型、迁云最佳实践
  • 云服务器ECS基本操作

    • 相关电子书

    更多
  • ECS全知道（下） 镜像与快照+块存储、安全、网运维与监控
  • ECS全知道（上） 实例+计费
  • 阿里巴巴HTTP 2.0实践及无线通信协议的演进之路

    • 相关实验场景

    更多
  • 使用ECS和RDS搭建个人博客
  • 利用云备份Cloud Backup实现ECS文件备份
  • 基于ECS搭建FTP服务
  • 基于ECS和NAS搭建个人网盘
  • 使用ECS和OSS搭建个人网盘
  • 基于ECS搭建云上博客
    • 下一篇
    AI助理直击要害，从繁复中提炼精华——使用CDN加速访问OSS存储的图片