简介
AndServer 是一个轻量级的 Android Web 服务器库,它允许开发者在 Android 设备上构建和运行 Web 应用程序。AndServer 是由严振杰开发的一个轻量级 Android Web 服务器库,它类似于 Apache 或 Tomcat,但是专门为 Android 设计,无需额外的第三方库或硬件编译。它体积小、使用简单,支持动态网站、静态网站以及 HTTP API。
其特点有:
SpringMVC 风格的注解支持: AndServer 2.0 引入了类似 SpringMVC 的注解 API,使得接口定义更加简洁。
静态资源托管: 通过 AssetsWebsite 或 StorageWebsite 轻松托管 HTML、CSS、JavaScript 等静态文件。
HTTPS 支持: 可通过配置 SSL 证书实现加密通信。
拦截器与过滤器: 使用拦截器(Interceptor)和过滤器(Filter)实现日志记录、权限检查等高级功能。
引入及配置
1.为项目引入AndServer
Android 项目根目录的build.gradle中添加 AndServer 插件引入:
// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
dependencies {
//AndServer插件配置
classpath('com.yanzhenjie.andserver:plugin:2.1.12')
}
}
plugins {
id 'com.android.application' version '8.0.2' apply false
id 'com.android.library' version '8.0.2' apply false
}
app目录的build.gradle中添加依赖:
plugins {
...
id 'com.yanzhenjie.andserver'
}
...
dependencies {
implementation 'com.yanzhenjie.andserver:api:2.1.12'
annotationProcessor 'com.yanzhenjie.andserver:processor:2.1.12'
}
2.添加网络权限
AndroidManifest.xml中添加:
<uses-permission android:name="android.permission.INTERNET" />
服务器启动与停止
在 AndServer 中,只需要启动服务器即可,其它组件 AndServer 会自动加载。AndServer 的服务器的启动是在子线程中进行的,因此服务器的启动成功与否,必须使用监听器。
public void startWebServer(){
server = AndServer.webServer(MainActivity.this)
.port(8080)
.timeout(10, TimeUnit.SECONDS)
.listener(new Server.ServerListener() {
@Override
public void onStarted() {
Log.d("AndServer","~onStarted");
}
@Override
public void onStopped() {
Log.d("AndServer","~onStopped");
}
@Override
public void onException(Exception e) {
Log.d("AndServer","~onException",e);
}
})
.build();
server.startup();
}
public void shutdownWebServer(){
if(server!=null&&server.isRunning()){
server.shutdown();
}
}
部署网站
AndServer 没有规定静态文件(网页、文件等)应该放在哪个位置,所以我们需要通过配置的方式告诉 AndServer 静态网站的位置在哪里,我们需要使用到WebConfig接口和Config注解。
@Config
public class WebsiteConfig implements WebConfig {
@Override
public void onConfig(Context context, Delegate delegate) {
// 增加一个位于assets的web目录的网站,不指定indexFileName时,默认为index.html
delegate.addWebsite(new AssetsWebsite(context, "/web/"/*,indexFileName*/));
// 增加一个位于/sdcard/Download/AndServer/目录的网站,不指定indexFileName时,默认为index.html
delegate.addWebsite(new StorageWebsite("/sdcard/Download/AndServer/"/*,indexFileName*/));
}
}
部署网站需要使用Website抽象类,AndServer提供了两个默认实现AssetsWebsite和StorageWebsite,当然你也可以根据需要自通过这个抽象类来实现。
上述/web/目录和/sdcard/Download/AndServer/目录就是网站根目录,它们的访问路径如http://192.168.1.1:8080/,默认访问index.html,如果要访问目录下的test.txt文件,那么访问的路径是http://192.168.1.1:8080/test.txt。
如果想要浏览设备目录文件,可以这样部署.
@Config
public class WebsiteConfig implements WebConfig {
@Override
public void onConfig(Context context, Delegate delegate) {
// 添加一个文件浏览器网站
delegate.addWebsite(new FileBrowser("/sdcard/"));
}
}
运行之后,通过浏览器打开网站根目录,就可以看到文件浏览器了。
部署Http服务器
HTTP API 在能力上分位两大类,一类是返回数据类型,在AndServer中约定把它叫做 RESTful 风格 HTTP API,另一类是重定向类型,在AndServer中约定把它叫做非 RESTful 风格 HTTP API。
1.RESTful 风格的 HTTP API
@RestController
class MyController {
@GetMapping("/hello")
public String hello(@RequestParam("name") String name) {
return "Hello " + name;
}
}
该 API 的请求地址如http://192.168.1.1:8080/hello,请求方法是GET,客户端需带上name请求,请求后返回“Hello $name”,默认情况下的响应码是 200。
@RestController
class MyController {
@PostMapping("/userInfo")
User login(@RequestParam("id") String id) {
User user = new User();
user.setId(id);
user.setName("大耳猫");
return user;
}
}
在 RestController 中,返回值可以是 String、可以是 Model 对象或者文件等。
2.非 RESTful 风格的 API
如果我们想让用户访问http://192.168.1.1:8080/时实际请求的是http://192.168.1.1:8080/index.html:
@Controller
class MyController {
@GetMapping("/")
public String visitIndex() {
return "forward:/index.html";
}
}
return 返回值中的forward:表示在服务器内部转发,forward:/index.html则表示转发到根目录下的index.html页面。
如果我们不想在服务器内部做转发,而是想发一个重定向响应,让客户端重新请求另一个 API,那么只需要把关键词forward改成redirect即可:
@Controller
class MyController {
@ResponseBody
@GetMapping("/project/info")
public String newInfo() {
return "I am new api.";
}
@GetMapping("/projectInfo")
public String oldInfo() {
return "redirect:/project/info";
}
}
现在,几个简单的 HTTP API 就写完了,你不需要任何注册或者配置,只需要启动服务器就可以通过浏览器访问上面的几个 HTTP API 。
配置SSH
在 AndServer 中配置 SSH(Secure Shell)主要涉及到启用 HTTPS 协议,因为 SSH 通常是指在服务器和客户端之间建立安全连接的协议,而在 Web 服务器的上下文中,这通常意味着使用 HTTPS 来加密 HTTP 通信。以下是如何在 AndServer 中配置 HTTPS 的简单步骤和示例代码:
-
生成 SSL 证书:你需要一个 SSL 证书来启用 HTTPS。可以使用 Java 的 keytool 命令行工具生成自签名证书,或者购买一个由证书颁发机构签发的证书。
-
创建 SSL 上下文:使用生成的 SSL 证书创建一个 SSLContext 实例。
-
配置 AndServer:在创建 AndServer 实例时,通过 .ssl(sslContext) 方法配置 SSL 上下文。
示例代码:
public void startWebServer(){
SSLContext sslContext = null;
try {
// 创建 SSL 上下文
sslContext = SSLContext.getInstance("TLS");
sslContext.init(null, null, null);
}catch (Exception e){
e.printStackTrace();
}
server = AndServer.webServer(MainActivity.this)
.port(8080)
.timeout(10, TimeUnit.SECONDS)
.sslContext(sslContext) //配置sslContext
.serverSocketFactory(sslContext.getServerSocketFactory())
.sslSocketInitializer(new SSLSocketInitializer() {
@Override
public void onCreated(@NonNull SSLServerSocket socket) throws SSLException {
Log.d("AndServer","~sslSocketInitializer onCreated");
}
})
.listener(new Server.ServerListener() {
@Override
public void onStarted() {
Log.d("AndServer","~onStarted");
}
@Override
public void onStopped() {
Log.d("AndServer","~onStopped");
}
@Override
public void onException(Exception e) {
Log.d("AndServer","~onException",e);
}
})
.build();
server.startup();
}
在上面的代码中,SSLContext 是一个包含 SSL 证书的 SSL 上下文对象,将其传递给AndServer的构建器来启用 HTTPS。
请注意,自签名证书通常只用于测试目的,因为它不受信任的证书颁发机构签发,可能会在浏览器中引起安全警告。在生产环境中,建议使用由受信任的证书颁发机构签发的证书。
总结
总的来说,AndServer 提供了一个在 Android 设备上快速搭建 Web 服务的解决方案,无论是静态资源托管还是动态 API 开发,都能提供有效的支持。