Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yanzhenjie/AndServer
:cherries: Web server and web framework of Android platform.
https://github.com/yanzhenjie/AndServer
android-server http-server springmvc web-server website
Last synced: about 2 months ago
JSON representation
:cherries: Web server and web framework of Android platform.
- Host: GitHub
- URL: https://github.com/yanzhenjie/AndServer
- Owner: yanzhenjie
- License: apache-2.0
- Created: 2016-06-14T00:52:52.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-07T08:04:09.000Z (over 1 year ago)
- Last Synced: 2024-06-19T06:53:04.450Z (3 months ago)
- Topics: android-server, http-server, springmvc, web-server, website
- Language: Java
- Homepage: https://yanzhenjie.com/AndServer
- Size: 6.34 MB
- Stars: 3,652
- Watchers: 110
- Forks: 741
- Open Issues: 125
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# AndServer
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:
```java
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.
```java
@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:
```text
POST http://.../user/login
GET http://.../user/uid_001?fields=id,name,age
PUT http://.../user/uid_001
```
Get connection information with the client:
```java
@GetMapping(path = "/connection")
void getConnection(HttpRequest request, ...) {
request.getLocalAddr(); // HostAddress
request.getLocalName(); // HostName
request.getLocalPort(); // server's port
request.getRemoteAddr(); // HostAddress
request.getRemoteHost(); // Especially HostName, second HostAddress
request.getRemotePort(); // client's port
...
}
```
For documentation and additional information see [the website](https://yanzhenjie.com/AndServer).
## Reverse Proxy Server
Deploy a reverse proxy server:
```java
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
Add the plugin to your project build script :
```gradle
buildscript {
repositories {
google()
mavenCentral()
}
dependencies {
classpath 'com.yanzhenjie.andserver:plugin:2.1.12'
...
}
}
allprojects {
repositories {
google()
mavenCentral()
}
}
...
```
And then add `AndServer` dependency to your module:
```gradle
apply plugin: 'com.yanzhenjie.andserver'
...
dependencies {
implementation 'com.yanzhenjie.andserver:api:2.1.12'
annotationProcessor 'com.yanzhenjie.andserver:processor:2.1.12'
...
}
```
If you are using Kotlin, replace `annotationProcessor` with `kapt`.
## Contributing
Before submitting pull requests, contributors must abide by the [agreement](./CONTRIBUTING.md) .
## License
```text
Copyright 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.
```