一个基于ioc、aop、config、cache、job、Jdbc轻量级JavaWeb框架（高分课设）

# oxygen [](https://maven-badges.herokuapp.com/maven-central/vip.justlive/oxygen/) [](https://www.apache.org/licenses/LICENSE-2.0.html) 轻量级Java框架 ## 介绍 一个轻量级Java框架 - oxygen-core - 配置管理，支持${attrs.key:defaultValue}表达式获取配置 - 加解密管理，提供加解密服务内置基础加密实现，例如SHA-1、SHA-256、MD5 - 异常管理，提供异常包装，统一异常编码，便于国际化 - i18n国际化 - 资源文件加载，提供file,jar,classpath等文件加载 - 类扫描器 - 基于构造器的轻量级依赖注入 - 缓存 - 提供基于注解`Scheduled`的定时任务 - 可使用注解`Aspect`或直接实现`Interceptor`编写切面 - 部分工具类 - oxygen-jdbc - 小巧简单的jdbc实现，纯jdk实现，无第三方jar - 支持多数据源 - 基于sql进行crud，不提供类似Hibernate的链式方法（原因：sql作为数据库领域的DSL，已经很自然优雅，Less is more） - oxygen-web - 轻量级web框架支持注解声明和函数式编程 - 支持Servlet3.0 `ServletContainerInitializer` 自动加载，省略web.xml - 支持i18n动态切换 - 提供`WebHook`进行请求拦截处理 - 支持自定义全局异常处理 - 内置aio服务器 ## 特性 * 轻量级，使用简单 * 支持插件扩展 * 函数式编程 * 流式风格 ## 快速开始 创建`Maven`项目 ```xml <!-- 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` ```java public static void main(String[] args) { Router.router().path("/").handler(ctx -> ctx.response().write("hello world")); Server.listen(8080); } ``` 用浏览器打开 http://localhost:8080 这样就可以看到 `hello world` 了！ ## 内容详解 - [**`注册路由`**](#注册路由) - [**`硬编码方式`**](#硬编码方式) - [**`注解方式`**](#注解方式) - [**`获取请求参数`**](#获取请求参数) - [**`表单参数或json请求参数`**](#表单参数或json请求参数) - [**`restful参数`**](#restful参数) - [**`header参数`**](#header参数) - [**`cookie参数`**](#cookie参数) - [**`参数转对象`**](#参数转对象) - [**`静态资源`**](#静态资源) - [**`上传文件`**](#上传文件) - [**`结果渲染`**](#结果渲染) - [**`渲染json`**](#渲染json) - [**`渲染文本`**](#渲染文本) - [**`渲染html`**](#渲染html) - [**`渲染模板`**](#渲染模板) - [**`重定向`**](#重定向) - [**`写入cookie`**](#写入cookie) - [**`添加header`**](#添加header) - [**`写入session`**](#写入session) - [**`拦截器`**](#拦截器) - [**`异常处理`**](#异常处理) - [**`部署项目`**](#部署项目) - [**`修改端口`**](#修改端口) - [**`运行项目`**](#运行项目) ### 注册路由 #### 硬编码方式 ```java 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); ``` #### 注解方式 ```java @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请求参数 项目将json请求参数与表单参数合并，使用相同的方法或注解获取 **使用RoutingContext获取** ```java Router.router().path("/").handler(ctx -> { String id = ctx.request().getParam("id"); ctx.response().write(id); }); ``` **使用注解获取** ```java @Mapping(value = "/ajax", method = {HttpMethod.POST}) public Book find(@Param Long id, @Param("tp") String type) { // ... return new Book(); } ``` #### restful参数 **使用RoutingContext获取** ```java Router.router().path("/{id}").handler(ctx -> { String id = ctx.request().getPathVariable("id"); ctx.response().write(id); }); ``` **使用注解获取** ```java @Mapping(value = "/{id}", method = {HttpMethod.POST}) public void ajax(@PathParam("id") Long id) { // ... } ``` #### header参数 **使用RoutingContext获取** ```java Router.router().path("/").handler(ctx -> { String id = ctx.request().getHeader("id"); ctx.response().write(id); }); ``` **使用注解获取** ```java @Mapping(value = "/", method = {HttpMethod.POST}) public void ajax(@HeaderParam("id") Long id) { // ... } ``` #### cookie参数 **使用RoutingContext获取** ```java Router.router().path("/").handler(ctx -> { String id = ctx.request().getCookie("id"); ctx.response().write(id); }); ``` **使用注解获取** ```java @Mapping(value = "/", method = {HttpMethod.POST}) public void ajax(@CookieParam("id") Long id) { // ... } ``` #### 参数转对象 **实体类** ```java @Data public class Book { private String name; private String author; } ``` **使用RoutingContext转换** ```java 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); }); ``` **使用注解获取** ```java @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` 自定义静态资源可使用下面代码 ```java Router.staticRoute().prefix("/lib").location("classpath:lib"); ``` 也可以通过配置文件指定 ```properties web.static.prefix=/public web.static.path=/public,/static,classpath:/META-INF/resources/webjars ``` ### 上传文件 **使用RoutingContext获取** ```java Router.router().path("/").handler(ctx -> { MultipartItem file = ctx.request().getMultipartItem("file"); // ... }); ``` **使用注解获取** ```java @Mapping("/") public void upload(MultipartItem image, @MultipartParam("file1") MultipartItem file) { // 不使用注解则使用方法参数名作为请求参数名称 // 使用注解指定请求参数名称 } ``` ### 结果渲染 #### 渲染json ```java // 使用RoutingContext返回 Router.router().path("/").handler(ctx -> { ctx.response().json(new Book("Java", "xxx")); }); // 注解式 @Mapping("/") public Book find() { // 直接返回对象，框架默认处理成json return new Book("Java", "xxx"); } ``` #### 渲染文本 ```java // 使用RoutingContext返回 Router.router().path("/").handler(ctx -> { ctx.response().text("hello world"); }); ``` #### 渲染html ```java // 使用RoutingContext返回 Router.router().path("/").handler(ctx -> { ctx.response().html("<html><body><span>hello world</span></body></html>"); }); ``` #### 渲染模板 内置支持了`jsp`和`thymeleaf`模板，默认对应`resources`下的`WEB-INF`和`templates`目录 ```properties # 可通过下面配置进行更改模板目录 web.view.jsp.prefix=WEB-INF web.view.thymeleaf.prefix=/templates ``` 模板使用 ```java // 使用RoutingContext Router.router().path("/").handler(ctx -> { ctx.response().template("index.html"); }); Router.router().path("/").han