Hutool Hutool
首页
指南
  • 核心(Hutool-core)
  • 配置文件(Hutool-setting)
  • 日志(Hutool-log)
  • 缓存(Hutool-cache)
  • JSON(Hutool-json)
  • 加密解密(Hutool-crypto)
  • DFA查找(Hutool-dfa)
  • 数据库(Hutool-db)
  • HTTP客户端(Hutool-http)
  • 定时任务(Hutool-cron)
  • 扩展(Hutool-extra)
  • 布隆过滤(Hutool-bloomFilter)
  • 切面(Hutool-aop)
  • 脚本(Hutool-script)
  • Office文档操作(Hutool-poi)
  • 系统调用(Hutool-system)
  • 图形验证码(Hutool-captcha)
  • 网络Socket(Hutool-socket)
  • JWT(Hutool-jwt)
支持
更新记录 (opens new window)
GitHub (opens new window)
首页
指南
  • 核心(Hutool-core)
  • 配置文件(Hutool-setting)
  • 日志(Hutool-log)
  • 缓存(Hutool-cache)
  • JSON(Hutool-json)
  • 加密解密(Hutool-crypto)
  • DFA查找(Hutool-dfa)
  • 数据库(Hutool-db)
  • HTTP客户端(Hutool-http)
  • 定时任务(Hutool-cron)
  • 扩展(Hutool-extra)
  • 布隆过滤(Hutool-bloomFilter)
  • 切面(Hutool-aop)
  • 脚本(Hutool-script)
  • Office文档操作(Hutool-poi)
  • 系统调用(Hutool-system)
  • 图形验证码(Hutool-captcha)
  • 网络Socket(Hutool-socket)
  • JWT(Hutool-jwt)
支持
更新记录 (opens new window)
GitHub (opens new window)
  • 快速入门

    • 简介
  • 核心(Hutool-core)

    • 克隆

      • 支持泛型的克隆接口和克隆类
    • 类型转换

      • 类型转换工具类-Convert
      • 自定义类型转换-ConverterRegistry
    • 日期时间

      • 概述
      • 日期时间工具-DateUtil
      • 日期时间对象-DateTime
      • 农历日期-ChineseDate
      • LocalDateTime工具-LocalDateTimeUtil
      • 计时器工具-TimeInterval
    • IO流相关

      • 概述
      • IO工具类-IoUtil
      • 文件工具类-FileUtil
      • 文件监听-WatchMonitor
      • 文件类型判断-FileTypeUtil
      • 文件

        • 文件读取-FileReader
        • 文件写入-FileWriter
        • 文件追加-FileAppender
        • 文件跟随-Tailer
        • 文件名工具-FileNameUtil
      • 资源

        • 概述
        • 资源工具-ResourceUtil
        • ClassPath资源访问-ClassPathResource
    • 工具类

      • 概述
      • 字符串工具-StrUtil
      • 16进制工具-HexUtil
      • Escape工具-EscapeUtil
      • Hash算法-HashUtil
      • URL工具-URLUtil
      • XML工具-XmlUtil
      • 对象工具-ObjectUtil
      • 反射工具-ReflectUtil
      • 泛型类型工具-TypeUtil
      • 分页工具-PageUtil
      • 剪贴板工具-ClipboardUtil
      • 类工具-ClassUtil
      • 枚举工具-EnumUtil
      • 命令行工具-RuntimeUtil
      • 数字工具-NumberUtil
      • 数组工具-ArrayUtil
      • 随机工具-RandomUtil
      • 唯一ID工具-IdUtil
      • 压缩工具-ZipUtil
      • 引用工具-ReferenceUtil
      • 正则工具-ReUtil
      • 身份证工具-IdcardUtil
      • 信息脱敏工具-DesensitizedUtil
      • 社会信用代码工具-CreditCodeUtil
      • SPI加载工具-ServiceLoaderUtil
      • 字符编码工具-CharsetUtil
      • 类加载工具-ClassLoaderUtil
    • 语言特性

      • 概述
      • HashMap扩展-Dict
      • 单例工具-Singleton
      • 断言-Assert
      • 二进码十进数-BCD
      • 控制台打印封装-Console
      • 字段验证器-Validator
      • 字符串格式化-StrFormatter
      • 树结构

        • 树结构工具-TreeUtil
    • JavaBean

      • 概述
      • Bean工具-BeanUtil
        • 什么是Bean
        • 方法
          • 是否为Bean对象
          • 内省 Introspector
          • Bean属性注入
          • Bean转为Map
          • Bean转Bean
          • Alias注解
      • DynaBean
      • 表达式解析-BeanPath
      • Bean描述-BeanDesc
      • 空检查属性获取-Opt
    • 集合类

      • 概述
      • 集合工具-CollUtil
      • 列表工具-ListUtil
      • Iterator工具-IterUtil
      • 有界优先队列-BoundedPriorityQueue
      • 线程安全的HashSet-ConcurrentHashSet
      • 集合串行流工具-CollStreamUtil
      • 行遍历器-LineIter
    • Map

      • 概述
      • Map工具-MapUtil
      • 双向查找Map-BiMap
      • 可重复键值Map-TableMap
      • Map流式构建器-MapBuilder copy
    • Codec编码

      • Base62编码解码-Base62
      • Base64编码解码-Base64
      • Base32编码解码-Base32
      • 莫尔斯电码-Morse
      • BCD码-BCD
      • 回转N位密码-Rot
      • Punycode实现-PunyCode
    • 文本操作

      • CSV文件处理工具-CsvUtil
      • Unicode编码转换工具-UnicodeUtil
      • 可复用字符串生成器-StrBuilder
      • 字符串切割-StrSplitter
    • 注解

      • 注解工具-AnnotationUtil
    • 比较器

      • 概述
      • 比较工具-CompareUtil
      • 版本比较器-VersionComparator
    • 异常

      • 异常工具-ExceptionUtil
      • 其它异常封装
    • 数学

      • 数学相关-MathUtil
    • 线程和并发

      • 线程工具-ThreadUtil
      • 异步工具类-AsyncUtil
      • 自定义线程池-ExecutorBuilder
      • 高并发测试-ConcurrencyTester
    • 图片

      • 图片工具-ImgUtil
      • 图片编辑器-Img
    • 网络

      • 网络工具-NetUtil
      • URL生成器-UrlBuilder
    • 源码编译

      • 源码编译工具-CompilerUtil
  • 配置文件(Hutool-setting)

    • 概述
    • Properties扩展-Props
    • 设置文件-Setting
  • 日志(Hutool-log)

    • 概述
    • 日志工厂-LogFactory
    • 疑惑解答
    • 静态调用日志-StaticLog
  • 缓存(Hutool-cache)

    • 概述
    • 缓存工具-CacheUtil
    • 先入先出-FIFOCache
    • 文件缓存-FileCache
    • 最少使用-LFUCache
    • 最近最久未使用-LRUCache
    • 超时-TimedCache
    • 弱引用-WeakCache
  • JSON(Hutool-json)

    • 概述
    • JSON工具-JSONUtil
    • JSON对象-JSONObject
    • JSON数组-JSONArray
  • 加密解密(Hutool-crypto)

    • 概述
    • 加密解密工具-SecureUtil
    • 国密算法工具-SmUtil
    • 对称加密-SymmetricCrypto
    • 摘要加密-Digester
    • 消息认证码算法-HMac
    • 签名和验证-Sign
    • 非对称加密-AsymmetricCrypto
  • DFA查找(Hutool-dfa)

    • 概述
    • DFA查找
  • 数据库(Hutool-db)

    • 概述
    • SQL执行器-SqlExecutor
    • 支持事务的CRUD-Session
    • 数据库简单操作-Db
    • 数据源工厂-DsFactory
    • 数据源配置db.setting样例
    • 案例1-导出Blob字段图像
    • 常见问题
    • NoSQL

      • Redis客户端封装-RedisDS
      • MongoDB客户端封装-MongoDS
  • HTTP客户端(Hutool-http)

    • 概述
    • Http客户端工具类-HttpUtil
    • HTML工具类-HtmlUtil
    • Http响应-HttpResponse
    • Http请求-HttpRequest
    • UA工具类-UserAgentUtil
    • 常用Http状态码-HttpStatus
    • 案例1-爬取开源中国的开源资讯
    • 常见问题
    • Server

      • 简易Http服务器-SimpleServer
    • WebService

      • Soap客户端-SoapClient
  • 定时任务(Hutool-cron)

    • 概述
    • 全局定时任务-CronUtil
  • 扩展(Hutool-extra)

    • 概述
    • Servlet工具-ServletUtil
    • 二维码工具-QrCodeUtil
    • 邮件工具-MailUtil
    • cglib

      • Cglib工具-CglibUtil
    • emoji

      • Emoji工具-EmojiUtil
    • FTP

      • FTP客户端封装-Ftp
      • 简易FTP服务器-SimpleFtpServer
    • Jsch封装

      • SFTP封装-Sftp
      • Jsch工具-JschUtil
    • Spring

      • Spring工具-SpringUtil
    • 中文分词

      • 中文分词封装-TokenizerUtil
    • 压缩

      • 压缩封装-CompressUtil
    • 拼音

      • 拼音工具-PinyinUtil
    • 表达式引擎

      • 表达式引擎封装-ExpressionUtil
    • 模板引擎

      • 模板引擎封装-TemplateUtil
  • 布隆过滤(Hutool-bloomFilter)

    • 概述
  • 切面(Hutool-aop)

    • 概述
    • 切面代理工具-ProxyUtil
  • 脚本(Hutool-script)

    • 概述
    • Script工具-ScriptUtil
  • Office文档操作(Hutool-poi)

    • 概述
    • Excel工具-ExcelUtil
    • Excel生成-ExcelWriter
    • Excel大数据生成-BigExcelWriter
    • Excel读取-ExcelReader
    • Word生成-Word07Writer
    • 流方式读取Excel2003-Excel03SaxReader
    • 流方式读取Excel2007-Excel07SaxReader
  • 系统调用(Hutool-system)

    • 系统属性调用-SystemUtil
    • Oshi封装-OshiUtil
  • 图形验证码(Hutool-captcha)

    • 概述
  • 网络Socket(Hutool-socket)

    • 概述
    • AIO封装-AioServer和AioClient
    • NIO封装-NioServer和NioClient
  • JWT(Hutool-jwt)

    • 概述
    • JWT工具-JWTUtil
    • JWT签名工具-JWTSignerUtil
    • JWT验证-JWTValidator
  • 指南
  • 核心(Hutool-core)
  • JavaBean
Hutool
2023-03-28
目录

Bean工具-BeanUtil

特别赞助 by:

# 什么是Bean

把一个拥有对属性进行set和get方法的类,我们就可以称之为JavaBean。实际上JavaBean就是一个Java类,在这个Java类中就默认形成了一种规则——对属性进行设置和获得。而反之将说Java类就是一个JavaBean,这种说法是错误的,因为一个java类中不一定有对属性的设置和获得的方法(也就是不一定有set和get方法)。

通常Java中对Bean的定义是包含setXXX和getXXX方法的对象,在Hutool中,采取一种简单的判定Bean的方法:是否存在只有一个参数的setXXX方法。

Bean工具类主要是针对这些setXXX和getXXX方法进行操作,比如将Bean对象转为Map等等。

# 方法

# 是否为Bean对象

BeanUtil.isBean方法根据是否存在只有一个参数的setXXX方法或者public类型的字段来判定是否是一个Bean对象。这样的判定方法主要目的是保证至少有一个setXXX方法用于属性注入。

boolean isBean = BeanUtil.isBean(HashMap.class);//false

# 内省 Introspector

把一类中需要进行设置和获得的属性访问权限设置为private(私有的)让外部的使用者看不见摸不着,而通过public(共有的)set和get方法来对其属性的值来进行设置和获得,而内部的操作具体是怎样的?外界使用的人不用知道,这就称为内省。

Hutool中对内省的封装包括:

  1. BeanUtil.getPropertyDescriptors 获得Bean字段描述数组
PropertyDescriptor[] propertyDescriptors = BeanUtil.getPropertyDescriptors(SubPerson.class);
  1. BeanUtil.getFieldNamePropertyDescriptorMap 获得字段名和字段描述Map
  2. BeanUtil.getPropertyDescriptor 获得Bean类指定属性描述

# Bean属性注入

BeanUtil.fillBean方法是bean注入的核心方法,此方法传入一个ValueProvider接口,通过实现此接口来获得key对应的值。CopyOptions参数则提供一些注入属性的选项。

CopyOptions的配置项包括:

  1. editable 限制的类或接口,必须为目标对象的实现接口或父类,用于限制拷贝的属性,例如一个类我只想复制其父类的一些属性,就可以将editable设置为父类。
  2. ignoreNullValue 是否忽略空值,当源对象的值为null时,true: 忽略而不注入此值,false: 注入null
  3. ignoreProperties 忽略的属性列表,设置一个属性列表,不拷贝这些属性值
  4. ignoreError 是否忽略字段注入错误

可以通过CopyOptions.create()方法创建一个默认的配置项,通过setXXX方法设置每个配置项。

ValueProvider接口需要实现两个方法:

  1. value方法是通过key和目标类型来从任何地方获取一个值,并转换为目标类型,如果返回值不和目标类型匹配,将会自动调用Convert.convert方法转换。
  2. containsKey方法主要是检测是否包含指定的key,如果不包含这个key,其对应的属性将会忽略注入。

首先定义两个bean:

// Lombok注解
@Data
public class Person{
	private String name;
	private int age;
}

// Lombok注解
@Data
public class SubPerson extends Person {
	public static final String SUBNAME = "TEST";

	private UUID id;
	private String subName;
	private Boolean isSlow;
}

然后注入这个bean:

Person person = BeanUtil.fillBean(new Person(), new ValueProvider<String>(){

	@Override
	public Object value(String key, Class<?> valueType) {
		switch (key) {
			case "name":
				return "张三";
			case "age":
				return 18;
		}
		return null;
	}

	@Override
	public boolean containsKey(String key) {
		//总是存在key
		return true;
	}
	
}, CopyOptions.create());

Assert.assertEquals(person.getName(), "张三");
Assert.assertEquals(person.getAge(), 18);

同时,Hutool还提供了BeanUtil.toBean方法,此处并不是传Bean对象,而是Bean类,Hutool会自动调用默认构造方法创建对象。

基于BeanUtil.fillBean方法Hutool还提供了Map对象键值对注入Bean,其方法有:

  1. BeanUtil.fillBeanWithMap 使用Map填充bean
HashMap<String, Object> map = CollUtil.newHashMap();
map.put("name", "Joe");
map.put("age", 12);
map.put("openId", "DFDFSDFWERWER");

SubPerson person = BeanUtil.fillBeanWithMap(map, new SubPerson(), false);
  1. BeanUtil.fillBeanWithMapIgnoreCase 使用Map填充bean,忽略大小写
HashMap<String, Object> map = CollUtil.newHashMap();
map.put("Name", "Joe");
map.put("aGe", 12);
map.put("openId", "DFDFSDFWERWER");
SubPerson person = BeanUtil.fillBeanWithMapIgnoreCase(map, new SubPerson(), false);

同时提供了map转bean的方法,与fillBean不同的是,此处并不是传Bean对象,而是Bean类,Hutool会自动调用默认构造方法创建对象。当然,前提是Bean类有默认构造方法(空构造),这些方法有:

  1. BeanUtil.toBean
HashMap<String, Object> map = CollUtil.newHashMap();
map.put("a_name", "Joe");
map.put("b_age", 12);
// 设置别名,用于对应bean的字段名
HashMap<String, String> mapping = CollUtil.newHashMap();
mapping.put("a_name", "name");
mapping.put("b_age", "age");
Person person = BeanUtil.toBean(map, Person.class, CopyOptions.create().setFieldMapping(mapping));
  1. BeanUtil.toBeanIgnoreCase
HashMap<String, Object> map = CollUtil.newHashMap();
map.put("Name", "Joe");
map.put("aGe", 12);

Person person = BeanUtil.toBeanIgnoreCase(map, Person.class, false);

# Bean转为Map

BeanUtil.beanToMap方法则是将一个Bean对象转为Map对象。

SubPerson person = new SubPerson();
person.setAge(14);
person.setOpenid("11213232");
person.setName("测试A11");
person.setSubName("sub名字");

Map<String, Object> map = BeanUtil.beanToMap(person);

# Bean转Bean

Bean之间的转换主要是相同属性的复制,因此方法名为copyProperties,此方法支持Bean和Map之间的字段复制。

BeanUtil.copyProperties方法同样提供一个CopyOptions参数用于自定义属性复制。

SubPerson p1 = new SubPerson();
p1.setSlow(true);
p1.setName("测试");
p1.setSubName("sub测试");

Map<String, Object> map = MapUtil.newHashMap();

BeanUtil.copyProperties(p1, map);

5.6.6+加入 复制集合中的Bean属性 List的转化可使用 copyToList


List<Student> studentList = new ArrayList<>();
Student student = new Student();
student.setName("张三");
student.setAge(123);
student.setNo(3158L);
studentList.add(student);

Student student2 = new Student();
student.setName("李四");
student.setAge(125);
student.setNo(8848L);
studentList.add(student2);
// 复制到 Person 类
List<Person> people = BeanUtil.copyToList(studentList, Person.class);

# Alias注解

5.x的Hutool中增加了一个自定义注解:@Alias,通过此注解可以给Bean的字段设置别名。

首先我们给Bean加上注解:

// Lombok注解
@Getter
@Setter
public static class SubPersonWithAlias {
	@Alias("aliasSubName")
	private String subName;
	private Boolean slow;

SubPersonWithAlias person = new SubPersonWithAlias();
person.setSubName("sub名字");
person.setSlow(true);

// Bean转换为Map时,自动将subName修改为aliasSubName
Map<String, Object> map = BeanUtil.beanToMap(person);
// 返回"sub名字"
map.get("aliasSubName")

同样Alias注解支持注入Bean时的别名:

Map<String, Object> map = MapUtil.newHashMap();
map.put("aliasSubName", "sub名字");
map.put("slow", true);

SubPersonWithAlias subPersonWithAlias = BeanUtil.mapToBean(map, SubPersonWithAlias.class, false);
// 返回"sub名字"
subPersonWithAlias.getSubName();
上次更新: 2023/05/08, 01:55:50
概述
DynaBean

← 概述 DynaBean→

Theme by Vdoing | Copyright © 2023-2023 Hutool | MulanPSL-2.0
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式