From 89a292aaf5eb66a6d4f2d925a229a4e2c6c7b6f8 Mon Sep 17 00:00:00 2001 From: Redkale <22250530@qq.com> Date: Mon, 28 Nov 2016 11:53:14 +0800 Subject: [PATCH] --- net.html | 11 ++++++++--- service.html | 2 +- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/net.html b/net.html index 850eca0e6..455efbdcf 100644 --- a/net.html +++ b/net.html @@ -99,7 +99,7 @@ } } -

        继承HttpBaseServlet的子类可以使用其自带的鉴权、请求分支、缓存等功能， 一个典型的操作用户HttpServlet:

+

        继承HttpBaseServlet的子类可以使用其自带的鉴权、请求分支、缓存等功能， 一个典型的操作用户HttpServlet: 

@WebServlet(value = {"/user/*"}, comment = "用户模块服务")  //拦截所有 /user/ 开头的请求
 public class UserServlet extends BaseSerlvet {
 
@@ -166,6 +166,11 @@
             
        如上, 配置了/pipes 前缀后，客户端发送Servlet请求需带上前缀，请求当前用户信息的url就变成：/pipes/user/myinfo 。

             

 
+            
   API Doc 

+            
        在小型互联网公司里，基本是追求敏捷开发，很少先花时间设计接口文档再进行开发，通常都是直接进行数据库设计和开发，开发完后需要开发人员需要编写接口文档提供给前端人员开发。为了减少文档的编写工作量和强制开发人员对接口进行注释，Redkale提供了apidoc命令，apidoc遍历当前进程中所有标记@WebServlet的可用HttpServlet，根据Servlet中@WebAction、@WebParam生成json对象并输出文件。在系统运行时执行apidoc命令会在进程根目录下生成apidoc.json、apidoc.html文件。apidoc.html的模板可以定制， 只需在conf/目录下存放一个 apidoc-template.html 文件，且文件中必须包含关键字 ${content} 即可实现接口文档的自定义。

+                        为了能正确显示接口文档，开发人员需要在编写HttpServlet时，在每个@WebAction方法上加上comment属性和@WebParam注解, 一个方法上可以注解多个@WebParam, 如上面的 UserServlet 。RestHttpServlet是由RestService自动生成，@WebAction、@WebParam在REST组件中存在对应的注解@RestMapping、@RestParam，因此在编写RestService时需要加上@RestMapping、@RestParam且加上comment属性。如范例: HelloService 。

+            

+
             
   WebSokcet 服务 

             
        WebSokcet协议遵循IETF RFC 6455，其接口并不符合Java EE中的WebSocket的接口规范。

                         一个WebSocket连接对应一个WebSocket实体，即一个WebSocket会绑定一个TCP连接。且有两种模式:

@@ -488,7 +493,7 @@
     //获取request创建时间
     public long getCreatetime();
 }
-
+

  . HttpResponse 对象

@@ -602,7 +607,7 @@ //HttpResponse回收时回调的监听方法 public void setRecycleListener(BiConsumer<HttpRequest, HttpResponse> recycleListener); } - +

  . WebSocket 对象

diff --git a/service.html b/service.html index 85298b294..6c9e2a2ce 100644 --- a/service.html +++ b/service.html @@ -489,7 +489,7 @@ } - 
/**
+            
/**
  * 类说明:
  * Flipper : Source组件中的翻页对象
  * UserInfo ：当前用户类