EasySQL

使用本插件可以更方便的使用MySQL数据库 使用本插件需要先了解一定的MySQL 至少要知道 字段，表名 的意思

• 使用方法: > - 实例化 SqlEnable, SqlManager 或者 UseTableSqlManager 任意一个均可连接数据库 > ~~~

  /**

  • 连接数据表 */ SqlManager manager = new SqlManager(Plugin, UserData);

 * 用法简介
    * SqlManager 类: 使用本插件需实例化本类连接数据库
      
      参数:
       - plugin: 插件的 pluginBase 类即可
       - data: 数据库账号密码等数据 具体参考 **UserData** 构造方法

      方法:
       - isEnable(): 返回数据库是否连接成功
       - disable(): 关闭数据库的连接 一般在插件onDisable 内使用
       - getConnection(): 获取**Connection**
       - executeSql(String sql, ChunkSqlType... value): 执行sql语句
       - executeFunction(MySqlFunctions functions): 执行MySQL函数
       - executeFunction(String functions): 执行MySQL函数
       - isExistTable(String tableName): 是否存在表
       - createTable(String tableName): 创建一个只包含自增ID的表
       - createTable(String tableName, TableType... tableTypes): 根据参数创建表
       - deleteTable(String tableName): 删除表
       - isExistColumn(String table, String column): 是否存在字段(列)  
       - createColumn(String tableName, TableType tableType): 创建字段(列)
       - deleteColumn(String tableName, String args): 删除字段(列)
       - isExistsData(String tableName, String column, String data): 是否存在数据
       - setData(String tableName, SqlData data, SqlData where): 修改数据
       - insertData(String tableName, SqlData data): 添加数据
       - insertData(String tableName, LinkedList<SqlData> datas): 添加多条数据
       - deleteData(String tableName, SqlData data): 删除数据
       - getDataSize(String sql, String tableName, ChunkSqlType... sqlType): 获取数据条数
       - getData(String tableName, SelectType selectType): 获取数据
       - getData(String sql, ChunkSqlType... types): 获取数据

* SqlData: 为查询语句获取的返回值 或者为向 MySQL写入数据用到的参数

  参数:
   - column: 字段名
   - object: 读取到的数值

  方法:
   - put(String column,Object object): 写入数据 column 为字段名 object 为要写入的数据
   - get(String column,T defaultValue): 根据字段名获取 任意类型数据 T 为返回值为null的情况下的类型
   - getColumns(): 获取返回的所有字段名称
   - getColumn(int index): 根据索引获取对应的字段名

ORM 部分

如果你习惯使用 orm 来操作数据库的话，EasyMySQL也提供了一个 orm 框架 (效率并不高)

使用 orm 能够更加的快捷方便的操作数据

• Example is all you need

先创建一个 Entity (这里的 Entity 不是 nk 里的实体，而是 orm 里面的数据对象)

例如:

public class ExampleEntity {

    @Column(name = "id", type = Types.ID) // ID 类型的 column 会自增
    public Long id;

    @Constraint(name = "t_unique_uuids", type = Constraint.Type.UNIQUE)
    @AutoUUIDGenerate // 自动生成 uuid
    @Column(name = "uuid", type = Types.VARCHAR)
    //@ForeignKey(tableName = "t_other", columnName = "uuid")  外键
    public String uuid;

    @Column(name = "register_index", type = Types.INT, options = {Options.NULL}) // 注意name字段不要命名成关键字，如这里的 index
    public Long index;

    @Constraint(name = "t_unique_uuids", type = Constraint.Type.UNIQUE)
    @AutoUUIDGenerate
    @Column(name = "second_uuid", type = Types.VARCHAR, options = {Options.NULL})  // 可以是 null
    public String secondUUID;

    @Column(name = "name", type = Types.VARCHAR)
    public String name;

}

更多的注解请看: https://github.com/iGxnon/EasyMySQL/tree/feat-orm/src/main/java/com/smallaswater/easysql/orm/annotations/entity

然后创建一个 接口(interface) 去继承我们的 com.smallaswater.easysql.orm.api.IDAO

IDAO的范型需要确定为你上面定义的 Entity

例如:

public interface ExampleDAO extends IDAO<ExampleEntity> {

    @DoInsert // DoInsert 注释的方法只支持一个参数，并且为范型类型
    void insert(ExampleEntity entity);

    @DoQuery("SELECT * FROM {table}") // {table} 会在执行时替换成Builder内的table
    List<ExampleEntity> queryEntities();

    /**
     * ? 为参数的占位符，多少个参数就多少个 ?，? 在什么位置参数就会补充到什么位置
     */
    @DoQuery("SELECT * FROM {table} WHERE id > ?")
    List<ExampleEntity> queryEntitiesIDAfter(Long id);

    @DoQueryRow("SELECT * FROM {table} WHERE id = ?")
    ExampleEntity queryEntity(Long id);

    @DoExecute("DELETE FROM {table} WHERE id = ? AND uuid = ?")
    void deleteEntity(Long id, String uuid);

    /**
     * 底层使用的是 javassist 生成代理类来执行这个方法
     */
    @DoDefault
    default void doSomething() {
        getManager(); // you got sqlManager
        getTable(); // you got tableName
        // and do something you like!
    }

}

在这个接口内，你可以使用 orm 提供的一些注解来 ‘注释’ 你的操作，如果你了解 SQL 语句的话，这会十分易懂

你只需模仿这个例子，写一个自己的 IDAO 就行了！

为什么只需要写一个接口？因为 orm 帮你把接口实现了！

更多注解请看: https://github.com/iGxnon/EasyMySQL/tree/feat-orm/src/main/java/com/smallaswater/easysql/orm/annotations/dao

最后，就像这样就能使用了!

public static void main(String[] args) {

        ORMHandleBuilder builder = ORMHandleBuilder.builder(null/*your pluginBase*/, "test");
        ExampleDAO dao = ((ExampleDAO) builder.fromUserData(new UserData("root", "114514", "localhost", 3306, "test_db")) // 连接你的数据库
                .buildHost()  // 这一步不能省略
                .buildORMDynaProxyIDAO(ExampleDAO.class));  // 传入你的 IDAO 接口，然后强转成那个类型

        ExampleEntity entity = new ExampleEntity();
        entity.name = "hahaha";
        entity.index = 114514L;
        dao.insert(entity); // doInsert 会在 ExampleEntity 表不存在时创建一个

        dao.deleteEntity(1L, "your uuid");  // 删掉这个数据
        List<ExampleEntity> got = dao.queryEntitiesIDAfter(2L);// 查询一些你想要的数据

        dao.doSomething();  // 做一些你想做的事情

}