1
mirror of https://github.com/CarmJos/EasyPlugin.git synced 2026-06-05 09:01:47 +08:00

Compare commits

..

12 Commits

Author SHA1 Message Date
carm 471bdab090 [v1.1.2] 版本更新
- [U] 对于可能为空的配置参数提供Optional方法
- [U] 将复用的方法提出为抽象类使用
- [U] 优化代码结构
2022-01-06 14:24:48 +08:00
carm 2628cb5c6a 修复格式错误 2022-01-05 05:29:05 +08:00
carm f7f382a874 [v1.1.1] 修复部署错误 2022-01-05 05:26:34 +08:00
carm c3119bb49a [v1.1.1] 修复部署错误 2022-01-05 05:25:59 +08:00
carm b753a5c331 移除CodeQL 2022-01-05 05:23:01 +08:00
carm eb073ce9dc 修复依赖 2022-01-05 05:19:40 +08:00
carm b2b5c41b86 修复依赖 2022-01-05 05:13:25 +08:00
carm 422d93eb1f 添加依赖方式介绍 2022-01-05 05:09:08 +08:00
carm 7be28a2c82 添加依赖方式介绍 2022-01-05 05:02:55 +08:00
carm fc948e7e24 [v1.1.0] 版本更新
- [U] 不再允许重写onLoad、onEnable与onDisable方法。
- [F] 修复GUI打开时的空指针异常。
- [A] 添加outputInfo方法,方便插件输出相关信息。
- [A] 添加 EasyPluginMessageProvider 用于实现多语言支持。
2022-01-05 03:55:49 +08:00
carm 33bef6b265 [v1.1.0] 版本更新
- [U] 不再允许重写onLoad、onEnable与onDisable方法。
- [F] 修复GUI打开时的空指针异常。
- [A] 添加outputInfo方法,方便插件输出相关信息。
- [A] 添加 EasyPluginMessageProvider 用于实现多语言支持。
2022-01-05 03:55:21 +08:00
carm 30832fc62b [v1.1.0] 版本更新
- [U] 不再允许重写onLoad、onEnable与onDisable方法。
- [F] 修复GUI打开时的空指针异常。
- [A] 添加outputInfo方法,方便插件输出相关信息。
- [A] 添加 EasyPluginMessageProvider 用于实现多语言支持。
2022-01-05 03:50:57 +08:00
29 changed files with 536 additions and 467 deletions
-70
View File
@@ -1,70 +0,0 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
on:
push:
branches: [ master ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ master ]
schedule:
- cron: '45 12 * * 1'
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: [ 'java' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://git.io/codeql-language-support
steps:
- name: Checkout repository
uses: actions/checkout@v2
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language
#- run: |
# make bootstrap
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
+3
View File
@@ -26,6 +26,9 @@ jobs:
- name: Generate docs
run: mvn clean package -DskipTests
env:
MAVEN_USERNAME: ${{ github.repository_owner }}
MAVEN_TOKEN: ${{secrets.GITHUB_TOKEN}}
- name: Copy to Location
run: |
+6
View File
@@ -21,8 +21,14 @@ jobs:
cache: maven
java-version: '11'
distribution: 'adopt'
server-id: github
server-username: MAVEN_USERNAME
server-password: MAVEN_TOKEN
- name: "Package"
run: mvn -B package --file pom.xml -Dmaven.javadoc.skip=true
env:
MAVEN_USERNAME: ${{ github.repository_owner }}
MAVEN_TOKEN: ${{secrets.GITHUB_TOKEN}}
- name: "Target Stage"
run: mkdir staging && cp */target/*.jar staging
- name: "Upload artifact"
+58 -17
View File
@@ -23,12 +23,14 @@
- 轻便独立的功能模块,按需使用,避免大量打包!
- 详细的Javadoc与使用文档,轻松上手,方便使用!
- 持续的更新与优化,需求不止,更新不止!
- 如需新功能支持,请 [点击这里](https://github.com/CarmJos/EasyPlugin/issues/new?assignees=&labels=enhancement&template=feature_issues.md&title=) 提交功能需求。
- 如需新功能支持,请通过 [Issues](https://github.com/CarmJos/EasyPlugin/issues) 提交功能需求。
## 内容
项目初创不久,加 * 的仍在开发更新中...
### 集合部分
- All [`easyplugin-all`](easyplugin-all)
- Common [`easyplugin-common`](easyplugin-common)
@@ -41,6 +43,7 @@
- GUI [`easyplugin-gui`](easyplugin-gui)
### 附属部分
- [PlaceholderAPI](https://www.spigotmc.org/resources/6245/)* [`easyplugin-placeholderapi`](easyplugin-placeholderapi)
- [Vault](https://github.com/MilkBowl/VaultAPI)* [`easyplugin-vault`](easyplugin-vault)
- [LuckPerms](https://www.spigotmc.org/resources/luckperms.28140/)* [`easyplugin-lp`](easyplugin-lp)
@@ -55,32 +58,30 @@
### 依赖方式
#### Maven 依赖
<details>
<summary>远程库配置</summary>
<summary>展开查看 Maven 依赖方式</summary>
```xml
<project>
<repositories>
<repository>
<!--采用github依赖库,安全稳定,但需要配置 (推荐)-->
<id>EasyPlugin</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/CarmJos/EasyPlugin</url>
</repository>
<repository>
<!--采用我的私人依赖库,简单方便,但可能因为变故而无法使用-->
<id>carm-repo</id>
<name>Carm's Repo</name>
<url>https://repo.carm.cc/repository/maven-public/</url>
</repository>
</repositories>
</project>
```
</details>
<details>
<summary>原生依赖</summary>
```xml
<project>
<dependencies>
<!--大全集版本,包含项目内所有模块-->
<dependency>
@@ -90,7 +91,15 @@
<scope>compile</scope>
</dependency>
<!--轻松插件主要接口集,包含方便的插件入口类与相关工具类。-->
<!--常用接口集,包含除附属插件模块外的所有模块-->
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-common</artifactId>
<version>[LATEST RELEASE]</version>
<scope>compile</scope>
</dependency>
<!--插件主要接口模块,包含方便的插件入口类与相关工具类-->
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-main</artifactId>
@@ -98,12 +107,44 @@
<scope>compile</scope>
</dependency>
<!-- 其他模块自行选择,详见 “内容”-->
</dependencies>
</project>
```
</details>
<details>
<summary>展开查看 Gradle 依赖方式</summary>
```groovy
repositories {
// 采用github依赖库,安全稳定,但需要配置 (推荐)
maven { url 'https://maven.pkg.github.com/CarmJos/EasyPlugin' }
// 采用我的私人依赖库,简单方便,但可能因为变故而无法使用
maven { url 'https://repo.carm.cc/repository/maven-public/' }
}
dependencies {
//大全集版本,包含项目内所有模块
api "cc.carm.lib:easyplugin-all:[LATEST RELEASE]"
//常用接口集,包含除附属插件模块外的所有模块
api "cc.carm.lib:easyplugin-common:[LATEST RELEASE]"
//插件主要接口模块,包含方便的插件入口类与相关工具类
api "cc.carm.lib:easyplugin-main:[LATEST RELEASE]"
// 其他模块自行选择,详见 “内容”
}
```
</details>
## 支持与捐赠
若您觉得本插件做的不错,您可以通过捐赠支持我!
@@ -126,8 +167,8 @@
> - 你可以自由使用,复制,修改,可以用于自己的项目。
> - 可以免费分发或用来盈利。
> - 唯一的限制是必须包含许可声明。
>
>
> MIT 协议是所有开源许可中最宽松的一个,除了必须包含许可声明外,再无任何限制。
>
>
> *以上文字来自 [五种开源协议GPL,LGPL,BSD,MIT,Apache](https://www.oschina.net/question/54100_9455) 。*
</details>
+2 -2
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.1.0</version>
<version>1.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -19,7 +19,7 @@
<artifactId>easyplugin-all</artifactId>
<packaging>jar</packaging>
<name>EasyPlugin-All</name>
<name>01-EasyPlugin-All</name>
<description>轻松插件全集,将打包全部工具类与工具接口。</description>
<url>https://github.com/CarmJos/EasyPlugin</url>
+3 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.1.0</version>
<version>1.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -17,6 +17,8 @@
</properties>
<artifactId>easyplugin-command</artifactId>
<packaging>jar</packaging>
<name>12-EasyPlugin-Command</name>
</project>
+3 -3
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.1.0</version>
<version>1.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -19,8 +19,8 @@
<artifactId>easyplugin-common</artifactId>
<packaging>jar</packaging>
<name>EasyPlugin-Main</name>
<description>轻松插件常用接口集,包含除附属模块外的所有模块。</description>
<name>02-EasyPlugin-Common</name>
<description>轻松插件常用接口集,包含除附属插件模块外的所有模块。</description>
<url>https://github.com/CarmJos/EasyPlugin</url>
<developers>
+2 -2
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.1.0</version>
<version>1.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -20,7 +20,7 @@
<packaging>jar</packaging>
<name>EasyPlugin-Configuration</name>
<name>11-EasyPlugin-Configuration</name>
<description>轻松插件配置模块,可以方便快捷的将配置文件作为静态参数使用。</description>
<url>https://github.com/CarmJos/EasyPlugin</url>
@@ -0,0 +1,58 @@
package cc.carm.lib.easyplugin.configuration.cast;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import cc.carm.lib.easyplugin.configuration.file.FileConfigCachedValue;
import org.bukkit.configuration.ConfigurationSection;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Optional;
import java.util.function.Function;
public class ConfigSectionCast<V> extends FileConfigCachedValue<V> {
@NotNull Function<ConfigurationSection, V> valueCast;
@Nullable V defaultValue;
public ConfigSectionCast(@NotNull String configSection,
@NotNull Function<ConfigurationSection, V> valueCast) {
this(configSection, valueCast, null);
}
public ConfigSectionCast(@NotNull String sectionName,
@NotNull Function<ConfigurationSection, V> valueCast,
@Nullable V defaultValue) {
this(null, sectionName, valueCast, defaultValue);
}
public ConfigSectionCast(@Nullable FileConfig source, @NotNull String sectionName,
@NotNull Function<ConfigurationSection, V> valueCast,
@Nullable V defaultValue) {
super(source, sectionName);
this.valueCast = valueCast;
this.defaultValue = defaultValue;
}
public @Nullable V get() {
V cached = getCachedValue();
if (cached != null && !isExpired()) {
return cached;
} else {
return getConfigOptional()
.map(config -> config.getConfigurationSection(getSectionName()))
.map(section -> updateCache(valueCast.apply(section)))
.orElse(defaultValue);
}
}
public @NotNull Optional<V> getOptional() {
return Optional.ofNullable(get());
}
public void set(ConfigurationSection section) {
}
}
@@ -0,0 +1,58 @@
package cc.carm.lib.easyplugin.configuration.cast;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import cc.carm.lib.easyplugin.configuration.file.FileConfigCachedValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Optional;
import java.util.function.Function;
public class ConfigStringCast<V> extends FileConfigCachedValue<V> {
@NotNull Function<String, V> valueCast;
@Nullable V defaultValue;
public ConfigStringCast(@NotNull String configSection,
@NotNull Function<String, V> valueCast) {
this(configSection, valueCast, null);
}
public ConfigStringCast(@NotNull String configSection,
@NotNull Function<String, V> valueCast,
@Nullable V defaultValue) {
this(null, configSection, valueCast, defaultValue);
}
public ConfigStringCast(@Nullable FileConfig source, @NotNull String sectionName,
@NotNull Function<String, V> valueCast,
@Nullable V defaultValue) {
super(source, sectionName);
this.valueCast = valueCast;
this.defaultValue = defaultValue;
}
public @Nullable V get() {
V cached = getCachedValue();
if (cached != null && !isExpired()) {
return cached;
} else {
return getConfigOptional()
.map(config -> config.getString(getSectionName()))
.map(s -> updateCache(valueCast.apply(s)))
.orElse(defaultValue);
}
}
public @NotNull Optional<V> getOptional() {
return Optional.ofNullable(get());
}
public void set(@Nullable String value) {
getSourceOptional().ifPresent(source -> {
source.getConfig().set(getSectionName(), value);
source.save();
});
}
}
@@ -0,0 +1,42 @@
package cc.carm.lib.easyplugin.configuration.file;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public abstract class FileConfigCachedValue<V> extends FileConfigValue {
protected V cachedValue;
protected long updateTime;
public FileConfigCachedValue(@NotNull String sectionName) {
super(sectionName);
}
public FileConfigCachedValue(@Nullable FileConfig source, @NotNull String sectionName) {
super(source, sectionName);
}
public V updateCache(V value) {
this.updateTime = System.currentTimeMillis();
this.cachedValue = value;
return getCachedValue();
}
public boolean isExpired() {
return getSource() == null || getSource().isExpired(this.updateTime);
}
public long getUpdateTime() {
return updateTime;
}
@Nullable
public V getCachedValue() {
return cachedValue;
}
public void clearCache() {
this.cachedValue = null;
}
}
@@ -0,0 +1,51 @@
package cc.carm.lib.easyplugin.configuration.file;
import org.bukkit.configuration.file.FileConfiguration;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Optional;
public abstract class FileConfigValue {
protected @Nullable FileConfig source;
private final @NotNull String sectionName;
public FileConfigValue(@NotNull String sectionName) {
this(null, sectionName);
}
public FileConfigValue(@Nullable FileConfig source, @NotNull String sectionName) {
this.source = source;
this.sectionName = sectionName;
}
public @NotNull String getSectionName() {
return sectionName;
}
public void save() {
getSourceOptional().ifPresent(FileConfig::save);
}
public @Nullable FileConfig getSource() {
return source == null ? FileConfig.getPluginConfiguration() : source;
}
public Optional<FileConfig> getSourceOptional() {
return Optional.ofNullable(getSource());
}
public Optional<FileConfiguration> getConfigOptional() {
return getSourceOptional().map(FileConfig::getConfig);
}
public static @Nullable <V> V castValue(@Nullable Object val, @NotNull Class<V> clazz) {
return castValue(val, clazz, null);
}
public static @Nullable <V> V castValue(@Nullable Object val, @NotNull Class<V> clazz, @Nullable V defaultValue) {
return clazz.isInstance(val) ? clazz.cast(val) : defaultValue;
}
}
@@ -1,73 +0,0 @@
package cc.carm.lib.easyplugin.configuration.impl;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import org.bukkit.configuration.ConfigurationSection;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.function.Function;
public class ConfigSectionCast<V> {
@Nullable FileConfig source;
@NotNull String configSection;
@NotNull Function<ConfigurationSection, V> valueCast;
@Nullable V defaultValue;
V valueCache;
long updateTime;
public ConfigSectionCast(@NotNull String configSection, @NotNull Function<ConfigurationSection, V> valueCast) {
this(configSection, valueCast, null);
}
public ConfigSectionCast(@NotNull String configSection,
@NotNull Function<ConfigurationSection, V> valueCast,
@Nullable V defaultValue) {
this(null, configSection, valueCast, defaultValue);
}
public ConfigSectionCast(@Nullable FileConfig source, @NotNull String configSection,
@NotNull Function<ConfigurationSection, V> valueCast,
@Nullable V defaultValue) {
this.source = source;
this.configSection = configSection;
this.valueCast = valueCast;
this.defaultValue = defaultValue;
}
public @Nullable V get() {
FileConfig source = getSource();
if (source == null) return defaultValue;
if (valueCache != null && !source.isExpired(this.updateTime)) return valueCache;
if (!source.getConfig().contains(this.configSection)) return defaultValue;
try {
V finalValue = this.valueCast.apply(source.getConfig().getConfigurationSection(this.configSection));
if (finalValue != null) {
this.valueCache = finalValue;
this.updateTime = System.currentTimeMillis();
return finalValue;
} else {
return defaultValue;
}
} catch (Exception ignore) {
return defaultValue;
}
}
public void set(ConfigurationSection section) {
}
public void save() {
if (getSource() != null) getSource().save();
}
public @Nullable FileConfig getSource() {
return source == null ? FileConfig.getPluginConfiguration() : source;
}
}
@@ -1,5 +1,6 @@
package cc.carm.lib.easyplugin.configuration.impl;
import cc.carm.lib.easyplugin.configuration.cast.ConfigStringCast;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import org.bukkit.Bukkit;
import org.bukkit.Sound;
@@ -7,6 +8,8 @@ import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.function.Function;
public class ConfigSound extends ConfigStringCast<ConfigSound.SoundData> {
public ConfigSound(@NotNull String configSection) {
@@ -18,30 +21,9 @@ public class ConfigSound extends ConfigStringCast<ConfigSound.SoundData> {
this(null, configSection, defaultValue);
}
public ConfigSound(@Nullable FileConfig source, @NotNull String configSection, @Nullable Sound defaultValue) {
super(source, configSection, string -> {
Sound finalSound = defaultValue;
float volume = 1;
float pitch = 1;
if (string != null) {
String[] args = string.contains(":") ? string.split(":") : new String[]{string};
try {
if (args.length >= 1) finalSound = Sound.valueOf(args[0]);
if (args.length >= 2) volume = Float.parseFloat(args[1]);
if (args.length >= 3) pitch = Float.parseFloat(args[2]);
} catch (Exception exception) {
Bukkit.getLogger().severe("声音 " + configSection + " 配置错误,不存在 " + string + " ,请检查。");
Bukkit.getLogger().severe("In " + configSection + " (" + string + ") doesn't match any sound name.");
}
}
if (finalSound != null) {
return new SoundData(finalSound, volume, pitch);
} else {
return null;
}
}, defaultValue == null ? null : new SoundData(defaultValue));
public ConfigSound(@Nullable FileConfig source, @NotNull String configSection,
@Nullable Sound defaultValue) {
super(source, configSection, getSoundParser(), defaultValue == null ? null : new SoundData(defaultValue));
}
public void set(@Nullable SoundData value) {
@@ -73,12 +55,38 @@ public class ConfigSound extends ConfigStringCast<ConfigSound.SoundData> {
if (data != null) data.play(player);
}
public void save() {
if (getSource() != null) getSource().save();
public void playToAll() {
SoundData data = get();
if (data != null) {
Bukkit.getOnlinePlayers().forEach(data::play);
}
}
public @Nullable FileConfig getSource() {
return source == null ? FileConfig.getPluginConfiguration() : source;
public static @NotNull Function<@Nullable String, @Nullable SoundData> getSoundParser() {
return string -> {
if (string == null) return null;
Sound finalSound = null;
float volume = 1;
float pitch = 1;
String[] args = string.contains(":") ? string.split(":") : new String[]{string};
try {
if (args.length >= 1) finalSound = Sound.valueOf(args[0]);
if (args.length >= 2) volume = Float.parseFloat(args[1]);
if (args.length >= 3) pitch = Float.parseFloat(args[2]);
} catch (Exception exception) {
Bukkit.getLogger().severe("声音 " + string + " 配置错误,不存在同名声音,请检查。");
Bukkit.getLogger().severe("Sound " + string + " doesn't match any sound name.");
}
if (finalSound != null) {
return new SoundData(finalSound, volume, pitch);
} else {
return null;
}
};
}
public static class SoundData {
@@ -1,76 +0,0 @@
package cc.carm.lib.easyplugin.configuration.impl;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.function.Function;
public class ConfigStringCast<V> {
@Nullable FileConfig source;
@NotNull String configSection;
@NotNull Function<String, V> valueCast;
@Nullable V defaultValue;
V valueCache;
long updateTime;
public ConfigStringCast(@NotNull String configSection, @NotNull Function<String, V> valueCast) {
this(configSection, valueCast, null);
}
public ConfigStringCast(@NotNull String configSection, @NotNull Function<String, V> valueCast, @Nullable V defaultValue) {
this(null, configSection, valueCast, defaultValue);
}
public ConfigStringCast(@Nullable FileConfig source, @NotNull String configSection,
@NotNull Function<String, V> valueCast, @Nullable V defaultValue) {
this.source = source;
this.configSection = configSection;
this.valueCast = valueCast;
this.defaultValue = defaultValue;
}
public @Nullable V get() {
FileConfig source = getSource();
if (source == null) return defaultValue;
if (valueCache != null && !source.isExpired(this.updateTime)) return valueCache;
if (!source.getConfig().contains(this.configSection)) return defaultValue;
try {
V finalValue = this.valueCast.apply(source.getConfig().getString(this.configSection));
if (finalValue != null) {
this.valueCache = finalValue;
this.updateTime = System.currentTimeMillis();
return finalValue;
} else {
return defaultValue;
}
} catch (Exception ignore) {
return defaultValue;
}
}
public void set(@Nullable String value) {
FileConfig source = getSource();
if (source != null) {
source.getConfig().set(this.configSection, value);
source.save();
}
}
public void save() {
if (getSource() != null) {
getSource().save();
}
}
public @Nullable FileConfig getSource() {
return source == null ? FileConfig.getPluginConfiguration() : source;
}
}
@@ -4,47 +4,50 @@ package cc.carm.lib.easyplugin.configuration.message;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import cc.carm.lib.easyplugin.configuration.values.ConfigValue;
import cc.carm.lib.easyplugin.utils.MessageUtils;
import org.bukkit.Bukkit;
import org.bukkit.command.CommandSender;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collections;
import java.util.List;
public class ConfigMessage extends ConfigValue<String> {
String[] messageParams;
public ConfigMessage(@NotNull String configSection) {
this(configSection, null);
public ConfigMessage(@NotNull String sectionName) {
this(sectionName, null);
}
public ConfigMessage(@NotNull String configSection, @Nullable String defaultValue) {
this(configSection, defaultValue, null);
public ConfigMessage(@NotNull String sectionName, @Nullable String defaultValue) {
this(sectionName, defaultValue, null);
}
public ConfigMessage(@NotNull String configSection, @Nullable String defaultValue, String[] messageParams) {
super(null, configSection, String.class, defaultValue);
public ConfigMessage(@NotNull String sectionName, @Nullable String defaultValue, String[] messageParams) {
super(null, sectionName, String.class, defaultValue);
this.messageParams = messageParams;
}
public ConfigMessage(@Nullable FileConfig config, @NotNull String configSection,
public ConfigMessage(@Nullable FileConfig source, @NotNull String sectionName,
@Nullable String defaultValue, String[] messageParams) {
super(config, configSection, String.class, defaultValue);
super(source, sectionName, String.class, defaultValue);
this.messageParams = messageParams;
}
public @NotNull String get(CommandSender sender) {
return MessageUtils.setPlaceholders(sender, get());
}
public @NotNull String get(CommandSender sender, Object[] values) {
if (messageParams != null) {
return get(sender, messageParams, values);
} else {
return get(sender, new String[0], new Object[0]);
return get(sender);
}
}
public @NotNull String get(CommandSender sender, String[] params, Object[] values) {
List<String> messages = MessageUtils.setPlaceholders(sender, Collections.singletonList(get()), params, values);
return messages != null && !messages.isEmpty() ? messages.get(0) : "";
return MessageUtils.setPlaceholders(sender, get(), params, values);
}
public void send(CommandSender sender) {
@@ -64,6 +67,23 @@ public class ConfigMessage extends ConfigValue<String> {
MessageUtils.sendWithPlaceholders(sender, Collections.singletonList(get()), params, values);
}
public void sendToAll() {
Bukkit.getOnlinePlayers().forEach(player -> MessageUtils.sendWithPlaceholders(player, Collections.singletonList(get())));
}
public void sendToAll(Object[] values) {
if (messageParams != null) {
sendToAll(messageParams, values);
} else {
sendToAll();
}
}
public void sendToAll(String[] params, Object[] values) {
Bukkit.getOnlinePlayers().forEach(pl -> MessageUtils.sendWithPlaceholders(pl, Collections.singletonList(get()), params, values));
}
@Override
public @Nullable FileConfig getSource() {
return source == null ? FileConfig.getMessageConfiguration() : source;
}
@@ -4,6 +4,7 @@ package cc.carm.lib.easyplugin.configuration.message;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import cc.carm.lib.easyplugin.configuration.values.ConfigValueList;
import cc.carm.lib.easyplugin.utils.MessageUtils;
import org.bukkit.Bukkit;
import org.bukkit.command.CommandSender;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -14,22 +15,22 @@ public class ConfigMessageList extends ConfigValueList<String> {
@Nullable String[] messageParams;
public ConfigMessageList(String configSection) {
this(configSection, new String[0]);
public ConfigMessageList(String sectionName) {
this(sectionName, new String[0]);
}
public ConfigMessageList(@NotNull String configSection, @Nullable String[] defaultValue) {
this(configSection, defaultValue, null);
public ConfigMessageList(@NotNull String sectionName, @Nullable String[] defaultValue) {
this(sectionName, defaultValue, null);
}
public ConfigMessageList(@NotNull String configSection, @Nullable String[] defaultValue, String[] messageParams) {
super(null, configSection, String.class, defaultValue);
public ConfigMessageList(@NotNull String sectionName, @Nullable String[] defaultValue, String[] messageParams) {
super(null, sectionName, String.class, defaultValue);
this.messageParams = messageParams;
}
public ConfigMessageList(@Nullable FileConfig config, @NotNull String configSection,
public ConfigMessageList(@Nullable FileConfig source, @NotNull String sectionName,
@Nullable String[] defaultValue, String[] messageParams) {
super(config, configSection, String.class, defaultValue);
super(source, sectionName, String.class, defaultValue);
this.messageParams = messageParams;
}
@@ -45,7 +46,6 @@ public class ConfigMessageList extends ConfigValueList<String> {
}
}
public @NotNull List<String> get(@Nullable CommandSender sender, String[] params, Object[] values) {
return MessageUtils.setPlaceholders(sender, get(), params, values);
}
@@ -62,6 +62,22 @@ public class ConfigMessageList extends ConfigValueList<String> {
}
}
public void sendToAll(String[] params, Object[] values) {
Bukkit.getOnlinePlayers().forEach(pl -> MessageUtils.sendWithPlaceholders(pl, get(), params, values));
}
public void sendToAll() {
Bukkit.getOnlinePlayers().forEach(player -> MessageUtils.sendWithPlaceholders(player, get()));
}
public void sendToAll(Object[] values) {
if (messageParams != null) {
sendToAll(messageParams, values);
} else {
sendToAll();
}
}
public void send(@Nullable CommandSender sender, String[] params, Object[] values) {
MessageUtils.sendWithPlaceholders(sender, get(), params, values);
}
@@ -70,4 +86,5 @@ public class ConfigMessageList extends ConfigValueList<String> {
public @Nullable FileConfig getSource() {
return source == null ? FileConfig.getMessageConfiguration() : source;
}
}
@@ -1,64 +1,54 @@
package cc.carm.lib.easyplugin.configuration.values;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import cc.carm.lib.easyplugin.configuration.file.FileConfigValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public class ConfigValue<V> {
import java.util.Optional;
protected @Nullable FileConfig source;
private final @NotNull String configSection;
public class ConfigValue<V> extends FileConfigValue {
private final @NotNull Class<V> clazz;
@Nullable V defaultValue;
public ConfigValue(@NotNull String configSection, @NotNull Class<V> clazz) {
this(configSection, clazz, null);
public ConfigValue(@NotNull String sectionName,
@NotNull Class<V> clazz) {
this(sectionName, clazz, null);
}
public ConfigValue(@NotNull String configSection, @NotNull Class<V> clazz, @Nullable V defaultValue) {
this(null, configSection, clazz, defaultValue);
public ConfigValue(@NotNull String sectionName,
@NotNull Class<V> clazz,
@Nullable V defaultValue) {
this(null, sectionName, clazz, defaultValue);
}
public ConfigValue(@Nullable FileConfig source, @NotNull String configSection,
@NotNull Class<V> clazz, @Nullable V defaultValue) {
this.source = source;
this.configSection = configSection;
public ConfigValue(@Nullable FileConfig source, @NotNull String sectionName,
@NotNull Class<V> clazz,
@Nullable V defaultValue) {
super(source, sectionName);
this.clazz = clazz;
this.defaultValue = defaultValue;
}
public V get() {
FileConfig source = getSource();
if (source == null) return this.defaultValue;
return getConfigOptional()
.map(config -> castValue(config.get(getSectionName()), clazz, this.defaultValue))
.orElse(setDefault()); // 如果没有默认值,就把配置写进去,便于配置
}
if (source.getConfig().contains(this.configSection)) {
Object val = source.getConfig().get(this.configSection, this.defaultValue);
return this.clazz.isInstance(val) ? this.clazz.cast(val) : this.defaultValue;
} else {
// 如果没有默认值,就把配置写进去,便于配置
return setDefault();
}
public @NotNull Optional<V> getOptional() {
return Optional.ofNullable(get());
}
public void set(@Nullable V value) {
FileConfig source = getSource();
if (source == null) return;
source.getConfig().set(this.configSection, value);
source.save();
}
public void save() {
if (getSource() != null) getSource().save();
getSourceOptional().ifPresent(source -> {
source.getConfig().set(getSectionName(), value);
source.save();
});
}
public V setDefault() {
set(this.defaultValue);
if (this.defaultValue != null) set(this.defaultValue);
return this.defaultValue;
}
public @Nullable FileConfig getSource() {
return source == null ? FileConfig.getPluginConfiguration() : source;
}
}
@@ -2,78 +2,66 @@ package cc.carm.lib.easyplugin.configuration.values;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import cc.carm.lib.easyplugin.configuration.file.FileConfigValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
public class ConfigValueList<V> {
public class ConfigValueList<V> extends FileConfigValue {
protected @Nullable FileConfig source;
private final @NotNull String configSection;
private final @NotNull Class<V> clazz;
@Nullable V[] defaultValue;
public ConfigValueList(@NotNull String configSection, @NotNull Class<V> clazz) {
this(configSection, clazz, null);
public ConfigValueList(@NotNull String sectionName,
@NotNull Class<V> clazz) {
this(sectionName, clazz, null);
}
public ConfigValueList(@NotNull String configSection, @NotNull Class<V> clazz, @Nullable V[] defaultValue) {
this(null, configSection, clazz, defaultValue);
public ConfigValueList(@NotNull String sectionName,
@NotNull Class<V> clazz,
@Nullable V[] defaultValue) {
this(null, sectionName, clazz, defaultValue);
}
public ConfigValueList(@Nullable FileConfig configuration, @NotNull String configSection, Class<V> clazz) {
this(configuration, configSection, clazz, null);
public ConfigValueList(@Nullable FileConfig configuration, @NotNull String sectionName,
Class<V> clazz) {
this(configuration, sectionName, clazz, null);
}
public ConfigValueList(@Nullable FileConfig configuration, @NotNull String configSection,
@NotNull Class<V> clazz, @Nullable V[] defaultValue) {
this.source = configuration;
this.configSection = configSection;
public ConfigValueList(@Nullable FileConfig configuration, @NotNull String sectionName,
@NotNull Class<V> clazz,
@Nullable V[] defaultValue) {
super(configuration, sectionName);
this.clazz = clazz;
this.defaultValue = defaultValue;
}
public @NotNull ArrayList<V> get() {
FileConfig source = getSource();
if (source == null) return new ArrayList<>();
return getConfigOptional()
.map(configuration -> configuration.getList(getSectionName()))
.map(list -> list.stream()
.map(o -> castValue(o, this.clazz))
.filter(Objects::nonNull)
.collect(Collectors.toCollection(ArrayList::new)))
.orElse(getDefaultList());
}
List<?> list = source.getConfig().getList(this.configSection);
if (list == null) {
if (defaultValue != null) {
return new ArrayList<>(Arrays.asList(defaultValue));
} else {
return new ArrayList<>();
}
} else {
ArrayList<V> result = new ArrayList<>();
public @NotNull ArrayList<V> getDefaultList() {
return defaultValue == null ? new ArrayList<>() : new ArrayList<>(Arrays.asList(defaultValue));
for (Object object : list) {
if (this.clazz.isInstance(object)) {
result.add(this.clazz.cast(object));
}
}
return result;
}
}
public void set(@Nullable ArrayList<V> value) {
FileConfig source = getSource();
if (source == null) return;
source.getConfig().set(this.configSection, value);
this.save();
getSourceOptional().ifPresent(source -> {
source.getConfig().set(getSectionName(), value);
source.save();
});
}
public void save() {
if (getSource() != null) getSource().save();
}
public @Nullable FileConfig getSource() {
return this.source == null ? FileConfig.getPluginConfiguration() : this.source;
}
}
@@ -1,88 +1,59 @@
package cc.carm.lib.easyplugin.configuration.values;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import org.bukkit.configuration.ConfigurationSection;
import cc.carm.lib.easyplugin.configuration.file.FileConfigCachedValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
public class ConfigValueMap<K, V> {
@Nullable FileConfig source;
@NotNull String configSection;
public class ConfigValueMap<K, V> extends FileConfigCachedValue<Map<K, V>> {
@NotNull Function<String, K> keyCast;
@NotNull Class<V> valueClazz;
@Nullable LinkedHashMap<K, V> valueCache;
long updateTime;
public ConfigValueMap(@NotNull String configSection, @NotNull Function<String, K> keyCast,
public ConfigValueMap(@NotNull String sectionName, @NotNull Function<String, K> keyCast,
@NotNull Class<V> valueClazz) {
this(null, configSection, keyCast, valueClazz);
this(null, sectionName, keyCast, valueClazz);
}
public ConfigValueMap(@Nullable FileConfig configuration, @NotNull String configSection,
public ConfigValueMap(@Nullable FileConfig source, @NotNull String sectionName,
@NotNull Function<String, K> keyCast, @NotNull Class<V> valueClazz) {
this.source = configuration;
this.configSection = configSection;
super(source, sectionName);
this.keyCast = keyCast;
this.valueClazz = valueClazz;
}
public void clearCache() {
this.valueCache = null;
}
@NotNull
public Map<K, V> get() {
FileConfig source = getSource();
if (source == null) return new HashMap<>();
if (valueCache != null && !getSource().isExpired(this.updateTime)) return valueCache;
ConfigurationSection section = source.getConfig().getConfigurationSection(this.configSection);
if (section == null) return new LinkedHashMap<>();
Set<String> keys = section.getKeys(false);
if (keys.isEmpty()) return new LinkedHashMap<>();
else {
LinkedHashMap<K, V> result = new LinkedHashMap<>();
for (String key : keys) {
K finalKey = keyCast.apply(key);
Object val = section.get(key);
V finalValue = this.valueClazz.isInstance(val) ? this.valueClazz.cast(val) : null;
if (finalKey != null && finalValue != null) {
result.put(finalKey, finalValue);
}
}
this.updateTime = System.currentTimeMillis();
this.valueCache = result;
return result;
Map<K, V> cached = getCachedValue();
if (cached != null && !isExpired()) {
return cached;
} else {
return getConfigOptional()
.map(config -> config.getConfigurationSection(getSectionName()))
.map(section -> {
Map<K, V> result = new LinkedHashMap<>();
for (String key : section.getKeys(false)) {
K finalKey = keyCast.apply(key);
V finalValue = castValue(section.get(key), valueClazz);
if (finalKey != null && finalValue != null) {
result.put(finalKey, finalValue);
}
}
return updateCache(result);
}).orElse(new LinkedHashMap<>());
}
}
public void set(@Nullable HashMap<K, V> valuesMap) {
FileConfig source = getSource();
if (source == null) return;
source.getConfig().createSection(this.configSection, valuesMap);
source.save();
}
public void save() {
if (getSource() != null) getSource().save();
}
public @Nullable FileConfig getSource() {
return source == null ? FileConfig.getPluginConfiguration() : source;
public void set(@Nullable Map<K, V> valuesMap) {
getSourceOptional().ifPresent(source -> {
source.getConfig().createSection(getSectionName(), valuesMap);
source.save();
});
}
}
+2 -9
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.1.0</version>
<version>1.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -19,7 +19,7 @@
<artifactId>easyplugin-database</artifactId>
<packaging>jar</packaging>
<name>EasyPlugin-Database</name>
<name>14-EasyPlugin-Database</name>
<description>轻松插件数据库模块,包含快速实现数据库功能的工具。</description>
<url>https://github.com/CarmJos/EasyPlugin</url>
@@ -49,13 +49,6 @@
<url>https://github.com/CarmJos/EasyPlugin/actions/workflows/maven.yml</url>
</ciManagement>
<repositories>
<repository>
<id>EasySQL</id>
<url>https://maven.pkg.github.com/CarmJos/EasySQL</url>
</repository>
</repositories>
<dependencies>
<dependency>
+2 -2
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.1.0</version>
<version>1.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -19,7 +19,7 @@
<artifactId>easyplugin-gui</artifactId>
<packaging>jar</packaging>
<name>EasyPlugin-GUI</name>
<name>13-EasyPlugin-GUI</name>
<description>轻松插件GUI接口模块,方便快捷的创建箱子GUI界面。</description>
<url>https://github.com/CarmJos/EasyPlugin</url>
+3 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.1.0</version>
<version>1.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -19,5 +19,7 @@
<artifactId>easyplugin-lp</artifactId>
<packaging>jar</packaging>
<name>23-EasyPlugin-LuckPerms</name>
</project>
+2 -2
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.1.0</version>
<version>1.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -20,7 +20,7 @@
<artifactId>easyplugin-main</artifactId>
<packaging>jar</packaging>
<name>EasyPlugin-Main</name>
<name>10-EasyPlugin-Main</name>
<description>轻松插件主要接口模块,包含方便的插件入口类与相关工具类。</description>
<url>https://github.com/CarmJos/EasyPlugin</url>
@@ -71,12 +71,12 @@ public abstract class EasyPlugin extends JavaPlugin {
log(messageProvider.disabled(this, startTime));
}
public void load() {
protected void load() {
}
public abstract boolean initialize();
protected abstract boolean initialize();
public void shutdown() {
protected void shutdown() {
}
/**
@@ -6,7 +6,11 @@ import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.Nullable;
import java.util.*;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
public class MessageUtils {
@@ -42,6 +46,15 @@ public class MessageUtils {
sendWithPlaceholders(sender, setCustomParams(messages, params, values));
}
public static String setPlaceholders(@Nullable CommandSender sender, String message) {
if (message == null || sender == null) return message;
if (hasPlaceholderAPI() && sender instanceof Player) {
return PlaceholderAPI.setPlaceholders((Player) sender, message);
} else {
return message;
}
}
public static List<String> setPlaceholders(@Nullable CommandSender sender, List<String> messages) {
if (messages == null || messages.isEmpty() || sender == null) return messages;
if (hasPlaceholderAPI() && sender instanceof Player) {
@@ -51,10 +64,36 @@ public class MessageUtils {
}
}
public static String setPlaceholders(@Nullable CommandSender sender, String message, String[] params, Object[] values) {
return setPlaceholders(sender, setCustomParams(message, params, values));
}
public static List<String> setPlaceholders(@Nullable CommandSender sender, List<String> messages, String[] params, Object[] values) {
return setPlaceholders(sender, setCustomParams(messages, params, values));
}
public static String setCustomParams(String message, String param, Object value) {
return setCustomParams(message, new String[]{param}, new Object[]{value});
}
public static String setCustomParams(String message, String[] params, Object[] values) {
if (params.length != values.length) return message;
HashMap<String, Object> paramsMap = new HashMap<>();
for (int i = 0; i < params.length; i++) {
paramsMap.put(params[i], values[i]);
}
return setCustomParams(message, paramsMap);
}
public static String setCustomParams(String message, HashMap<String, Object> params) {
String afterMessage = message;
for (Map.Entry<String, Object> entry : params.entrySet()) {
afterMessage = afterMessage.replace(entry.getKey(), entry.getValue().toString());
}
return afterMessage;
}
public static List<String> setCustomParams(List<String> messages, String param, Object value) {
return setCustomParams(messages, new String[]{param}, new Object[]{value});
}
@@ -70,15 +109,7 @@ public class MessageUtils {
public static List<String> setCustomParams(List<String> messages, HashMap<String, Object> params) {
List<String> list = new ArrayList<>();
for (String message : messages) {
String afterMessage = message;
for (Map.Entry<String, Object> entry : params.entrySet()) {
afterMessage = afterMessage.replace(entry.getKey(), entry.getValue().toString());
}
list.add(afterMessage);
}
return list;
return messages.stream().map(message -> setCustomParams(message, params)).collect(Collectors.toList());
}
+3 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.1.0</version>
<version>1.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -17,6 +17,8 @@
</properties>
<artifactId>easyplugin-placeholderapi</artifactId>
<packaging>jar</packaging>
<name>21-EasyPlugin-PlaceholderAPI</name>
</project>
+3 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.1.0</version>
<version>1.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -19,6 +19,8 @@
<artifactId>easyplugin-vault</artifactId>
<packaging>jar</packaging>
<name>22-EasyPlugin-Vault</name>
<dependencies>
<dependency>
+12 -9
View File
@@ -14,7 +14,7 @@
<groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-parent</artifactId>
<packaging>pom</packaging>
<version>1.1.0</version>
<version>1.1.2</version>
<modules>
<module>easyplugin-main</module>
@@ -72,12 +72,6 @@
<repositories>
<repository>
<id>github</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/CarmJos/EasyPlugin</url>
</repository>
<repository>
<id>central</id>
<url>https://repo1.maven.org/maven2/</url>
@@ -90,8 +84,17 @@
</repository>
<repository>
<id>nexus</id>
<url>https://mvn.lumine.io/repository/maven-public/</url>
<id>EasySQL</id>
<url>https://maven.pkg.github.com/CarmJos/EasySQL</url>
</repository>
<repository>
<id>github</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/CarmJos/EasyPlugin</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>