1
mirror of https://github.com/CarmJos/EasyPlugin.git synced 2024-09-20 03:35:48 +00:00

[v1.3.6] 消息配置文件相关更新

- [A] 添加MessageBuilder,更方便构建参数
- [U] 采用 `Object...` 的形式传入参数
This commit is contained in:
Carm Jos 2022-02-25 22:12:00 +08:00
parent c575805c72
commit acea995996
16 changed files with 277 additions and 160 deletions

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>

View File

@ -1,6 +1,7 @@
package cc.carm.lib.easyplugin.configuration.language; package cc.carm.lib.easyplugin.configuration.language;
import cc.carm.lib.easyplugin.configuration.file.FileConfig; import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import cc.carm.lib.easyplugin.configuration.language.builder.EasyMessageBuilder;
import cc.carm.lib.easyplugin.configuration.values.ConfigValue; import cc.carm.lib.easyplugin.configuration.values.ConfigValue;
import cc.carm.lib.easyplugin.utils.ColorParser; import cc.carm.lib.easyplugin.utils.ColorParser;
import cc.carm.lib.easyplugin.utils.MessageUtils; import cc.carm.lib.easyplugin.utils.MessageUtils;
@ -14,106 +15,110 @@ import org.jetbrains.annotations.Nullable;
public class EasyMessage { public class EasyMessage {
@Nullable ConfigValue<String> configValue; @Nullable ConfigValue<String> configValue;
@Nullable String defaultValue; @Nullable String defaultValue;
@Nullable String[] messageParams; @Nullable String[] messageParams;
public EasyMessage() { public static EasyMessageBuilder builder() {
this(null); return new EasyMessageBuilder();
} }
public EasyMessage(@Nullable String defaultValue) { public EasyMessage() {
this(defaultValue, null); this(null);
} }
public EasyMessage(@Nullable String defaultValue, @Nullable String[] messageParams) { public EasyMessage(@Nullable String defaultValue) {
this.defaultValue = defaultValue; this(defaultValue, null);
this.messageParams = messageParams; }
}
public void initialize(@NotNull FileConfig source, @NotNull String sectionName) { public EasyMessage(@Nullable String defaultValue, @Nullable String[] messageParams) {
this.configValue = new ConfigValue<>(() -> source, sectionName, String.class, getDefaultValue()); this.defaultValue = defaultValue;
} this.messageParams = messageParams;
}
private @Nullable String getDefaultValue() { public void initialize(@NotNull FileConfig source, @NotNull String sectionName) {
return defaultValue; this.configValue = new ConfigValue<>(() -> source, sectionName, String.class, getDefaultValue());
} }
private @Nullable String[] getMessageParams() { private @Nullable String getDefaultValue() {
return messageParams; return defaultValue;
} }
private @NotNull String getDefaultMessages() { private @Nullable String[] getMessageParams() {
if (getDefaultValue() == null) return ""; return messageParams;
else return getDefaultValue(); }
}
private @NotNull String getMessages() { private @NotNull String getDefaultMessages() {
if (configValue == null) { if (getDefaultValue() == null) return "";
return getDefaultMessages(); else return getDefaultValue();
} else { }
return configValue.get();
}
}
public @NotNull String get(@Nullable CommandSender sender) { private @NotNull String getMessages() {
return get(sender, null); if (configValue == null) {
} return getDefaultMessages();
} else {
return configValue.get();
}
}
public @NotNull String get(@Nullable CommandSender sender, @Nullable Object[] values) { public @NotNull String get(@Nullable CommandSender sender) {
return get(sender, getMessageParams(), values); return get(sender, (Object[]) null);
} }
public @NotNull String get(@Nullable CommandSender sender, @Nullable String[] params, @Nullable Object[] values) { public @NotNull String get(@Nullable CommandSender sender, @Nullable Object... values) {
String messages = getMessages(); return get(sender, getMessageParams(), values);
if (sender == null || messages.length() < 1) return messages; }
params = params == null ? new String[0] : params;
values = values == null ? new Object[0] : values;
return ColorParser.parse(MessageUtils.setPlaceholders(sender, messages, params, values));
}
public void send(@Nullable CommandSender sender) { public @NotNull String get(@Nullable CommandSender sender, @Nullable String[] params, @Nullable Object[] values) {
send(sender, null); String messages = getMessages();
} if (sender == null || messages.length() < 1) return messages;
params = params == null ? new String[0] : params;
values = values == null ? new Object[0] : values;
return ColorParser.parse(MessageUtils.setPlaceholders(sender, messages, params, values));
}
public void send(@Nullable CommandSender sender, @Nullable Object[] values) { public void send(@Nullable CommandSender sender) {
send(sender, getMessageParams(), values); send(sender, (Object[]) null);
} }
public void send(@Nullable CommandSender sender, @Nullable String[] params, @Nullable Object[] values) { public void send(@Nullable CommandSender sender, @Nullable Object... values) {
String message = get(sender, params, values); send(sender, getMessageParams(), values);
if (message.length() < 1) return; }
MessageUtils.send(sender, message);
}
public void sendBar(@Nullable Player player) { public void send(@Nullable CommandSender sender, @Nullable String[] params, @Nullable Object[] values) {
sendBar(player, null); String message = get(sender, params, values);
} if (message.length() < 1) return;
MessageUtils.send(sender, message);
}
public void sendBar(@Nullable Player player, @Nullable Object[] values) { public void sendBar(@Nullable Player player) {
sendBar(player, getMessageParams(), values); sendBar(player, (Object[]) null);
} }
public void sendBar(@Nullable Player player, @Nullable String[] params, @Nullable Object[] values) { public void sendBar(@Nullable Player player, @Nullable Object... values) {
if (player == null) return; sendBar(player, getMessageParams(), values);
String message = get(player, params, values); }
if (message.length() < 1) return; public void sendBar(@Nullable Player player, @Nullable String[] params, @Nullable Object[] values) {
player.spigot().sendMessage(ChatMessageType.ACTION_BAR, TextComponent.fromLegacyText(get(player, params, values))); if (player == null) return;
} String message = get(player, params, values);
public void sendToAll() { if (message.length() < 1) return;
sendToAll(null); player.spigot().sendMessage(ChatMessageType.ACTION_BAR, TextComponent.fromLegacyText(get(player, params, values)));
} }
public void sendToAll(@Nullable Object[] values) { public void sendToAll() {
sendToAll(messageParams, values); sendToAll((Object[]) null);
} }
public void sendToAll(@Nullable String[] params, @Nullable Object[] values) { public void sendToAll(@Nullable Object... values) {
Bukkit.getOnlinePlayers().forEach(pl -> send(pl, params, values)); sendToAll(messageParams, values);
} }
public void sendToAll(@Nullable String[] params, @Nullable Object[] values) {
Bukkit.getOnlinePlayers().forEach(pl -> send(pl, params, values));
}
} }

View File

@ -1,6 +1,7 @@
package cc.carm.lib.easyplugin.configuration.language; package cc.carm.lib.easyplugin.configuration.language;
import cc.carm.lib.easyplugin.configuration.file.FileConfig; import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import cc.carm.lib.easyplugin.configuration.language.builder.EasyMessageListBuilder;
import cc.carm.lib.easyplugin.configuration.values.ConfigValueList; import cc.carm.lib.easyplugin.configuration.values.ConfigValueList;
import cc.carm.lib.easyplugin.utils.ColorParser; import cc.carm.lib.easyplugin.utils.ColorParser;
import cc.carm.lib.easyplugin.utils.MessageUtils; import cc.carm.lib.easyplugin.utils.MessageUtils;
@ -16,93 +17,97 @@ import java.util.List;
public class EasyMessageList { public class EasyMessageList {
@Nullable ConfigValueList<String> configValue; @Nullable ConfigValueList<String> configValue;
@Nullable String[] defaultValue; @Nullable String[] defaultValue;
@Nullable String[] messageParams; @Nullable String[] messageParams;
public EasyMessageList() { public static EasyMessageListBuilder builder() {
this((String[]) null); return new EasyMessageListBuilder();
} }
public EasyMessageList(@Nullable String... defaultValue) { public EasyMessageList() {
this(defaultValue, null); this((String[]) null);
} }
public EasyMessageList(@Nullable String[] defaultValue, public EasyMessageList(@Nullable String... defaultValue) {
@Nullable String[] messageParams) { this(defaultValue, null);
this.defaultValue = defaultValue; }
this.messageParams = messageParams;
}
public void initialize(FileConfig sourceConfig, String sectionName) { public EasyMessageList(@Nullable String[] defaultValue,
configValue = new ConfigValueList<>(() -> sourceConfig, sectionName, String.class, getDefaultValue()); @Nullable String[] messageParams) {
} this.defaultValue = defaultValue;
this.messageParams = messageParams;
}
private @Nullable String[] getDefaultValue() { public void initialize(FileConfig sourceConfig, String sectionName) {
return defaultValue; configValue = new ConfigValueList<>(() -> sourceConfig, sectionName, String.class, getDefaultValue());
} }
@Unmodifiable private @Nullable String[] getDefaultValue() {
private @NotNull List<String> getDefaultMessages() { return defaultValue;
if (getDefaultValue() == null) return new ArrayList<>(); }
else return Arrays.asList(getDefaultValue());
}
private @Nullable String[] getMessageParams() { @Unmodifiable
return messageParams; private @NotNull List<String> getDefaultMessages() {
} if (getDefaultValue() == null) return new ArrayList<>();
else return Arrays.asList(getDefaultValue());
}
private @NotNull List<String> getMessages() { private @Nullable String[] getMessageParams() {
if (configValue == null) { return messageParams;
return getDefaultMessages(); }
} else {
return configValue.get();
}
}
public @NotNull List<String> get(@Nullable CommandSender sender) { private @NotNull List<String> getMessages() {
return get(sender, null); if (configValue == null) {
} return getDefaultMessages();
} else {
return configValue.get();
}
}
public @NotNull List<String> get(@Nullable CommandSender sender, @Nullable Object[] values) { public @NotNull List<String> get(@Nullable CommandSender sender) {
return get(sender, getMessageParams(), values); return get(sender, (Object[]) null);
} }
public @NotNull List<String> get(@Nullable CommandSender sender, @Nullable String[] params, @Nullable Object[] values) { public @NotNull List<String> get(@Nullable CommandSender sender, @Nullable Object... values) {
if (sender == null) return getMessages(); return get(sender, getMessageParams(), values);
params = params == null ? new String[0] : params; }
values = values == null ? new Object[0] : values;
return ColorParser.parse(MessageUtils.setPlaceholders(sender, getMessages(), params, values)); public @NotNull List<String> get(@Nullable CommandSender sender, @Nullable String[] params, @Nullable Object[] values) {
} if (sender == null) return getMessages();
params = params == null ? new String[0] : params;
values = values == null ? new Object[0] : values;
public void send(@Nullable CommandSender sender) { return ColorParser.parse(MessageUtils.setPlaceholders(sender, getMessages(), params, values));
send(sender, null); }
}
public void send(@Nullable CommandSender sender, @Nullable Object[] values) { public void send(@Nullable CommandSender sender) {
send(sender, getMessageParams(), values); send(sender, (Object[]) null);
} }
public void send(@Nullable CommandSender sender, @Nullable String[] params, @Nullable Object[] values) { public void send(@Nullable CommandSender sender, @Nullable Object... values) {
List<String> messages = get(sender, params, values); send(sender, getMessageParams(), values);
if (messages.isEmpty()) return; }
if (messages.size() == 1 && messages.get(0).length() == 0) return; //空消息不再发送
MessageUtils.send(sender, messages);
}
public void sendToAll() { public void send(@Nullable CommandSender sender, @Nullable String[] params, @Nullable Object[] values) {
sendToAll(null); List<String> messages = get(sender, params, values);
} if (messages.isEmpty()) return;
if (messages.size() == 1 && messages.get(0).length() == 0) return; //空消息不再发送
MessageUtils.send(sender, messages);
}
public void sendToAll(@Nullable Object[] values) { public void sendToAll() {
sendToAll(messageParams, values); sendToAll((Object[]) null);
} }
public void sendToAll(@Nullable String[] params, @Nullable Object[] values) { public void sendToAll(@Nullable Object... values) {
Bukkit.getOnlinePlayers().forEach(pl -> send(pl, params, values)); sendToAll(messageParams, values);
} }
public void sendToAll(@Nullable String[] params, @Nullable Object[] values) {
Bukkit.getOnlinePlayers().forEach(pl -> send(pl, params, values));
}
} }

View File

@ -0,0 +1,51 @@
package cc.carm.lib.easyplugin.configuration.language.builder;
import cc.carm.lib.easyplugin.configuration.language.EasyMessage;
import org.jetbrains.annotations.Nullable;
import java.util.Arrays;
import java.util.Optional;
public class EasyMessageBuilder {
String content;
String[] params;
@Nullable String paramPrefix = "%(";
@Nullable String paramSuffix = ")";
public EasyMessageBuilder() {
}
EasyMessageBuilder contents(String content) {
this.content = content;
return this;
}
EasyMessageBuilder params(String... placeholders) {
this.params = placeholders;
return this;
}
public EasyMessageBuilder setParamPrefix(@Nullable String paramPrefix) {
this.paramPrefix = paramPrefix;
return this;
}
public EasyMessageBuilder setParamSuffix(@Nullable String paramSuffix) {
this.paramSuffix = paramSuffix;
return this;
}
public EasyMessageBuilder setParamFormat(@Nullable String paramPrefix, @Nullable String paramSuffix) {
this.paramPrefix = paramPrefix;
this.paramSuffix = paramSuffix;
return this;
}
public EasyMessage build() {
return new EasyMessage(this.content, Optional.ofNullable(this.params).map(params -> Arrays.stream(this.params).map(param -> paramPrefix + param + paramSuffix).toArray(String[]::new)).orElse(null));
}
}

View File

@ -0,0 +1,51 @@
package cc.carm.lib.easyplugin.configuration.language.builder;
import cc.carm.lib.easyplugin.configuration.language.EasyMessageList;
import org.jetbrains.annotations.Nullable;
import java.util.Arrays;
import java.util.Optional;
public class EasyMessageListBuilder {
String[] contents;
String[] params;
@Nullable String paramPrefix = "%(";
@Nullable String paramSuffix = ")";
public EasyMessageListBuilder() {
}
EasyMessageListBuilder contents(String... contents) {
this.contents = contents;
return this;
}
EasyMessageListBuilder params(String... placeholders) {
this.params = placeholders;
return this;
}
public EasyMessageListBuilder setParamPrefix(@Nullable String paramPrefix) {
this.paramPrefix = paramPrefix;
return this;
}
public EasyMessageListBuilder setParamSuffix(@Nullable String paramSuffix) {
this.paramSuffix = paramSuffix;
return this;
}
public EasyMessageListBuilder setParamFormat(@Nullable String paramPrefix, @Nullable String paramSuffix) {
this.paramPrefix = paramPrefix;
this.paramSuffix = paramSuffix;
return this;
}
public EasyMessageList build() {
return new EasyMessageList(this.contents, Optional.ofNullable(this.params).map(params -> Arrays.stream(this.params).map(param -> paramPrefix + param + paramSuffix).toArray(String[]::new)).orElse(null));
}
}

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
@ -54,7 +54,7 @@
<dependency> <dependency>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<artifactId>easysql-beecp</artifactId> <artifactId>easysql-beecp</artifactId>
<version>0.2.7</version> <version>0.3.8</version>
<optional>true</optional> <optional>true</optional>
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>

View File

@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<version>1.3.5</version> <version>1.3.6</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>

View File

@ -14,7 +14,7 @@
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-parent</artifactId> <artifactId>easyplugin-parent</artifactId>
<packaging>pom</packaging> <packaging>pom</packaging>
<version>1.3.5</version> <version>1.3.6</version>
<modules> <modules>
<module>easyplugin-main</module> <module>easyplugin-main</module>
@ -86,6 +86,11 @@
<url>https://repo1.maven.org/maven2/</url> <url>https://repo1.maven.org/maven2/</url>
</repository> </repository>
<repository>
<id>minebench-repo</id>
<url>https://repo.minebench.de/</url>
</repository>
<repository> <repository>
<id>sonatype</id> <id>sonatype</id>
<url>https://oss.sonatype.org/content/groups/public</url> <url>https://oss.sonatype.org/content/groups/public</url>