构建轻量级文件服务器

现在的WEB应用基本上都离不开文件服务器,各种图片,视频,文档等资源文件的存取一直WEB应用的一部分,对于这种资源的处理一般是通过独立的一个文件服务器来进行处理,文件服务器会提供upload,download等操作分别进行文件的存储和获取,比较完备的还会提供delete操作,但是一般不需要。
我希望用Java构建一个轻量级的文件服务器应用,这个应用要能满足这么几个需求:

  • 最少依赖,最好只依赖Web容器(例如Tomcat)环境

  • 对外接口至简

  • 相对成熟,上传操作使用标准表单模式,下载操作支持断点续传

对于这些需求,我是这么考量的:

1. 依赖性

java处理文件上传往往需要引入一个org.apache.commons.fileupload-1.2.0.jar这个依赖库,就算引入了还是有一堆的API调用要去写,比较繁琐,SpringMVC在它的基础上做了进一步的封装,相对比较好用了。但是引入Spring就重了,这个不予考量。
如果不想引入第三方的lib,Servlet3给了非常好的解决方案,只是要求Web容器支持Servlet3(Tomcat7.0++)。这个就确认使用Servlet3了。

2. 简易性

接口的简易性我希望的目标是这么想的,尽量简单,尽量做到不依赖参数信息。

2.1 对于upload接口

  • 支持多文件批量上传

  • 不依赖文件参数名,客户端上传时可以任意命名文件名参数

2.2 对于download接口

  • 客户获取文件时只需要传入文件名参数即可

  • 支持Rest风格。(我发现Servlet的url-pattern不支持正则表达式,无法天然支持这种风格,现在是通过编码解析Url进行实现的)

2.3 成熟性

对于成熟性的考虑我主要是考虑通用。upload就是使用标准的表单上传处理,这个大家最容易理解,表单是很视觉化的东西嘛,测试也方便。download最基本的就是要支持断点续传,因为有的视频文件可能比较大,下载需要一点时间,如果网络中断了,在下次在线的时候能继续下载而不用重新来过。还有就是现在一些Html5的音频,视频组件对于源的要求也是断点续传的兼容性是最好的,这个在公司的产品中有测试过,简单的Servlet有时候这些HTML5组件识别不了,或者报一些莫名其妙的错误(例如音频不能重复播放,或者压根不能播放)。而支持断点续传的Servlet基本上没有问题。

好了,做了这么多铺垫,我直接上代码吧。
Upload
==================

@WebServlet("/upload")
@MultipartConfig(location = Defs.temp_path, maxRequestSize = 1024L * 10000)
public class UploadServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.reset();
        resp.setContentType("text/plain; charset=utf-8");
        PrintWriter writer = resp.getWriter();
        writer.write("不支持Get操作!");
        writer.flush();
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        req.setCharacterEncoding("utf-8");
        Collection<Part> parts = null;
        resp.reset();
        resp.setContentType("text/plain; charset=utf-8");
        PrintWriter writer = resp.getWriter();
        // 获取上传的文件列表,Part对象就是Servlet3对文件上传支持中对文件数据的抽象结构
        try {
            parts = req.getParts();
        } catch (Exception e) {
            System.out.println("======>get file part error");
            e.printStackTrace();
            writer.write("上传文件出现错误!" + e.getMessage());
            writer.flush();
            return;
        }
        if(parts == null || parts.isEmpty()){
            writer.write("上传文件为空!");
            writer.flush();
            return;
        }
        List<String> fileNameList = new ArrayList<String>();
        for (Part part : parts) {
            if(part == null){
                continue;
            }
            FileUtil.logPartInfo(part);
            String fileName = FileUtil.getFileName(part);
            String ext = FileUtil.getFileExt(fileName);
            InputStream is = part.getInputStream();
            //创建全局唯一的文件名
            String newName =new ObjectId().toString()+ext;
            String newFileName = Defs.file_path+newName;
            try {
                // 将文件保存指硬盘
                IOUtil.copyInputStreamToFile(is,newFileName);
                fileNameList.add(newName);
            } catch (Exception e) {
                e.printStackTrace();
                continue;
            }
        }

        Map<String,Object> data = new HashMap<String,Object>();
        data.put("fileNames",fileNameList);
        data.put("result",1);
        writer.write(data.toString());
        writer.flush();
    }


}

上传的逻辑很简单,基本上没有注释的必要。稍微提一下文件名的产生机制,我这里偷了个懒,直接套用了mongodb的ObjectId来生成。这里在依赖性方面做了妥协,但是我只把ObjectId的源码给拷贝过来,所以还可以接受。为啥要用ObjectId来产生文件名,主要是它很好的做到了分布式环境中同一时间的产生的差异性。一个ObjectId由 时间戳+机器码+进程号+计数器组成,简单而强大,我懒得重复造轮子了,这里直接移过来。

Download

@WebServlet("/download/*")
public class DownloadServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

        String fileName=null;
        String requestUri = req.getRequestURI();
        int lastIndex = requestUri.lastIndexOf("/");
        if (lastIndex > 0) {
            fileName = requestUri.substring(lastIndex + 1);
        }
        if (fileName == null || fileName.trim().length() == 0) {
            resp.reset();
            resp.setContentType("text/plain;charset=utf-8");
            PrintWriter writer = resp.getWriter();
            writer.write("error:can't get the file name! 不能获取文件名");
            writer.flush();
            return;
        }
        fileName = Defs.file_path + fileName;
        File file = new File(fileName);
        if (!file.exists()) {
            resp.reset();
            resp.setContentType("text/plain;charset=utf-8");
            PrintWriter writer = resp.getWriter();
            writer.write("error: file not exist! 文件不存在");
            writer.flush();
        }

        long length = file.length();
        long start = 0;
        resp.reset();
        resp.setHeader("Accept-Ranges", "byte");
        //断点续传的信息就存储在这个Header属性里面: range:bytes=3-100;200 (从3开始,读取长度为100,总长度为200)
        String range = req.getHeader("Range");
        if (range != null) {
            //SC_PARTIAL_CONTENT 206 表示服务器已经成功处理了部分 GET 请求。类似于 FlashGet 或者迅雷这类的 HTTP下载工具都是使用此类响应实现断点续传或者将一个大文档分解为多个下载段同时下载。
            resp.setStatus(HttpServletResponse.SC_PARTIAL_CONTENT);
            range = range.substring("bytes=".length());
            String[] rangeInfo = range.split("-");
            start = new Long(rangeInfo[0]);
            if (start > file.length()) {
                resp.sendError(HttpServletResponse.SC_REQUESTED_RANGE_NOT_SATISFIABLE);
                return;
            }
            if (rangeInfo.length > 1) {
                length = Long.parseLong(rangeInfo[1]) - start + 1;
            } else {
                length = length - start;
            }
            if (length + start > file.length()) {
                length = file.length() - start;
            }
        }

        resp.setHeader("Content-Type", FileUtil.getMime(fileName));
        resp.setHeader("Content-Length", new Long(length).toString());
        if (range != null) {
            resp.setHeader("Content-Range", "bytes " + new Long(start).toString() + "-" + new Long(start + length - 1).toString() + "/" + new Long(file.length()).toString());
        }
        resp.setContentType(FileUtil.getMime(fileName));
        resp.setHeader("Content-Disposition", "attachment;filename=" + new String(file.getName().getBytes(), "utf-8"));
        long k = 0;
        int ibuffer = 65536;
        byte[] bytes = new byte[ibuffer];
        FileInputStream fileinputstream = new FileInputStream(file);
        try {
            if (start != 0) {
                fileinputstream.skip(start);
            }
            OutputStream os = resp.getOutputStream();
            while (k < length) {
                int j = fileinputstream.read(bytes, 0, (int) (length - k < ibuffer ? length - k : ibuffer));
                if (j < 1) {
                    break;
                }
                os.write(bytes, 0, j);
                k += j;
            }
            os.flush();

        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            fileinputstream.close();
        }
    }
}

下载的逻辑其实也不复杂,只是很繁琐。我也稍微解释一下。
把这段代码翻译成汉语是这样的:

  1. 通过解析Url获取文件名
  2. 判断文件是否存在,及时反馈
  3. 如果文件存在,判断请求的Header信息中是否存在Range信息,分断下载的信息就存储在range里面,这里就需要繁琐的解析 range信息,并于相应的文件信息比较判断,最终获取下载文件的分段起止位置进行下载。
  4. 将读取好文件信息通过byte数组返回。

Test

测试代码的提供也很重要,因为对外发布的接口往往需要提供调用范例。因为是Http请求测试,这里我也偷了个懒,基于httpclient4做了下测试,过程通畅,把代码列一下。

public class TestFileServer {


    @Test
    public void testUpload() throws Exception {
        String url = "http://127.0.0.1:8080/file/upload";
        File file = new File("/Users/por/yee/temp/a.jpg");
        postFile(file, url);

    }

    @Test
    public void testDownload() throws Exception {
        String url = "http://127.0.0.1:8080/file/download/52f2f9ac036495c277b2e13d.jpg";
        HttpClient httpclient = new DefaultHttpClient();
        HttpGet httpGet = new HttpGet(url);
        HttpResponse response = httpclient.execute(httpGet);
        if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
            HttpEntity entity = response.getEntity();
            byte[] datas = EntityUtils.toByteArray(entity);
            System.out.println("data_length="+datas.length);
        }

    }


    public String postFile(File file, String url) throws ClientProtocolException, IOException {
        HttpClient httpclient = new DefaultHttpClient();

        HttpPost httppost = new HttpPost(url);
        FileBody fileBody = new FileBody(file);
        MultipartEntity reqEntity = new MultipartEntity();
        reqEntity.addPart("data", fileBody);
        httppost.setEntity(reqEntity);
        System.out.println("执行: " + httppost.getRequestLine());
        HttpResponse response = httpclient.execute(httppost);
        int statusCode = response.getStatusLine().getStatusCode();
        System.out.println("statusCode is " + statusCode);
        if (statusCode == 200) {
            HttpEntity resEntity = response.getEntity();
            if (resEntity != null) {
                byte[] resData = EntityUtils.toByteArray(resEntity);
                String content = new String(resData, "utf-8");
                System.out.println(content);
                return content;
            }
        }
        return "";
    }
}

文件服务器代码量不大,但是确实WEB应用中不可缺少的一个组成部分。同时,相关的逻辑基本上把Servlet,Http等知识都走了一遍,属于麻雀虽小五脏俱全的知识专区,值得好好探索一下。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,384评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,845评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,148评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,640评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,731评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,712评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,703评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,473评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,915评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,227评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,384评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,063评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,706评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,302评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,531评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,321评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,248评论 2 352

推荐阅读更多精彩内容

  • 这部分主要是与Java Web和Web Service相关的面试题。 96、阐述Servlet和CGI的区别? 答...
    杂货铺老板阅读 1,402评论 0 10
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,028评论 25 707
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,089评论 4 62
  • 医学专家说,左耳靠近心脏,甜言蜜语要说给左耳听。
    珥陵阅读 215评论 0 0