BeanUtils (bus-all 5.6.6 API)

java.lang.Object
- org.aoju.bus.core.utils.BeanUtils

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

Since:

JDK 1.8+

Version:

5.6.6

Author:

Kimi Liu

Constructor Summary

Constructors
Constructor and Description

BeanUtils()

Constructors
Constructor and Description
`BeanUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`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则忽略这个字段,以便实现：
`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`	`create(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)` 判断Bean中是否有值为null的字段
`static boolean`	`hasNullField(Object bean)` 判断Bean是否包含值为`null`的属性对象本身为`null`也返回true
`static boolean`	`hasNullField(Object bean, String... ignoreFiledNames)` 判断Bean是否包含值为`null`的属性对象本身为`null`也返回true
`static boolean`	`hasPublicField(Class<?> clazz)` 指定类中是否有public类型字段(static字段除外)
`static boolean`	`hasSetter(Class<?> clazz)` 判断是否有Setter方法判定方法是是否存在只有一个参数的setXXX方法
`static boolean`	`isBean(Class<?> clazz)` 判断是否为Bean对象判定方法是是否存在只有一个参数的setXXX方法
`static boolean`	`isEmpty(Object bean, String... ignoreFiledNames)` 判断Bean是否为空对象，空对象表示本身为`null`或者所有属性都为`null`
`static boolean`	`isMatchName(Object bean, String beanClassName, boolean isSimple)` 给定的Bean的类名是否匹配指定类名字符串如果isSimple为`false`,则只匹配类名而忽略包名如果isSimple为`true`,则匹配包括包名的全类名
`static boolean`	`isNotEmpty(Object bean, String... ignoreFiledNames)` 判断Bean是否为非空对象，非空对象表示本身不为`null`或者含有非`null`属性的对象
`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`	`trimStrField(T bean, String... ignoreField)` 把Bean里面的String属性做trim操作

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class BeanUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BeanUtils

Method Detail

isBean

isEmpty

isNotEmpty

hasNull

hasSetter

hasGetter

hasPublicField

hasNullField

hasNullField

trimStrField

create

findEditor

getBeanDesc

getPropertyDescriptors

getPropertyDescriptorMap

getPropertyDescriptor

getPropertyDescriptor

getFieldValue

setFieldValue

getProperty

setProperty

toBean

toBean

mapToBean

mapToBean

mapToBeanIgnoreCase

fillBean

fillBeanWithMap

fillBeanWithMap

fillBeanWithMapIgnoreCase

fillBeanWithMap

fillBeanWithMap

beanToMap

beanToMap

beanToMap

beanToMap

copyProperties

copyProperties

copyProperties

copyProperties

isMatchName