org.nutz.dao.util

类 Daos

java.lang.Object

org.nutz.dao.util.Daos

public abstract class Daos
extends Object

Dao 的帮助函数

作者:

zozoh(zozohtnt@gmail.com), wendal(wendal1985@gmail.com), cqyunqin, rekoe(koukou890@qq.com)

字段概要

字段

限定符和类型	字段和说明
static boolean	CHECK_COLUMN_NAME_KEYWORD 是否检查字段为数据库的关键字
static int	DEFAULT_VARCHAR_WIDTH varchar 字段的默认字段长度
static boolean	FORCE_HUMP_COLUMN_NAME
static boolean	FORCE_UPPER_COLUMN_NAME 是否把字段名给变成大写
static boolean	FORCE_WRAP_COLUMN_NAME 是否把字段名用字符包裹来进行关键字逃逸

构造器概要

构造器

构造器和说明
Daos()

方法概要

限定符和类型	方法和说明
static void	checkTableColumn(Dao dao, Object tableName, Class<?> clsType) 检查分表中是否有字段变化 提示
static void	createTablesInPackage(Dao dao, Class<?> oneClzInPackage, boolean force) 为特定package下带@Table注解的类调用dao.create(XXX.class, force), 批量建表
static void	createTablesInPackage(Dao dao, String packageName, boolean force) 为特定package下带@Table注解的类调用dao.create(XXX.class, force), 批量建表,优先建立带@ManyMany的表
static StringBuilder	dataDict(Dao dao, String... packages) 根据Pojo生成数据字典,zdoc格式
static StringBuilder	dataDict(DataSource ds, String... packages)
static Dao	ext(Dao dao, FieldFilter filter) 创建一个带FieldFilter的Dao代理实例.
static Dao	ext(Dao dao, FieldFilter filter, Object tableName) 同时进行字段过滤和动态表名封装
static Dao	ext(Dao dao, Object tableName) 创建一个带TableName的Dao代理实例.
static boolean	filterFields(Object obj, FieldMatcher matcher, Dao dao, Callback2<MappingField,Object> callback)
static int	getColumnIndex(ResultSetMetaData meta, String colName) 获取colName所在的行数
static SqlFormat	getSqlFormat() 获取SQL打印格式
static String	getTableName(Dao dao, Class<?> klass, Object target) 获取动态表的表名
static String	getTableName(Dao dao, Entity<?> en, Object target) 获取动态表的表名
static void	insertBySpecialChain(Dao dao, Entity en, String tableName, Chain chain) 执行一个特殊的Chain(事实上普通Chain也能执行,但不建议使用)
static boolean	isIntLikeColumn(ResultSetMetaData meta, int index) 是不是数值字段
static void	migration(Dao dao, Class<?> klass, boolean add, boolean del) 为数据表自动增减字段
static void	migration(Dao dao, Class<?> klass, boolean add, boolean del, boolean checkIndex) 为数据表自动增减字段
static void	migration(Dao dao, Class<?> klass, boolean add, boolean del, boolean checkIndex, Object tableName) 为数据表自动增减字段
static void	migration(Dao dao, Class<?> klass, boolean add, boolean del, Object tableName) 为数据表自动增减字段
static void	migration(Dao dao, String packageName, boolean add, boolean del) 为指定package及旗下package中带@Table注解的Pojo执行migration
static void	migration(Dao dao, String packageName, boolean add, boolean del, boolean checkIndex) 为指定package及旗下package中带@Table注解的Pojo执行migration
static void	migration(Dao dao, String packageName, boolean add, boolean del, boolean checkIndex, Object nameTable) 为指定package及旗下package中带@Table注解的Pojo执行migration
static void	migration(Dao dao, String packageName, boolean add, boolean del, Object nameTable) 为指定package及旗下package中带@Table注解的Pojo执行migration
static <T> List<T>	query(Dao dao, Class<T> classOfT, String sql, Condition cnd, Pager pager) 查询sql并把结果放入传入的class组成的List中
static Object	query(Dao dao, String sql_str, SqlCallback callback) 执行sql和callback
static long	queryCount(Dao dao, Sql sql) 查询某sql的结果条数
static long	queryCount(Dao dao, String sql) 已过时。
static <T> List<T>	queryList(Dao dao, Class<T> klass, String sql_str) 根据sql查询特定的记录,并转化为指定的类对象
static <T> List<T>	queryWithLinks(Dao dao, Class<T> classOfT, Condition cnd, Pager pager, String regex) 在同一个事务内查询对象及关联对象
static void	safeClose(ResultSet rs) 安全关闭=ResultSet
static void	safeClose(Statement stat) 安全关闭Statement
static void	safeClose(Statement stat, ResultSet rs) 安全关闭Statement和ResultSet
static void	setSqlFormat(SqlFormat sqlFormat) 设置SQL打印格式
static Set<String>	sql2003Keywords() 获取SQL2003关键字
static Pager	updatePagerCount(Pager pager, Dao dao, Class<?> entityType, Condition cnd) 填充记录总数
static Pager	updatePagerCount(Pager pager, Dao dao, String tableName, Condition cnd) 填充记录总数

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

CHECK_COLUMN_NAME_KEYWORD

public static boolean CHECK_COLUMN_NAME_KEYWORD

是否检查字段为数据库的关键字

FORCE_WRAP_COLUMN_NAME

public static boolean FORCE_WRAP_COLUMN_NAME

是否把字段名用字符包裹来进行关键字逃逸

FORCE_UPPER_COLUMN_NAME

public static boolean FORCE_UPPER_COLUMN_NAME

是否把字段名给变成大写

FORCE_HUMP_COLUMN_NAME

public static boolean FORCE_HUMP_COLUMN_NAME

DEFAULT_VARCHAR_WIDTH

public static int DEFAULT_VARCHAR_WIDTH

varchar 字段的默认字段长度

构造器详细资料

Daos

public Daos()

方法详细资料

safeClose

public static void safeClose(Statement stat,
                             ResultSet rs)

安全关闭Statement和ResultSet

参数:

stat - Statement实例,可以为null

rs - ResultSet实例,可以为null

safeClose

public static void safeClose(Statement stat)

安全关闭Statement

参数:

stat - Statement实例,可以为null

safeClose

public static void safeClose(ResultSet rs)

安全关闭=ResultSet

参数:

rs - ResultSet实例,可以为null

getColumnIndex

public static int getColumnIndex(ResultSetMetaData meta,
                                 String colName)
                          throws SQLException

获取colName所在的行数

参数:

meta - 从连接中取出的ResultSetMetaData

colName - 字段名

返回:

所在的索引,如果不存在就抛出异常

抛出:

SQLException - 指定的colName找不到

isIntLikeColumn

public static boolean isIntLikeColumn(ResultSetMetaData meta,
                                      int index)
                               throws SQLException

是不是数值字段

参数:

meta - 从连接中取出的ResultSetMetaData

index - 字段索引

返回:

如果是就返回true

抛出:

SQLException - 指定的索引不存在

updatePagerCount

public static Pager updatePagerCount(Pager pager,
                                     Dao dao,
                                     Class<?> entityType,
                                     Condition cnd)

填充记录总数

参数:

pager - 分页对象,如果为null就不进行任何操作

dao - Dao实例

entityType - 实体类,可以通过dao.getEntity获取

cnd - 查询条件

返回:

传入的Pager参数

updatePagerCount

public static Pager updatePagerCount(Pager pager,
                                     Dao dao,
                                     String tableName,
                                     Condition cnd)

填充记录总数

参数:

pager - 分页对象,如果为null就不进行任何操作

dao - Dao实例

tableName - 表名

cnd - 查询条件

返回:

传入的Pager参数

queryList

public static <T> List<T> queryList(Dao dao,
                                    Class<T> klass,
                                    String sql_str)

根据sql查询特定的记录,并转化为指定的类对象

参数:

dao - Dao实例

klass - Pojo类

sql_str - sql语句

返回:

查询结果

query

public static Object query(Dao dao,
                           String sql_str,
                           SqlCallback callback)

执行sql和callback

参数:

dao - Dao实例

sql_str - sql语句

callback - sql回调

返回:

回调的返回值

queryWithLinks

public static <T> List<T> queryWithLinks(Dao dao,
                                         Class<T> classOfT,
                                         Condition cnd,
                                         Pager pager,
                                         String regex)

在同一个事务内查询对象及关联对象

参数:

dao - Dao实例

classOfT - 指定的Pojo类

cnd - 查询条件

pager - 分页语句

regex - 需要查出的关联对象, 可以参阅dao.fetchLinks

返回:

查询结果

dataDict

public static StringBuilder dataDict(DataSource ds,
                                     String... packages)

dataDict

public static StringBuilder dataDict(Dao dao,
                                     String... packages)

根据Pojo生成数据字典,zdoc格式

query

public static <T> List<T> query(Dao dao,
                                Class<T> classOfT,
                                String sql,
                                Condition cnd,
                                Pager pager)

查询sql并把结果放入传入的class组成的List中

queryCount

@Deprecated
public static long queryCount(Dao dao,
                                           String sql)

已过时。

查询某sql的结果条数. 请使用Sql接口的版本

queryCount

public static long queryCount(Dao dao,
                              Sql sql)

查询某sql的结果条数

参数:

dao - 用于执行该count方法的dao实例

sql - 原本的Sql对象,将复制其sql语句,变量和参数表.

insertBySpecialChain

public static void insertBySpecialChain(Dao dao,
                                        Entity en,
                                        String tableName,
                                        Chain chain)

执行一个特殊的Chain(事实上普通Chain也能执行,但不建议使用)

另请参阅:

Chain.addSpecial(String, Object)

createTablesInPackage

public static void createTablesInPackage(Dao dao,
                                         String packageName,
                                         boolean force)

为特定package下带@Table注解的类调用dao.create(XXX.class, force), 批量建表,优先建立带@ManyMany的表

参数:

dao - Dao实例

packageName - package名称,自动包含子类

force - 如果表存在,是否先删后建

createTablesInPackage

public static void createTablesInPackage(Dao dao,
                                         Class<?> oneClzInPackage,
                                         boolean force)

为特定package下带@Table注解的类调用dao.create(XXX.class, force), 批量建表

参数:

dao - Dao实例

oneClzInPackage - 使用package中某一个class文件, 可以防止写错pkgName

force - 如果表存在,是否先删后建

ext

public static Dao ext(Dao dao,
                      FieldFilter filter)

创建一个带FieldFilter的Dao代理实例. 注意,为避免出错,生成的Dao对象不应该传递到其他方法去.

参数:

dao - 原始的Dao实例

filter - 字段过滤器

返回:

带FieldFilter的Dao代理实例

ext

public static Dao ext(Dao dao,
                      Object tableName)

创建一个带TableName的Dao代理实例. 注意,为避免出错,生成的Dao对象不应该传递到其他方法去.

参数:

dao - 原始的Dao实例

tableName - 动态表名上下文

返回:

带TableName的Dao代理实例

ext

public static Dao ext(Dao dao,
                      FieldFilter filter,
                      Object tableName)

同时进行字段过滤和动态表名封装

参数:

dao - Dao实例

filter - 字段过滤

tableName - 动态表名参数

返回:

封装好的Dao实例

filterFields

public static boolean filterFields(Object obj,
                                   FieldMatcher matcher,
                                   Dao dao,
                                   Callback2<MappingField,Object> callback)

migration

public static void migration(Dao dao,
                             Class<?> klass,
                             boolean add,
                             boolean del,
                             boolean checkIndex)

为数据表自动增减字段

参数:

dao - Dao实例

klass - 映射Pojo

add - 是否允许添加字段

del - 是否允许删除字段

checkIndex - 是否检查索引

migration

public static void migration(Dao dao,
                             Class<?> klass,
                             boolean add,
                             boolean del)

为数据表自动增减字段

参数:

dao - Dao实例

klass - 映射Pojo

add - 是否允许添加字段

del - 是否允许删除字段

migration

public static void migration(Dao dao,
                             Class<?> klass,
                             boolean add,
                             boolean del,
                             Object tableName)

为数据表自动增减字段

参数:

dao - Dao实例

klass - 映射Pojo

add - 是否允许添加字段

del - 是否允许删除字段

tableName - 动态表名上下文

migration

public static void migration(Dao dao,
                             Class<?> klass,
                             boolean add,
                             boolean del,
                             boolean checkIndex,
                             Object tableName)

为数据表自动增减字段

参数:

dao - Dao实例

klass - 映射Pojo

add - 是否允许添加字段

del - 是否允许删除字段

checkIndex - 是否检查索引

tableName - 动态表名上下文

migration

public static void migration(Dao dao,
                             String packageName,
                             boolean add,
                             boolean del,
                             boolean checkIndex,
                             Object nameTable)

为指定package及旗下package中带@Table注解的Pojo执行migration

参数:

dao - Dao实例

packageName - 指定的package名称

add - 是否允许添加字段

del - 是否允许删除字段

checkIndex - 是否检查索引

nameTable - 动态表名上下文

migration

public static void migration(Dao dao,
                             String packageName,
                             boolean add,
                             boolean del,
                             Object nameTable)

为指定package及旗下package中带@Table注解的Pojo执行migration

参数:

dao - Dao实例

packageName - 指定的package名称

add - 是否允许添加字段

del - 是否允许删除字段

nameTable - 动态表名上下文

migration

public static void migration(Dao dao,
                             String packageName,
                             boolean add,
                             boolean del,
                             boolean checkIndex)

为指定package及旗下package中带@Table注解的Pojo执行migration

参数:

dao - Dao实例

packageName - 指定的package名称

add - 是否允许添加字段

del - 是否允许删除字段

checkIndex - 是否检查索引

migration

public static void migration(Dao dao,
                             String packageName,
                             boolean add,
                             boolean del)

为指定package及旗下package中带@Table注解的Pojo执行migration

参数:

dao - Dao实例

packageName - 指定的package名称

add - 是否允许添加字段

del - 是否允许删除字段

checkTableColumn

public static void checkTableColumn(Dao dao,
                                    Object tableName,
                                    Class<?> clsType)

检查分表中是否有字段变化 提示

参数:

dao - Dao实例

tableName - 动态表名上下文

clsType - 映射Pojo

getTableName

public static String getTableName(Dao dao,
                                  Class<?> klass,
                                  Object target)

获取动态表的表名

参数:

dao - Dao实例

klass - 映射Pojo

target - 参考对象

getTableName

public static String getTableName(Dao dao,
                                  Entity<?> en,
                                  Object target)

获取动态表的表名

参数:

dao - Dao实例

en - Pojo的数据库实体

target - 参考对象

getSqlFormat

public static SqlFormat getSqlFormat()

获取SQL打印格式

setSqlFormat

public static void setSqlFormat(SqlFormat sqlFormat)

设置SQL打印格式

参数:

sqlFormat - SQL打印格式

sql2003Keywords

public static Set<String> sql2003Keywords()

获取SQL2003关键字