Sinetja = Sinatra + Netty + Java
You can use Sinetja with Java 6+. Below examples use Java 8 lambda syntax.
import sinetja.Server;
public class App {
public static void main(String[] args) {
Server server = new Server(8000);
server
.GET("/", (req, res) ->
res.respondText("Hello World")
)
.GET("/hello/:name", (req, res) -> {
String name = req.param("name");
res.respondText("Hello " + name);
});
server.start();
server.stopAtShutdown();
}
}
req and res are
FullHttpRequest
and
FullHttpResponse
with several helper methods to let you extract params and respond.
Javadoc:
Use server.uri:
import sinetja.Action;
Action helloAction = (req, res) -> {
String name = req.param("name");
res.respondText("Hello " + name);
};
server
.GET("/", (req, res) ->
res.respondText(
"URI to Hello World action: " +
server.uri(helloAction, "name", "World") // => "/hello/World"
)
)
.GET("/hello/:name", helloAction);
You can also use Map:
Map<String, String> params = new HashMap<String, String>();
params.put("name", "World");
params.put("foo", "bar");
server.uri(helloAction, params); // => "/hello/World?foo=bar"
Common methods:
CONNECT, DELETE, GET, HEAD, OPTIONS,
PATCH, POST, PUT, and TRACE.
You can also use ANY, which means the route will match all request methods.
If you want to specify that a route should be matched first or last, use
GET_FIRST, GET_LAST etc.
In the example below, /articles/new will be matched before /articles/:id.
server
.GET ("/articles/:id", ...)
.GET_FIRST("/articles/new", ...);
Use these methods of Request:
String param(String name) throws MissingParam String paramo(String name) List<String> params(String name)
param and paramo return a single value.
params returns a collection (can be empty) of values (params can be multiple values with same name).
If the request param is missing:
paramowill just returns null.paramwill throwMissingParam. By default, Sinetja will respond error 400 bad request for you. If you want to change the default behavior, you can catch that exception in your action, or at the global error handler (see "500 Internal Server Error" section below).
Order of request param priority: path > body > query. For example, if the routing pattern is
/hello/:foo, when request /hello/abc?foo=xyz comes in, param("foo") will return abc.
Use these methods of Response:
respondText respondXml respondHtml respondJs respondJsonText respondJson respondJsonPText respondJsonP respondBinary respondFile respondEventSource
All the methods return ChannelFuture.
Thanks to Netty, unlike most Java web frameworks, Sinetja is async. You don't have to respond right away as soon as possible. You can respond later.
Java 8 style:
server.before((req, res) -> {
...
});
If the filter responds something, the main action will not be called.
Similar to before filter. It's run after the main action, but before the response is returned to the client. For example, if you want to add a header to all responses, you can do it here.
Sinetja uses SLF4J. Please add an implementation like Logback to your project.
<dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.2.2</version> </dependency>
You can get a logger like this:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class MyClass {
private static final Logger LOGGER = LoggerFactory.getLogger(MyClass.class);
...
}
Or if you don't care about the originality of the logger, simply use sinetja.Log:
sinetja.Log.debug("Debug msg");
sinetja.Log.info("Info msg");
sinetja.Log.warn("Warning msg");
sinetja.Log.error("Error msg", error);
If there's no matched action, Sinetja will automatically respond simple "Not Found" text for you.
If you want to handle yourself:
Java 8 style:
import io.netty.handler.codec.http.HttpResponseStatus;
server.notFound((req, res) -> {
String uri = req.getUri();
Log.info("User tried to access nonexistent path: {}", uri);
res.setStatus(HttpResponseStatus.NOT_FOUND);
res.respondText("Not Found: " + uri);
});
By default, Sinetja will automatically respond simple "Internal Server Error" text for you.
If you want to handle yourself:
import io.netty.handler.codec.http.HttpResponseStatus;
server.error((req, res, e) -> {
Log.error("Error with request: {}", req, e);
res.setStatus(HttpResponseStatus.INTERNAL_SERVER_ERROR);
res.respondText("Internal Server Error");
});
Use autogenerated selfsigned certificate:
server.jdkSsl();
or (Apache Portable Runtime and OpenSSL libs must be in load path such as system library directories, $LD_LIBRARY_PATH on *nix or %PATH% on Windows):
server.openSsl();
If you want to use your own certificate, use one of these methods:
jdkSsl(String certChainFile, String keyFile) jdkSsl(String certChainFile, String keyFile, String keyPassword) openSsl(String certChainFile, String keyFile) openSsl(String certChainFile, String keyFile, String keyPassword)
The above are utility methods for setting SslContext. If you want to set it directly:
sslContext(SslContext sslContext)
To tell the server to handle CORS, set CorsConfig:
import io.netty.handler.codec.http.cors.CorsConfig; CorsConfig config = CorsConfig.withAnyOrigin().build(); server.cors(config);
After starting the server, you can stop it:
server.stop();
You can also register a JVM shutdown hook that calls the above automatically:
server.stopAtShutdown();
After the hook has been registered, you can stop the server by running OS command:
kill <PID>
- Sinetja-Skeleton8: If you want to use Java 8 with its lambda syntax.
- Sinetja-Skeleton: If you use older Java.
- Sinetja-Scaleton: If you use Scala. Please also try Xitrum.
Discussion mailing list (Google group)
<dependency> <groupId>tv.cntt</groupId> <artifactId>sinetja</artifactId> <version>1.4.0</version> </dependency>
You should also add Javassist because it boosts Netty speed:
<dependency> <groupId>org.javassist</groupId> <artifactId>javassist</artifactId> <version>3.21.0-GA</version> </dependency>
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent