1 Star 1 Fork 0

lhtzbj12 / snowflake-go

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Snowflake-Go

介绍

Snowflake-Go使用Golang实现了雪花算法(参考了美团Leaf项目,该项目采用JAVA实现),其解决了时钟回拨问题,基于Gin封装成Rest微服务,使用Nacos作为服务发现。雪花算法需要提供datacenterId和workerId,本项目直接简化成workerId,workerId为范围为0~1023,多副本部署时,需要保证各副本的workerId唯一,否则可能导致id重复(虽然概率很低),支持Zookeeper、环境变量、HostName等多种分配workerId的方式。

安装教程

  1. 在Docker运行

    直接通过下面的命令启动一个容器,运行Snowflake-Go

    # 使用环境变量方式提供workerId
    docker run --env "SNOWFLAKE_WORKER_ID=1" --env "DISCOVERY_ENABLED=false" -p 8074:8074 -d registry.cn-beijing.aliyuncs.com/lhtzbj12/snowflake-go

    使用curl命令请求一下接口

    # 获取1个id
    curl http://localhost:8074/id/get
    # 获取多个id
    curl http://localhost:8074/id/batch?count=100
    # 使用Zookeeper方式提供workerId
    docker run --env "WOKER_ID_PROVIDER=zookeeper" --env "ZOOKEEPER_CONN_STRING=localhost:2181" --env "DISCOVERY_ENABLED=false" -p 8074:8074 -d registry.cn-beijing.aliyuncs.com/lhtzbj12/snowflake-go
    # 使用HostName方式提供workerId
    docker run --env "WOKER_ID_PROVIDER=hostname" --hostname "id-gen-1" --env "DISCOVERY_ENABLED=false" -p 8074:8074 -d registry.cn-beijing.aliyuncs.com/lhtzbj12/snowflake-go
  2. Docker-Compose部署

    使用Docker-Compose部署时,需要提供docker-compose.yaml文件,可参考本项目下的文件docker-compose.yaml

    docker-compose -f docker-compose.yaml up
  3. 部署至K8s 在K8s集群里进行部署时,需要提供配置文件,可参考本项目下的文件k8s-statefulset.yaml。采用SatefulSet部署,Pod的HostName自动分配为XXX-0、XXX-1等,数字尾辍即可作为workerId。

    kubectl apply -f k8s-statefulset.yaml

环境变量说明

变量名称 默认值 说明
SERVER_PORT 8074 Gin服务启动后监听的端口
DISCOVERY_MICROSRV_NAME id-generator 微服务名称,用于服务发现、Zookeeper里创建节点等
DISCOVERY_ENABLED true 是否启用服务发现,即是否注册到Nacos(注册中心)里,提供微服务
DISCOVERY_SRV_ADDR localhost:8848 Nacos服务地址
DISCOVERY_NAMESPACE public Nacos中的命名空间
DISCOVERY_MICROSRV_HOST 应用启动时,往注册中心注册时,使用的IP
DISCOVERY_MICROSRV_PORT -1 应用启动时,往注册中心注册时,使用的端口,-1时将取 SERVER_PORT
WOKER_ID_PROVIDER envirnment 工作节点ID分配方式,值可以为 hostname envirnment zookeeper,如果为hostname,则要求服务器hostName类似 XXXX-1,XXXX-2等,后面的数字就是workerId,建议在k8s里使用StatefulSet部署
SNOWFLAKE_WORKER_ID 如果WOKER_ID_PROVIDER值为envirnment,可通过本环境变量设置work
ZOOKEEPER_CONN_STRING localhost:2181 如果WOKER_ID_PROVIDER值为zookeeper,可通过本环境变量设置Zookeeper连接字符串
DISCOVERY_MICROSRV_HEALTH_URL /health 健康检查地址,检查通过,才会往注册中心发出注册的请求

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Snowflake-Go使用Golang实现了雪花算法(参考了美团Leaf项目,该项目采用JAVA实现),其解决了时钟回拨问题,基于Gin封装成Rest微服务,使用Nacos作为服务发现。雪花算法需要提供datacenterId和workerId,本项目直接简化成workerId,workerId为范围为0~1023,多副本部署时,需要保证各副本的workerId唯一,否则可能导致id重复(虽然概 展开 收起
Go 等 3 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/lhtzbj12/snowflake-go.git
git@gitee.com:lhtzbj12/snowflake-go.git
lhtzbj12
snowflake-go
snowflake-go
main

搜索帮助