介绍
分布式ID生成器:
全局唯一ID作为一种唯一标识来区分数据,可用作订单号、用户ID等。ID生成器是生成全局唯一ID的工具,可封装为一种基础服务为其他业务提供服务。因此此项目就是用springboot封装ID生成器,让各种业务系统调用
雪花算法
ID生成算法有很多种,此项目是严格遵循Twitter开源的雪花算法来生成唯一性ID。 它是带有时间戳的全局唯一ID生成算法。有一套固定的ID格式,如下:
41位的时间戳(精确到毫秒,41位的长度可使用69年)10位的机器ID(10位长度最多支持1024个服务器节点部署)12位的计数序列号(12位支持每节点每毫秒最多生成4096个序列号)
使用
启动运行项目
根目录下执行maven命令
mvn clean install -DskipTests -Dmaven.test.skip=true
在id-generate-rest的target目录下找到打包生成的zip包,如下图
找到红线所指的zip包解压,然后放置到本地某一目录下,这里我是放置在我本机电脑根目录下。如下图
切换到终端窗口,进入bin目录,执行start.sh启动脚本 命令如下:
./start.shps -ef |grep restApplication
如果出现如下图情形,则证明项目启动成功
我设置的启动端口为10010,上下文名字为myID
在浏览器窗口输入http://localhost:10010/myID/swagger-ui.html 界面如下
使用Swagger查看和测试4个springboot封装的API接口,具体介绍Swagger中已有,下文我也会详细截图说明
API使用介绍
4个API接口
实时生成ID
如图,直接点击“try it out”按钮,不需要输入任何参数,返回long型ID
解析ID
如图,可用前一接口生成的ID,拷贝到输入框,然后直接点击“try it out”按钮,返回json格式字符串,包括时间戳,机器ID和序列号3个属性值
输入参数生成ID
输入json格式字符串,包括时间戳,机器ID和序列号3个属性值,返回long型ID。如下图 建议输入解析ID接口返回的json格式字符串,和前一接口是互逆操作
解析时间戳
输入时间戳值,返回具体的日期值,格式是yyyy-MM-dd HH:mm:ss。如下图 建议输入此前json格式字符串中时间戳值
脚本概述
start.sh
启动脚本内容如下
#!/bin/shecho -------------------------------------------echo start serverecho -------------------------------------------# 设置项目代码路径export CODE_HOME="/id-generate-rest"#日志路径export LOG_PATH="/Users/wujunshen/Downloads/id-generator"mkdir -p $LOG_PATH# 设置依赖路径export CLASSPATH="$CODE_HOME/classes:$CODE_HOME/lib/*"# java可执行文件位置export _EXECJAVA="$JAVA_HOME/bin/java"# JVM启动参数export JAVA_OPTS="-server -Xms8m -Xmx2048m "# 服务端端口、上下文、项目根配置export SERVER_INFO="-Dserver.port=10010 -Dserver.contextPath=/myID -Dserver.docBase=$CODE_HOME"# 启动类export MAIN_CLASS=com.wujunshen.rest.RestApplicationnohup $_EXECJAVA $JAVA_OPTS -classpath $CLASSPATH $SERVER_INFO $MAIN_CLASS >$LOG_PATH/id-generator.log 2>&1 &
CODE_HOME和LOG_PATH可自行根据zip包解压的目录进行配置修改。包括最后一行的日志文件名,都可修改。 启动类即springboot的Application启动类,相应JVM参数也可根据自身电脑硬件配置做增添修改。还有脚本中端口和上下文名需要和项目中/id-generate-rest/src/main/resources/application.properties文件中的server.port和server.context-path的值一致.
stop.sh
停止脚本内容如下
#日志路径export LOG_PATH="/Users/wujunshen/Downloads/id-generator"mkdir -p $LOG_PATH# 启动类export MAIN_CLASS=com.wujunshen.rest.RestApplicationecho -------------------------------------------echo stop server#所有相关进程PIDs=`jps -l | grep $MAIN_CLASS | awk '{print $1}'`#停止进程if [ -n "$PIDs" ]; thenfor PID in $PIDs; dokill $PIDecho "kill $PID"donefi#等待50秒for i in 1 10; doPIDs=`jps -l | grep $MAIN_CLASS | awk '{print $1}'`if [ ! -n "$PIDs" ]; thenecho "stop server success"echo -------------------------------------------breakfiecho "sleep 5s"sleep 5done#如果等待50秒还没有停止完,直接杀掉PIDs=`jps -l | grep $MAIN_CLASS | awk '{print $1}'`if [ -n "$PIDs" ]; thenfor PID in $PIDs; dokill -9 $PIDecho "kill -9 $PID"donefi