Ids

IDS

ICe Distribution Service

快速开发分布式服务器框架

IDS

快速开发分布式服务器框架
探索本项目的文档 »

查看Demo · 报告Bug · 提出新特性

本篇README.md面向开发者

目录

• 上手指南
  • 特点
  • 适用场景
  • 开发前的配置要求
  • 安装步骤
  • 新项目生成方法
• 文件目录说明
• 开发的架构
• 部署
• 使用到的框架
• 贡献者
  • 如何参与开源项目
• 版本说明
• 版本控制
• 作者
• 鸣谢

上手指南

特点

保持微服务理念前提下 完全不依赖中间件 一键启动 最大化节省服务器维护成本 让使用者精力集中到业务本身

麻雀虽小五脏俱全 只需要绑定一个端口 就可以实现 http websocket socket 等通讯手段 原生支持json protobuf等协议

支持静态资源访问 与vue天然结合

集成最简单数据库访问方式 用户可以无需关心数据库状态 原生支持mysql redis mongodb

低资源占用 体积小 启动快速 集成docker 一键部署

适用场景

中小型网站快速开发

网络游戏服务器

手机app,小程序,公众号服务器

admin后台开发

开发前的配置要求

1. Java Development Kit (JDK)

   • 安装 JDK 1.8 或更高版本。
   • 确保设置了正确的 JAVA_HOME 环境变量。

2. Maven

   • 安装 Maven 构建工具。
   • 版本要求：Maven 3.x。

3. Lombok 插件

   • 项目使用 Lombok，请确保 IDE 安装了 Lombok 插件，以提供注解支持。

4. 其他依赖

   • 根据项目需要，安装并配置相关依赖。详细信息可参考项目文档或相关文档链接。

安装步骤

1. Clone the repo

   git clone http://www.sencorsta.com:2203/ice/Ids.git
   

2. maven 导入pom文件

新项目生成方法

1,本地更新并安装idsArchetypes

mvn clean install -f idsArchetypes/pom.xml

2,执行下面脚本 (执行前先修改对应的变量)

mvn archetype:generate -DarchetypeGroupId=com.sencorsta -DarchetypeArtifactId=idsArchetypes -DinteractiveMode=false -Dversion=2.0-SNAPSHOT -Dpackage=com.sencorsta.ids -DgroupId=com.sencorsta -DartifactId=SuperMarioGame

文件目录说明

.
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           └── Main.java
│   │   └── resources/
│   │       ├── application.properties
│   │       └── ...
│   └── test/
│       ├── java/
│       │   └── com/
│       │       └── example/
│       │           └── MainTest.java
│       └── resources/
│           └── ...
├── target/
│   └── ...
├── Dockerfile
├── README.md
└── pom.xml

• src/main/java: 主要源代码目录。
• src/main/resources: 主要资源文件目录。
• src/test/java: 测试源代码目录。
• src/test/resources: 测试资源文件目录。
• target: 构建输出目录。
• Dockerfile: Docker 镜像构建文件。
• README.md: 项目文档。

开发的架构

部署

支持Dockerfile一键部署

使用到的框架

• netty
• jackson
• redisson
• hutool

贡献者

请阅读CONTRIBUTING.md 查阅为该项目做出贡献的开发者。

如何参与开源项目

贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是非常感谢的。

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

版本说明

ids1.0系列最高版本号v1.6.21 目前已经停止维护

ids2.0系列是船新重构版本 目前处于开发阶段....

版本控制

该项目使用Git进行版本管理。您可以在repository参看当前可用版本。

作者

ice

Email: icemaker88@gmail.com

知乎:ice   qq:123709547

您也可以在贡献者名单中参看所有参与该项目的开发者。

版权说明

该项目签署了MIT 授权许可，详情请参阅 LICENSE.txt

鸣谢

• GitHub Emoji Cheat Sheet
• Img Shields
• Choose an Open Source License
• GitHub Pages
• Animate.css