代码拉取完成，页面将自动刷新
同步操作将从 justlive1/oxygen 强制同步，此操作会覆盖自 Fork 仓库以来所做的任何修改，且无法恢复！！！
确定后同步将在后台操作，完成时将刷新页面，请耐心等待。
轻量级Java框架
一个轻量级Java框架
oxygen-core
oxygen-ioc
oxygen-aop
Aspect或直接实现Interceptor编写切面oxygen-cache
Cacheable的方法缓存oxygen-job
Scheduled的定时任务oxygen-jdbc
oxygen-web
ServletContainerInitializer 自动加载，省略web.xmlWebHook进行请求拦截处理创建Maven项目
<!-- tomcat,jetty,undertow -->
<properties>
<oxygen.server>-tomcat</oxygen.server>
</properties>
<!-- 使用内嵌容器启动 -->
<dependency>
<groupId>vip.justlive</groupId>
<artifactId>oxygen-web${oxygen.server}</artifactId>
<version>${oxygen.version}</version>
</dependency>
或Gradle
compile 'vip.justlive:oxygen-web-tomcat:$oxygenVersion'
不需要
webapp项目框架，支持Servlet3.0
编写 main 函数写一个 Hello World
public static void main(String[] args) {
Router.router().path("/").handler(ctx -> ctx.response().write("hello world"));
Server.server().listen(8080);
}
用浏览器打开 http://localhost:8080 这样就可以看到 hello world 了！
Router.router().path("/").handler(ctx -> ctx.response().write("hello world"));
Router.router().path("/get").method(HttpMethod.GET).handler(get);
Router.router().path("/post").method(HttpMethod.POST).handler(post);
@Router("/book")
public class BookRouter {
// 视图
@Mapping("/")
public ViewResult index() {
return Result.view("/book.html");
}
// json
@Mapping(value = "/ajax", method = {HttpMethod.POST})
public Book find(RoutingContext ctx) {
// ...
return new Book();
}
}
项目将json请求参数与表单参数合并，使用相同的方法或注解获取
使用RoutingContext获取
Router.router().path("/").handler(ctx -> {
String id = ctx.request().getParam("id");
ctx.response().write(id);
});
使用注解获取
@Mapping(value = "/ajax", method = {HttpMethod.POST})
public Book find(@Param Long id, @Param("tp") String type) {
// ...
return new Book();
}
使用RoutingContext获取
Router.router().path("/{id}").handler(ctx -> {
String id = ctx.request().getPathVariable("id");
ctx.response().write(id);
});
使用注解获取
@Mapping(value = "/{id}", method = {HttpMethod.POST})
public void ajax(@PathParam("id") Long id) {
// ...
}
使用RoutingContext获取
Router.router().path("/").handler(ctx -> {
String id = ctx.request().getHeader("id");
ctx.response().write(id);
});
使用注解获取
@Mapping(value = "/", method = {HttpMethod.POST})
public void ajax(@HeaderParam("id") Long id) {
// ...
}
使用RoutingContext获取
Router.router().path("/").handler(ctx -> {
String id = ctx.request().getCookie("id");
ctx.response().write(id);
});
使用注解获取
@Mapping(value = "/", method = {HttpMethod.POST})
public void ajax(@CookieParam("id") Long id) {
// ...
}
实体类
@Data
public class Book {
private String name;
private String author;
}
使用RoutingContext转换
Router.router().path("/").handler(ctx -> {
// 表单或json请求参数绑定
Book book = ctx.bindParam(Book.class);
// cookie参数绑定
book = ctx.bindCookie(Book.class);
// header参数绑定
book = ctx.bindHeader(Book.class);
// restful参数绑定
book = ctx.bindPathVariables(Book.class);
});
使用注解获取
@Mapping(value = "/", method = {HttpMethod.POST})
public void ajax(@Param Book b1, @CookieParam Book b2, @HeaderParam Book b3, @PathParam Book b4) {
// ...
}
内置默认将classpath下/public,/static作为静态资源目录，支持webjars，映射到/public
自定义静态资源可使用下面代码
Router.staticRoute().prefix("/lib").location("classpath:lib");
也可以通过配置文件指定
web.static.prefix=/public
web.static.path=/public,/static,classpath:/META-INF/resources/webjars
使用RoutingContext获取
Router.router().path("/").handler(ctx -> {
MultipartItem file = ctx.request().getMultipartItem("file");
// ...
});
使用注解获取
@Mapping("/")
public void upload(MultipartItem image, @MultipartParam("file1") MultipartItem file) {
// 不使用注解则使用方法参数名作为请求参数名称
// 使用注解指定请求参数名称
}
// 使用RoutingContext返回
Router.router().path("/").handler(ctx -> {
ctx.response().json(new Book("Java", "xxx"));
});
// 注解式
@Mapping("/")
public Book find() {
// 直接返回对象，框架默认处理成json
return new Book("Java", "xxx");
}
// 使用RoutingContext返回
Router.router().path("/").handler(ctx -> {
ctx.response().text("hello world");
});
// 使用RoutingContext返回
Router.router().path("/").handler(ctx -> {
ctx.response().html("<html><body><span>hello world</span></body></html>");
});
内置支持了jsp和thymeleaf模板，默认对应resources下的WEB-INF和templates目录
# 可通过下面配置进行更改模板目录
web.view.jsp.prefix=WEB-INF
web.view.thymeleaf.prefix=/templates
模板使用
// 使用RoutingContext
Router.router().path("/").handler(ctx -> {
ctx.response().template("index.html");
});
Router.router().path("/").handler(ctx -> {
Map<String, Object> attrs = new HashMap<>();
// ...
ctx.response().template("index.html", attrs);
});
// 注解式
@Mapping("/")
public Result index() {
return Result.view("index.html");
}
@Mapping("/")
public Result index() {
Map<String, Object> attrs = new HashMap<>();
// ...
return Result.view("index.html").addAttributes(attrs);
}
Router.router().path("/").handler(ctx -> {
ctx.response().redirect("https://github.com/justlive1");
});
@Mapping("/a")
public Result index() {
// 内部地址 相对于根目录: /b
// return Result.redirect("/b");
// 内部地址 相对于当前路径: /a/b
// return Result.redirect("b");
// 协议地址
return Result.redirect("https://github.com/justlive1");
}
@Mapping("/")
public void index(RoutingContext ctx) {
ctx.response().setCookie("hello", "world");
ctx.response().setCookie("java", "script", 100);
ctx.response().setCookie("uid", "xxx", ".justlive.vip", "/", 3600, true);
}
@Mapping("/")
public void index(RoutingContext ctx) {
ctx.response().setHeader("hello", "world");
}
@Mapping("/")
public void index(RoutingContext ctx) {
ctx.request().getSession().put("key", "value");
}
WebHook是拦截器接口，可以实现执行前、执行后和结束拦截处理
@Slf4j
@Bean
public class LogWebHook implements WebHook {
@Override
public boolean before(RoutingContext ctx) {
log.info("before");
return true;
}
@Override
public void after(RoutingContext ctx) {
log.info("after");
}
@Override
public void finished(RoutingContext ctx) {
log.info("finished");
}
}
框架默认提供了一个异常处理器，如需自定义处理异常，可以像下面这样使用
@Bean
public class CustomExceptionHandler extends ExceptionHandlerImpl {
@Override
public void handle(RoutingContext ctx, Exception e, int status) {
if (e instanceof CustomException) {
// do something
} else {
super.handle(ctx, e, status);
}
}
}
编码指定
Server.server().listen(8080);
配置文件
server.port=8081
启动命令
java -jar -Dserver.port=8090 app.jar
使用内嵌容器启动
启动类
public class Application {
public static void main(String[] args) {
Server.server().listen();
}
}
通用打包方式
${mainClass}为上面的启动类lib目录存放依赖jar
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>${maven.compiler.source}</source>
<target>${maven.compiler.target}</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<classpathPrefix>lib/</classpathPrefix>
<mainClass>${mainClass}</mainClass>
</manifest>
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<id>copy</id>
<phase>package</phase>
<goals>
<goal>copy-dependencies</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/lib</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
打成fat-jar:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>1.3.8.RELEASE</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
使用外部容器（jetty、tomcat等）
无需web.xml配置，打包成war放入容器即可，实现机制可查看WebContainerInitializer
<!-- 解决默认打war包报错 webxml attribute is required -->
<properties>
<failOnMissingWebXml>false</failOnMissingWebXml>
</properties>
框架可以通过使用配置文件进行修改默认属性
##### 基础配置
# 配置覆盖地址，用户外部配置覆盖项目配置 例 file:/config/*.properties,classpath*:/config/*.properties,xx.properties
config.override.path=
# 类扫描路径属性
main.class.scan=vip.justlive
# 临时文件根目录
main.temp.dir=.oxygen
# 缓存实现类，自定义缓存时使用
cache.impl.class=
##### web
# embedded 启动端口
server.port=8080
# context path
server.contextPath=
# session失效时间，单位秒
web.session.expired=3600
# 默认静态资源请求前缀
web.static.prefix=/public
# 默认静态资源目录
web.static.path=/public,/static,classpath:/META-INF/resources/webjars
# 静态资源缓存时间
web.static.cache=3600
# jsp路径前缀
web.view.jsp.prefix=WEB-INF
# thymeleaf 路径前缀
web.view.thymeleaf.prefix=/templates
# thymeleaf 视图后缀
web.view.thymeleaf.suffix=.html
# 内置简单视图处理 路径前缀
web.view.simple.prefix=/templates
# 内置简单视图处理 视图后缀
web.view.simple.suffix=.htm
# 是否开启模板缓存
web.view.cache.enabled=true
##### 定时任务job
# job线程名称格式
job.thread.name.format=jobs-%d
# job核心线程池大小
job.core.pool.size=10
##### i18n国际化
# i18n配置文件地址
i18n.path=classpath:message/*.properties
# i18n默认语言
i18n.default.language=zh
# i18n默认国家
i18n.default.country=CN
# i18n参数key
i18n.param.key=locale
# i18n Session key
i18n.session.key=I18N_SESSION_LOCALE
##### jetty
# 虚拟主机
server.jetty.virtualHosts=
# 连接器在空闲状态持续该时间后（单位毫秒）关闭
server.jetty.idleTimeout=30000
# 温和的停止一个连接器前等待的时间（毫秒）
server.jetty.stopTimeout=30000
# 等待处理的连接队列大小
server.jetty.acceptQueueSize=
# 允许Server socket被重绑定，即使在TIME_WAIT状态
server.jetty.reuseAddress=true
# 是否启用servlet3.0特性
server.jetty.configurationDiscovered=true
# 最大表单数据大小
server.jetty.maxFormContentSize=256 * 1024 * 1024
# 最大表单键值对数量
server.jetty.maxFormKeys=200
##### tomcat
# 最大请求队列数
server.tomcat.acceptCount=100
# 最大连接数
server.tomcat.maxConnections=5000
# 最大工作线程数
server.tomcat.maxThreads=200
# 最小线程数
server.tomcat.minSpareThreads=10
# 最大请求头数据大小
server.tomcat.maxHttpHeaderSize=8 * 1024
# 最大表单数据大小
server.tomcat.maxHttpPostSize=2 * 1024 * 1024
# 连接超时
server.tomcat.connectionTimeout=20000
# URI解码编码
server.tomcat.uriEncoding=utf-8
# 调用backgroundProcess延迟时间
server.tomcat.backgroundProcessorDelay=10
# 是否启用访问日志
server.tomcat.accessLogEnabled=false
# 访问日志是否开启缓冲
server.tomcat.accessLogBuffered=true
# 是否设置请求属性，ip、host、protocol、port
server.tomcat.accessLogRequestAttributesEnabled=false
# 每日日志格式
server.tomcat.accessLogFileFormat=.yyyy-MM-dd
# 日志格式
server.tomcat.accessLogPattern=common
##### undertow
# 主机名
server.undertow.host=0.0.0.0
# io线程数
server.undertow.ioThreads=
# worker线程数
server.undertow.workerThreads=
# 是否开启gzip压缩
server.undertow.gzipEnabled=false
# gzip处理优先级
server.undertow.gzipPriority=100
# 压缩级别，默认值 -1。 可配置 1 到 9。 1 拥有最快压缩速度，9 拥有最高压缩率
server.undertow.gzipLevel=-1
# 触发压缩的最小内容长度
server.undertow.gzipMinLength=1024
# url是否允许特殊字符
server.undertow.allowUnescapedCharactersInUrl=true
# 是否开启http2
server.undertow.http2enabled=false
E-mail: qq11419041@163.com
QQ群: 950216299
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。