Mini Http Server for Java (Android)

MiniHttpServer

一：开发环境

Mac OS 10、Java 1.8、IDEA（Gradle工程）

二：介绍

一款基于Java Nio实现的Http解析框架，支持常见的请求解析和逻辑；采用单线程解析多线程业务处理方案，内置线程池方便线程管理；支持静态文件下载；支持表单参数和文件上传，支持PUT文件上传。解析成功后返回HttpRequest和HttpResponse。除常见的接口请求返回外，HttpResponse可以向客户端发送跨域请求结果，也可以发送文件，支持区分附件模式。

三：特点

• 纯Java API实现，性能好
• 基于Java Nio，异步机制，相比传统IO，有更高的性能。
• 体积小，代码少，支持Http部分协议，满足绝大部分需求。
• 支持POST表单数据和多文件上传。
• 支持PUT上传文件，自动保存到file目录。
• 支持发送文件到客户端。
• 支持发送重定向等基本http协议内容。
• 支持反馈跨域请求。
• 支持自定义header。

四：引入(最新版本)

1. Maven

<dependency>
  <groupId>com.itgowo</groupId>
  <artifactId>MiniHttpServer</artifactId>
  <version>0.0.21</version>
  <type>pom</type>
</dependency>

2. Gradle

implementation 'com.itgowo:MiniHttpServer:0.0.21'

五：初始化(库Jar中有Demo类，可以参考)

Demo.java

1. 创建MiniHttpServer
   MiniHttpServer 继承自Thread，复写了Thread.start()方法，与MiniHttpServer.startServer()方法作用相同，不会冲突。

MiniHttpServer miniHttpServer = new MiniHttpServer(); 

2. 设置初始信息

public void init(boolean isBlocking, InetSocketAddress inetSocketAddress, String webDir, onHttpListener onHttpListener)

3.设置文件存储策略

当有文件上传到服务器时，默认保存在webDir里的file目录下，创建UUID命名的目录，将上传的文件放入其中，文件名已Http信息fileName命名，防止重名文件冲突。例 web/file/02e86423-d1bd-4218-8f70-a7c73c71bf62/test.png
默认每次server初始化后执行清理功能。需要手动执行使用这个方法miniHttpServer.getFileManager().cleanOldFile();

  httpServer.setFileLimit(long fileSize, long fileLastTime);

4. onHttpListener类

public void onError(Throwable throwable)`

public void onHandler(HttpRequest httpRequest, HttpResponse httpResponse) throws Exception`

六：情景

1. 获取header

    Map<String, String> headers = httpRequest.getHeaders();
    boolean hasContentType = httpRequest.containsHeader(HttpHeaderNames.CONTENT_TYPE);
    String contentType = httpRequest.getHeaders().get(HttpHeaderNames.CONTENT_TYPE);

2. 获取Parms，参数操作，来源一:url中"?"后面解析出来的参数键值对;来源二:POST表单参数解析

    Map<String, String> parms = httpRequest.getParms();
    String userId = httpRequest.getParms().get("userId");

3. 客户端GET请求资源

    if (HttpMethod.GET == httpRequest.getMethod()) {
        if (httpRequest.getUri().equalsIgnoreCase("/")) {
            httpRequest.setUri("/index.html");
        }
        //缓存策略，浏览器指定时间内只获取一次文件,如果sendFile()包含cacheControl参数，则不需要在设置，设置了以单独设置为准。没有cacheControl的方法则默认没有此参数
        httpResponse.addHeader(HttpHeaderNames.CACHE_CONTROL, HttpHeaderValues.MAX_AGE + "=3600");

//      httpResponse.sendFile(httpNioServer.getFileManager().getFile(httpRequest.getUri()));
//      httpResponse.sendFile(httpNioServer.getFileManager().getFile(httpRequest.getUri()), true);
        //cacheControl参数添加了不一定起作用，如果单独加了header，则此方法参数无效
        httpResponse.sendFile(httpNioServer.getFileManager().getFile(httpRequest.getUri()), HttpStatus.OK, 3600, true);
    }

4. 客户端POST请求，POST请求，常见的Body传Json文本或者表单上传文件

    if (HttpMethod.POST == httpRequest.getMethod()) {
        if (httpRequest.isMultipart_formdata()) {
            Map<String, File> fileMap = httpRequest.getFileList();
          //  httpResponse.sendData(HttpStatus.OK);
            httpResponse.setData(Arrays.toString(fileMap.values().toArray())).sendData(HttpStatus.OK);
        } else {
            String requestBody = httpRequest.getBody();
            httpResponse.setData(requestBody).sendData(HttpStatus.OK);
        }
    }

5. 客户端OPTIONS请求，OPTIONS请求，跨域请求最多的是ajax发出的，应对web请求

    if (HttpMethod.OPTIONS == httpRequest.getMethod()) {
        httpResponse.sendOptionsResult();
    }

6. 客户端PUT请求，跟POST表单上传文件不同，Http中Body默认为一个文件，临时存在temp目录，PUT如果需要传递文件名请在headers中添加自定义数据。

    if (HttpMethod.PUT == httpRequest.getMethod()) {
        Map<String, File> fileMap = httpRequest.getFileList();
        httpResponse.sendData(HttpStatus.OK);
    }

7. 客户端其他请求，HEAD、DELETE、TRACE、CONNECT、PATCH 等不常见，需要自己返回结果即可，无特殊需求。

8. 重定向

    httpResponse.sendRedirect("http://www.baidu.com");

七：关键类

HttpRequest

HttpResponse

八：小期待

以下项目都是我围绕远程控制写的项目和子项目。都给star一遍吧。😍

我的小站：IT狗窝
技术联系QQ:1264957104