AndServer，一个Android端的web服务器

版权声明：转载必须注明本文转自严振杰的博客：http://blog.yanzhenjie.com



大家好，今天跟大家介绍一个让原生Android也可以做Web开发的开源项目——AndServer。

开源地址：https://github.com/yanzhenjie/AndServer

AndServer

是一个Android端的Web服务器，类似Apache或者Tomcat，但又有不同，它是一个普通的Android Library，Android项目Gradle远程依赖或者添加Jar包皆可引入该项目，然后就通过正常Android开发一样开发App了。

AndServer

是用纯Android API写一个库，所以不用任何第三方的库或者什么硬件编译，打成Jar包后仅仅580kb。

很多人看到这里就有疑问了：它的使用场景是什么？按照国际惯例，我举个栗子：

某公司公开了一款TV APP，可以安装在电视或者盒子上，有一个功能是这样的：

APP安装在电视上打开后，会生成一个唯一ID，用户用微信扫码通过公司提供的公众号和该电视上的该APP绑定，用户通过公众号打开一个H5页面，这个页面可以上传图片或者视频到服务器，服务器检测到该用户和某个屏幕的APP绑定，动态把用户发送的图片或者视频发送到电视播放。

这样一个功能是很好的体验，但是耗费服务器资源、远端上传、远端下载也都需要时间，还不如我直接用U盘拷贝到电视呢。那么如果我通过网页在局域网直接把视频或者图片发送到电视上的APP播放，岂不是更加直接快捷？

当然大部分同学可能很少接触到APP之间互相在局域网通信、局域网上传下载、局域网登录这样的需求，还有很多栗子我就不举了，下面开始正式安利。

特点

接受客户端文件上传、下载文件。

动态Http API，就像Java的Servlet一样写接口。

部署静态网站，例如纯Html，支持JS、CSS、Image分离。

部署动态网站，例如Html表单，当然可以结合上面的Android Http接口。

基本上和Java的Servlet一样的功能，如果你做过Java开发或者其它语言的Web开发应该就很熟悉了。

依赖

Gradle

compile 'com.yanzhenjie:andserver:1.0.2'

Maven

<dependency>
<groupId>com.yanzhenjie</groupId>
<artifactId>andserver</artifactId>
<version>1.0.2</version>
<type>pom</type>
</dependency>

ADT，可以去AndServer主页下载Jar包。

使用方法

最好的教程是

sample

，建议到AndServer主页下载sample运行查看效果，然后结合README就更加清晰了。

创建服务器

AndServer andServer = new AndServer.Build()
...
.build();

// 创建服务器。
Server mServer = andServer.createServer();
...

// 启动服务器。
mServer.start();
...

// 停止服务器。
mServer.stop();
...

// 服务器正在运行吗？
boolean running = mServer.isRunning();

端口号和响应超时设置

AndServer andServer = new AndServer.Build()
.port(8080) // 默认是8080，Android平台允许的端口号都可以。
.timeout(10 * 1000) // 默认10 * 1000毫秒。
...
.build();
...

部署网站

部署网站是通过

Website

接口，你也可以自己实现这个接口，当然

AndServer

已经提供了两个默认实现：

AssetsWebsite

StorageWebsite

如果用上面两个实现注册你的网站，那么你的默认首页（

index.html

）是：

http://ip:port/ http://ip:port/youPath http://ip:port/youPath/index.html

注册网站到AndServer

Wesite wesite = new AssetsWebsite(AssetManager, youPath);
// 或者
Wesite wesite = new StorageWebsite(youPath);

AndServer andServer = new AndServer.Build()
...
.website(wesite);
.build();

AssetsWebsite的使用

如果你的网站在

assets

下，那么你就用

AssetsWebsite

来部署你的网站。

使用方法是：

//AssetManager不能被关闭。
AssetManager mAssetManager = getAssets();

Wesite wesite = new AssetsWebsite(mAssetManager, youPath);

上面我们看到new AssetsWebsite时需要传一个AssetManager和一个path，path支持assets根目录和子目录，下面是这两种情况的举例。

如果你的网站在

assets

根目录下, 你的

path

就填

""

，比如：

Wesite wesite = new AssetsWebsite(mAssetManager, "");

那么你的默认首页访问地址就是：

http://ip:port http://ip:port/index.html[/code] 
那么你的其它页面访问地址是：

http://ip:port/login.html http://ip:port/error.html[/code] 
比如：

http://192.168.1.12:8080/index.html http://192.168.1.12:8080/login.html[/code] 
如果你的网站根目录在
assets
的子目录下，那么你传入
assets
的相对目录地址就好了比如你的网站在
assets
下
web
目录，例如：



Wesite wesite = new AssetsWebsite(mAssetManager, "web");


那么你的默认首页访问地址就是：

http://ip:port http://ip:port/web http://ip:port/web/index.html


那么你的其它页面访问地址是：

http://ip:port/web/login.html http://ip:port/web/error.html[/code] 
例如：

http://192.168.1.12:8080/ http://192.168.1.12:8080/index.html http://192.168.1.12:8080/web/index.html http://192.168.1.12:8080/web/index.html http://192.168.1.12:8080/web/login.html


StorageWebsite的使用
如果你的网站在内存设备下，只要以文件的形式可以读取到，那么你就用
StorageWebsite
来部署你的网站，比如你的网站在SD卡下时。

使用方法是：

Wesite wesite = new StorageWebsite(youPath);


它很简单，只要传入你的网站的存储目录地址即可，例如你的网站在SD卡下的
www
目录：

File file = new File(Environment.getExternalStorageDirectory(), "www");
String websiteDirectory = file.getAbsolutePath();

Wesite wesite = new StorageWebsite(websiteDirectory);


访问地址和
AssetsWebsite
的道理相同。

像Servlet一样写Http接口
Http API是通过
RequestHandler
接口来注册的，它是一个
java interface
，它和
Java
的
Servlet
一样。

你需要实现这个接口，然后在
AndServer
注册即可，例如：

public class RequestLoginHandler implements RequestHandler {

@Override
public void handle(HttpRequest req, HttpResponse res, HttpContext con) {
Map<String, String> params = HttpRequestParser.parse(request);

// Request params.
String userName = params.get("username");
String password = params.get("password");

if ("123".equals(userName) && "123".equals(password)) {
StringEntity stringEntity = new StringEntity("Login Succeed", "utf-8");
response.setEntity(stringEntity);
} else {
StringEntity stringEntity = new StringEntity("Login Failed", "utf-8");
response.setEntity(stringEntity);
}
}
}


然后在
AndServer
中注册：

AndServer andServer = new AndServer.Build()
...
.registerHandler("login", new RequestLoginHandler())
.build();


现在你就得到了一个唯一的访问地址：
http://ip:port/login
, 例如：

http://192.168.1.12:8080/login?username=123&password=123


文件下载和文件上传的例子请下载
sample
查看。

提交Html表单到Android端
在
Html
的
form
的
action
中填入你注册
RequestHandler
时的
key
就可以了，然后在
RequestHandler
的

handle(HttpRequest, HttpResponse, HttpContext)


方法就可以获取
form
提交的参数了。

比如我们上面注册
Login RequestHandler
在
form
中这样使用:

<form id="form1" method="post" action="login">
...
</form>


监听服务器的状态
服务器一般情况下有三种状态：成功启动、启动时失败、成功停止服务器，失败时会返回一个异常，一般情况下是网络问题或者端口被占用。

private Server.Listener mListener = new Server.Listener() {
@Override
public void onStarted() {
// 服务器启动成功.
}

@Override
public void onStopped() {
// 服务器停止了，一般是开发者调用server.stop()才会停止。
}

@Override
public void onError(Exception e) {
// 服务器启动发生错误，一般是端口被占用。
}
};

AndServer andServer = new AndServer.Build()
...
.listener(mListener)
.build();


如果你觉得还不错，请关注我的微信公众号吧



版权声明：转载必须注明本文转自严振杰的博客：http://blog.yanzhenjie.com