cn.hutool.db.sql

Class Wrapper

java.lang.Object

cn.hutool.db.sql.Wrapper

All Implemented Interfaces:

Serializable

public class Wrapper
extends Object
implements Serializable

包装器
主要用于字段名的包装（在字段名的前后加字符，例如反引号来避免与数据库的关键字冲突）

Author:

Looly

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Wrapper()
Wrapper(Character wrapQuote) 构造
Wrapper(Character preWrapQuote, Character sufWrapQuote) 包装符号

Method Summary

Modifier and Type	Method and Description
char	getPreWrapQuote()
char	getSufWrapQuote()
void	setPreWrapQuote(Character preWrapQuote) 设置前置包装的符号
void	setSufWrapQuote(Character sufWrapQuote) 设置后置包装的符号
String	unWrap(String field) 解包装字段名
Collection<String>	wrap(Collection<String> fields) 包装字段名 有时字段与SQL的某些关键字冲突，导致SQL出错，因此需要将字段名用单引号或者反引号包装起来，避免冲突
Condition[]	wrap(Condition... conditions) 包装字段名 有时字段与SQL的某些关键字冲突，导致SQL出错，因此需要将字段名用单引号或者反引号包装起来，避免冲突
Entity	wrap(Entity entity) 包装表名和字段名，此方法返回一个新的Entity实体类 有时字段与SQL的某些关键字冲突，导致SQL出错，因此需要将字段名用单引号或者反引号包装起来，避免冲突
String[]	wrap(String... fields) 包装字段名 有时字段与SQL的某些关键字冲突，导致SQL出错，因此需要将字段名用单引号或者反引号包装起来，避免冲突
String	wrap(String field) 包装字段名 有时字段与SQL的某些关键字冲突，导致SQL出错，因此需要将字段名用单引号或者反引号包装起来，避免冲突

Methods inherited from class java.lang.Object

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

Constructor Detail

Wrapper

public Wrapper()

Wrapper

public Wrapper(Character wrapQuote)

构造

Parameters:

wrapQuote - 单包装字符

Wrapper

public Wrapper(Character preWrapQuote,
               Character sufWrapQuote)

包装符号

Parameters:

preWrapQuote - 前置包装符号

sufWrapQuote - 后置包装符号

Method Detail

getPreWrapQuote

public char getPreWrapQuote()

Returns:

前置包装符号

setPreWrapQuote

public void setPreWrapQuote(Character preWrapQuote)

设置前置包装的符号

Parameters:

preWrapQuote - 前置包装符号

getSufWrapQuote

public char getSufWrapQuote()

Returns:

后置包装符号

setSufWrapQuote

public void setSufWrapQuote(Character sufWrapQuote)

设置后置包装的符号

Parameters:

sufWrapQuote - 后置包装符号

wrap

public String wrap(String field)

包装字段名
有时字段与SQL的某些关键字冲突，导致SQL出错，因此需要将字段名用单引号或者反引号包装起来，避免冲突

Parameters:

field - 字段名

Returns:

包装后的字段名

unWrap

public String unWrap(String field)

解包装字段名

Parameters:

field - 字段名

Returns:

未包装的字段名

Since:

5.8.27

wrap

public String[] wrap(String... fields)

包装字段名
有时字段与SQL的某些关键字冲突，导致SQL出错，因此需要将字段名用单引号或者反引号包装起来，避免冲突

Parameters:

fields - 字段名

Returns:

包装后的字段名

wrap

public Collection<String> wrap(Collection<String> fields)

包装字段名
有时字段与SQL的某些关键字冲突，导致SQL出错，因此需要将字段名用单引号或者反引号包装起来，避免冲突

Parameters:

fields - 字段名

Returns:

包装后的字段名

wrap

public Entity wrap(Entity entity)

包装表名和字段名，此方法返回一个新的Entity实体类
有时字段与SQL的某些关键字冲突，导致SQL出错，因此需要将字段名用单引号或者反引号包装起来，避免冲突

Parameters:

entity - 被包装的实体

Returns:

新的实体

wrap

public Condition[] wrap(Condition... conditions)

包装字段名
有时字段与SQL的某些关键字冲突，导致SQL出错，因此需要将字段名用单引号或者反引号包装起来，避免冲突

Parameters:

conditions - 被包装的实体

Returns:

包装后的字段名