zihluwang
70 lines
2.9 KiB
Markdown
70 lines
2.9 KiB
Markdown
# Module `guid`
|
|
|
|
## Introduction
|
|
|
|
Module `guid` is a library that provides utilities for generating and working with globally unique
|
|
identifiers (GUIDs). GUIDs are globally unique across all devices and systems, making them ideal
|
|
for various use cases like database record keys, distributed systems, and tracking objects.
|
|
|
|
The `guid` module offers a reliable and efficient GUID generator, allowing developers to create
|
|
unique identifiers with low collision probability. It also provides features to customize the
|
|
format of generated GUIDs, making it flexible and suitable for different applications.
|
|
|
|
With `guid`, developers can easily integrate globally unique identifiers into their projects,
|
|
ensuring data integrity, avoiding duplicates, and simplifying the identification of objects across
|
|
various systems. The module is designed to be simple to use, highly performant, and compatible with
|
|
different programming languages and frameworks.
|
|
|
|
## Prerequisites
|
|
|
|
This whole `JDevKit` is developed by **JDK 17**, which means you have to use JDK 17 for
|
|
better experience.
|
|
|
|
## Installation
|
|
|
|
### If you are using `Maven`
|
|
|
|
It is quite simple to install this module by `Maven`. The only thing you need to do is find your
|
|
`pom.xml` file in the project, then find the `<dependencies>` node in the `<project>` node, and add
|
|
the following codes to `<dependencies>` node:
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>com.onixbyte</groupId>
|
|
<artifactId>devkit-utils</artifactId>
|
|
<version>${devkit-utils.version}</version>
|
|
</dependency>
|
|
```
|
|
|
|
And run `mvn dependency:get` in your project root folder(i.e., if your `pom.xml` is located at
|
|
`/path/to/your/project/pom.xml`, then your current work folder should be `/path/to/your/project`),
|
|
then `Maven` will automatically download the `jar` archive from `Maven Central Repository`. This
|
|
could be **MUCH EASIER** if you are using IDE(i.e., IntelliJ IDEA), the only thing you need to do
|
|
is click the refresh button of `Maven`.
|
|
|
|
If you are restricted using the Internet, and have to make `Maven` offline, you could follow the
|
|
following steps.
|
|
|
|
1. Download the `jar` file from any place you can get and transfer the `jar` files to your work
|
|
computer.
|
|
2. Move the `jar` files to your local `Maven` Repository as the path of
|
|
`/path/to/maven_local_repo/com/onixbyte/devkit-utils/`.
|
|
|
|
### If you are using `Gradle`
|
|
|
|
Add this module to your project with `Gradle` is much easier than doing so with `Maven`.
|
|
|
|
Find `build.gradle` in the needed project, and add the following code to the `dependencies` closure
|
|
in the build script:
|
|
|
|
```groovy
|
|
implementation 'com.onixbyte:guid:${guid.version}'
|
|
```
|
|
|
|
### If you are not using `Maven` or `Gradle`
|
|
|
|
1. Download the `jar` file from the Internet.
|
|
2. Create a folder in your project and name it as a name you like(i.e., for me, I prefer `vendor`).
|
|
3. Put the `jar` file to the folder you just created in Step 2.
|
|
4. Add this folder to your project `classpath`.
|