关闭

AndServer,一个Android端的web服务器

标签: andserverserver局域网服务器安卓服务器androidweb
26000人阅读 评论(75) 收藏 举报
分类:

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

Features Image

大家好,今天跟大家介绍一个让原生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之间互相在局域网通信、局域网上传下载、局域网登录这样的需求,还有很多栗子我就不举了,下面开始正式安利。


特点

  1. 接受客户端文件上传、下载文件。
  2. 动态Http API,就像Java的Servlet一样写接口。
  3. 部署静态网站,例如纯Html,支持JS、CSS、Image分离。
  4. 部署动态网站,例如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已经提供了两个默认实现:

如果用上面两个实现注册你的网站,那么你的默认首页(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就填"",比如:

Assets根目录

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

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

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

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

http://ip:port/login.html
http://ip:port/error.html

比如:

http://192.168.1.12:8080/index.html  
http://192.168.1.12:8080/login.html
  • 如果你的网站根目录在assets的子目录下,那么你传入assets的相对目录地址就好了比如你的网站在assetsweb目录,例如:

Assets子目录

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

例如:

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,它和JavaServlet一样。

你需要实现这个接口,然后在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端

Htmlformaction中填入你注册RequestHandler时的key就可以了,然后在RequestHandler

handle(HttpRequest, HttpResponse, HttpContext)

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

比如我们上面注册Login RequestHandlerform中这样使用:

<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

24
0
查看评论

使用AndServer在Android上搭建Web服务器

AndServer是一个Android的Web服务器, 支持部署动态网站和静态网站, 支持写Http接口,和Java的Servlet一样。 特点:     部署动态网站。         部署静态网站。 动态Http API,就是...
  • koma025
  • koma025
  • 2017-04-01 11:23
  • 2673

Anroid搭建一个局域网Web服务器

这几天有人问我局域网Client和Client通信的时候有时候用什么技术比较好,其实我想到的是Socket和Http,我们知道Http是基于Socket的,所以它是一个非常成熟的Socket,所以我选择了用Http来实现,今天的博客内容也是主要讲Android端如何搭建一个Http服务器。
  • yanzhenjie1003
  • yanzhenjie1003
  • 2016-06-14 00:31
  • 31778

android充当server服务器

在android上跑起来一个web服务器,可供电脑和手机通过http访问。这个需求并不常见,网上资料也不多,找了一会发现了一个不错的框架。github链接地址https://github.com/NanoHttpd/nanohttpd     这个框架使用起来比较简单,也符合需...
  • tianyaleixiaowu
  • tianyaleixiaowu
  • 2016-02-29 10:45
  • 3719

Android 客户端与服务器端进行数据交互(一、登录服务器端)

概要安卓APP要实现很多功能(比如登录注册、发表评论等)时都必须要使用到网络数据交互。所以在学习了这部分内容后,就将其以最常见的登录过程为例整理出来,也方便跟我一样的新手能迅速学习上手。 预期效果图如下,输入手机号和密码,点击Login按钮,上传数据到服务器端进行验证,再对结果进行反馈。 博客分一...
  • u012145166
  • u012145166
  • 2016-05-06 22:48
  • 26032

自己动手——快速搭建Android应用服务器

Motivation我写这套帖子的目的,是在自己学会、实现并熟练掌握之后,想帮助下面将会提到的这样一群正在学习安卓的新手(虽然我自己也是新手),通过自己的经验传递出去,让他们少走一点弯路,节省大量用在查询和翻阅资料的时间。我在学习编写自己的Android应用程序服务器的时候遇到过以下的问题: 1....
  • Mr_Megamind
  • Mr_Megamind
  • 2017-05-08 11:33
  • 3977

Android 项目实践(四)——服务器搭建

每一个应用应该都要有自己的服务器。在应用发布之后一定会有不同的用户注册,用户注册后的信息要上传给服务器保存,用户登录后还会产生不同的数据,就像我们在上一篇博客中创建的“客户”数据表一样,不同的用户一定有不同的“客户”数据表。这些信息最终都是要上传给服务器保存的。所以每个应用都要拥有一个自己的服务器。...
  • To_be_Designer
  • To_be_Designer
  • 2015-10-14 09:02
  • 4204

Eclipse开发简易的Android服务器

android开发自己的服务器
  • qq_36220729
  • qq_36220729
  • 2017-04-07 16:38
  • 1067

Android连接服务器的5种方式

原文地址1. URLpublic class MyURLActivity extends Activity { @Override protected void onCreate(Bundle savedInstanceState) { ...
  • zaoan_wx
  • zaoan_wx
  • 2016-03-12 14:49
  • 3054

Android本地服务器——TomCat服务器的搭建

一、前言。 沉迷工作,日渐消瘦,好久没有更新博客了。之前的那本java设计模式,已经看全了。没时间更新博客,最近学服务器端的配置,趁着有时间,赶紧的博客一下。 当然了。作为一名Android程序员,需要自己的一个服务器,现在这篇博客简单的配置下本地服务器,可以轻松的开发自己的程序。 ...
  • xh870189248
  • xh870189248
  • 2017-06-21 16:41
  • 463

Android 客户端与服务器端进行数据交互(二、登录客户端)

概要Android客户端分为User,HttpUtil,HttpCallbackListener,MainActivity四个部分。User model与服务端的一样,一方面是用于本地用户信息的存储model,另一方面也是为了保证构造URL时使用的key一致。 HttpUtil封装了发送Http请...
  • u012145166
  • u012145166
  • 2016-05-06 22:54
  • 10738
    个人资料
    • 访问:1639322次
    • 积分:6593
    • 等级:
    • 排名:第4317名
    • 原创:52篇
    • 转载:0篇
    • 译文:1篇
    • 评论:1296条
    我的微信公众号
    欢迎关注我的公众号,不定期为您推送优选博文,生活趣事!
    关注我的微信公众号

    关注我的微博
    友情链接


    我的Github

    QQ交流群 547839514

    博客专栏