editreadme

Java/README.md

@@ -1,4 +1,76 @@
-# idgenerator
-
-something is going on.
-
+
+## 运行环境
+
+JDK 1.8
+
+## 引用 maven 包
+```
+
+```
+
+## 调用示例
+```
+// 全局初始化设置WorkerId，默认最大2^16-1。（初始化过程全局只需一次，且必须最先设置）
+IdGeneratorOptions options = new IdGeneratorOptions();
+options.WorkerId = 1;
+IdHelper.setIdGenerator(options);
+
+// 初始化以后，就可以在需要的地方调用方法生成ID。
+long newId = IdHelper.nextId();
+
+```
+如果基于DI框架集成，可以参考 IdHelper 去管理 IdGenerator 对象，必须使用**单例**模式。
+
+## options说明
+```
+/**
+     * 雪花计算方法
+     * （1-漂移算法|2-传统算法），默认1
+     */
+    public short Method = 1;
+
+    /**
+     * 开始时间
+     * 不能超过当前系统时间
+     */
+    public long StartTime = 0;
+
+    /**
+     * 机器码，必须由外部系统设置
+     * 与 WorkerIdBitLength 有关系
+     */
+    public short WorkerId = 0;
+
+    /**
+     * 机器码位长
+     * 范围：2-21（要求：序列数位长+机器码位长不超过22）。
+     * 建议范围：6-12。
+     */
+    public byte WorkerIdBitLength = 6;
+
+    /**
+     * 序列数位长
+     * 范围：2-21（要求：序列数位长+机器码位长不超过22）。
+     * 建议范围：6-14。
+     */
+    public byte SeqBitLength = 6;
+
+    /**
+     * 最大序列数（含）
+     * （由SeqBitLength计算的最大值）
+     */
+    public short MaxSeqNumber = 0;
+
+    /**
+     * 最小序列数（含）
+     * 默认11，不小于5，不大于MaxSeqNumber-2
+     */
+    public short MinSeqNumber = 11;
+
+    /**
+     * 最大漂移次数（含）
+     * 默认2000，推荐范围500-10000（与计算能力有关）
+     */
+    public short TopOverCostCount = 2000;
+
+```

Java/source/src/main/java/com/yitter/contract/IdGeneratorException.java

@@ -17,6 +17,7 @@ public class IdGeneratorException extends RuntimeException {
     public IdGeneratorException(Throwable cause) {
         super(cause);
     }
+
     public IdGeneratorException(String message, Throwable cause) {
         super(message, cause);
     }

Java/source/src/main/java/com/yitter/contract/IdGeneratorOptions.java

@@ -9,6 +9,7 @@ package com.yitter.contract;
  * 此处代码不采用 get/set 那种冗长的写法
  */
 public class IdGeneratorOptions {
+
     /**
      * 雪花计算方法
      * （1-漂移算法|2-传统算法），默认1