添加使用统计显示

- [U] 当物品不足时发送提示
- [A] 使用bStats进行数据统计

.documentation/README.md

@@ -14,5 +14,3 @@
 ## [开发文档](JAVADOC-README.md)
 
 基于 [Github Pages](https://pages.github.com/) 搭建，请访问 [JavaDoc](https://carmjos.github.io/UltraDepository) 。
-
-## 文档目录

.examples/depositories/README.md

@@ -1,8 +1,12 @@
-# UltraDepository 示例仓库配置
+# UltraDepository 预设仓库配置
+
+## 详细示例
+
+您可以 [点击这里](full-example.yml) 查看一份详细的示例。
 
 ## 使用须知
 
-示例配置基于 MineCraft 1.16 实现，更低版本可能无法使用。
+预设配置基于 MineCraft 1.16 实现，更低版本可能无法使用。
 
 ## 如何使用？
 
@@ -11,8 +15,7 @@
 3. 下载你想要的示例仓库配置文件，并放入 `插件配置目录/depositories` 下。
 4. 重启服务器，即可令对应的配置文件生效！
 
-
-## 示例图片
+## 预设配置截图
 
 ### 渔夫仓库 ([fishman.yml](files/fishman.yml))
 

.examples/depositories/full-example.yml

@@ -0,0 +1,48 @@
+
+name: "&b&l示例仓库" # 仓库名，用于消息显示
+
+capacity: # 容量配置
+  default: 500 # 若为0则默认不可以使用该仓库
+  permissions: # 特殊权限对应的仓库容量，格式为 "权限:容量
+    - "UltraDepository.vip:1000"
+    - "UltraDepository.mvp:1500"
+
+gui: # GUI额外配置
+  title: "&b&l示例仓库 &7| 界面" #示例仓库的GUI标题
+  lines: 4 # GUI的行数，支持 1-6行。
+  items:
+    "TEST":
+      material: CHEST # 物品图标的类型
+      data: 0 # 物品图标的数据值
+      slot: 31 # 在GUI中显示的格子
+      name: "&9&l测试图标"
+      lore:
+        # 支持使用变量
+        - "你好 %player_name% !"
+      actions: # 物品点击操作
+        - "[CHAT] Hello!" #以玩家身份发送Hello，支持PlaceholderAPI变量
+        - "[CHAT] /help" #若内容以"/"开头，则会以玩家身份执行指令,支持PlaceholderAPI变量
+        - "[CONSOLE] say HELLO WORLD" #以后台身份执行指令，不需要加"/"，支持PlaceholderAPI变量
+        - "[MESSAGE] &(#FFBBBBB)Test %player_name%" # 向玩家发送消息，支持PlaceholderAPI变量和RGB颜色
+        - "[SOUND] ENTITY_EXPERIENCE_ORB_PICKUP:0.5" # 向玩家发送声音，可以规定音量大小和音调，格式为 <声音>:[音量]:[音调]
+        - "[CLOSE]" # 为玩家关闭界面
+
+        - "[LEFT:CLOSE]" #限制只有 鼠标左键 才触发CLOSE
+        - "[SHIFT_LEFT:CLOSE]" #限制只有 按住Shift+鼠标左键 才触发CLOSE
+        - "[RIGHT:CLOSE]" #限制只有 鼠标右键 才触发CLOSE
+        - "[SHIFT_RIGHT:CLOSE]" #限制只有 按住Shift+鼠标右键 才触发CLOSE
+        - "[MIDDLE:CLOSE]" #限制只有 鼠标中键 才触发CLOSE
+        - "[DROP:CLOSE]" #限制只有 丢弃建 才触发CLOSE
+        - "[CONTROL_DROP:CLOSE]" #限制只有 按住Ctrl+丢弃键 才触发CLOSE
+        - "[DOUBLE_CLICK:CLOSE]" #限制只有 鼠标双击物品 才触发CLOSE
+        - "[NUMBER_KEY:CLOSE]" #限制只有 数字键切换 才触发CLOSE
+
+items:
+  "INK_SAC": #物品ID，若需要限制数据ID则可以加“:”,如 "INK_SANK:4"
+    slot: 11 # 物品在GUI中显示的槽位
+    price: 0.1 # 物品单价
+    limit: 500 # 物品每日售出限制
+    name: "&8&l墨囊" # 物品显示的名字
+    lore: # 物品的lore
+      - " "
+      - "&f抓住墨鱼！"

.examples/userdata/uuid.json

@@ -0,0 +1,41 @@
+{
+  "farmer": {},
+  "hunter": {
+    "CHICKEN:0": {
+      "amount": 3
+    },
+    "FEATHER:0": {
+      "amount": 2
+    }
+  },
+  "miner": {
+    "COAL:0": {
+      "amount": 9,
+      "sold": 10
+    },
+    "LAPIS_LAZULI:0": {
+      "amount": 9
+    },
+    "REDSTONE:0": {
+      "sold": 129
+    },
+    "COBBLESTONE:0": {
+      "amount": 12
+    },
+    "CLAY_BALL:0": {
+      "amount": 112
+    },
+    "DIAMOND:0": {
+      "amount": 975,
+      "sold": 1500
+    }
+  },
+  "fishman": {
+    "COD:0": {
+      "amount": 3
+    },
+    "PUFFERFISH:0": {
+      "amount": 64
+    }
+  }
+}

README.md

@@ -26,19 +26,27 @@
 
 ## 效果预览
 
-### 收集物品
+<details>
+<summary>收集物品</summary>
 
 ![collect](.documentation/images/collect-message.jpg)
 
-### 仓库界面 (可自定义配置)
+</details>
+
+<details>
+<summary>仓库界面 (可自定义配置)</summary>
 
 ![item-gui](.documentation/images/item-in-gui.png)
 
-### 出售界面
+</details>
+
+<details>
+<summary>出售界面</summary>
 
 ![sell-gui](.documentation/images/sell-gui.png)
 
 ![sell-message](.documentation/images/sell-message.png)
+</details>
 
 ## 插件依赖
 
@@ -179,79 +187,27 @@
 
 ## 配置文件
 
-### [插件配置文件](src/main/resources/config.yml) (config.yml)
+### 插件配置文件 ([config.yml](src/main/resources/config.yml))
 
 详见源文件。
 
-### [消息配置文件](src/main/resources/messages.yml) (messages.yml)
+### 消息配置文件 ([messages.yml](src/main/resources/messages.yml))
 
 详见源文件。
 
-### 仓库配置文件 (depositories/<ID>.yml)
+### 仓库配置文件 ([depositories/<仓库ID>.yml](.examples/depositories/full-example.yml))
 
 所有仓库配置均为单独的配置文件，存放于 `插件配置目录/depositories` 下，便于管理。
 
-文件名即仓库的ID，理论上可以随便取，但**强烈推荐**使用纯英文，部分符号可能会影响正常读取，请避免使用。
+文件名即仓库的ID，**强烈推荐使用纯英文**，部分符号可能会影响正常读取，请避免使用。
 
-这里准备了几个常用的仓库类型，可以 [在这里](.examples/depositories) 找到您需要的直接使用或加以修改后使用。
+随本项目预设了几个常用的仓库类型，可以 [在这里](.examples/depositories) 找到您需要的直接使用或加以修改后使用。
 
-您也可以查看下方的示例，看到所有相关的配置，以制作您自己的仓库。
-<details>
-<summary>展开查看示例仓库配置</summary>
+您也可以 [点击这里](.examples/depositories/full-example.yml) 查看一份*详细的仓库配置示例*，以制作您自己的仓库。
 
-```yaml
+## 使用统计
 
-name: "&b&l示例仓库" # 仓库名，用于消息显示
-
-capacity: # 容量配置
-  default: 500 # 若为0则默认不可以使用该仓库
-  permissions: # 特殊权限对应的仓库容量，格式为 "权限:容量
-    - "UltraDepository.vip:1000"
-    - "UltraDepository.mvp:1500"
-
-gui: # GUI额外配置
-  title: "&b&l示例仓库 &7| 界面" #示例仓库的GUI标题
-  lines: 4 # GUI的行数，支持 1-6行。
-  items:
-    "TEST":
-      material: CHEST # 物品图标的类型
-      data: 0 # 物品图标的数据值
-      slot: 31 # 在GUI中显示的格子
-      name: "&9&l测试图标"
-      lore:
-        # 支持使用变量
-        - "你好 %player_name% !"
-      actions: # 物品点击操作
-        - "[CHAT] Hello!" #以玩家身份发送Hello，支持PlaceholderAPI变量
-        - "[CHAT] /help" #若内容以"/"开头，则会以玩家身份执行指令,支持PlaceholderAPI变量
-        - "[CONSOLE] say HELLO WORLD" #以后台身份执行指令，不需要加"/"，支持PlaceholderAPI变量
-        - "[MESSAGE] &(#FFBBBBB)Test %player_name%" # 向玩家发送消息，支持PlaceholderAPI变量和RGB颜色
-        - "[SOUND] ENTITY_EXPERIENCE_ORB_PICKUP:0.5" # 向玩家发送声音，可以规定音量大小和音调，格式为 <声音>:[音量]:[音调]
-        - "[CLOSE]" # 为玩家关闭界面
-
-        - "[LEFT:CLOSE]" #限制只有 鼠标左键 才触发CLOSE
-        - "[SHIFT_LEFT:CLOSE]" #限制只有 按住Shift+鼠标左键 才触发CLOSE
-        - "[RIGHT:CLOSE]" #限制只有 鼠标右键 才触发CLOSE
-        - "[SHIFT_RIGHT:CLOSE]" #限制只有 按住Shift+鼠标右键 才触发CLOSE
-        - "[MIDDLE:CLOSE]" #限制只有 鼠标中键 才触发CLOSE
-        - "[DROP:CLOSE]" #限制只有 丢弃建 才触发CLOSE
-        - "[CONTROL_DROP:CLOSE]" #限制只有 按住Ctrl+丢弃键 才触发CLOSE
-        - "[DOUBLE_CLICK:CLOSE]" #限制只有 鼠标双击物品 才触发CLOSE
-        - "[NUMBER_KEY:CLOSE]" #限制只有 数字键切换 才触发CLOSE
-
-items:
-  "INK_SAC": #物品ID，若需要限制数据ID则可以加“:”,如 "INK_SANK:4" 
-    slot: 11 # 物品在GUI中显示的槽位
-    price: 0.1 # 物品单价
-    limit: 500 # 物品每日售出限制
-    name: "&8&l墨囊" # 物品显示的名字
-    lore: # 物品的lore
-      - " "
-      - "&f抓住墨鱼！"
-
-```
-
-</details>
+![bStats](https://bstats.org/signatures/bukkit/UltraDepository.svg)
 
 ## 支持与捐赠
 

pom.xml

@@ -14,7 +14,7 @@
     <groupId>cc.carm.plugin</groupId>
     <artifactId>ultradepository</artifactId>
     <packaging>jar</packaging>
-    <version>1.1.0</version>
+    <version>1.1.4</version>
 
     <name>UltraDepository</name>
     <description>超级仓库插件，支持设定不同物品的存储仓库。</description>
@@ -91,6 +91,13 @@
 
     <dependencies>
 
+        <dependency>
+            <groupId>org.bstats</groupId>
+            <artifactId>bstats-bukkit</artifactId>
+            <version>2.2.1</version>
+            <scope>compile</scope>
+        </dependency>
+
         <dependency>
             <groupId>cc.carm.lib</groupId>
             <artifactId>easysql-beecp</artifactId>
@@ -207,6 +214,20 @@
                     </execution>
                 </executions>
                 <configuration>
+                    <relocations>
+                        <relocation>
+                            <pattern>org.bstats</pattern>
+                            <shadedPattern>cc.carm.plugin.ultradepository.lib.bstats</shadedPattern>
+                        </relocation>
+                        <relocation>
+                            <pattern>cc.carm.lib.easysql</pattern>
+                            <shadedPattern>cc.carm.plugin.ultradepository.lib.easysql</shadedPattern>
+                        </relocation>
+                        <relocation>
+                            <pattern>cn.beecp</pattern>
+                            <shadedPattern>cc.carm.plugin.ultradepository.lib.beecp</shadedPattern>
+                        </relocation>
+                    </relocations>
                     <filters>
                         <filter>
                             <artifact>*:*</artifact>

src/main/java/cc/carm/plugin/ultradepository/Main.java

@@ -15,6 +15,8 @@ import cc.carm.plugin.ultradepository.storage.MySQLStorage;
 import cc.carm.plugin.ultradepository.util.ColorParser;
 import cc.carm.plugin.ultradepository.util.MessageUtil;
 import cc.carm.plugin.ultradepository.util.SchedulerUtils;
+import org.bstats.bukkit.Metrics;
+import org.bstats.charts.SingleLineChart;
 import org.bukkit.Bukkit;
 import org.bukkit.command.CommandExecutor;
 import org.bukkit.command.PluginCommand;
@@ -27,6 +29,7 @@ import org.jetbrains.annotations.Nullable;
 public class Main extends JavaPlugin {
 
 	private static Main instance;
+	private static Metrics metrics;
 	private static SchedulerUtils scheduler;
 
 	private static DataStorage storage;
@@ -94,6 +97,15 @@ public class Main extends JavaPlugin {
 			log("检测到未安装PlaceholderAPI，跳过变量注册。");
 		}
 
+		if (PluginConfig.METRICS.get()) {
+			log("启用统计数据...");
+			metrics = new Metrics(this, 13777);
+			metrics.addCustomChart(new SingleLineChart(
+					"active_depositories",
+					() -> getDepositoryManager().getDepositories().size())
+			);
+		}
+
 		initialized = true;
 		log("加载完成 ，共耗时 " + (System.currentTimeMillis() - startTime) + " ms 。");
 

src/main/java/cc/carm/plugin/ultradepository/configuration/PluginConfig.java

@@ -11,9 +11,14 @@ import org.bukkit.Material;
 public class PluginConfig {
 
 	public static final ConfigValue<Boolean> DEBUG = new ConfigValue<>(
-			"debug", Boolean.class
+			"debug", Boolean.class, false
 	);
 
+	public static final ConfigValue<Boolean> METRICS = new ConfigValue<>(
+			"metrics", Boolean.class, true
+	);
+
+
 	public static final ConfigValue<String> STORAGE_METHOD = new ConfigValue<>(
 			"storage.method", String.class
 	);

src/main/java/cc/carm/plugin/ultradepository/data/UserData.java

@@ -9,6 +9,8 @@ import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.sql.Date;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.UUID;
 
@@ -148,4 +150,21 @@ public class UserData {
 		this.storage.saveUserData(this);
 	}
 
+	public Map<String, Map<String, Map<String, Integer>>> serializeToMap() {
+		Map<String, Map<String, Map<String, Integer>>> values = new LinkedHashMap<>();
+
+		getDepositories().forEach((depositoryID, depositoryData) -> {
+			Map<String, Map<String, Integer>> depositoryDataMap = new LinkedHashMap<>();
+			depositoryData.getContents().forEach((itemType, itemData) -> {
+				Map<String, Integer> itemDataMap = new HashMap<>();
+				if (itemData.getAmount() > 0) itemDataMap.put("amount", itemData.getAmount());
+				if (itemData.getSold() > 0) itemDataMap.put("sold", itemData.getSold());
+				if (!itemDataMap.isEmpty()) depositoryDataMap.put(itemType, itemDataMap);
+			});
+			if (!depositoryDataMap.isEmpty()) values.put(depositoryID, depositoryDataMap);
+		});
+
+		return values;
+	}
+
 }

src/main/java/cc/carm/plugin/ultradepository/storage/FileStorage.java

@@ -15,8 +15,6 @@ import org.jetbrains.annotations.NotNull;
 import java.io.File;
 import java.io.IOException;
 import java.util.HashMap;
-import java.util.LinkedHashMap;
-import java.util.Map;
 import java.util.UUID;
 
 public class FileStorage implements DataStorage {
@@ -104,21 +102,8 @@ public class FileStorage implements DataStorage {
 		YamlConfiguration userDataConfig = new YamlConfiguration();
 		userDataConfig.set("date", data.getDateInt());
 
-		Map<String, Map<String, Map<String, Integer>>> values = new LinkedHashMap<>();
-
-		data.getDepositories().forEach((depositoryID, depositoryData) -> {
-			Map<String, Map<String, Integer>> depositoryDataMap = new LinkedHashMap<>();
-			depositoryData.getContents().forEach((itemType, itemData) -> {
-				Map<String, Integer> itemDataMap = new HashMap<>();
-				if (itemData.getAmount() > 0) itemDataMap.put("amount", itemData.getAmount());
-				if (itemData.getSold() > 0) itemDataMap.put("sold", itemData.getSold());
-				if (!itemDataMap.isEmpty()) depositoryDataMap.put(itemType, itemDataMap);
-			});
-			if (!depositoryDataMap.isEmpty()) values.put(depositoryID, depositoryDataMap);
-		});
-		
 		try {
-			userDataConfig.createSection("depositories", values);
+			userDataConfig.createSection("depositories", data.serializeToMap());
 			userDataConfig.save(new File(getDataContainer(), data.getUserUUID() + ".yml"));
 		} catch (IOException ioException) {
 			Main.error("在保存玩家 #" + data.getUserUUID() + " 的数据时出现异常。");

src/main/java/cc/carm/plugin/ultradepository/storage/MySQLStorage.java

@@ -18,7 +18,6 @@ import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
 import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
 
 import java.sql.Date;
 import java.sql.ResultSet;
@@ -133,12 +132,16 @@ public class MySQLStorage implements DataStorage {
 					for (Map.Entry<String, JsonElement> entry : dataElement.getAsJsonObject().entrySet()) {
 						Depository depository = Main.getDepositoryManager().getDepository(entry.getKey());
 						if (depository == null) continue;
+
 						DepositoryData contentsData = parseContentsData(depository, data, entry.getValue());
 						if (contentsData != null) data.setDepository(contentsData);
+
 					}
 				}
+
 				Main.debug("通过 MySQLStorage 加载 " + uuid + " 的用户数据完成，"
 						+ "耗时 " + (System.currentTimeMillis() - start) + "ms。");
+
 				return data;
 			}
 			Main.debug("当前库内不存在玩家 " + uuid + " 的数据，视作新档。");
@@ -153,15 +156,13 @@ public class MySQLStorage implements DataStorage {
 		long start = System.currentTimeMillis();
 		Main.debug("正通过 MySQLStorage 保存 " + data.getUserUUID() + " 的用户数据...");
 
-		JsonObject dataObject = new JsonObject();
-
-		data.getDepositories().forEach((id, contents) -> dataObject.add(id, serializeContentsData(contents)));
-
 		try {
+
 			getSQLManager().createReplace(SQLTables.USER_DATA.getName())
 					.setColumnNames("uuid", "data", "day")
-					.setParams(data.getUserUUID(), GSON.toJson(dataObject), data.getDate())
+					.setParams(data.getUserUUID(), GSON.toJson(data.serializeToMap()), data.getDate())
 					.execute();
+
 		} catch (SQLException exception) {
 			Main.error("在保存玩家 #" + data.getUserUUID() + " 的数据时出现异常。");
 			Main.error("Error occurred when saving #" + data.getUserUUID() + " data.");
@@ -191,10 +192,13 @@ public class MySQLStorage implements DataStorage {
 	private DepositoryData parseContentsData(Depository source, UserData owner, JsonObject contentsObject) {
 		DepositoryData data = DepositoryData.emptyContents(source, owner);
 		for (Map.Entry<String, JsonElement> entry : contentsObject.entrySet()) {
+
 			DepositoryItem item = source.getItems().get(entry.getKey());
 			if (item == null) continue;
+
 			DepositoryItemData itemData = parseItemData(item, data, entry.getValue());
 			if (itemData != null) data.getContents().put(item.getTypeID(), itemData);
+
 		}
 		return data;
 	}
@@ -207,26 +211,8 @@ public class MySQLStorage implements DataStorage {
 		int amount = itemObject.has("amount") ? itemObject.get("amount").getAsInt() : 0;
 		int sold = itemObject.has("sold") ? itemObject.get("sold").getAsInt() : 0;
 		if (amount == 0 && sold == 0) return null;
-		else return new DepositoryItemData(source, owner, amount, sold);
-	}
 
-	@Nullable
-	private JsonObject serializeContentsData(@Nullable DepositoryData contentsData) {
-		if (contentsData == null) return null;
-		JsonObject contentsObject = new JsonObject();
-		contentsData.getContents().entrySet().stream()
-				// 只存取有数值的部分，减少数据量
-				.filter(entry -> entry.getValue().getSold() > 0 || entry.getValue().getAmount() > 0)
-				.forEach(entry -> contentsObject.add(entry.getKey(), serializeItemData(entry.getValue())));
-		return contentsObject;
-	}
-
-	@NotNull
-	private JsonObject serializeItemData(@NotNull DepositoryItemData itemData) {
-		JsonObject itemObject = new JsonObject();
-		if (itemData.getAmount() > 0) itemObject.addProperty("amount", itemData.getAmount());
-		if (itemData.getSold() > 0) itemObject.addProperty("sold", itemData.getSold());
-		return itemObject;
+		return new DepositoryItemData(source, owner, amount, sold);
 	}
 
 }

src/main/java/cc/carm/plugin/ultradepository/ui/DepositoryGUI.java

@@ -59,7 +59,11 @@ public class DepositoryGUI extends GUI {
 		return new GUIItem(factory.toItemStack()) {
 			@Override
 			public void onClick(ClickType type) {
-				if (itemData.getAmount() < 1) return;
+				if (itemData.getAmount() < 1) {
+					PluginMessages.NO_ENOUGH_ITEM.send(player);
+					return;
+				}
+
 				if (type == ClickType.LEFT) {
 					player.closeInventory();
 					if (itemData.getAmount() >= 1) {
@@ -71,7 +75,6 @@ public class DepositoryGUI extends GUI {
 					} else {
 						PluginMessages.NO_ENOUGH_ITEM.send(player);
 					}
-
 				} else if (type == ClickType.RIGHT) {
 					player.closeInventory();
 					if (hasEmptySlot(player)) {
@@ -84,7 +87,6 @@ public class DepositoryGUI extends GUI {
 					} else {
 						PluginMessages.NO_SPACE.send(player);
 					}
-
 				}
 			}
 		};

src/main/resources/config.yml

@@ -6,12 +6,17 @@ version: ${project.version}
 
 debug: false
 
+# 统计数据设定
+# 改选项用于帮助开发者统计插件版本与使用情况，且绝不会影响性能与使用体验。
+# 当然，您也可以选择在这里关闭，或在plugins/bStats下的配置文件中关闭。
+metrics: true
+
 # 存储相关配置
 # 注意：存储配置不会通过重载指令生效，如有修改请重新启动服务器。
 storage:
 
   # 存储方式，可选 [ file | mysql ]
-  method: mysql
+  method: file
 
   # 选择 file 存储方式时的存储路径
   # 默认为相对路径，相对于插件生成的配置文件夹下的路径

src/test/java/GsonMapTest.java

@@ -0,0 +1,41 @@
+import com.google.gson.Gson;
+import org.junit.Test;
+
+import java.util.*;
+
+public class GsonMapTest {
+
+	private static final Gson GSON = new Gson();
+
+	@Test
+	public void test() {
+
+		Map<String, Map<String, Map<String, Integer>>> values = new LinkedHashMap<>();
+
+
+		for (int u = 0; u < 3; u++) {
+			Map<String, Map<String, Integer>> depositoryDataMap = new LinkedHashMap<>();
+			for (int i = 0; i < 5; i++) {
+				Map<String, Integer> itemDataMap = new HashMap<>();
+				int amount = Math.max(0, new Random().nextInt(15));
+				int sold = Math.max(0, new Random().nextInt(15));
+				if (amount > 0) itemDataMap.put("amount", amount);
+				if (sold > 0) itemDataMap.put("sold", sold);
+				if (!itemDataMap.isEmpty()) {
+					depositoryDataMap.put(UUID.randomUUID().toString().substring(0, 4), itemDataMap);
+				}
+			}
+			if (!depositoryDataMap.isEmpty()) {
+				values.put(UUID.randomUUID().toString().substring(0, 8), depositoryDataMap);
+			}
+		}
+
+		System.out.println(values.size());
+
+
+		String jsonValues = GSON.toJson(values);
+		System.out.println(jsonValues);
+	}
+
+
+}