1 Star 8 Fork 4

糍粑 / AndroidNettyServer

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

AndroidServer

@Tony沈哲 on weibo License

基于 Kotlin + Netty 开发,为 Android 系统提供 Web Server 的功能,包括 Http、TCP、WebSocket

Feature:

  • 支持 Http、TCP、WebSocket 服务
  • 支持 Rest 风格的 API、文件上传、下载
  • 支持加载静态网页
  • Http 的路由表、全局的 HttpFilter 均采用字典树(Tried Tree)实现
  • 日志隔离,开发者可以使用自己的日志库
  • core 模块只依赖 netty-all,不依赖其他第三方库

最新版本

模块 最新版本
android-server-core Download
android-server-converter-gson Download

下载安装

Gradle:

implementation 'com.safframework.server:android-server-core:<latest-version>'
implementation 'com.safframework.server:android-server-converter-gson:<latest-version>'

Usage:

Http 服务

通过使用 Service 来启动一个 http 服务,它的 http 服务本身支持 rest 风格、支持跨域、cookies 等。

class HttpService : Service() {

    private lateinit var androidServer: AndroidServer

    override fun onCreate() {
        super.onCreate()
        startServer()
    }

    // 启动 Http 服务端
    private fun startServer() {

        androidServer = AndroidServer.Builder{
            converter {
                GsonConverter()
            }
            logProxy {
                LogProxyImpl
            }
        }.build()

        androidServer
            .get("/hello") { _, response: Response ->
                response.setBodyText("hello world")
            }
            .get("/sayHi/{name}") { request, response: Response ->
                val name = request.param("name")
                response.setBodyText("hi $name!")
            }
            .post("/uploadLog") { request, response: Response ->
                val requestBody = request.content()
                response.setBodyText(requestBody)
            }
            .get("/downloadFile") { request, response: Response ->
                val fileName = "xxx.txt"
                File("/sdcard/$fileName").takeIf { it.exists() }?.let {
                    response.sendFile(it.readBytes(),fileName,"application/octet-stream")
                }?: response.setBodyText("no file found")
            }
            .get("/test") { _, response: Response ->
                response.html(this,"test")
            }
            .fileUpload("/uploadFile") { request, response: Response -> // curl -v -F "file=@/Users/tony/1.png" 10.184.18.14:8080/uploadFile

                val uploadFile = request.file("file")
                val fileName = uploadFile.fileName
                val f = File("/sdcard/$fileName")
                val byteArray = uploadFile.content
                f.writeBytes(byteArray)

                response.setBodyText("upload success")
            }
            .filter("/sayHi/*", object : HttpFilter {
                override fun before(request: Request): Boolean {
                    L.d("before....")
                    return true
                }

                override fun after(request: Request, response: Response) {
                    L.d("after....")
                }

            })
            .start()
    }

    override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
        return super.onStartCommand(intent, flags, startId)
    }

    override fun onDestroy() {
        androidServer.close()
        super.onDestroy()
    }

    override fun onBind(intent: Intent): IBinder? {
        return null
    }
}

测试:

curl -v 127.0.0.1:8080/hello
*   Trying 127.0.0.1...
* Connected to 127.0.0.1 (127.0.0.1) port 8080 (#0)
> GET /hello HTTP/1.1
> Host: 127.0.0.1:8080
> User-Agent: curl/7.50.1-DEV
> Accept: */*
>
< HTTP/1.1 200 OK
< server: monica
< content-type: text/plain
< content-length: 11
<
* Connection #0 to host 127.0.0.1 left intact
hello world
curl -v -d 测试 127.0.0.1:8080/uploadLog
*   Trying 127.0.0.1...
* Connected to 127.0.0.1 (127.0.0.1) port 8080 (#0)
> POST /uploadLog HTTP/1.1
> Host: 127.0.0.1:8080
> User-Agent: curl/7.50.1-DEV
> Accept: */*
> Content-Length: 6
> Content-Type: application/x-www-form-urlencoded
>
* upload completely sent off: 6 out of 6 bytes
< HTTP/1.1 200 OK
< server: monica
< content-type: text/plain
< content-length: 6
<
* Connection #0 to host 127.0.0.1 left intact
测试

Socket 服务

Socket 服务,AndroidServer 支持同一个端口同时提供 TCP/WebSocket 服务

class SocketService : Service() {

    private lateinit var androidServer: AndroidServer

    override fun onCreate() {
        super.onCreate()
        startServer()
    }

    // 启动 Socket 服务端
    private fun startServer() {

        androidServer = AndroidServer.Builder{
            port {
                8888
            }
            converter {
                GsonConverter()
            }
            logProxy {
                LogProxy
            }
        }.build()

        androidServer
            .socket("/ws", object: SocketListener<String> {
                override fun onMessageResponseServer(msg: String, ChannelId: String) {
                    LogManager.d("SocketService","msg = $msg")
                }

                override fun onChannelConnect(channel: Channel) {
                    val insocket = channel.remoteAddress() as InetSocketAddress
                    val clientIP = insocket.address.hostAddress
                    LogManager.d("SocketService","connect client: $clientIP")

                }

                override fun onChannelDisConnect(channel: Channel) {
                    val ip = channel.remoteAddress().toString()
                    LogManager.d("SocketService","disconnect client: $ip")
                }

            })
            .start()
    }

    override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
        return super.onStartCommand(intent, flags, startId)
    }

    override fun onDestroy() {

        androidServer.close()
        super.onDestroy()
    }


    override fun onBind(intent: Intent): IBinder? {
        return null
    }
}

Socket 服务可以使用 :https://github.com/fengzhizi715/NetDiagnose 进行测试

TODO List:

  • Android 上性能的优化
  • 完善 Android.Builder 类
  • 支持 HttpSession
  • 支持 Https
  • 支持 HTTP/2

联系方式

Wechat:fengzhizi715

Java与Android技术栈:每周更新推送原创技术文章,欢迎扫描下方的公众号二维码并关注,期待与您的共同成长和进步。

ChangeLog

版本更新记录

License

Copyright (C) 2017 - present, Tony Shen.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

空文件

简介

Android Netty Server 展开 收起
Kotlin
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Kotlin
1
https://gitee.com/pc_859107393/android-netty-server.git
git@gitee.com:pc_859107393/android-netty-server.git
pc_859107393
android-netty-server
AndroidNettyServer
master

搜索帮助