diff --git a/src/org/redkale/convert/ArrayDecoder.java b/src/org/redkale/convert/ArrayDecoder.java index f83e87f0e..447f91d7e 100644 --- a/src/org/redkale/convert/ArrayDecoder.java +++ b/src/org/redkale/convert/ArrayDecoder.java @@ -9,7 +9,8 @@ import java.lang.reflect.*; import java.util.*; /** - * 对象数组的序列化,不包含int[]、long[]这样的primitive class数组. + * 数组的反序列化操作类 + * 对象数组的反序列化,不包含int[]、long[]这样的primitive class数组。 * 数组长度不能超过 32767。 在BSON中数组长度设定的是short,对于大于32767长度的数组传输会影响性能,所以没有采用int存储。 * 支持一定程度的泛型。 * diff --git a/src/org/redkale/convert/ArrayEncoder.java b/src/org/redkale/convert/ArrayEncoder.java index d2aebd34b..b9875234b 100644 --- a/src/org/redkale/convert/ArrayEncoder.java +++ b/src/org/redkale/convert/ArrayEncoder.java @@ -8,7 +8,8 @@ package org.redkale.convert; import java.lang.reflect.*; /** - * 对象数组的反序列化,不包含int[]、long[]这样的primitive class数组. + * 数组的序列化操作类 + * 对象数组的序列化,不包含int[]、long[]这样的primitive class数组。 * 数组长度不能超过 32767。 在BSON中数组长度设定的是short,对于大于32767长度的数组传输会影响性能,所以没有必要采用int存储。 * 支持一定程度的泛型。 * diff --git a/src/org/redkale/convert/CollectionDecoder.java b/src/org/redkale/convert/CollectionDecoder.java index 65b1850d7..70d85bd04 100644 --- a/src/org/redkale/convert/CollectionDecoder.java +++ b/src/org/redkale/convert/CollectionDecoder.java @@ -11,7 +11,7 @@ import java.lang.reflect.Type; import java.util.Collection; /** - * 对象集合的反序列化. + * Collection的反序列化操作类 * 集合大小不能超过 32767。 在BSON中集合大小设定的是short,对于大于32767长度的集合传输会影响性能,所以没有采用int存储。 * 支持一定程度的泛型。 * diff --git a/src/org/redkale/convert/CollectionEncoder.java b/src/org/redkale/convert/CollectionEncoder.java index 2b8a8dfde..480a16c17 100644 --- a/src/org/redkale/convert/CollectionEncoder.java +++ b/src/org/redkale/convert/CollectionEncoder.java @@ -9,8 +9,8 @@ import java.lang.reflect.*; import java.util.Collection; /** - * 对象集合的序列化. - * 集合大小不能超过 32767。 在BSON中集合大小设定的是short,对于大于32767长度的集合传输会影响性能,所以没有采用int存储。 + * Collection的序列化操作类 + * 集合大小不能超过 32767。 在BSON中集合大小设定的是short,对于大于32767长度的集合传输会影响性能,故没有采用int存储。 * 支持一定程度的泛型。 * *
diff --git a/src/org/redkale/convert/Convert.java b/src/org/redkale/convert/Convert.java index 3d4589547..21c737530 100644 --- a/src/org/redkale/convert/Convert.java +++ b/src/org/redkale/convert/Convert.java @@ -6,7 +6,7 @@ package org.redkale.convert; /** - * 序列化操作类 + * 序列化/反序列化操作类 * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/ConvertEntity.java b/src/org/redkale/convert/ConvertEntity.java index 6911d03e7..eaea18f20 100644 --- a/src/org/redkale/convert/ConvertEntity.java +++ b/src/org/redkale/convert/ConvertEntity.java @@ -10,11 +10,13 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; import java.lang.annotation.*; /** - * 用于类名的别名, 类似javax.persistence.Table + * 用于类名的别名 * 该值必须是全局唯一 - * 使用场景: 当BSON序列化为了不指定class可以使用@ConvertEntity来取个别名。关联方法: Reader.readClassName() 和 Writer.writeClassName(String value) 。 + * 使用场景: 当BSON序列化为了不指定class可以使用@ConvertEntity来取个别名。关联方法: Reader.readClassName() 和 Writer.writeClassName(String value) 。 + * + *
+ * 详情见: https://redkale.org * - *
详情见: https://redkale.org * @author zhangjx */ @Inherited @@ -23,5 +25,10 @@ import java.lang.annotation.*; @Retention(RUNTIME) public @interface ConvertEntity { + /** + * 别名值 + * + * @return String + */ String value(); } diff --git a/src/org/redkale/convert/ConvertException.java b/src/org/redkale/convert/ConvertException.java index 024bf2948..31acf0e62 100644 --- a/src/org/redkale/convert/ConvertException.java +++ b/src/org/redkale/convert/ConvertException.java @@ -5,8 +5,11 @@ package org.redkale.convert; /** + * 序列化自定义异常类 + * + *
+ * 详情见: https://redkale.org * - *
详情见: https://redkale.org * @author zhangjx */ public class ConvertException extends RuntimeException { diff --git a/src/org/redkale/convert/ConvertFactory.java b/src/org/redkale/convert/ConvertFactory.java index fc2a5d45c..2ff1aae4c 100644 --- a/src/org/redkale/convert/ConvertFactory.java +++ b/src/org/redkale/convert/ConvertFactory.java @@ -17,6 +17,7 @@ import org.redkale.convert.ext.*; import org.redkale.util.*; /** + * 序列化模块的工厂类,用于注册自定义的序列化类型,获取Convert * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/ConvertType.java b/src/org/redkale/convert/ConvertType.java index f3e0bbe43..0f85dc8d8 100644 --- a/src/org/redkale/convert/ConvertType.java +++ b/src/org/redkale/convert/ConvertType.java @@ -6,8 +6,11 @@ package org.redkale.convert; /** + * 序列化类型枚举,结合@ConvertColumn使用 + * + *
+ * 详情见: https://redkale.org * - *
详情见: https://redkale.org * @author zhangjx */ public enum ConvertType { diff --git a/src/org/redkale/convert/DeMember.java b/src/org/redkale/convert/DeMember.java index a12bc8f1d..8732595c1 100644 --- a/src/org/redkale/convert/DeMember.java +++ b/src/org/redkale/convert/DeMember.java @@ -9,6 +9,7 @@ import java.lang.reflect.*; import org.redkale.util.Attribute; /** + * 字段的反序列化操作类 * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/Decodeable.java b/src/org/redkale/convert/Decodeable.java index 2a01eddac..98e9b933f 100644 --- a/src/org/redkale/convert/Decodeable.java +++ b/src/org/redkale/convert/Decodeable.java @@ -8,6 +8,7 @@ package org.redkale.convert; import java.lang.reflect.Type; /** + * 反序列化操作类 * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/EnMember.java b/src/org/redkale/convert/EnMember.java index 883ff0bcc..7f5739e31 100644 --- a/src/org/redkale/convert/EnMember.java +++ b/src/org/redkale/convert/EnMember.java @@ -9,6 +9,7 @@ import java.lang.reflect.*; import org.redkale.util.Attribute; /** + * 字段的序列化操作类 * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/Encodeable.java b/src/org/redkale/convert/Encodeable.java index 374781979..a6b591949 100644 --- a/src/org/redkale/convert/Encodeable.java +++ b/src/org/redkale/convert/Encodeable.java @@ -8,6 +8,7 @@ package org.redkale.convert; import java.lang.reflect.Type; /** + * 序列化操作类 * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/MapDecoder.java b/src/org/redkale/convert/MapDecoder.java index 9157c86c7..1caa2289f 100644 --- a/src/org/redkale/convert/MapDecoder.java +++ b/src/org/redkale/convert/MapDecoder.java @@ -11,6 +11,7 @@ import java.lang.reflect.Type; import java.util.Map; /** + * Map的反序列化操作类 * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/MapEncoder.java b/src/org/redkale/convert/MapEncoder.java index 687941ee5..d7be51a38 100644 --- a/src/org/redkale/convert/MapEncoder.java +++ b/src/org/redkale/convert/MapEncoder.java @@ -10,6 +10,7 @@ import java.lang.reflect.Type; import java.util.Map; /** + * Map的序列化操作类 * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/ObjectDecoder.java b/src/org/redkale/convert/ObjectDecoder.java index 93882cf3a..50ba2e3bd 100644 --- a/src/org/redkale/convert/ObjectDecoder.java +++ b/src/org/redkale/convert/ObjectDecoder.java @@ -13,6 +13,7 @@ import java.util.Set; import org.redkale.util.*; /** + * 自定义对象的反序列化操作类 * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/ObjectEncoder.java b/src/org/redkale/convert/ObjectEncoder.java index bf596676e..c604505aa 100644 --- a/src/org/redkale/convert/ObjectEncoder.java +++ b/src/org/redkale/convert/ObjectEncoder.java @@ -10,6 +10,7 @@ import java.util.*; import org.redkale.util.*; /** + * 自定义对象的序列化操作类 * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/Reader.java b/src/org/redkale/convert/Reader.java index 17a83b292..1b940f77b 100644 --- a/src/org/redkale/convert/Reader.java +++ b/src/org/redkale/convert/Reader.java @@ -6,6 +6,7 @@ package org.redkale.convert; /** + * 反序列化的数据读取流 * *
* 详情见: https://redkale.org @@ -42,6 +43,7 @@ public abstract class Reader { * 读取对象的类名, 返回 null 表示对象为null, 返回空字符串表示当前class与返回的class一致,返回非空字符串表示class是当前class的子类。 * * @param clazz 类名 + * * @return 返回字段数 */ public String readObjectB(final Class clazz) { @@ -86,6 +88,7 @@ public abstract class Reader { * 根据字段读取字段对应的DeMember * * @param members DeMember的全量集合 + * * @return 匹配的DeMember */ public abstract DeMember readFieldName(final DeMember[] members); diff --git a/src/org/redkale/convert/SimpledCoder.java b/src/org/redkale/convert/SimpledCoder.java index 7bccc8fa9..f198cdb92 100644 --- a/src/org/redkale/convert/SimpledCoder.java +++ b/src/org/redkale/convert/SimpledCoder.java @@ -9,6 +9,8 @@ import java.lang.reflect.ParameterizedType; import java.lang.reflect.Type; /** + * 简易类的序列化和反序列化操作类 + * 能序列化为Boolean、Number或者字符串的类视为简易类 * *
* 详情见: https://redkale.org diff --git a/src/org/redkale/convert/Writer.java b/src/org/redkale/convert/Writer.java index 3c36014aa..6306c0343 100644 --- a/src/org/redkale/convert/Writer.java +++ b/src/org/redkale/convert/Writer.java @@ -8,6 +8,7 @@ package org.redkale.convert; import org.redkale.util.Attribute; /** + * 序列化的数据输出流 * *
* 详情见: https://redkale.org @@ -37,7 +38,7 @@ public abstract class Writer { * @return boolean */ public abstract boolean needWriteClassName(); - + /** * 写入类名 * diff --git a/src/org/redkale/convert/bson/BsonConvert.java b/src/org/redkale/convert/bson/BsonConvert.java index 424a3bd27..e0e862ab5 100644 --- a/src/org/redkale/convert/bson/BsonConvert.java +++ b/src/org/redkale/convert/bson/BsonConvert.java @@ -15,21 +15,21 @@ import org.redkale.util.*; /** *
** BSON协议格式: - * 1). 基本数据类型: 直接转换成byte[] - * 2). SmallString(无特殊字符且长度小于256的字符串): length(1 byte) + byte[](utf8); 通常用于类名、字段名、枚举。 - * 3). String: length(4 bytes) + byte[](utf8); - * 4). 数组: length(4 bytes) + byte[]... - * 5). Object: - * 1. realclass (SmallString) (如果指定格式化的class与实体对象的class不一致才会有该值, 该值可以使用@ConvertEntity给其取个别名) - * 2. 空字符串(SmallString) - * 3. SIGN_OBJECTB 标记位,值固定为0xBB (short) - * 4. 循环字段值: + * 1) 基本数据类型: 直接转换成byte[] + * 2) SmallString(无特殊字符且长度小于256的字符串): length(1 byte) + byte[](utf8); 通常用于类名、字段名、枚举。 + * 3) String: length(4 bytes) + byte[](utf8); + * 4) 数组: length(4 bytes) + byte[]... + * 5) Object: + * 1、 realclass (SmallString) (如果指定格式化的class与实体对象的class不一致才会有该值, 该值可以使用@ConvertEntity给其取个别名) + * 2、 空字符串(SmallString) + * 3、 SIGN_OBJECTB 标记位,值固定为0xBB (short) + * 4、 循环字段值: * 4.1 SIGN_HASNEXT 标记位,值固定为1 (byte) * 4.2 字段类型; 1-9为基本类型和字符串; 101-109为基本类型和字符串的数组; 127为Object * 4.3 字段名 (SmallString) * 4.4 字段的值Object - * 5. SIGN_NONEXT 标记位,值固定为0 (byte) - * 6. SIGN_OBJECTE 标记位,值固定为0xEE (short) + * 5、 SIGN_NONEXT 标记位,值固定为0 (byte) + * 6、 SIGN_OBJECTE 标记位,值固定为0xEE (short) * *
diff --git a/src/org/redkale/convert/bson/BsonReader.java b/src/org/redkale/convert/bson/BsonReader.java
index b46036a40..e39881e47 100644
--- a/src/org/redkale/convert/bson/BsonReader.java
+++ b/src/org/redkale/convert/bson/BsonReader.java
@@ -5,7 +5,6 @@
*/
package org.redkale.convert.bson;
-import java.util.function.*;
import org.redkale.convert.*;
import static org.redkale.convert.Reader.SIGN_NULL;
import org.redkale.convert.ext.*;
@@ -42,19 +41,7 @@ public class BsonReader extends Reader {
}
public static ObjectPool
+ * 详情见: https://redkale.org
*
- * 详情见: https://redkale.org
* @author zhangjx
*/
public class Context {
private static final Charset UTF8 = Charset.forName("UTF-8");
+ //服务启动时间
protected final long serverStartTime;
+ //Server的线程池
protected final ExecutorService executor;
+ //ByteBuffer的容量,默认8K
protected final int bufferCapacity;
+ //ByteBuffer对象池
protected final ObjectPool
+ * 详情见: https://redkale.org
*
- * 详情见: https://redkale.org
* @author zhangjx
*/
@SuppressWarnings("unchecked")
diff --git a/src/org/redkale/net/PrepareServlet.java b/src/org/redkale/net/PrepareServlet.java
index 047a7adce..6cd757eae 100644
--- a/src/org/redkale/net/PrepareServlet.java
+++ b/src/org/redkale/net/PrepareServlet.java
@@ -14,6 +14,9 @@ import java.util.logging.*;
import org.redkale.util.*;
/**
+ * 根Servlet, 一个Server只能存在一个根Servlet
+ *
+ * 用于分发Request请求
*
*
* 详情见: https://redkale.org
diff --git a/src/org/redkale/net/ProtocolServer.java b/src/org/redkale/net/ProtocolServer.java
index aaa73afd2..5a8c17e53 100644
--- a/src/org/redkale/net/ProtocolServer.java
+++ b/src/org/redkale/net/ProtocolServer.java
@@ -13,6 +13,7 @@ import java.util.*;
import java.util.concurrent.*;
/**
+ * 协议底层Server
*
* 详情见: https://redkale.org
* @author zhangjx
diff --git a/src/org/redkale/net/Request.java b/src/org/redkale/net/Request.java
index c2353a811..4ef3133ee 100644
--- a/src/org/redkale/net/Request.java
+++ b/src/org/redkale/net/Request.java
@@ -11,6 +11,7 @@ import org.redkale.convert.bson.BsonConvert;
import org.redkale.convert.json.JsonConvert;
/**
+ * 协议请求对象
*
*
* 详情见: https://redkale.org
diff --git a/src/org/redkale/net/Response.java b/src/org/redkale/net/Response.java
index 8636b2f1e..aef96b5d0 100644
--- a/src/org/redkale/net/Response.java
+++ b/src/org/redkale/net/Response.java
@@ -10,6 +10,7 @@ import java.nio.channels.CompletionHandler;
import java.util.function.BiConsumer;
/**
+ * 协议响应对象
*
*
* 详情见: https://redkale.org
diff --git a/src/org/redkale/net/Servlet.java b/src/org/redkale/net/Servlet.java
index 26059a886..152478880 100644
--- a/src/org/redkale/net/Servlet.java
+++ b/src/org/redkale/net/Servlet.java
@@ -9,6 +9,7 @@ import org.redkale.util.AnyValue;
import java.io.IOException;
/**
+ * 协议请求处理类
*
*
* 详情见: https://redkale.org
diff --git a/src/org/redkale/net/WorkThread.java b/src/org/redkale/net/WorkThread.java
index 4f15b0763..c80a87598 100644
--- a/src/org/redkale/net/WorkThread.java
+++ b/src/org/redkale/net/WorkThread.java
@@ -8,8 +8,11 @@ package org.redkale.net;
import java.util.concurrent.*;
/**
+ * 协议处理的自定义线程类
+ *
+ *
+ * 详情见: https://redkale.org
*
- * 详情见: https://redkale.org
* @author zhangjx
*/
public class WorkThread extends Thread {
diff --git a/src/org/redkale/net/http/HttpPrepareServlet.java b/src/org/redkale/net/http/HttpPrepareServlet.java
index 81deb7223..ee575d90b 100644
--- a/src/org/redkale/net/http/HttpPrepareServlet.java
+++ b/src/org/redkale/net/http/HttpPrepareServlet.java
@@ -155,7 +155,7 @@ public class HttpPrepareServlet extends PrepareServlet
* 详情见: https://redkale.org
diff --git a/src/org/redkale/source/EntityCache.java b/src/org/redkale/source/EntityCache.java
index f34e82ac8..39cdd8a0c 100644
--- a/src/org/redkale/source/EntityCache.java
+++ b/src/org/redkale/source/EntityCache.java
@@ -17,6 +17,7 @@ import static org.redkale.source.FilterFunc.*;
import org.redkale.util.*;
/**
+ * Entity数据的缓存类
*
*
* 详情见: https://redkale.org
diff --git a/src/org/redkale/source/EntityInfo.java b/src/org/redkale/source/EntityInfo.java
index 96ec02dfc..ba94c728b 100644
--- a/src/org/redkale/source/EntityInfo.java
+++ b/src/org/redkale/source/EntityInfo.java
@@ -18,6 +18,7 @@ import static org.redkale.source.DataDefaultSource.*;
import org.redkale.util.*;
/**
+ * Entity操作类
*
*
* 详情见: https://redkale.org