一部分Android開發者看到這個標題時可能有點疑惑,SpringMVC不是用來做JavaWeb開發的嗎?難道被移植到Android上來了?答案是否定的,因爲SpringMVC是基於Servlet的,在Android上開發一個支持Servlet的容器(Tomcat、JBoss)可不簡單,所以我們是在Android上開發了一套全新的WebServer + WebFramework。
AndServer2.0基於編譯時註解實現了SpringMVC的大部分註解Api,其Request的分發流程也基本和SpringMVC一致,與SpringMVC最大的不同是SpringMVC基於運行時註解,並且SpringMVC提供的功能更多更強大。不過AndServer提供的功能在Android上來做服務端開發是完全足夠的。
看到這裏讀者朋友應該知道了,AndServer2.0是使用註解開發Web程序的,爲了有個更直觀的瞭解,我們先看一個模擬用戶登錄的Http Api:
@RestController
public class UserController {
@PostMapping("/login")
public String login(@RequestParam("account") String account,
@RequestParam("password") String password) {
if(...) {
return "Successful";
}
return "Failed";
}
}
假設服務端的Address是192.168.1.11
,監聽的端口是8080
,那麼通過http://192.168.1.11:8080/login
就可以訪問該登錄Http Api了。
感興趣的讀者可以幫我們做一下Code Review:
https://github.com/yanzhenjie/AndServer
下文將依次介紹以下三點:
- 系統層架構
- 應用層架構
- 使用示例
1. 系統層架構
我們都知道Http是根據Http協議使用Socket做了連接屬性、數據格式、交互邏輯方面的包裝,我們來模擬一段服務端啓動Server的代碼:
public void startServer(String address, int port) {
InetAddress inetAddress = InetAddress.getByName();
ServerSocket serverSocket = new ServerSocket(8080, 512, inetAddress);
while (true) {
Socket socket = serverSocket.accept();
HttpConnection connection = HttpParser.parse(socket);
HttpThead thread = new HttpThread(connection);
thread.start();
}
}
ServerSocket
監聽了某個端口,當有Socket
連接上來的時候去把這個Socket
解析爲HttpConnection
,解析過程是按照Http協議擬定的格式,從Socket
的InputStream
讀取一些數據後,用Request
和Response
包裝Socket
和未讀取的流(比如標記下次讀取流的起點),下文會再提到。
接着HttpParser
用HttpConnection
包裝了Request
和Reponse
返回,可想而知,作爲服務端程序,HttpConnection
至少包涵了Request
和Response
對象:
public class HttpConnection {
private Request mRequest;
private Response mResponse;
...
}
緊接着啓動了一個線程去處理當前連接,其實也就是處理當前Request
,用Response
寫出數據,怎麼處理這個Request
是一個WebFramework的核心,作爲Http服務端程序,應該能提供Html文件、JS文件、Java Method(Http Api)等讓客戶端訪問,因此得有一個管理員來負責請求和資源的匹配,所以有一個叫做HttpDispatcher
的類來決定這個Request
應該發給哪個資源去處理:
public class HttpDispatcher {
public void dispath(Request request, Response response) {
...
}
}
在HttpThead
裏面,當線程被喚起時只需要負責調用HttpDispatcher#diaptch()
即可,到這裏就比較清晰了,只需要HttpDispatcher
把當前Request
派發到對應的Html File或者Java Method處理就可以了,具體的處理就屬於HttpFramework的事,我們下文再講。
這就是一個簡單的WebServer的藍圖,我們根據設想畫出了系統層架構圖:
系統層運行時流程圖:
上圖中,Handler
表示處理請求的操作手柄,可能是Html File或者Java Method。值得高興的一點是,在我們迭代了幾個版本後,發現Apache組織提供了上述藍圖中的HttpParser
層,因此爲了穩定性和節省人力我們已經替換該層爲Apache的實現。
2. 應用層架構
應用層就是上文中提到的WebFramework,也就是上一個小節流程圖的Framework
層,包括了Session的處理、Cookie的處理、Cache的處理等。
接着上文,HttpDispatcher
需要把當前Request
派發到對應的Html File或者Java Method處理,而Handler
代表了Html File或者Java Method,因爲此二者區別極大,用一個類來表示它們顯然有些不合理,於是我們想到了使用Adapter
模式,所以有了一個抽象類RequestHandler
:
public abstract class RequestHandler {
public abstract void handle(Request request, Response response);
}
RequestHandler
可以表示任何文件或者Java Method,HttpDispatcher
的作用是分發請求到各個資源,所以HttpDispatcher
不應該來分析某個RequestHandler
具體是什麼東西,它應該直接調用RequestHandler
來處理請求,因爲Html File或者Java Method對應的RequestHandler
在實現上顯然大有不同,所以這裏適用Adapter
模式,於是我們用HandlerAdapter
去做RequestHandler
的適配:
public class HandlerAdapter {
public RequestHandler getHandler(Request request) {
...
}
...
}
HandlerAdapter
除了能獲取RequestHandler
之外,還需要做一些描述性的工作,好讓HttpDispatcher
知道當前適配的RequestHandler
是可以處理正要分發的這個Request
的。
因爲Html File和Java Method的返回值又是大相徑庭,因爲返回值是輸出到客戶端展示的,所以我們把返回值抽象爲View
:
public class View {
public Object output() {
...
}
...
}
如上所以,output()
方法就是獲取Handler
輸出的內容,還有其他方法是對這個輸出的描述,這裏不例舉。
因爲View
是返回值,沒有具體的交互了,所以不適用Adapter
模式了,因此我們必須有一個處理返回值的機制,把處理返回值的機制叫做ViewResolver
:
public class ViewResolver {
public void resolver(View view, Request request, Response response) {
...
}
}
在ViewResolver
中根據輸出內容的類型不同,處理方式也不同,最終把輸出內容通過Response
對象寫出去,底層是使用上文中提到的被Response
包裝的Socket
寫出。
這就是一個簡單的WebFramework的藍圖,我們根據設想畫出了應用層架構圖:
應用層運行時流程圖:
上圖中,Interceptor
表示對請求的攔截器,比如可以做一些不允許沒登錄或者沒權限的請求進入的工作。ExceptionResolver
表示全局異常處理器,比如某個Api發生了異常,會轉到ExceptionResolver
中處理,而不至於當前請求不響應或者響應了不想被客戶端看到的消息。
另外需要補充的是,上文中提到的都是粗略的設計,中間還有一些細節,例如Session的處理、Cookie的處理、緩存的處理等都未提到,其中任何一個知識點單獨拿出來都可以寫一篇文章,由於篇幅關係這裏不做詳細介紹。
架構設計和流程到此就都介紹完了,有興趣的開發者也可以自己實現一下。
3. 使用示例
AndServer對於方便使用的理念是:只需要添加註解即可,不需要再做額外的配置。所以除了像文章開頭那樣用註解寫好Api之外,只需要指定監聽端口啓動服務器就可以了。
與讀者做個約定,下文中服務器Address都是
192.168.1.11
,監聽的端口是8080
。
3.1. 網站部署示例
我們先來部署一個位於Assets中/web
下的網站:
@Website
public class InternalWebsite extends AssetsWebsite {
public InternalWebsite() {
super("/web");
}
}
因此SD的文件可以刪除也可以增加,所以很方便做一些文件的熱插拔,部署SD卡的網站:
@Website
public class InternalWebsite extends StorageWebsite {
public InternalWebsite() {
super("/sdcard/AndServer/web");
}
}
如上所示,開發者只需要將網站所在的路徑告訴AndServer
,並添加Website
註解即可,該網站的Html、CSS、JS、其它文件都可以被訪問,例如/web
目錄下有一個index.html
文件,那麼訪問地址就是http://192.168.1.11:8080/
或者http://192.168.1.11:8080/index.html
。
3.2. Http Api開發示例
在文章開頭我們看了一個模擬用戶的Http Api,下面我們增加一個模擬獲取用戶信息的Api:
@RequestMapping("/user")
@RestController
public class UserController {
@PostMapping("/login")
public String login(@RequestParam("account") String account,
@RequestParam("password") String password) {
if(...) {
return "Successful";
}
return "Failed";
}
@GetMapping("/info/{userId}")
public User info(@PathVariable("userId") String userId) {
User user = ...;
return user;
}
}
於是我們得到兩個地址:
POST http://192.168.1.11:8080/user/login
GET http://192.168.1.11:8080/user/info/uid_001
接下來什麼配置都不用做,只需要啓動服務器,這幾個地址就可以用了。
3.3. 啓動服務器
AndServer.serverBuilder()
.inetAddress(NetUtils.getLocalIPAddress())
.port(8080)
.timeout(10, TimeUnit.SECONDS)
.build()
.start();
如上所示只需要指定要監聽的服務端地址和端口,啓動服務器就可以訪問上面的所有地址了,不需要再做其他配置。
由於篇幅關係,本文到此結束,介紹的比較粗略,有興趣的開發者可以看看項目使用文檔:
https://www.yanzhenjie.com/AndServer