Skip to content

mySync-repo/AndServer

 
 

Repository files navigation

AndServer

Logo

AndServer is an HTTP and reverse proxy server.

Web server and Web framework of Android platform. It provides annotations like SpringMVC, and if you are familiar with SpringMVC, you can master it very quickly.

  • Static html website deployment.
  • Dynamic http api deployment.
  • Reverse proxy server.

Web Server

Deploy a web server:

Server server = AndServer.webServer(context)
    .port(8080)
    .timeout(10, TimeUnit.SECONDS)
    .build();

// startup the server.
server.startup();

...

// shutdown the server.
server.shutdown();

It also has some features, such as inetAddress(InetAddress), serverSocketFactory(ServerSocketFactory) and sslContext(SSLContext), depending on what you want to achieve.

@RestController
@RequestMapping(path = "/user")
public class UserController {

    @PostMapping("/login")
    public String login(@RequestParam("account") String account,
                        @RequestParam("password") String password) {

        ...
        return "Successful.";
    }

    @GetMapping(path = "/{userId}")
    public User info(@PathVariable("userId") String userId,
                     @QueryParam("fields") String fields) {

        User user = findUserById(userId, fields);
        ...

        return user;
    }

    @PutMapping(path = "/{userId}")
    public void modify(@PathVariable("userId") String userId
                       @RequestParam("age") int age) {
        ...
    }
}

The above code will generate the following two http apis:

POST http://.../user/login
GET http://.../user/uid_001?fields=id,name,age
PUT http://.../user/uid_001

For documentation and additional information see the website.

Reverse Proxy Server

Deploy a reverse proxy server:

Server server = AndServer.proxyServer()
    .addProxy("www.example1.com", "http://192.167.1.11:8080")
    .addProxy("example2.com", "https://192.167.1.12:9090")
    .addProxy("55.66.11.11", "http://www.google.com")
    .addProxy("192.168.1.11", "https://github.com:6666")
    .port(80)
    .timeout(10, TimeUnit.SECONDS)
    .build();

// startup the server.
server.startup();

...

// shutdown the server.
server.shutdown();

Note: It is just a reverse proxy and does not have the ability to take care of loading balance.

Download

dependencies {
    implementation 'com.yanzhenjie.andserver:api:2.1.2'
    annotationProcessor 'com.yanzhenjie.andserver:processor:2.1.2'
    ...
}

If you are using Kotlin, replace annotationProcessor with kapt.

Library Modules

If you use AndServer in the library module, we recommend that you use the AndServer plugin, but this is not necessary. This is to avoid conflicts with the application module when using AndServer.

Add the plugin to your project build script :

buildscript {
    repositories {
        mavenCentral()
        google()
    }

    dependencies {
        classpath 'com.yanzhenjie.andserver:plugin:2.1.2'
        ...
    }
}
...

And then apply it in your module:

apply plugin: 'com.yanzhenjie.andserver'

Contributing

Before submitting pull requests, contributors must abide by the agreement .

License

Copyright 2020 Zhenjie Yan

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.

About

🍒 Web server and web framework of Android platform.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%