10EasySql快速操作数据库
导入依赖：
<repository>
<!--采用github的repo分支依赖，实时更新。 (推荐)-->
<id>EasySQL</id>
<name>GitHub Branch Repository</name>
<url>https://github.com/CarmJos/EasySQL/blob/repo/</url>
</repository>
<!-- EasySql hikaricp-->
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>easysql-hikaricp</artifactId>
<version>0.4.1</version>
</dependency>
创建数据库：
create table player
(
id int auto_increment
primary key,
name varchar(16) not null comment '玩家名',
uuid varchar(64) null comment 'UUID',
money int default 0 null,
constraint player_name_uindex
unique (name)
)
row_format = DYNAMIC;
配置文件config.yml
yunfei:
#数据源
datasource:
#驱动：默认为mysql8
driver: com.mysql.cj.jdbc.Driver
#连接
url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&useSSL=true&serverTimezone=GMT%2B8&allowPublicKeyRetrieval=true
#数据库用户名
username: root
#数据库密码
password: 123456
初始化连接：
private static SQLManager sqlManager;
/**
* 初始化连接池
*/
private void initSQLManager() {
// 加载config.yml必要的几个步骤
this.saveDefaultConfig(); // 将位于jar包中的config.yml持久化到本地，如果本地已经存在配置文件，则啥也不干
this.reloadConfig(); // 重新从本地的config.yml中读取配置，并赋值给config
FileConfiguration config = this.getConfig();
// 读取配置信息
String driver = config.getString("yunfei.datasource.driver");
String url = config.getString("yunfei.datasource.url");
String username = config.getString("yunfei.datasource.username");
String password = config.getString("yunfei.datasource.password");
// 校验配置，校验失败则关闭插件
if (driver == null || url == null || username == null || password == null) {
getLogger().severe("数据库连接配置不完整，插件将关闭！");
Bukkit.getPluginManager().disablePlugin(this);
return;
}
// 初始化Manager
sqlManager = EasySQL.createManager(driver, url, username, password);
// 检查并捕获
try {
if (!sqlManager.getConnection().isValid(5)) {
getLogger().warning("[EasySQLTutorial] 数据库连接超时!");
}
} catch (SQLException e) {
getLogger().severe("[EasySQLTutorial] 数据库连接失败，将关闭插件!");
getLogger().warning("错误:" + e.getMessage());
Bukkit.getPluginManager().disablePlugin(this);
}
}
在插件关闭时，关闭连接：
@Override
public void onDisable() {
// Plugin shutdown logic
// 停止掉当前插件所生成的任务
Bukkit.getScheduler().cancelTasks(this);
getLogger().info("关闭插件中。。。。");
// 关闭数据源中的连接池
if (Objects.nonNull(sqlManager)) {
// 使用由EasySQL提供的静态方法直接关闭数据管理器。
EasySQL.shutdownManager(sqlManager);
}
}
具体的增删改查操作：
public class SqlExecutor implements CommandExecutor {
private final SQLManager sqlManager;
public SqlExecutor(SQLManager sqlManager) {
this.sqlManager = sqlManager;
}
@Override
public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
boolean flag = false;
if (args.length >= 1) {
switch (args[0]) {
case "query":
// /db-easy-sql query <playerName>
flag = executeQuery(sender, args);
break;
case "insert":
// /db-easy-sql insert <playerName>
flag = executeInsert(sender, args);
break;
case "update":
// /db-easy-sql update <playerName> <money>
flag = executeUpdate(sender, args);
break;
case "delete":
// /db-easy-sql delete <playerName>
flag = executeDelete(sender, args);
break;
}
}
return flag;
}
private boolean executeQuery(CommandSender sender, String[] args) {
if (args.length >= 2) {
sender.sendMessage("查询前线程：" + Thread.currentThread().getName());
/**
* SELECT id, name, uuid, money
* FROM player
* WHERE name = 'args[1]的值'
* ORDER BY id DESC
* LIMIT 0, 5
*/
// 得到查询构建器
QueryAction queryAction = sqlManager.createQuery()
// 指明需要操作的table表
.inTable("player")
// 指明需要操作的column字段
.selectColumns("id", "name", "uuid", "money")
// 添加where查询条件
.addCondition("name", args[1])
// 还支持字符串拼接的形式，以及多次调用#addCondition来拼接多条where条件
//.addCondition("name = '" + args[1] + "'")
//.addCondition("uuid", "玩家UUID")
// Order by
.orderBy("id", false)
// LIMIT 0, 5 LIMIT实现的分页，CRUD人基操了（
.setPageLimit(0, 5)
//.setLimit(5) //同效果于上面的 LIMIT 0, 5
// 构建查询
.build();
/**
* 函数式编程
* 这里是个Async回调函数，此时EasySql会将任务提交到自己的线程池里，
* 接着主动开启链接、执行Sql语句，关闭连接，
* 并返回一个包装了ResultSet结果等信息的实参，也就是这里的successQuery。
* 由于我们调用的是Async异步方法，如果需要通过Spigot/Bukkit API对查询到的信息
* 进行消费，则需要回到服务器的主线程。
*/
// 通过query对象执行里面的查询sql
queryAction.executeAsync(successQuery -> {
// 获取resultSet
ResultSet resultSet1 = successQuery.getResultSet();
// 保存resultSet到线程安全的数据结构中
ConcurrentHashMap<String, Object> concurrentHashMap = new ConcurrentHashMap<>();
// 上面的查询结果只有一个，就直接这样写了
if (resultSet1.next()) {
concurrentHashMap.put("id", resultSet1.getInt("id"));
concurrentHashMap.put("name", resultSet1.getString("name"));
concurrentHashMap.put("uuid", resultSet1.getString("uuid"));
concurrentHashMap.put("money", resultSet1.getInt("money"));
}
sender.sendMessage("EasySql创建的线程：" + Thread.currentThread().getName());
/**
* Bukkit.getScheduler.runTask(plugin, task)
* 可以让代码回到服务端的主线程运行，对于需要调用Spigot/Bukkit API的场景，
* 请尽量回到主线程后在调用。
*/
Bukkit.getScheduler().runTask(MyPlugin.instance, () -> {
sender.sendMessage("查询成功！");
sender.sendMessage("服务器主线程：" + Thread.currentThread().getName());
/**
* 查询一般用同步形式就好了，
* 这里是作为一个例子来告诉大家怎么在异步代码里正确调用Spigot/Bukkit API
*/
// 消费查询结果
concurrentHashMap.forEach((key, value) -> {
sender.sendMessage(key + ":" + value);
});
sender.sendMessage("查询结束！");
});
});
return true;
}
return false;
}
private boolean executeInsert(CommandSender sender, String[] args) {
if (args.length >= 2) {
Player player = Bukkit.getPlayer(args[1]);
if (Objects.nonNull(player)) {
/**
* INSERT INTO player(name, uuid)
* VALUE('玩家名', '玩家的UUID')
*/
// 直接链式编程一气呵成
sqlManager.createInsert("player")
.setColumnNames("name", "uuid") // 需要插入的字段名，顺序与下面的Params顺序一致
.setParams(args[1], player.getUniqueId())
.executeAsync(); // 非查询操作不需要build，直接execute | executeAsync
sender.sendMessage("插入成功");
return true;
}
sender.sendMessage("玩家不存在");
return true;
}
return false;
}
private boolean executeUpdate(CommandSender sender, String[] args) {
if (args.length >= 2) {
Player player = Bukkit.getPlayer(args[1]);
if (Objects.nonNull(player)) {
/**
* 对于不影响程序运行的运行时异常，
* 可以对其进行捕获，并提示。
*/
try {
// 参数校验，不通过就直接捕获处理
Integer.parseInt(args[2]);
} catch (NumberFormatException e) {
sender.sendMessage("金额必须是数字!");
return true;
}
// key: 字段名， value: 值
LinkedHashMap<String, Object> infoMap = new LinkedHashMap<>();
infoMap.put("name", player.getName());
infoMap.put("uuid", player.getUniqueId());
infoMap.put("money", Integer.parseInt(args[2]));
/**
* UPDATE player
* SET name = '玩家名', uuid = '玩家uuid', money = 金钱
* WHERE name = '玩家名'
*/
sqlManager.createUpdate("player")
.setColumnValues(infoMap) // 实现字段映射与数据
.setConditions("name = '" + args[1] + "'") // where条件，String类型的数据记得像这样用 ' 单引号包裹住，这种单纯的拼接方法不如传入键值对的那个方便
.build() // 需要build得到SQLAction再execute | executeAsync
.executeAsync((success) -> {
// 操作成功回调
sender.sendMessage("更新成功");
}, (exception, sqlAction) -> {
// 操作失败回调
MyPlugin.instance.getLogger().warning("数据库异常！");
MyPlugin.instance.getLogger().warning("请求语句：" + sqlAction.getSQLContents());
MyPlugin.instance.getLogger().warning(exception.getMessage());
});
return true;
}
sender.sendMessage("玩家不存在");
return true;
}
return false;
}
private boolean executeDelete(CommandSender sender, String[] args) {
if (args.length >= 2) {
Player player = Bukkit.getPlayer(args[1]);
sender.sendMessage("正在搜寻玩家：" + args[1]);
if (Objects.nonNull(player)) {
/**
* DELETE FROM player
* WHERE name = '玩家名'
*/
sqlManager.createDelete("player")
.setConditions("name = '" + args[1] + "'")
.build()
.execute(null); // 同步执行，异常回调为null
// .executeAsync();
sender.sendMessage("删除成功");
return true;
}
sender.sendMessage("玩家不存在");
return true;
}
return false;
}
}