Tinyid 开源项目使用教程

1. 项目的目录结构及介绍

Tinyid 项目的目录结构如下：

tinyid/
├── doc/
├── tinyid-base/
├── tinyid-client/
├── tinyid-server/
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── README.md
└── pom.xml

目录结构介绍

• doc/: 包含项目的文档文件。
• tinyid-base/: 基础模块，包含一些公共的类和接口。
• tinyid-client/: 客户端模块，提供 Java 客户端接入方式。
• tinyid-server/: 服务端模块，提供 REST API 服务。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• pom.xml: Maven 项目配置文件。

2. 项目的启动文件介绍

Tinyid 项目的启动文件主要位于 tinyid-server 模块中。以下是主要的启动文件：

• tinyid-server/src/main/java/com/xiaoju/uemc/tinyid/server/TinyIdServerApplication.java

启动文件介绍

TinyIdServerApplication.java 是 Tinyid 服务端的启动类，使用 Spring Boot 框架。通过运行该类，可以启动 Tinyid 服务端，提供 REST API 服务。

package com.xiaoju.uemc.tinyid.server;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class TinyIdServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(TinyIdServerApplication.class, args);
    }
}

3. 项目的配置文件介绍

Tinyid 项目的配置文件主要位于 tinyid-server 模块中。以下是主要的配置文件：

• tinyid-server/src/main/resources/application.properties

配置文件介绍

application.properties 是 Tinyid 服务端的配置文件，包含数据库连接、服务端口等配置信息。

# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/tinyid
spring.datasource.username=root
spring.datasource.password=root

# 服务端口
server.port=9999

# Tinyid 服务配置
tinyid.server=localhost:9999
tinyid.token=0f673adf80504e2eaa552f5d791b644c

以上配置文件中，spring.datasource 配置了数据库的连接信息，server.port 配置了服务端口，tinyid.server 和 tinyid.token 配置了 Tinyid 服务的地址和身份验证信息。

通过以上配置，可以启动 Tinyid 服务端，并提供 ID 生成服务。