BeanUtil (hutool-core 4.6.4 API)

java.lang.Object
- cn.hutool.core.bean.BeanUtil

```
public class BeanUtil
extends Object
```
Bean工具类
把一个拥有对属性进行set和get方法的类，我们就可以称之为JavaBean。

从以下版本开始:

3.1.2

作者:

Looly

构造器概要

构造器
构造器和说明

BeanUtil()

构造器
构造器和说明
`BeanUtil()`

方法概要

方法
限定符和类型	方法和说明
`static Map<String,Object>`	`beanToMap(Object bean)` 对象转Map，不进行驼峰转下划线，不忽略值为空的字段
`static Map<String,Object>`	`beanToMap(Object bean, boolean isToUnderlineCase, boolean ignoreNullValue)` 对象转Map
`static Map<String,Object>`	`beanToMap(Object bean, Map<String,Object> targetMap, boolean isToUnderlineCase, boolean ignoreNullValue)` 对象转Map
`static Map<String,Object>`	`beanToMap(Object bean, Map<String,Object> targetMap, boolean ignoreNullValue, Editor<String> keyEditor)` 对象转Map 通过实现`Editor` 可以自定义字段值，如果这个Editor返回null则忽略这个字段，以便实现： 1.
`static void`	`copyProperties(Object source, Object target)` 复制Bean对象属性
`static void`	`copyProperties(Object source, Object target, boolean ignoreCase)` 复制Bean对象属性
`static void`	`copyProperties(Object source, Object target, CopyOptions copyOptions)` 复制Bean对象属性限制类用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
`static void`	`copyProperties(Object source, Object target, String... ignoreProperties)` 复制Bean对象属性限制类用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
`static DynaBean`	`createDynaBean(Object bean)` 创建动态Bean
`static <T> T`	`fillBean(T bean, ValueProvider<String> valueProvider, CopyOptions copyOptions)` 填充Bean的核心方法
`static <T> T`	`fillBeanWithMap(Map<?,?> map, T bean, boolean isIgnoreError)` 使用Map填充Bean对象
`static <T> T`	`fillBeanWithMap(Map<?,?> map, T bean, boolean isToCamelCase, boolean isIgnoreError)` 使用Map填充Bean对象，可配置将下划线转换为驼峰
`static <T> T`	`fillBeanWithMap(Map<?,?> map, T bean, boolean isToCamelCase, CopyOptions copyOptions)` 使用Map填充Bean对象
`static <T> T`	`fillBeanWithMap(Map<?,?> map, T bean, CopyOptions copyOptions)` 使用Map填充Bean对象
`static <T> T`	`fillBeanWithMapIgnoreCase(Map<?,?> map, T bean, boolean isIgnoreError)` 使用Map填充Bean对象，忽略大小写
`static PropertyEditor`	`findEditor(Class<?> type)` 查找类型转换器 `PropertyEditor`
`static BeanDesc`	`getBeanDesc(Class<?> clazz)` 获取`BeanDesc` Bean描述信息
`static Object`	`getFieldValue(Object bean, String fieldNameOrIndex)` 获得字段值，通过反射直接获得字段值，并不调用getXXX方法对象同样支持Map类型，fieldNameOrIndex即为key
`static Object`	`getProperty(Object bean, String expression)` 解析Bean中的属性值
`static PropertyDescriptor`	`getPropertyDescriptor(Class<?> clazz, String fieldName)` 获得Bean类属性描述，大小写敏感
`static PropertyDescriptor`	`getPropertyDescriptor(Class<?> clazz, String fieldName, boolean ignoreCase)` 获得Bean类属性描述
`static Map<String,PropertyDescriptor>`	`getPropertyDescriptorMap(Class<?> clazz, boolean ignoreCase)` 获得字段名和字段描述Map，获得的结果会缓存在 `BeanInfoCache`中
`static PropertyDescriptor[]`	`getPropertyDescriptors(Class<?> clazz)` 获得Bean字段描述数组
`static boolean`	`hasGetter(Class<?> clazz)` 判断是否为Bean对象判定方法是是否存在只有一个参数的setXXX方法
`static boolean`	`hasNull(Object bean)` 已过时。请使用`hasNullField(Object)`
`static boolean`	`hasNullField(Object bean)` 判断Bean是否包含值为`null`的属性对象本身为`null`也返回true
`static boolean`	`hasSetter(Class<?> clazz)` 判断是否有Setter方法判定方法是是否存在只有一个参数的setXXX方法
`static boolean`	`isBean(Class<?> clazz)` 判断是否为Bean对象判定方法是是否存在只有一个参数的setXXX方法
`static boolean`	`isEmpty(Object bean)` 判断Bean是否为空对象，空对象表示本身为`null`或者所有属性都为`null`
`static boolean`	`isMatchName(Object bean, String beanClassName, boolean isSimple)` 给定的Bean的类名是否匹配指定类名字符串如果isSimple为`false`，则只匹配类名而忽略包名，例如：cn.hutool.TestEntity只匹配TestEntity 如果isSimple为`true`，则匹配包括包名的全类名，例如：cn.hutool.TestEntity匹配cn.hutool.TestEntity
`static <T> T`	`mapToBean(Map<?,?> map, Class<T> beanClass, boolean isIgnoreError)` Map转换为Bean对象
`static <T> T`	`mapToBean(Map<?,?> map, Class<T> beanClass, CopyOptions copyOptions)` Map转换为Bean对象
`static <T> T`	`mapToBeanIgnoreCase(Map<?,?> map, Class<T> beanClass, boolean isIgnoreError)` Map转换为Bean对象忽略大小写
`static void`	`setFieldValue(Object bean, String fieldNameOrIndex, Object value)` 设置字段值，，通过反射设置字段值，并不调用setXXX方法对象同样支持Map类型，fieldNameOrIndex即为key
`static void`	`setProperty(Object bean, String expression, Object value)` 解析Bean中的属性值
`static <T> T`	`toBean(Class<T> beanClass, ValueProvider<String> valueProvider, CopyOptions copyOptions)` ServletRequest 参数转Bean
`static <T> T`	`toBean(Object source, Class<T> clazz)` 对象或Map转Bean
`static <T> T`	`trimStrFields(T bean, String... ignoreFields)` 把Bean里面的String属性做trim操作。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - BeanUtil
```
public BeanUtil()
```
- 方法详细资料
  - isBean
```
public static boolean isBean(Class<?> clazz)
```
    判断是否为Bean对象
    判定方法是是否存在只有一个参数的setXXX方法
    
    参数:
    clazz - 待测试类
    
    返回:
    是否为Bean对象
    另请参阅:
    hasSetter(Class)
  - hasSetter
```
public static boolean hasSetter(Class<?> clazz)
```
    判断是否有Setter方法
    判定方法是是否存在只有一个参数的setXXX方法
    
    参数:
    clazz - 待测试类
    
    返回:
    是否为Bean对象
    从以下版本开始:
    
    4.2.2
  - hasGetter
```
public static boolean hasGetter(Class<?> clazz)
```
    判断是否为Bean对象
    判定方法是是否存在只有一个参数的setXXX方法
    
    参数:
    clazz - 待测试类
    
    返回:
    是否为Bean对象
    从以下版本开始:
    
    4.2.2
  - createDynaBean
```
public static DynaBean createDynaBean(Object bean)
```
    创建动态Bean
    
    参数:
    bean - 普通Bean或Map
    
    返回:
    DynaBean
    从以下版本开始:
    
    3.0.7
  - findEditor
```
public static PropertyEditor findEditor(Class<?> type)
```
    查找类型转换器 PropertyEditor
    
    参数:
    type - 需要转换的目标类型
    
    返回:
    PropertyEditor
  - hasNull
```
@Deprecated
public static boolean hasNull(Object bean)
```
    已过时。 请使用hasNullField(Object)
    
    判断Bean中是否有值为null的字段
    
    参数:
    bean - Bean
    
    返回:
    是否有值为null的字段
  - getBeanDesc
```
public static BeanDesc getBeanDesc(Class<?> clazz)
```
    获取BeanDesc Bean描述信息
    
    参数:
    clazz - Bean类
    
    返回:
    BeanDesc
    从以下版本开始:
    
    3.1.2
  - getPropertyDescriptors
```
public static PropertyDescriptor[] getPropertyDescriptors(Class<?> clazz)
                                                   throws BeanException
```
    获得Bean字段描述数组
    
    参数:
    clazz - Bean类
    
    返回:
    字段描述数组
    
    抛出:
    
    BeanException - 获取属性异常
  - getPropertyDescriptorMap
```
public static Map<String,PropertyDescriptor> getPropertyDescriptorMap(Class<?> clazz,
                                                      boolean ignoreCase)
                                                               throws BeanException
```
    获得字段名和字段描述Map，获得的结果会缓存在 BeanInfoCache中
    
    参数:
    clazz - Bean类
    ignoreCase - 是否忽略大小写
    
    返回:
    字段名和字段描述Map
    
    抛出:
    
    BeanException - 获取属性异常
  - getPropertyDescriptor
```
public static PropertyDescriptor getPropertyDescriptor(Class<?> clazz,
                                       String fieldName)
                                                throws BeanException
```
    获得Bean类属性描述，大小写敏感
    
    参数:
    clazz - Bean类
    fieldName - 字段名
    
    返回:
    PropertyDescriptor
    
    抛出:
    
    BeanException - 获取属性异常
  - getPropertyDescriptor
```
public static PropertyDescriptor getPropertyDescriptor(Class<?> clazz,
                                       String fieldName,
                                       boolean ignoreCase)
                                                throws BeanException
```
    获得Bean类属性描述
    
    参数:
    clazz - Bean类
    fieldName - 字段名
    ignoreCase - 是否忽略大小写
    
    返回:
    PropertyDescriptor
    
    抛出:
    
    BeanException - 获取属性异常
  - getFieldValue
```
public static Object getFieldValue(Object bean,
                   String fieldNameOrIndex)
```
    获得字段值，通过反射直接获得字段值，并不调用getXXX方法
    对象同样支持Map类型，fieldNameOrIndex即为key
    
    参数:
    bean - Bean对象
    fieldNameOrIndex - 字段名或序号，序号支持负数
    
    返回:
    字段值
  - setFieldValue
```
public static void setFieldValue(Object bean,
                 String fieldNameOrIndex,
                 Object value)
```
    设置字段值，，通过反射设置字段值，并不调用setXXX方法
    对象同样支持Map类型，fieldNameOrIndex即为key
    
    参数:
    bean - Bean
    fieldNameOrIndex - 字段名或序号，序号支持负数
    value - 值
  - getProperty
```
public static Object getProperty(Object bean,
                 String expression)
```
    解析Bean中的属性值
    
    参数:
    bean - Bean对象，支持Map、List、Collection、Array
    expression - 表达式，例如：person.friend[5].name
    
    返回:
    Bean属性值
    从以下版本开始:
    
    3.0.7
    
    另请参阅:
    BeanPath.get(Object)
  - setProperty
```
public static void setProperty(Object bean,
               String expression,
               Object value)
```
    解析Bean中的属性值
    
    参数:
    bean - Bean对象，支持Map、List、Collection、Array
    expression - 表达式，例如：person.friend[5].name
    从以下版本开始:
    
    4.0.6
    
    另请参阅:
    BeanPath.get(Object)
  - mapToBean
```
public static <T> T mapToBean(Map<?,?> map,
              Class<T> beanClass,
              boolean isIgnoreError)
```
    Map转换为Bean对象
    
    类型参数:
    T - Bean类型
    参数:
    map - Map
    beanClass - Bean Class
    isIgnoreError - 是否忽略注入错误
    
    返回:
    Bean
  - mapToBeanIgnoreCase
```
public static <T> T mapToBeanIgnoreCase(Map<?,?> map,
                        Class<T> beanClass,
                        boolean isIgnoreError)
```
    Map转换为Bean对象
    忽略大小写
    
    类型参数:
    T - Bean类型
    参数:
    map - Map
    beanClass - Bean Class
    isIgnoreError - 是否忽略注入错误
    
    返回:
    Bean
  - mapToBean
```
public static <T> T mapToBean(Map<?,?> map,
              Class<T> beanClass,
              CopyOptions copyOptions)
```
    Map转换为Bean对象
    
    类型参数:
    T - Bean类型
    参数:
    map - Map
    beanClass - Bean Class
    copyOptions - 转Bean选项
    
    返回:
    Bean
  - fillBeanWithMap
```
public static <T> T fillBeanWithMap(Map<?,?> map,
                    T bean,
                    boolean isIgnoreError)
```
    使用Map填充Bean对象
    
    类型参数:
    T - Bean类型
    参数:
    map - Map
    bean - Bean
    isIgnoreError - 是否忽略注入错误
    
    返回:
    Bean
  - fillBeanWithMap
```
public static <T> T fillBeanWithMap(Map<?,?> map,
                    T bean,
                    boolean isToCamelCase,
                    boolean isIgnoreError)
```
    使用Map填充Bean对象，可配置将下划线转换为驼峰
    
    类型参数:
    T - Bean类型
    参数:
    map - Map
    bean - Bean
    isToCamelCase - 是否将下划线模式转换为驼峰模式
    isIgnoreError - 是否忽略注入错误
    
    返回:
    Bean
  - fillBeanWithMapIgnoreCase
```
public static <T> T fillBeanWithMapIgnoreCase(Map<?,?> map,
                              T bean,
                              boolean isIgnoreError)
```
    使用Map填充Bean对象，忽略大小写
    
    类型参数:
    T - Bean类型
    参数:
    map - Map
    bean - Bean
    isIgnoreError - 是否忽略注入错误
    
    返回:
    Bean
  - fillBeanWithMap
```
public static <T> T fillBeanWithMap(Map<?,?> map,
                    T bean,
                    CopyOptions copyOptions)
```
    使用Map填充Bean对象
    
    类型参数:
    T - Bean类型
    参数:
    map - Map
    bean - Bean
    copyOptions - 属性复制选项 CopyOptions
    
    返回:
    Bean
  - fillBeanWithMap
```
public static <T> T fillBeanWithMap(Map<?,?> map,
                    T bean,
                    boolean isToCamelCase,
                    CopyOptions copyOptions)
```
    使用Map填充Bean对象
    
    类型参数:
    T - Bean类型
    参数:
    map - Map
    bean - Bean
    isToCamelCase - 是否将Map中的下划线风格key转换为驼峰风格
    copyOptions - 属性复制选项 CopyOptions
    
    返回:
    Bean
    从以下版本开始:
    
    3.3.1
  - toBean
```
public static <T> T toBean(Object source,
           Class<T> clazz)
```
    对象或Map转Bean
    
    参数:
    source - Bean对象或Map
    clazz - 目标的Bean类型
    
    返回:
    Bean对象
    从以下版本开始:
    
    4.1.20
  - toBean
```
public static <T> T toBean(Class<T> beanClass,
           ValueProvider<String> valueProvider,
           CopyOptions copyOptions)
```
    ServletRequest 参数转Bean
    
    类型参数:
    T - Bean类型
    参数:
    beanClass - Bean Class
    valueProvider - 值提供者
    copyOptions - 拷贝选项，见 CopyOptions
    
    返回:
    Bean
  - fillBean
```
public static <T> T fillBean(T bean,
             ValueProvider<String> valueProvider,
             CopyOptions copyOptions)
```
    填充Bean的核心方法
    
    类型参数:
    T - Bean类型
    参数:
    bean - Bean
    valueProvider - 值提供者
    copyOptions - 拷贝选项，见 CopyOptions
    
    返回:
    Bean
  - beanToMap
```
public static Map<String,Object> beanToMap(Object bean)
```
    对象转Map，不进行驼峰转下划线，不忽略值为空的字段
    
    参数:
    bean - bean对象
    
    返回:
    Map
  - beanToMap
```
public static Map<String,Object> beanToMap(Object bean,
                           boolean isToUnderlineCase,
                           boolean ignoreNullValue)
```
    对象转Map
    
    参数:
    bean - bean对象
    isToUnderlineCase - 是否转换为下划线模式
    ignoreNullValue - 是否忽略值为空的字段
    
    返回:
    Map
  - beanToMap
```
public static Map<String,Object> beanToMap(Object bean,
                           Map<String,Object> targetMap,
                           boolean isToUnderlineCase,
                           boolean ignoreNullValue)
```
    对象转Map
    
    参数:
    bean - bean对象
    targetMap - 目标的Map
    isToUnderlineCase - 是否转换为下划线模式
    ignoreNullValue - 是否忽略值为空的字段
    
    返回:
    Map
    从以下版本开始:
    
    3.2.3
  - beanToMap
```
public static Map<String,Object> beanToMap(Object bean,
                           Map<String,Object> targetMap,
                           boolean ignoreNullValue,
                           Editor<String> keyEditor)
```
    对象转Map
    通过实现Editor 可以自定义字段值，如果这个Editor返回null则忽略这个字段，以便实现：
```
 1. 字段筛选，可以去除不需要的字段
 2. 字段变换，例如实现驼峰转下划线
 3. 自定义字段前缀或后缀等等
 
```
    参数:
    bean - bean对象
    targetMap - 目标的Map
    ignoreNullValue - 是否忽略值为空的字段
    keyEditor - 属性字段（Map的key）编辑器，用于筛选、编辑key
    
    返回:
    Map
    从以下版本开始:
    
    4.0.5
  - copyProperties
```
public static void copyProperties(Object source,
                  Object target)
```
    复制Bean对象属性
    
    参数:
    source - 源Bean对象
    target - 目标Bean对象
  - copyProperties
```
public static void copyProperties(Object source,
                  Object target,
                  String... ignoreProperties)
```
    复制Bean对象属性
    限制类用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
    
    参数:
    source - 源Bean对象
    target - 目标Bean对象
    ignoreProperties - 不拷贝的的属性列表
  - copyProperties
```
public static void copyProperties(Object source,
                  Object target,
                  boolean ignoreCase)
```
    复制Bean对象属性
    
    参数:
    source - 源Bean对象
    target - 目标Bean对象
    ignoreCase - 是否忽略大小写
  - copyProperties
```
public static void copyProperties(Object source,
                  Object target,
                  CopyOptions copyOptions)
```
    复制Bean对象属性
    限制类用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
    
    参数:
    source - 源Bean对象
    target - 目标Bean对象
    copyOptions - 拷贝选项，见 CopyOptions
  - isMatchName
```
public static boolean isMatchName(Object bean,
                  String beanClassName,
                  boolean isSimple)
```
    给定的Bean的类名是否匹配指定类名字符串
    如果isSimple为false，则只匹配类名而忽略包名，例如：cn.hutool.TestEntity只匹配TestEntity
    如果isSimple为true，则匹配包括包名的全类名，例如：cn.hutool.TestEntity匹配cn.hutool.TestEntity
    
    参数:
    bean - Bean
    beanClassName - Bean的类名
    isSimple - 是否只匹配类名而忽略包名，true表示忽略包名
    
    返回:
    是否匹配
    从以下版本开始:
    
    4.0.6
  - trimStrFields
```
public static <T> T trimStrFields(T bean,
                  String... ignoreFields)
```
    把Bean里面的String属性做trim操作。通常bean直接用来绑定页面的input，用户的输入可能首尾存在空格，通常保存数据库前需要把首尾空格去掉
    
    类型参数:
    T - Bean类型
    参数:
    bean - Bean对象
    ignoreFields - 不需要trim的Field名称列表（不区分大小写）
  - isEmpty
```
public static boolean isEmpty(Object bean)
```
    判断Bean是否为空对象，空对象表示本身为null或者所有属性都为null
    
    参数:
    bean - Bean对象
    
    返回:
    是否为空，true - 空 / false - 非空
    从以下版本开始:
    
    4.1.10
  - hasNullField
```
public static boolean hasNullField(Object bean)
```
    判断Bean是否包含值为null的属性
    对象本身为null也返回true
    
    参数:
    bean - Bean对象
    
    返回:
    是否包含值为null的属性，true - 包含 / false - 不包含
    从以下版本开始:
    
    4.1.10

类 BeanUtil

构造器概要

方法概要

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

构造器详细资料

BeanUtil

方法详细资料

isBean

hasSetter

hasGetter

createDynaBean

findEditor

hasNull

getBeanDesc

getPropertyDescriptors

getPropertyDescriptorMap

getPropertyDescriptor

getPropertyDescriptor

getFieldValue

setFieldValue

getProperty

setProperty

mapToBean

mapToBeanIgnoreCase

mapToBean

fillBeanWithMap

fillBeanWithMap

fillBeanWithMapIgnoreCase

fillBeanWithMap

fillBeanWithMap

toBean

toBean

fillBean

beanToMap

beanToMap

beanToMap

beanToMap

copyProperties

copyProperties

copyProperties

copyProperties

isMatchName

trimStrFields

isEmpty

hasNullField