作为一个全新的微服务框架，Redkale在接口定义上使用了Java 8大量的新语法，接口有默认实现、接口带静态方法、重复注解等特性，同时在设计上与主流框架有很大不同。Redkale是按组件形式设计的，而非以容器为主，几乎每个子包都是能提供独立功能的组件。如Tomcat是按容器设计的，所有web资源/配置由Tomcat控制，开发者很能难控制到Tomcat内部，而Redkale的HTTP服务只是个组件，开发者既可以自己启动和配置HttpServer，也可以把Redkale当成容器通过Redkale进程来初始化服务。Spring的Ioc容器也是如此，Redkale提供的依赖注入仅通过ResouceFactory一个类来控制，非常轻量，并且可动态更改已注入的资源。Spring提倡控制反转思想，而自身的容器却让开发者很难控制。Redkale是一个既能以组件形式也能以容器形式存在的框架。从整体上看，Redkale的架构分两层：接口和默认实现。开发者若想替换掉Redkale内置的HTTP服务而使用符合JavaEE规范的HttpServlet, 可以采用自定义协议基于JSR 340(Servlet 3.1)来实现自己的HTTP服务；若想使用Hibernate作为数据库操作，可以写一个自己的DataSource实现类；JSON的序列化和反序列化也可以使用第三方的实现；Memcached或Redis也可以作为另一个CacheSource的实现替换Redkale的默认实现。这其实包含了控制反转的思想，让框架里的各个组件均可让开发者控制。
- 与主流框架比，功能上Redkale显得很简单，这也是Redkale的一个特点并非不足，从一个良好的设计习惯或架构上来看，有些常用功能是不需要提供的，如Redkale的HTTP服务不支持HTTPS和JSP，HTTPS比HTTP多了一层加密解密，这种密集的数字计算不是Java的专长，通常提供HTTP服务的架构不会将Java动态服务器放在最前端，而是在前方会放nginx或apache，除了负载均衡还能静动分离，因此HTTPS的加解密应交给nginx这样的高性能服务器处理。Redkale再提供HTTPS服务就显得鸡肋。JSP其实算是一个落后的技术，现在是一个多样化终端的时代，终端不只局限于桌面程序和PC浏览器，还有原生App、混合式App、微信端、移动H5、提供第三方接口等各种形式的终端，这些都不是JSP能兼顾的，而HTTP+JSON作为通用性接口可以避免重复开发，模版引擎的功能加上各种强大的JS框架足以取代JSP。Redkale在功能上做了筛选，不会只因为迎合主流而提供，而是以良好的设计思想为指导。这也是Redkale一个很重要的思维。
Redkale 的HTTP是基于异步NIO.2实现的，HttpRequest的输入与HttpResponse的输出均是异步操作，HttpRequest内置JSON参数的获取和文件上传功能，HttpResponse提供数据对象和文件的数据，同时集成了REST ，因此并不遵循JSR 340规范(Servlet 3.1)且也没有实现JSP规范。 HTTP Server只提供四个对象：HttpContext、HttpRequest、HttpResponse、HttpServlet。 传统Session则由数据层实现。Redkale提倡HTTP+JSON接口(网站、PC客户端、APP移动端、第三方接口均可统一接口)， 故内置了JSON序列化与反序列化接口，同时内置HTTP缓存机制。
+
HTTP组件是基于异步NIO.2实现的，HttpRequest的输入与HttpResponse的输出均是异步操作，HttpRequest内置JSON参数的获取和文件上传功能，HttpResponse提供数据对象和文件的数据，同时集成了REST ，因此并不遵循JSR 340规范(Servlet 3.1)且也没有实现JSP规范。 HTTP Server只提供四个对象：HttpContext、HttpRequest、HttpResponse、HttpServlet。 传统Session则由数据层实现。Redkale提倡HTTP+JSON接口(网站、PC客户端、APP移动端、第三方接口均可统一接口)， 故内置了JSON序列化与反序列化接口，同时内置HTTP缓存机制。
Redkale 的WebSocket服务接口不同于JSR 340(Servlet 3.1)， 除了提供基本的WebSocket功能， 还提供分布式与集中式部署， 当部署多个WebSocket进程时，通过配置文件可以实现WebSocket之间连接信息的数据同步。
SNCP(Service Node Communicate Protocol)是Redkale独有的RPC协议， 主要用于进程间的数据传输，支持泛型和子类的数据转换。开发人员通过配置文件可以轻易的将Service由本地模式变成远程模式。远程模式Service使用SNCP协议与其他进程的Service通信。开发人员无需对远程通信接口使用类似Mina的第三方包自行开发。SNCP是Redkale的核心功能，其微服务架构都是基于本地模式Service和远程模式Service。
+SNCP(Service Node Communicate Protocol)是Redkale独有的RPC协议， 主要用于进程间的数据传输，支持泛型和子类的数据转换。开发人员通过配置文件可以轻易的将Service由本地模式变成远程模式。远程模式Service使用SNCP协议与其他进程的Service通信。开发人员无需对远程通信接口使用类似Mina的第三方包进行开发。SNCP是Redkale的核心功能，其微服务架构都是基于本地模式Service和远程模式Service。
继承HttpBaseServlet的子类可以使用其自带的鉴权、请求分支、缓存等功能， 一个典型的操作用户HttpServlet:
-@WebServlet({"/user/*"}) //拦截所有 /user/ 开头的请求
+ @WebServlet(value = {"/user/*"}, comment = "用户模块服务") //拦截所有 /user/ 开头的请求
public class UserServlet extends BaseSerlvet {
@Resource
@@ -110,7 +110,8 @@
@AuthIgnore //登录操作不要判断登录态，所以需要标记为@AuthIgnore，不会调用 BaseSerlvet.authenticate 方法
//因为WebAction的判断规则用的是String.startsWith，所以WebAction.url不能用正则表达式，只能是getRequestURI的前缀
//且同一个HttpServlet类内的所有WebAction不能存在包含关系, 如 /user/myinfo 和 /user/myinforecord 不能存在同一HttpServlet中。
- @WebAction(url = "/user/login")
+ @WebAction(url = "/user/login", comment = "用户登录")
+ @WebParam(name = "bean", type = LoginBean.class, comment = "登录参数对象")
public void login(HttpRequest req, HttpResponse resp) throws IOException {
LoginBean bean = req.getJsonParameter(LoginBean.class, "bean"); //获取参数
RetResult<UserInfo> result = service.login(bean); //登录操作， service内部判断bean的合法性
@@ -119,7 +120,7 @@
//获取当前用户信息
//未登录的请求会被BaseSerlvet.authenticate方法拦截，因此能进入该方法说明用户态存在
- @WebAction(url = "/user/myinfo")
+ @WebAction(url = "/user/myinfo", comment = "获取当前用户信息")
public void myinfo(HttpRequest req, HttpResponse resp) throws IOException {
UserInfo user = service.current(req.getSessionid(false));
//或者使用 user = req.getAttribute("_current_userinfo"); 因为BaseSerlvet.authenticate方法已经将UserInfo注入到_current_userinfo属性中
@@ -132,14 +133,15 @@
// @HttpCacheable 必须配合 @AuthIgnore 使用， 因为跟当前用户有关的请求一般不适合所有用户请求。
// 翻页查询想缓存就需要将翻页信息带进url: /user/query/page:2/size:50 。
@HttpCacheable(timeout = 30) //有效期30秒
- @WebAction(url = "/user/userinfo/")
+ @WebAction(url = "/user/userinfo/", comment = "获取指定用户ID的用户信息")
+ @WebParam(name = "#", type = int.class, comment = "用户ID")
public void userinfo(HttpRequest req, HttpResponse resp) throws IOException {
UserInfo user = service.findUserInfo(Integer.parseInt(req.getRequstURILastPath()));
resp.finishJson(user); //输出用户信息
}
//更新个人头像
- @WebAction(url = "/user/updateface")
+ @WebAction(url = "/user/updateface", comment = "更新用户头像")
public void updateface(HttpRequest req, HttpResponse resp) throws IOException {
UserInfo user = service.current(req.getSessionid(false));
for (MultiPart part : req.multiParts()) { //遍历上传文件列表
diff --git a/redkale.html b/redkale.html
index e7e01e765..3e6d1d0bd 100644
--- a/redkale.html
+++ b/redkale.html
@@ -36,17 +36,17 @@
Java 源码
Github 源码 https://github.com/redkale
-
+
Redkale 服务器
Redkale作为服务器的目录如下:
bin ： 存放启动/关闭/apidoc脚本(start.sh、shutdown.sh、apidoc.sh、start.bat、shutdown.bat、apidoc.bat)
conf ： 存放服务器所需配置文件:
application.xml： 服务配置文件 (必需)；
logging.properties：日志配置文件 (可选)；
- persistence.xml：数据库配置文件 (可选)；
+ persistence.xml：数据库配置文件 (可选)；
lib ： 存放服务所依赖的第三方包，redkale.jar 放在此处。
logs ： logging.properties 配置中默认的日志存放目录。
- root ： application.xml 配置中HTTP服务所需页面的默认根目录。
+ root ： application.xml 配置中HTTP服务所需页面的默认根目录。
Redkale启动的流程如下：
@@ -83,7 +83,8 @@
bean.setPassword("123456");
System.out.println(service.login(bean));
}
- Application.singleton 运行流程与通过bin脚本启动的流程基本一致，区别在于singleton运行时不会启动Server和Application自身的服务监听。Redkale提倡接入层(Servlet)与业务层(Service)分开，Service在代码上不能依赖于Servlet，因此调试Service自身逻辑时不需要启动接入层服务(类似WebSocket依赖Servlet的功能除外)。
+ Application.singleton 运行流程与通过bin脚本启动的流程基本一致，区别在于singleton运行时不会启动Server和Application自身的服务监听。Redkale提倡接入层(Servlet)与业务层(Service)分开，Service在代码上不能依赖于Servlet，因此调试Service自身逻辑时不需要启动接入层服务(类似WebSocket依赖Servlet的功能除外)。
+ 注: Application.singleton的参数Service类不能是抽象类、接口或不存在非final的public方法。
Redkale的依赖注入
Redkale内置的依赖注入实现很简单，只有三个注解和一个类: javax.annotation.Resource、org.redkale.util.ResourceType、org.redkale.util.ResourceListener、org.redkale.util.ResourceFactory，采用反射技术，依赖注入通常不会在频繁的操作中进行，因此性能要求不会很高。其中前两个是注解，ResourceFactory是主要操作类，主要提供注册和注入两个接口。ResourceFactory的依赖注入不仅提供其他依赖注入框架的常规功能，还能动态的自动更新通过inject注入的资源。
@@ -720,7 +721,7 @@
<services autoload="true" includes="" excludes="" />
</server>
</application>
-