# Voovan

**Repository Path**: wangscript/Voovan

## Basic Information

- **Project Name**: Voovan
- **Description**: Voovan是高性能异步通信、HTTP服务器和客户端通信、动态编译支持、数据库操作帮助类等工具的框架，且完全原生不依赖任何第三方包。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: http://www.voovan.org
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 229
- **Created**: 2017-12-29
- **Last Updated**: 2024-06-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![](http://git.oschina.net/uploads/images/2016/0510/122514_7d971a34_116083.jpeg)


[![](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![](https://maven-badges.herokuapp.com/maven-central/org.voovan/voovan-framework/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.voovan/voovan-framework)
![JDK 1.7](https://img.shields.io/badge/JDK-1.7-green.svg "JDK 1.8")
[![jar size 497K](https://img.shields.io/badge/size-497K-green.svg "size 497K")](https://git.oschina.net/helyho/Voovan/raw/master/voovan-framework.jar)

Voovan 是一个高性能异步网络框架和WEB服务器框架,同时支持HTTP客户端抓取、动态编译支持、数据库访问封装以及DateTime、String、Log、反射、对象工具、流操作、文件操作、异步双向通道等功能。旨在提供可靠、方便、可单元测试的代码。它是一个无任何依赖的独立工具包，希望能够方便广大开发者快速的实现应用。

**极简并且优雅的编码是 Voovan 的宗旨和目标**

---------------------

**文档入口:**【[Voovan 开发手册](http://voovan.mydoc.io/)】

**入门教程:**【[Voovan 一步步入门](http://voovanturorial.mydoc.io/)】

**交流QQ群** 454201740

**开源协议:** Apache v2 License

**Voovan开源项目源代码主要托管于 Git@OSC.**

**Issues地址:** [Git@OSC](http://git.oschina.net/helyho/Voovan/issues)

---------------------

**Maven中央库支持:**
```xml
<dependency>
    <groupId>org.voovan</groupId>
    <artifactId>voovan-framework</artifactId>
    <version>3.0.0</version>
</dependency>
```

---------------------
**Voovan 3.0.0 新特性:**
[- 详情 -](https://git.oschina.net/helyho/Voovan/releases/v3.0.0)

**Web模块:**
  - WebServer 对注解形式路由的支持, 类似一个轻量化的 Spring MVC
  - WebServer 增加热部署支持, 修改类和 jar 中的类,无须重启 web 服务
  - WebServer 增加扫描新类和 jar 到 ClassPath 的支持,新增类和 jar 无须重启 web 服务
  - WebServer 路径变量抽取算法优化, 以获得性能提升
  - WebServer 路径变量支持通过'_' 和 '-' 来进行变量分
  - WebServer 实现基于 redis 的 session 共享形式的集群
  - WebServer 提供对基于 Websocket 协议的 socket.io 和 engine.io 的支持

**Network 模块:**
  - 提高了 Voovan 对于并发性能的支持,测试结果并发性能提升为10%-15%
  - 优化ByteBufferChannel增加 shrink \ read \ write 的通用方法
  - IoSession 的状态模型重构
  - 增加心跳控制

**Common 模块:**
  - 新增时间轮定时任务,并且支持异步任务的方式,Voovan 内部所有定时器全部都替换为时间轮的方式,以提升性能
  - 增加了动态编译以及沙盒对于加载类的安全控制


        - 动态类的的支持,参见:org.voovan.tools.compiler.clazz.DynamicClass
        - 动态函数的的支持,参见:org.voovan.tools.compiler.function.DynamicFunction
        - 动态编译部分的沙盒安全支持: /Voovan/Common/src/main/resources/sandbox.properties


  - 提供通用的热部署支持,使任何 JVM 应用都能够支持热部署, 参见: org.voovan.tools.hotswap.Hotswaper

---------------------
 **典型案例:**
 - 商旅行业酒店预订系统,基于 Voovan 开发的后端API服务
 - 基于 Voovan 开发物联网管理服务
 - 基于 Voovan 开发的游戏后端服务
 - 基于 Voovan 开发的 WEB 服务以及手机推送服务
 - 某通信企业基于 Voovan开发日通信10w+ 次的关口机
 - Vestful 一款提供 Restful 服务的框架
 - Dockerfly 一款 Docker web 管理工具
 - JDocker 一款 java 开发 Docker API 封装的框架

---------------------
** Voovan 相关新闻 **

|日期                              | 标题                   |
|-------------------------------    |-----------------------|
| 2017-06-28 | [t-io 和 Voovan 并发性能测试](https://my.oschina.net/helyho/blog/1068640)  |
| 2017-06-02 | [Netty、t-io、Voovan 框架浅谈](https://my.oschina.net/helyho/blog/919465) |
| 2017-02-21 | [Netty与Voovan并发性能对比](https://my.oschina.net/helyho/blog/853755)    |
| 2017-01-04 | [Voovan 参照 Jetty 的性能测试](http://www.oschina.net/news/80665/voovan-performance-test) |

---------------------



 **JDK支持:**

 - 推荐使用 JDK1.8,懒人专用。
 - 目前自2.0.1开始所有版本在发布前都会进行 jdk1.7的测试。
 - 如果 WebServer 使用lambda 需要 JDK1.8,不使用 lambda 需要 JDK1.7。
 - 有能力的同学可以通过很简单几行修改使 WebServer 和 HTTPClient使用 NIO 那么就是 JDK1.6。

---------------------

 **框架特点介绍:**
 - 使用 JDK8 的 lambda 表达式,快速实现 HTTP/WebSocket 服务的开发。[【演示】](http://webserver.voovan.org/)/[【性能测试报告】](https://git.oschina.net/helyho/Voovan/issues/12)
 - 异步通信框架解决粘包问题,过滤器链等。
 - 独立无依赖的代码。
 - 源码注释丰富，方便码友学习、调试、使用。

---------------------

 **一、高性能异步通信(AIO、NIO异步通信) [voovan-network]**

  类似 Netty 和 MINA 的异步 Socket 通信框架.但有有所不同。
  1. **可灵活解决Socket通信粘包的支持**（源码中包含 HTTP协议,字符串换行,定长报文的粘包实现）。
  1. **支持 SSL/TLS 加密通信。**
  1. **提供线程池依据系统负载情况自动动态调整。**
  1. 同时支持 NIO 和 AIO 特性。
  1. 采用非阻塞方式的异步传输。
  1. 事件驱动(Connect、Recive、Sent、Close、Exception)，采用回调的方式完成调用。
  1. **可灵活的加载过滤器机制。**

---------------------

 **二、HTTP客户端和WEB服务器[voovan-web]**
 **HTTP客户端特性:**
  1. 基于 Voovan 异步通信框架实现。
  1. 客户端可以灵活自定义请求报文。
  1. 同步实现 HTTP请求(需要同步实现可参考)。
  1. 实现 WebSocket 客户端调用,可以连接任何支持 **WebSocket Version 13**的 WebSocket 服务。



 **WEB服务器特性:[voovan-web]**
  1. 支持 **WebSocket Version 13**，并且保持 WebSocket请求参数。
  1. **使用 Lambda 实现更加方便的 Http 响应实现。**
  1. **支持路径参数自动抽取**  当路径定义/:name,在使用/jonh地址访问时，可以通过 name 参数获取 jonh 字符串。
  1. 重定向支持。
  1. 可灵活实现session共享。
  1. **异常统一展示**支持。
  1. MIME 配置支持。
  1. 支持基于 HTTP1.1 的 HTTPS 访问,默认采用TLS模式.
  1. 支持性能监控.  [[HTTP服务端性能监控演示](http://webserver.voovan.org/VoovanMonitor/Monitor.html)]

---------------------

**三、动态编译支持 [voovan-common]**

  在内存中编一个保存有 java 代码的字符串,并将编译后的 byte 字节加入到 classloader 中,可灵活的动态定义类和使用。

---------------------

**四、数据库操作帮助类 [voovan-database]**
提供类似Spring JDBCTemplate 的数据访问支持，但提供了更好更灵活易用的函数设计。
 - 支持的参数类型:
  - Map 参数
  - 不定参数
  - 对象作为参数
 - 支持存储过程调用。
 - 支持批量更新。
 - 数据库事务的支持。
 - 支持自动移除无匹配参数的条件。
 - 结果转换对象的时候使用模糊匹配。

---------------------

 **五、DateTime、String、Log、反射、对象工具、流操作、文件操作、异步双向通道等 [voovan-common]**

  1. 简单的 JSON 序列化和反序列化,效率比不过专业的序列化工具(如:FastJson),但重在轻量级好用。
  1. 日期类型和字符串和日期类型互转,日期类型加减操作。
  1. 反射的快捷实现,可直接通过反射取属性值,调用方法,实例化对象,**判断类的继承及实现**。
  1. 简单的日志记录类,支持指定输出流,日志报文自定义等。
  1. 简单的**自推导的对象类型强制转换**,根绝参数类型,运算类型自动退定强制转换类型。
  1. 流操作,读取定长、按行读取、**基于byte的split操作**等。
  1. 使用 ByteBuffer 实现的一个双向通道。
  1. 属性文件操作。
  1. 文件路径拼接、从绝对路径读取、从相对路径读取、从包路径读取、指定起始和结束位置内容读取等。
  1. List 和 Map 的快速初始化。
  1. 热部署
  1. 动态函数和类

---------------------

**包结构说明**

|  包名                      | 名称           |
| -------------             |:-------------: |
|org.voovan.db              |数据库操作类      |
|org.voovan.http            |HTTP工具包       |
|org.voovan.dynamicComplier |动态编译包        |
|org.voovan.network         |网络异步通信包    |
|org.voovan.tools           |基本工具包        |

---------------------


**Voovan 在异步通信的范畴内的同类框架有:**
  - [t-io](http://www.t-io.org:9292/): 长连接异步通信框架,提供心跳和连接保持的支持.
  - [netty](http://netty.io/):  老牌异步通信框架和voovan有面对相同的场景, 两者相比的话 voovan 开发更易上手,针对 Socket 通信中粘包的处理 Voovan 提供了更加优雅的方式.

大家可以根据自己的需要适应的场景选择不同框架.