# WiseToolkit

**Repository Path**: Chuanwise/WiseToolkit

## Basic Information

- **Project Name**: WiseToolkit
- **Description**: 椽子工具包
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-02-27
- **Last Updated**: 2022-02-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### WiseToolkit
# 椽子工具包

`WiseToolkit` 涵盖了椽子编写 `Java` 程序时的常用小工具。

## 文档

* [开发文档](./docs/README.md)
* [JavaDoc](http://chuanwise.gitee.io/wisetoolkit/)

> **QQ 群**：`小明练剑场`：[1028959718](https://jq.qq.com/?_wv=1027&k=sjBXo6xh) <br>
> **作者**：[`椽子`](https://github.com/Chuanwise)

## 使用方式

请在 `pom.xml` 中加入椽子的 `Maven` 中央仓库

```xml
<repositories>
    <!-- ... -->

    <repository>
        <id>chuanwise-maven</id>
        <url>https://gitee.com/Chuanwise/MavenCenter/raw/master/repository</url>
    </repository>

    <!-- ... -->
</repositories>
```

随后添加 `WiseToolkit` 的依赖：

```xml
<dependencies>
    <!-- ... -->
    
    <dependency>
        <groupId>cn.chuanwise</groupId>
        <artifactId>WiseToolkit</artifactId>
        <version>4.0.1-SNAPSHOT</version>

        <!-- 请根据需要选择范围，建议使用 compile -->
        <scope>compile</scope>
    </dependency>

    <!-- ... -->
</dependencies>
```

这里面的版本号 `4.0.1-SNAPSHOT` 不一定是最新的（文档偶尔才更新）。

最后，如果依赖范围不是 `provided`，别忘了添加打包插件。写好之后，你的 `pom.xml` 应该看起来像是这样：


这是一个 `pom.xml` 文件示意
```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>cn.chuanwise.xiaoming</groupId>
    <artifactId>XiaomingMinecraft</artifactId>
    <packaging>pom</packaging>
    <version>2.2</version>

    <repositories>
        <!-- 椽子的 Maven 仓库 -->
        <repository>
            <id>chuanwise-maven</id>
            <url>https://maven.chuanwise.cn</url>
        </repository>
    </repositories>

    <dependencies>
        <!-- WiseToolkit -->
        <dependency>
            <groupId>cn.chuanwise</groupId>
            <artifactId>WiseToolkit</artifactId>
            <version>4.0.1-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!-- 使用 maven-shade-plugin 将 WiseToolkit 打包进你的软件，并将依赖范围设置为 compile -->
            <!-- 或者保证软件运行时具备 WiseToolkit 的类，此时可以不使用打包插件，并将依赖范围设置为 provided -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.1.1</version>
                <configuration>
                    <!-- 最小化 Jar 包，可以避免将没有使用的其他 WiseToolkit 组件打包进插件增大插件体积 -->
                    <minimizeJar>true</minimizeJar>

                    <!-- 避免完整性校验，还可以进一步缩小 Jar 体积 -->
                    <filters>
                        <filter>
                            <artifact>*:*</artifact>
                            <excludes>
                                <exclude>META-INF/*.SF</exclude>
                                <exclude>META-INF/*.DSA</exclude>
                                <exclude>META-INF/*.RSA</exclude>
                            </excludes>
                        </filter>
                    </filters>

                    <!-- 可以加一些额外的 maven-shade 配置信息 -->
                </configuration>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>
```