2. Spring早期类型转换，基于PropertyEditor实现

小灰灰 2022-12-24 11:55 93阅读 0赞

> 青年时种下什么，老年时就收获什么。关注公众号【**BAT的乌托邦**】，有Spring技术栈、MyBatis、JVM、中间件等小而美的**原创专栏**供以免费学习。分享、成长，拒绝浅尝辄止。本文已被 [**https://www.yourbatman.cn**][https_www.yourbatman.cn] 收录。

### 目录 ###

*  ✍前言
 *   *  版本约定
 *  ✍正文
 *   *  PropertyEditor是什么？
     *   *  注意：PropertyEditorSupport线程不安全
     *  Spring为何基于它扩展？
     *  Spring内建扩展实现有哪些？
     *   *  标准实现示例
         *  特殊实现
     *  “谁”在使用ProertyEditor
     *  PropertyEditor自动发现机制
     *  PropertyEditor存在的缺陷
 *  ✍总结
 *   *  附：Spring主要版本发布时间和特性
     *   *   *   *  ✔推荐阅读：
 *  ♥关注A哥♥

![在这里插入图片描述][20201203061043610.jpg_pic_center]

# ✍前言 #

你好，我是YourBatman。

Spring早在1.0（2004年发布，2003年孵化中）的时候，就有了类型转换功能模块。此模块存在的必要性不必多说，相信每个同学都可理解。最初，Spring做类型转换器是基于Java标准的`java.beans.PropertyEditor`这个API去扩展实现的，直到Spring 3.0后才得以出现更好替代方案（Spring 3.0发布于2009 年12月）。

> 提示：文章末尾附有Spring主要版本的发布时间和以及主要特性，感兴趣者可文末查看

虽说Spring自3.0就提出了更为灵活、优秀的类型转换接口/服务，但是早期基于`PropertyEditor`实现的转换器并未废弃且还在发挥余热中，因此本文就针对其早期类型转换实现做出专文讲解。

## 版本约定 ##

*  Spring Framework：5.3.1
 *  Spring Boot：2.4.0

> 说明：版本均于2020-11发布，且版本号均不带有`.RELEASE`后缀，这和之前是不一样的。具体原因请参考：[Spring改变版本号命名规则：此举对非英语国家很友好][Spring]

# ✍正文 #

若你用当下的眼光去看Spring基于`PropertyEditor`的类型转换实现，会发现这么搞是存在一些设计缺陷的。当然并不能这么去看，毕竟现在都2020年了，那会才哪跟哪呢。既然Spring里的`PropertyEditor`现如今依然健在，那咱就会会它呗。

## PropertyEditor是什么？ ##

`PropertyEditor`位于java.beans包中，要知道这个包里面的类都是设计为Java GUI程序（AWT）服务的，所以你看官方javadoc对`PropertyEditor`的介绍也无出其右：

A PropertyEditor class provides support for GUIs that want to allow users to edit a property value of a given type.

为GUI程序提供支持，允许你对给定的value进行编辑，作用类似于一个转换器：GUI上你可以输入、编辑某个属性然后经过它转换成合适的类型。  
![Java GUI程序][Java GUI]

此接口提供的方法挺多的，和本文类型转换有关的最多只有4个：

1.  `void setValue(Object value)`：设置属性值
2.  `Object getValue()`：获取属性值
3.  `String getAsText()`：输出。把属性值转换成String输出
4.  `void setAsText(String text)`：输入。将String转换为属性值类型输入

JDK对PropertyEditor接口提供了一个默认实现`java.beans.PropertyEditorSupport`，因此我们若需扩展此接口，仅需继承此类，根据需要复写`getAsText/setAsText`这两个方法即可，Spring无一例外都是这么做的。

PropertyEditor作为一个JDK原生接口，内置了一些基本实现来服务于GUI程序，如：

*  `BooleanEditor`：将true/false字符串转换为Boolean类型
 *  `IntegerEditor`：将字符串转换为Integer类型
    
     *  同类别的还有LongEditor、FloatEditor…

JDK内置的实现比较少（如上），功能简陋，但对于服务GUI程序来说已经够用，毕竟界面输入的只可能是字符串，并且还均是基础类型。但这对于复杂的Spring环境、以及富文本的web环境来说就不够用了，所以Spring在此基础上有所扩展，因此才有了本文来讨论。

### 注意：PropertyEditorSupport线程不安全 ###

`PropertyEditor`实现的是双向类型转换：String和Object互转。调用`setValue()`方法后，需要先“缓存”起来后续才能够使用（输出）。`PropertyEditorSupport`为此提供了一个成员属性来做：

PropertyEditorSupport：
    
        // 调用setValue()方法对此属性赋值 getValue()方法取值
    	private Object value;

这么一来`PropertyEditorSupport`就是有状态的了，因此是线程不安全的。在使用过程中需要特别注意，避免出现并发风险。

> 说明：Support类里还看到属性监听器`PropertyChangeListener`，因它属于GUI程序使用的组件，与我们无关，所以后续丝毫不会提及哦

Spring内置的**所有扩展**均是基于PropertyEditorSupport来实现的，因此也**都是**线程不安全的哦~

## Spring为何基于它扩展？ ##

官方的javadoc都说得很清楚：PropertyEditor设计是为GUI程序服务的，那么Spring为何看上它了呢？

试想一下：那会的Spring只能支持xml方式配置，而XML属于文本类型配置，因此在给某个属性设定值的时候，书写上去的\*\*100%\*\*是个字符串，但是此属性对应的类型却不一定是字符串，可能是任意类型。你思考下，这种场景是不是跟GUI程序（AWT）一毛一样：输入字符串，对应任意类型。

为了实现这种需求，在`PropertyEditorSupport`的基础上只需要复写`setAsText`和`getAsText`这两个方法就行，然后Spring就这么干了。我`个人yy`一下，当初Spring选择这么干而没自己另起炉灶的原因可能有这么几个：

1.  本着不重复发明轮子的原则，有得用就直接用呗，况且是100%满足要求的
2.  示好Java EE技术。毕竟那会Spring地位还并不稳，有大腿就先榜上
3.  2003年左右，Java GUI程序还并未退出历史舞台，Spring为了通用性就选择基于它扩展喽
    
    1.  说明：那会的通用性可能和现在通用性含义上是不一样的，需要稍作区别

## Spring内建扩展实现有哪些？ ##

Spring为了扩展自身功能，提高配置灵活性，扩展出了非常非常多的`PropertyEditor`实现，共计40余个，部分截图如下：  
![在这里插入图片描述][20201129232906258.png_pic_center]

<table> 
 <thead> 
  <tr> 
   <th>PropertyEditor</th> 
   <th>功能</th> 
   <th>举例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>ZoneIdEditor</td> 
   <td>转为java.time.ZoneId</td> 
   <td>Asia/Shanghai</td> 
  </tr> 
  <tr> 
   <td>URLEditor</td> 
   <td>转为URL，支持传统方式<code>file:,http:</code>，也支持Spring风格：<code>classpath:,context上下文相对路径</code>等等</td> 
   <td>http://www.baidu.com</td> 
  </tr> 
  <tr> 
   <td>StringTrimmerEditor</td> 
   <td>trim()字符串，也可删除指定字符char</td> 
   <td>任意字符串</td> 
  </tr> 
  <tr> 
   <td>StringArrayPropertyEditor</td> 
   <td>转为字符串数组</td> 
   <td>A,B,C</td> 
  </tr> 
  <tr> 
   <td>PropertiesEditor</td> 
   <td>转为Properties</td> 
   <td>name = YourBatman</td> 
  </tr> 
  <tr> 
   <td>PatternEditor</td> 
   <td>转为Pattern</td> 
   <td>(\D*)(\d+)(.*)</td> 
  </tr> 
  <tr> 
   <td>PathEditor</td> 
   <td>转为java.nio.file.Path。支持传统URL和Spring风格的url</td> 
   <td>classpath:xxx</td> 
  </tr> 
  <tr> 
   <td>ClassEditor</td> 
   <td>转为Class</td> 
   <td>全类名</td> 
  </tr> 
  <tr> 
   <td>CustomBooleanEditor</td> 
   <td>转为Boolean</td> 
   <td>见示例</td> 
  </tr> 
  <tr> 
   <td>CharsetEditor</td> 
   <td>转为Charset</td> 
   <td>见示例</td> 
  </tr> 
  <tr> 
   <td>CustomDateEditor</td> 
   <td>转为java.util.Date</td> 
   <td>见示例</td> 
  </tr> 
 </tbody> 
</table>

Spring把实现基本(大多数)都放在`org.springframework.beans.propertyeditors`包下，接下来我挑选几个代表性API举例说明。

### 标准实现示例 ###

*  **CustomBooleanEditor**：

@Test
    public void test1() { 
        PropertyEditor editor = new CustomBooleanEditor(true);
    
        // 这些都是true，不区分大小写
        editor.setAsText("trUe");
        System.out.println(editor.getAsText());
        editor.setAsText("on");
        System.out.println(editor.getAsText());
        editor.setAsText("yes");
        System.out.println(editor.getAsText());
        editor.setAsText("1");
        System.out.println(editor.getAsText());
    
        // 这些都是false（注意：null并不会输出为false，而是输出空串）
        editor.setAsText(null);
        System.out.println(editor.getAsText());
        editor.setAsText("fAlse");
        System.out.println(editor.getAsText());
        editor.setAsText("off");
        System.out.println(editor.getAsText());
        editor.setAsText("no");
        System.out.println(editor.getAsText());
        editor.setAsText("0");
        System.out.println(editor.getAsText());
    
        // 报错
        editor.setAsText("2");
        System.out.println(editor.getAsText());
    }

关注点：对于Spring来说，传入的**true、on、yes、1**等都会被“翻译”成true（字母不区分大小写），大大提高兼容性。

> 现在知道为啥你用Postman传个1，用Bool值也能正常封装进去了吧，就是它的功劳。此效果等同于转换器`StringToBooleanConverter`，将在后面进行讲述对比

*  **CharsetEditor**：

@Test
    public void test2() { 
        // 虽然都行，但建议你规范书写：UTF-8
        PropertyEditor editor = new CharsetEditor();
        editor.setAsText("UtF-8");
        System.out.println(editor.getAsText()); // UTF-8
        editor.setAsText("utF8");
        System.out.println(editor.getAsText()); // UTF-8
    }

关注点：utf-8中间的横杠可要可不要，但建议加上使用标准写法，另外字母也是不区分大小写的。

*  **CustomDateEditor**：

@Test
    public void test3() { 
        PropertyEditor editor = new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"),true);
        editor.setAsText("2020-11-30 09:10:10");
        System.out.println(editor.getAsText()); // 2020-11-30 09:10:10
    
        // null输出空串
        editor.setAsText(null);
        System.out.println(editor.getAsText());
    
        // 报错
        editor.setAsText("2020-11-30");
        System.out.println(editor.getAsText());
    }

关注点：这个时间/日期转换器很不好用，构造时就必须指定一个`SimpleDateFormat`格式化器。在实际应用中，Spring并没有使用到它，而是用后面会说到的替代方案。

### 特殊实现 ###

把没有放在`org.springframework.beans.propertyeditors`包下的实现称作特殊实现（前者称为标准实现）。

*  **MediaTypeEditor**：位于org.springframework.http。依赖的核心API是`MediaType.parseMediaType(text)`，可以把诸如text/html、application/json转为MediaType对象
    
     *  显然它属于spring-web包，使用在web环境下
 *  **FormatterPropertyEditorAdapter**：位于org.springframework.format.support。将3.0新增的Formatter接口适配为一个PropertyEditor：setAsText这种转换操作委托给`formatter.parse()`去完成，反向委托给`formatter.print()`去完成。
    
     *  此适配器在`DataBinder#addCustomFormatter()`得到应用
 *  **PropertyValuesEditor**：位于org.springframework.beans。将k-v字符串（Properties格式）转换为一个PropertyValues，从而方便放进Environment里
 *  **ResourceEditor**：位于org.springframework.core.io。此转换器将String转换为`Resource`资源，特别实用。作为基础设施，广泛被用到Spring的很多地方
    
     *  像什么标准的`FileEditor、InputSourceEditor、InputStreamEditor、URLEditor`等等与资源相关的转换器，均依赖它而实现

@Test
    public void test4() { 
        // 支持标准URL如file:C:/myfile.txt，也支持classpath:myfile.txt
        // 同时还支持占位符形式
        PropertyEditor editor = new ResourceEditor(new DefaultResourceLoader(), new StandardEnvironment(), true);
    
        // file:形式本处略
        // editor.setAsText("file:...");
        // System.out.println(editor.getAsText());
    
        // classpath形式（注意：若文件不存在不会报错，而是输出null）
        editor.setAsText("classpath:app.properties");
        System.out.println(editor.getAsText()); // 输出带盘符的全路径
    
        System.setProperty("myFile.name", "app.properties");
        editor.setAsText("classpath:${myFile.name}");
        System.out.println(editor.getAsText()); // 结果同上
    }

关注点：Spring扩展出来的Resource不仅自持常规`file:`资源协议，还支持平时使用最多的`classpath:`协议，可谓非常好用。

*  **ConvertingPropertyEditorAdapter**：位于org.springframework.core.convert.support。将3.0新增的`ConversionService`转换服务适配为一个`PropertyEditor`，内部转换动作都委托给前者去完成。
    
     *  `AbstractPropertyBindingResult#findEditor()`为属性寻找合适PropertyEditor的时候，若ConversionService能支持就包装为ConvertingPropertyEditorAdapter供以使用，这是适配器模式的典型应用场景。

## “谁”在使用ProertyEditor ##

## PropertyEditor自动发现机制 ##

## PropertyEditor存在的缺陷 ##

考虑到阅读的舒适性，单篇文章不宜太长，因此涉及到`PropertyEditor`的这几个问题，放在下篇文章单独列出。这个几个问题会明显比本文更深入，欢迎保持持续关注，peace！

# ✍总结 #

本文主要介绍了三点内容：

1.  PropertyEditor是什么？
2.  Spring为何选择基于PropertyEditor？
3.  Spring内建的那些PropertyEditor都有哪些，各自什么作用？

PropertyEditor虽然已经很古老，不适合当下复杂环境。但不可否认它依旧有存在的价值，Spring内部也大量的仍在使用，因此**不容忽视**。下篇文章将深度探讨Spring内部是如何使用PropertyEditor的，赋予了它哪些机制，以及最终为何还是决定自己另起炉灶搞一套呢？欢迎对本系列保持持续关注~

--------------------

## 附：Spring主要版本发布时间和特性 ##

*  **2002-02**，开始开发孵化此项目，项目名叫：`interface21`，它便就是Spring的前身
 *  **2004-03**，1.0版发布。进入迅速发展期
 *  **2006-10**，2.0版发布。支持可扩展的xml配置功能、支持Java5、支持动态语言、支持更多扩展点
 *  **2007-11**，2.5版发布。项目名从此改为Spring Source，支持Java 6，支持注解配置（部分）
 *  **2009-12**，3.0版发布。这是非常非常重要的一个版本，支持了模块驱动、支持SpEL、支持Java Bean配置、支持嵌入式数据库…
 *  **2011和2012**，这两年发布了非常多的3.x系列小版本，带来了很多惊喜，同时也让Spring更加扎实
 *  **2013-12**，4.0版发布。这是有一次进步，提供了对Java 8的全面支持，支持Java EE 7、支持websocket、泛型依赖注入…
 *  **2017-09**，5.0版发布。最低JDK版本要求是Java 8，同时支持Servlet 3.1。当然最为重要的是引入了全新模块：WebFlux

截止到当前，Spring Framework的最新版本是`5.3.x`版本，此版本是5.x的最后一个主要功能分支，下个版本将是6.x喽，咱们拭目以待。

--------------------

##### ✔推荐阅读： #####

*  [1. 揭秘Spring类型转换 - 框架设计的基石][1. _Spring_ -]
 *  
 *  [蚂蚁金服上市了，我不想努力了][Link 1]
 *  [如果程序员和产品经理都用凡尔赛文学对话…][Link 2]
 *  [程序人生 | 春风得意马蹄疾，一日看尽长安花][Link 3]

--------------------

# ♥关注A哥♥ #

<table> 
 <thead> 
  <tr> 
   <th>Author</th> 
   <th><a href="https://www.yourbatman.cn/about" rel="nofollow">A哥(YourBatman)</a></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>个人站点</td> 
   <td><a href="https://www.yourbatman.cn" rel="nofollow">www.yourbatman.cn</a></td> 
  </tr> 
  <tr> 
   <td>E-mail</td> 
   <td>yourbatman@qq.com</td> 
  </tr> 
  <tr> 
   <td><strong>微 信</strong></td> 
   <td><a href="https://www.yourbatman.cn/images/wechat.png" rel="nofollow">fsx1056342982</a></td> 
  </tr> 
  <tr> 
   <td><strong><code>活跃平台</code></strong></td> 
   <td><a href="https://www.yourbatman.cn" rel="nofollow"><img src="https://img-blog.csdnimg.cn/2020071015182276.png" alt=""></a> <a href="https://fangshixiang.blog.csdn.net/" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710151913394.png" alt=""></a><a href="https://yourbatman.cnblogs.com" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710151929355.png" alt=""></a><a href="https://juejin.im/user/5b44d178f265da0fa1220efe/posts" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710151938937.png" alt=""></a><a href="https://www.zhihu.com/people/fangshixiang/posts" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710151950629.png" alt=""></a><a href="https://www.jianshu.com/u/8740f1fdd684" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710152000530.png" alt=""></a><a href="https://segmentfault.com/u/yourbatman/articles" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710152008726.png" alt=""></a><a href="https://github.com/yourbatman" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710152015895.png" alt=""></a></td> 
  </tr> 
  <tr> 
   <td><strong>公众号</strong></td> 
   <td><a href="https://www.yourbatman.cn/images/wechat_channel.jpg" rel="nofollow">BAT的乌托邦（ID：BAT-utopia）</a></td> 
  </tr> 
  <tr> 
   <td>知识星球</td> 
   <td><a href="https://t.zsxq.com/nQBi66I" rel="nofollow">BAT的乌托邦</a></td> 
  </tr> 
  <tr> 
   <td>每日文章推荐</td> 
   <td><a href="https://github.com/yourbatman/reading/issues" rel="nofollow">每日文章推荐</a></td> 
  </tr> 
 </tbody> 
</table>

![BAT的乌托邦][BAT]

[https_www.yourbatman.cn]: https://www.yourbatman.cn
[20201203061043610.jpg_pic_center]: /images/20221120/efb47c18ba2a4d89b0f9973ea4ffe1d1.png
[Spring]: https://mp.weixin.qq.com/s/ZoUG9h1TndW2QpnPyGeIQA
[Java GUI]: /images/20221120/1bfc0873ee604752a928a21414a73869.png
[20201129232906258.png_pic_center]: https://img-blog.csdnimg.cn/20201129232906258.png#pic_center
[1. _Spring_ -]: https://mp.weixin.qq.com/s/5daOOdhIFqrGbpgtnuQMNw
[Link 1]: https://mp.weixin.qq.com/s/oEShE0fiHSGG8D89NRQYGw
[Link 2]: https://mp.weixin.qq.com/s/SZUJ0sy4vM7UH10pk6NM3g
[Link 3]: https://mp.weixin.qq.com/s/PGIFtpI7aZaxY7es0F6C6Q
[BAT]: https://img-blog.csdnimg.cn/20200710160552549.gif