@@ -7,6 +7,7 @@
< link rel = "stylesheet" type = "text/css" href = "stylesheets/normalize.css" media = "screen" >
< link rel = "stylesheet" type = "text/css" href = "stylesheets/stylesheet.css" media = "screen" >
< link rel = "stylesheet" type = "text/css" href = "stylesheets/github-light.css" media = "screen" >
< link rel = "stylesheet" type = "text/css" href = "stylesheets/highlight.css" media = "screen" >
< / head >
< body >
< section class = "page-header" >
@@ -24,10 +25,196 @@
< / section >
< section class = "main-content" >
< h3 >
< a id = "welcome-to-github-pages" class = "anchor" href = "#welcome-to-github-pages" aria-hidden = "true" > < span class = "octicon octicon-link" > < / span > < / a > RedKale 入门介绍< / h3 >
< h3 > < a id = "redkale_start" class = "anchor" href = "#" aria-hidden = "true" > < span class = "octicon octicon-link" > < / span > < / a > RedKale 入门介绍< / h3 >
< p > RedKale既可以 作为服务器使用，可以 当工具包使用。< / p >
< p > RedKale虽然只有1.xM大小， 既可作为服务器使用，也 可当工具包使用。作为独立的工具包提供以下功能：< br / >
1、convert包提供JSON的序列化和反解析功能， < br / >
2、convert包提供Java对象二进制的序列化和反解析功能， < br / >
3、source包提供很简便的数据库操作功能， < br / >
4、net包提供TCP/UDP服务功能， < br / >
5、net.http提供HTTP服务， < br / >
6、ResourceFactory提供轻量级的依赖注入功能， < br / >
< / p >
< h3 > < a id = "redkale_server" class = "anchor" href = "#" aria-hidden = "true" > < span class = "octicon octicon-link" > < / span > < / a > RedKale 服务器< / h3 >
< p > RedKale作为服务器的目录如下: < br / >
< b > bin< / b > ： < br / >
< b > conf< / b > ： < br / >
application.xml： ； < br / >
logging.properties： ； < br / >
persistence.xml： ； < br / >
< b > lib< / b > ： ， < br / >
< b > logs< / b > ： < br / >
< b > root< / b > ： < br / >
< / p >
< p > appplication.xml配置说明: < / p >
< div class = "highlight" > < pre > < span class = "cp" > < ?xml version=" 1.0" encoding=" UTF-8" ?> < / span >
< span class = "c" > < !-- < / span >
< span class = "c" > 文件说明:< / span >
< span class = "c" > ${APP_HOME} 指当前程序的根目录APP_HOME< / span >
< span class = "c" > required： < / span >
< span class = "c" > --> < / span >
< span class = "c" > < !-- < / span >
< span class = "c" > address: 本地的IP地址， ， ， < / span >
< span class = "c" > port: required 程序的管理Server的端口， < / span >
< span class = "c" > host: 程序的管理Server的地址; 默认为127.0.0.1。< / span >
< span class = "c" > lib: 加上额外的lib路径,多个路径用分号;隔开； 默认为空。 例如: ${APP_HOME}/lib/a.jar;${APP_HOME}/lib2/b.jar;< / span >
< span class = "c" > --> < / span >
< span class = "nt" > < application< / span > < span class = "na" > port=< / span > < span class = "s" > " 6560" < / span > < span class = "na" > lib=< / span > < span class = "s" > " " < / span > < span class = "nt" > > < / span >
< span class = "c" > < !-- 所有服务所需的资源 --> < / span >
< span class = "nt" > < resources> < / span >
< span class = "c" > < !--< / span >
< span class = "c" > 一个组包含多个NODE， ， ， < / span >
< span class = "c" > name: 服务组ID， < / span >
< span class = "c" > protocol： ， < / span >
< span class = "c" > 注意: 一个node只能所属一个group。只要存在protocol=SNCP的Server节点信息， < / span >
< span class = "c" > --> < / span >
< span class = "nt" > < group< / span > < span class = "na" > name=< / span > < span class = "s" > " " < / span > < span class = "na" > protocol=< / span > < span class = "s" > " TCP" < / span > < span class = "nt" > > < / span >
< span class = "c" > < !--< / span >
< span class = "c" > 需要将本地node的addr与port列在此处。< / span >
< span class = "c" > addr: required IP地址< / span >
< span class = "c" > port: required 端口< / span >
< span class = "c" > clients: 连接池数， 默认: CPU核数*4< / span >
< span class = "c" > buffers: ByteBuffer对象池的大小， < / span >
< span class = "c" > --> < / span >
< span class = "nt" > < node< / span > < span class = "na" > addr=< / span > < span class = "s" > " 127.0.0.1" < / span > < span class = "na" > port=< / span > < span class = "s" > " 7070" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /group> < / span >
< span class = "c" > < !-- < / span >
< span class = "c" > 全局的参数配置, 可以通过@Resource(name=" property.xxxxxx" ) 进行注入, 被注解的字段类型只能是String、primitive class< / span >
< span class = "c" > 如果name是system.property.开头的值将会在进程启动时进行System.setProperty(" yyyy" , " YYYYYY" )操作。< / span >
< span class = "c" > 如果name是mimetype.property.开头的值将会在进程启动时进行MimeType.add(" yyyy" , " YYYYYY" )操作。< / span >
< span class = "c" > load: 加载文件，多个用;隔开。< / span >
< span class = "c" > 默认置入的system.property.的有：< / span >
< span class = "c" > System.setProperty(" convert.json.tiny" , " true" );< / span >
< span class = "c" > System.setProperty(" convert.bson.tiny" , " true" );< / span >
< span class = "c" > System.setProperty(" convert.json.pool.size" , " 128" );< / span >
< span class = "c" > System.setProperty(" convert.bson.pool.size" , " 128" );< / span >
< span class = "c" > System.setProperty(" convert.json.writer.buffer.defsize" , " 4096" );< / span >
< span class = "c" > System.setProperty(" convert.bson.writer.buffer.defsize" , " 4096" );< / span >
< span class = "c" > --> < / span >
< span class = "nt" > < properties< / span > < span class = "na" > load=< / span > < span class = "s" > " config.properties" < / span > < span class = "nt" > > < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > " system.property.yyyy" < / span > < span class = "na" > value=< / span > < span class = "s" > " YYYYYY" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > " xxxxxx" < / span > < span class = "na" > value=< / span > < span class = "s" > " XXXXXXXX" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > " xxxxxx" < / span > < span class = "na" > value=< / span > < span class = "s" > " XXXXXXXX" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > " xxxxxx" < / span > < span class = "na" > value=< / span > < span class = "s" > " XXXXXXXX" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /properties> < / span >
< span class = "nt" > < /resources> < / span >
< span class = "c" > < !--< / span >
< span class = "c" > protocol: required server所启动的协议， ， < / span >
< span class = "c" > host: 服务所占address ， < / span >
< span class = "c" > port: required 服务所占端口 < / span >
< span class = "c" > root: 如果是web类型服务， < / span >
< span class = "c" > lib: server额外的class目录， < / span >
< span class = "c" > charset: 文本编码， 默认: UTF-8< / span >
< span class = "c" > backlog: 默认10K< / span >
< span class = "c" > threads： < / span >
< span class = "c" > maxbody: request.body最大值， < / span >
< span class = "c" > capacity: ByteBuffer的初始化大小， < / span >
< span class = "c" > bufferPoolSize： ， < / span >
< span class = "c" > responsePoolSize： ， < / span >
< span class = "c" > readTimeoutSecond: 读操作超时秒数， 默认0， < / span >
< span class = "c" > writeTimeoutSecond: 写操作超时秒数， 默认0， < / span >
< span class = "c" > --> < / span >
< span class = "nt" > < server< / span > < span class = "na" > protocol=< / span > < span class = "s" > " HTTP" < / span > < span class = "na" > host=< / span > < span class = "s" > " 127.0.0.1" < / span > < span class = "na" > port=< / span > < span class = "s" > " 6060" < / span > < span class = "na" > root=< / span > < span class = "s" > " root" < / span > < span class = "na" > lib=< / span > < span class = "s" > " " < / span > < span class = "nt" > > < / span >
< span class = "c" > < !-- < / span >
< span class = "c" > 加载所有的Service服务;< / span >
< span class = "c" > 在同一个进程中同一个name同一类型的Service将共用同一个实例< / span >
< span class = "c" > autoload=" true" 默认值. 自动加载以下目录（ ） < / span >
< span class = "c" > server.lib; server.lib/*; server.classes; < / span >
< span class = "c" > autoload=" false" 需要显著的指定Service类< / span >
< span class = "c" > includes： " true" ， < / span >
< span class = "c" > excludes： " true" ， < / span >
< span class = "c" > groups: 所属组的节点,多个节点值用;隔开， ， < / span >
< span class = "c" > 当 protocol == SNCP 时 group表示当前Server与哪些节点组关联。< / span >
< span class = "c" > 当 protocol != SNCP 时 group只能是空或者一个group的节点值， < / span >
< span class = "c" > --> < / span >
< span class = "nt" > < services< / span > < span class = "na" > autoload=< / span > < span class = "s" > " true" < / span > < span class = "na" > includes=< / span > < span class = "s" > " " < / span > < span class = "na" > excludes=< / span > < span class = "s" > " " < / span > < span class = "nt" > > < / span >
< span class = "c" > < !-- 显著加载指定的Service的接口类 --> < / span >
< span class = "nt" > < service< / span > < span class = "na" > value=< / span > < span class = "s" > " com.xxx.XXX1Service" < / span > < span class = "nt" > /> < / span >
< span class = "c" > < !-- < / span >
< span class = "c" > name: 显式指定name， < / span >
< span class = "c" > groups: 显式指定groups， < services> 节点的groups默认值。< / span >
< span class = "c" > --> < / span >
< span class = "nt" > < service< / span > < span class = "na" > value=< / span > < span class = "s" > " com.xxx.XXX2Service" < / span > < span class = "na" > name=< / span > < span class = "s" > " " < / span > < span class = "na" > groups=< / span > < span class = "s" > " xxx;yyy" < / span > < span class = "nt" > /> < / span >
< span class = "c" > < !-- 给Service增加配置属性 --> < / span >
< span class = "nt" > < service< / span > < span class = "na" > value=< / span > < span class = "s" > " com.xxx.XXX1Service" < / span > < span class = "nt" > > < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > " xxxxxx" < / span > < span class = "na" > value=< / span > < span class = "s" > " XXXXXXXX" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > " xxxxxx" < / span > < span class = "na" > value=< / span > < span class = "s" > " XXXXXXXX" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /service> < / span >
< span class = "nt" > < /services> < / span >
< span class = "c" > < !--< / span >
< span class = "c" > 当Server为HTTP协议时, request节点才有效。< / span >
< span class = "c" > remoteaddr 节点: 替换请求方节点的IP地址， < / span >
< span class = "c" > 且value值只能是以request.headers.开头， < / span >
< span class = "c" > 例如下面例子获取request.getRemoteAddr()值， ， < / span >
< span class = "c" > --> < / span >
< span class = "nt" > < request> < / span >
< span class = "nt" > < remoteaddr< / span > < span class = "na" > value=< / span > < span class = "s" > " request.headers.X-RemoteAddress" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /request> < / span >
< span class = "c" > < !--< / span >
< span class = "c" > 当Server为HTTP协议时, response节点才有效。< / span >
< span class = "c" > defcookie 节点: 当response里输出的cookie没有指定domain 和path时， < / span >
< span class = "c" > 如果addheader、setheader 的value值以request.headers.开头则表示从request.headers中获取对应的header值< / span >
< span class = "c" > 例如下面例子是在Response输出header时添加两个header（ ， ） < / span >
< span class = "c" > --> < / span >
< span class = "nt" > < response> < / span >
< span class = "nt" > < defcookie< / span > < span class = "na" > domain=< / span > < span class = "s" > " " < / span > < span class = "na" > path=< / span > < span class = "s" > " " < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < addheader< / span > < span class = "na" > name=< / span > < span class = "s" > " Access-Control-Allow-Origin" < / span > < span class = "na" > value=< / span > < span class = "s" > " request.headers.Origin" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < setheader< / span > < span class = "na" > name=< / span > < span class = "s" > " Access-Control-Allow-Credentials" < / span > < span class = "na" > value=< / span > < span class = "s" > " true" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /response> < / span >
< span class = "c" > < !-- < / span >
< span class = "c" > 加载所有的Servlet服务;< / span >
< span class = "c" > path: servlet的ContextPath前缀 默认为空< / span >
< span class = "c" > autoload=" true" 默认值. 自动加载以下目录（ ） < / span >
< span class = "c" > ${APP_HOME}/lib; ${APP_HOME}/root/lib/*; ${APP_HOME}/root/classes; < / span >
< span class = "c" > autoload=" false" 需要显著的指定Service类< / span >
< span class = "c" > includes： " true" ， < / span >
< span class = "c" > excludes： " true" ， < / span >
< span class = "c" > --> < / span >
< span class = "nt" > < servlets< / span > < span class = "na" > path=< / span > < span class = "s" > " /pipes" < / span > < span class = "na" > autoload=< / span > < span class = "s" > " true" < / span > < span class = "na" > includes=< / span > < span class = "s" > " " < / span > < span class = "na" > excludes=< / span > < span class = "s" > " " < / span > < span class = "nt" > > < / span >
< span class = "c" > < !-- < / span >
< span class = "c" > 当Server为HTTP协议时， < / span >
< span class = "c" > webroot: web资源的根目录, 默认取server节点中的root值< / span >
< span class = "c" > --> < / span >
< span class = "nt" > < resource-servlet< / span > < span class = "na" > webroot=< / span > < span class = "s" > " root" < / span > < span class = "nt" > > < / span >
< span class = "c" > < !--< / span >
< span class = "c" > 资源缓存的配置, 默认存在一个含默认属性的caches节点< / span >
< span class = "c" > limit: 资源缓存最大容量， 默认: 128M, 为0表示不缓存， ， < / span >
< span class = "c" > lengthmax: 可缓存的文件大小上限， 默认: 1M（ ） < / span >
< span class = "c" > --> < / span >
< span class = "nt" > < caches< / span > < span class = "na" > limit=< / span > < span class = "s" > " 128M" < / span > < span class = "na" > lengthmax=< / span > < span class = "s" > " 1M" < / span > < span class = "nt" > /> < / span >
< span class = "c" > < !--< / span >
< span class = "c" > 支持类似nginx中的rewrite， < / span >
< span class = "c" > type: 匹配的类型, 目前只支持location(匹配requestURI), 默认: location< / span >
< span class = "c" > match: 匹配的正则表达式< / span >
< span class = "c" > forward: 需跳转后的资源链接< / span >
< span class = "c" > 例如下面例子是将/xxx-yyy.html的页面全部跳转到/xxx.html< / span >
< span class = "c" > --> < / span >
< span class = "nt" > < rewrite< / span > < span class = "na" > type=< / span > < span class = "s" > " location" < / span > < span class = "na" > match=< / span > < span class = "s" > " ^/([^-]+)-[^-\.]+\.html(.*)" < / span > < span class = "na" > forward=< / span > < span class = "s" > " /$1.html" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /resource-servlet> < / span >
< span class = "c" > < !-- 显著加载指定的Servlet --> < / span >
< span class = "nt" > < servlet< / span > < span class = "na" > value=< / span > < span class = "s" > " com.xxx.XXX1Servlet" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < servlet< / span > < span class = "na" > value=< / span > < span class = "s" > " com.xxx.XXX2Servlet" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < servlet< / span > < span class = "na" > value=< / span > < span class = "s" > " com.xxx.XXX3Servlet" < / span > < span class = "nt" > > < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > " xxxxxx" < / span > < span class = "na" > value=< / span > < span class = "s" > " XXXXXXXX" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > " yyyyyy" < / span > < span class = "na" > value=< / span > < span class = "s" > " YYYYYYYY" < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /servlet> < / span >
< span class = "nt" > < /servlets> < / span >
< span class = "nt" > < /server> < / span >
< span class = "nt" > < server< / span > < span class = "na" > protocol=< / span > < span class = "s" > " SNCP" < / span > < span class = "na" > host=< / span > < span class = "s" > " 127.0.0.1" < / span > < span class = "na" > port=< / span > < span class = "s" > " 7070" < / span > < span class = "na" > root=< / span > < span class = "s" > " root" < / span > < span class = "na" > lib=< / span > < span class = "s" > " " < / span > < span class = "nt" > > < / span >
< span class = "c" > < !-- 参数完全同上 --> < / span >
< span class = "nt" > < services< / span > < span class = "na" > autoload=< / span > < span class = "s" > " true" < / span > < span class = "na" > includes=< / span > < span class = "s" > " " < / span > < span class = "na" > excludes=< / span > < span class = "s" > " " < / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /server> < / span >
< span class = "nt" > < /application> < / span >
< / pre > < / div >
< footer class = "site-footer" >
< span class = "site-footer-owner" > < a href = "https://github.com/wentch/redkale" > RedKale< / a > © < a href = "https://github.com/wentch" > wentch< / a > 欢迎加入RedKale技术交流QQ群: 527523235< / span >
wentch