All Downloads are FREE. Search and download functionalities are using the official Maven repository.

top.lingkang.finalsql.sql.FinalSql Maven / Gradle / Ivy

Go to download

final-sql 一个轻量级数据库ORM框架。

The newest version!
package top.lingkang.finalsql.sql;

import top.lingkang.finalsql.annotation.Nullable;
import top.lingkang.finalsql.config.SqlConfig;
import top.lingkang.finalsql.error.FinalException;

import javax.sql.DataSource;
import java.sql.Connection;
import java.util.List;
import java.util.Map;

/**
 * @author lingkang
 * Created by 2022/4/12
 * 对外操作接口
 */
public interface FinalSql extends ExtendSql{
    /**
     * 每个 FinalSql实现的唯一ID
     *
     * @return
     */
    int getId();

    /**
     * 查询
     *
     * @param clazz 表映射实体类
     * @return
     */
     List select(Class clazz);

    /**
     * 条件查询
     *
     * @param clazz     表映射实体类
     * @param condition 条件
     * @return
     */
     List select(Class clazz, Condition condition);

    /**
     * 查询返回一行
     *
     * @param clazz 表映射实体类
     * @param 
     * @return
     */
    @Nullable
     T selectOne(Class clazz);

    /**
     * 查询返回一行
     *
     * @param clazz     表映射实体类
     * @param condition 条件
     * @return
     */
    @Nullable
     T selectOne(Class clazz, Condition condition);


    /**
     * 总数查询
     *
     * @param clazz 表映射实体类
     * @return
     */
     int selectCount(Class clazz);

    /**
     * 总数查询
     *
     * @param clazz     表映射实体类
     * @param condition 条件
     * @return
     */
     int selectCount(Class clazz, Condition condition);

    /**
     * 执行SQL查询返回对象
     *
     * @param sql
     * @param resultClass 对象、Map或者 String.class || Integer.class ||  Long.class || Boolean.class || Byte.class ||
     *                    Double.class || Float.class || Short.class;
     * @param 
     * @return
     */
     List selectForList(String sql, Class resultClass);

    /**
     * @param sql
     * @param t   对象、Map或者 String.class || Integer.class ||  Long.class || Boolean.class || Byte.class ||
     *            Double.class || Float.class || Short.class;
     * @param row 指定返回的行数
     * @param 
     * @return
     */
     List selectForListRow(String sql, Class t, int row);


    /**
     * 执行SQL查询返回对象
     *
     * @param sql
     * @param t     对象、Map或者 String.class || Integer.class ||  Long.class || Boolean.class || Byte.class ||
     *              Double.class || Float.class || Short.class;
     * @param param sql中的 ? 入参
     * @param 
     * @return
     */
    @Nullable
     List selectForList(String sql, Class t, Object... param);

    /**
     * 执行SQL查询返回对象
     *
     * @param sql
     * @param t     对象、Map或者 String.class || Integer.class ||  Long.class || Boolean.class || Byte.class ||
     *              Double.class || Float.class || Short.class;
     * @param param
     * @param 
     * @return
     */
     List selectForList(String sql, Class t, List param);


    /**
     * 查询返回指定行数，受方言处理影响，针对不同数据库会有不同表现，严格编写SQL
     *
     * @param sql
     * @param t     对象、Map或者 String.class || Integer.class ||  Long.class || Boolean.class || Byte.class ||
     *              Double.class || Float.class || Short.class;
     * @param row   指定返回的行数
     * @param param
     * @param 
     * @return
     */
     List selectForListRow(String sql, Class t, int row, Object... param);


    /**
     * 查询返回指定行数，受方言处理影响，针对不同数据库会有不同表现，严格编写SQL
     *
     * @param sql
     * @param t     对象、Map或者 String.class || Integer.class ||  Long.class || Boolean.class || Byte.class ||
     *              Double.class || Float.class || Short.class;
     * @param row
     * @param param
     * @param 
     * @return
     */
     List selectForListRow(String sql, Class t, int row, List param);

    /**
     * 执行SQL返回对象
     *
     * @param sql
     * @param t   对象、Map或者 String.class || Integer.class ||  Long.class || Boolean.class || Byte.class ||
     *            Double.class || Float.class || Short.class;
     * @param 
     * @return
     */
    @Nullable
     T selectForObject(String sql, Class t);

    /**
     * 执行SQL返回对象
     *
     * @param sql
     * @param t     对象、Map或者 String.class || Integer.class ||  Long.class || Boolean.class || Byte.class ||
     *              Double.class || Float.class || Short.class;
     * @param param
     * @param 
     * @return
     */
    @Nullable
     T selectForObject(String sql, Class t, Object... param);

    /**
     * 执行SQL返回对象
     *
     * @param sql
     * @param t     对象、Map或者 String.class || Integer.class ||  Long.class || Boolean.class || Byte.class ||
     *              Double.class || Float.class || Short.class;
     * @param param
     * @param 
     * @return
     */
    @Nullable
     T selectForObject(String sql, Class t, List param);


    /**
     * 将查询结果转化为 map
     *
     * @param sql
     * @return
     */
    Map selectForMap(String sql);

    /**
     * 将查询结果转化为 map
     *
     * @param sql
     * @param param
     * @return
     */
    Map selectForMap(String sql, Object... param);

    /**
     * 将查询结果转化为 map
     *
     * @param sql
     * @param param
     * @return
     */
    Map selectForMap(String sql, List param);

    /**
     * 插入数据
     *
     * @param entity
     * @return
     */
     int insert(T entity);

    /**
     * 手动处理插入
     *
     * @param entity
     * @param rc     回调函数
     * @param 
     * @return
     */
     int insert(T entity, ResultCallback rc);

    /**
     * 批量插入
     *
     * @param entity
     * @param 
     * @return
     * @throws FinalException
     */
     int batchInsert(List entity) throws FinalException;

    /**
     * 插入返回主键值，若是联合主键，将只会返回一个key
     *
     * @param sql
     * @param classType
     * @param 
     * @return
     */
     T insertReturnGeneratedKey(String sql, Class classType);

    /**
     * 插入返回主键值，若是联合主键，将只会返回一个key
     *
     * @param sql
     * @param classType
     * @param param
     * @param 
     * @return
     */
     T insertReturnGeneratedKey(String sql, Class classType, List param);

    /**
     * 更新数据，会根据 @Id注解的字段作为条件更新
     * 实体对象的空值属性将被忽略
     *
     * @param entity
     * @return
     */
     int update(T entity);

    /**
     * 更新数据，会根据 @Id注解的字段作为条件更新 和入参 Condition 条件来更新
     * 实体对象的空值属性将被忽略
     *
     * @param entity
     * @param condition 条件，存在条件时，不再基于ID更新，即基于条件更新
     * @return
     */
     int update(T entity, Condition condition);

    /**
     * 删除数据，根据实体的 @id 字段作为条件删除
     *
     * @param entity
     * @return
     */
     int delete(T entity);

    /**
     * 删除数据，若条件Condition不为空，按 Condition 删除，否则根据实体的 @id 字段作为条件删除
     *
     * @param entity
     * @param condition 条件
     * @return
     */
     int delete(T entity, Condition condition);

    /**
     * 根据id删除数据
     *
     * @param entity
     * @param ids
     * @param 
     * @return
     */
     int deleteByIds(Class entity, Object... ids);


    /**
     * 根据id删除数据
     *
     * @param entity
     * @param ids
     * @param 
     * @return
     */
     int deleteByIds(Class entity, List ids);

    /**
     * 执行原生查询SQL语句，可能会返回空 ArrayList，需要注意SQL注入
     *
     * @param sql
     * @param callback
     * @return new ArrayList()
     * @throws FinalException
     */
     List nativeSelect(String sql, ResultCallback callback) throws FinalException;

    /**
     * 执行原生查询SQL语句，可能会返回空 ArrayList，
     * 在SQL中使用 ? 代表入参，可防止SQL注入风险
     *
     * @param sql
     * @param callback
     * @param param
     * @param 
     * @return
     * @throws FinalException
     */
     List nativeSelect(String sql, ResultCallback callback, Object... param) throws FinalException;


    /**
     * 执行原生查询SQL语句，可能会返回空 ArrayList，
     * 在SQL中使用 ? 代表入参，可防止SQL注入风险
     *
     * @param sql
     * @param callback
     * @param param
     * @param 
     * @return
     * @throws FinalException
     */
     List nativeSelect(String sql, ResultCallback callback, List param) throws FinalException;

    /**
     * 执行原生更新SQL
     *
     * @param sql
     * @return
     * @throws FinalException
     */
    int nativeUpdate(String sql) throws FinalException;

    /**
     * 执行原生更新SQL
     *
     * @param sql
     * @param param
     * @return
     * @throws FinalException
     */
    int nativeUpdate(String sql, Object... param) throws FinalException;

    /**
     * 执行原生更新SQL
     *
     * @param sql
     * @param param
     * @return
     * @throws FinalException
     */
    int nativeUpdate(String sql, List param) throws FinalException;

    /**
     * 执行查询回调，需要手动判断结果是否为空:
     * while(result.next()){
     * ...
     * }
     *
     * @param sql
     * @param callback
     * @throws FinalException
     */
    void nativeQueryRow(String sql, ResultCallback callback) throws FinalException;

    /**
     * 获取 DataSource
     *
     * @return
     */
    DataSource getDataSource();

    /**
     * 获取连接对象
     *
     * @return
     */
    Connection getConnection();

    /**
     * 开始事务
     * 设置当前事务的隔离级别:(开启事务后再设置)
     * finalSql.getConnection().setTransactionIsolation(Connection.TRANSACTION_READ_COMMITTED);
     */
    void beginTransaction();

    /**
     * 提交事务
     */
    void commitTransaction();

    /**
     * 回滚事务
     */
    void rollbackTransaction();

    /**
     * 判断当前线程是否已经开启事务
     *
     * @return true 已经开启事务
     */
    boolean isOpenTransaction();

    /**
     * @param entityClass 映射实体类
     * @return 返回表名
     */
    String getTableName(Class entityClass);

    // ----------------------------  mapper  相关 -------------------------------

    /**
     * 获取mapper映射接口
     *
     * @param clazz
     * @param 
     * @return
     */
     T getMapper(Class clazz);

    // ----------------------------  分页  相关 -------------------------------

    /**
     * 开始一个分页，执行FinalPageHelper.startPage 应该接着查询操作，非查询操作会导致异常
     *
     * @param page 开始页，从 1 开始
     * @param size 页长度
     */
    void startPage(Integer page, Integer size);

    /**
     * @return 获取分页数据，每个startPage对个一个getPageInfo，第二次getPageInfo将会抛出异常
     */
    PageInfo getPageInfo();


    // ----------------------------  其他 -------------------------------
    SqlConfig getSqlConfig();
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy