如何扩展实现自定义的属性编辑器
- 自定义一个实现了PropertyEditorSupport接口的编辑器
- 让spring能够识别到此编辑器,自定义实现一个属性编辑器的注册器,实现了PropertyEditorRegistrar接口
- 让spring能够识别到对应的注册器
导航,文件结构
程序入口
package com.mashibing;
import com.mashibing.selfEditor.Customer;
public class TestCustomer {
//01 源码分析-spring的bean工厂准备工作.vep
//prepareBeanfactory
public static void main(String[] args) {
MyClassPathXmlApplicationContext ac = new MyClassPathXmlApplicationContext("selfEditor.xml");
Customer bean = ac.getBean(Customer.class);
System.out.println(bean);
}
}
Address类解析器注册
package com.mashibing.selfEditor;
import org.springframework.beans.PropertyEditorRegistrar;
import org.springframework.beans.PropertyEditorRegistry;
public class AddressPropertyEditorRegistrar implements PropertyEditorRegistrar {
@Override
public void registerCustomEditors(PropertyEditorRegistry registry) {
registry.registerCustomEditor(Address.class,new AddressPropertyEditor());
}
}
Address类解析器,将address值转换为Address类
package com.mashibing.selfEditor;
import java.beans.PropertyEditorSupport;
public class AddressPropertyEditor extends PropertyEditorSupport {
@Override
public void setAsText(String text) throws IllegalArgumentException {
String[] s = text.split("_");
Address address = new Address();
address.setProvince(s[0]);
address.setCity(s[1]);
address.setTown(s[2]);
this.setValue(address);
}
}
selfEditor.xml 有两种方式注入值
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="customer" class="com.mashibing.selfEditor.Customer">
<property name="name" value="zhangsan"></property>
<property name="address" value="河北省_邯郸市_武安市"></property>
</bean>
<bean class="org.springframework.beans.factory.config.CustomEditorConfigurer">
<property name="propertyEditorRegistrars">
<list>
<bean class="com.mashibing.selfEditor.AddressPropertyEditorRegistrar"></bean>
</list>
</property>
</bean>
<!-- <bean class="org.springframework.beans.factory.config.CustomEditorConfigurer">-->
<!-- <property name="customEditors">-->
<!-- <map>-->
<!-- <entry key="com.mashibing.selfEditor.Address">-->
<!-- <value>com.mashibing.selfEditor.AddressPropertyEditor</value>-->
<!-- </entry>-->
<!-- </map>-->
<!-- </property>-->
<!-- </bean>-->
<!-- -->
</beans>
测试用例
https://download.csdn.net/download/weixin_50750933/85749576
相关类
CustomEditorConfigurer.java
注意查看此文件最后一个方法postProcessBeanFactory,可以选择两种方式进行注入。
/*
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.beans.factory.config;
import java.beans.PropertyEditor;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.PropertyEditorRegistrar;
import org.springframework.core.Ordered;
import org.springframework.lang.Nullable;
import org.springframework.util.ClassUtils;
/**
* 此类用来方便的注册一个用户自定义的属性编辑器
*
* {@link BeanFactoryPostProcessor} implementation that allows for convenient
* registration of custom {@link PropertyEditor property editors}.
*
* <p>In case you want to register {@link PropertyEditor} instances,
* the recommended usage as of Spring 2.0 is to use custom
* {@link PropertyEditorRegistrar} implementations that in turn register any
* desired editor instances on a given
* {@link org.springframework.beans.PropertyEditorRegistry registry}. Each
* PropertyEditorRegistrar can register any number of custom editors.
*
* <pre class="code">
* <bean id="customEditorConfigurer" class="org.springframework.beans.factory.config.CustomEditorConfigurer">
* <property name="propertyEditorRegistrars">
* <list>
* <bean class="mypackage.MyCustomDateEditorRegistrar"/>
* <bean class="mypackage.MyObjectEditorRegistrar"/>
* </list>
* </property>
* </bean>
* </pre>
*
* <p>
* It's perfectly fine to register {@link PropertyEditor} <em>classes</em> via
* the {@code customEditors} property. Spring will create fresh instances of
* them for each editing attempt then:
*
* <pre class="code">
* <bean id="customEditorConfigurer" class="org.springframework.beans.factory.config.CustomEditorConfigurer">
* <property name="customEditors">
* <map>
* <entry key="java.util.Date" value="mypackage.MyCustomDateEditor"/>
* <entry key="mypackage.MyObject" value="mypackage.MyObjectEditor"/>
* </map>
* </property>
* </bean>
* </pre>
*
* <p>
* Note, that you shouldn't register {@link PropertyEditor} bean instances via
* the {@code customEditors} property as {@link PropertyEditor PropertyEditors} are stateful
* and the instances will then have to be synchronized for every editing
* attempt. In case you need control over the instantiation process of
* {@link PropertyEditor PropertyEditors}, use a {@link PropertyEditorRegistrar} to register
* them.
*
* <p>
* Also supports "java.lang.String[]"-style array class names and primitive
* class names (e.g. "boolean"). Delegates to {@link ClassUtils} for actual
* class name resolution.
*
* <p><b>NOTE:</b> Custom property editors registered with this configurer do
* <i>not</i> apply to data binding. Custom editors for data binding need to
* be registered on the {link org.springframework.validation.DataBinder}:
* Use a common base class or delegate to common PropertyEditorRegistrar
* implementations to reuse editor registration there.
*
* @author Juergen Hoeller
* @since 27.02.2004
* @see java.beans.PropertyEditor
* @see org.springframework.beans.PropertyEditorRegistrar
* @see ConfigurableBeanFactory#addPropertyEditorRegistrar
* @see ConfigurableBeanFactory#registerCustomEditor
* see org.springframework.validation.DataBinder#registerCustomEditor
*/
public class CustomEditorConfigurer implements BeanFactoryPostProcessor, Ordered {
protected final Log logger = LogFactory.getLog(getClass());
private int order = Ordered.LOWEST_PRECEDENCE; // default: same as non-Ordered
@Nullable
private PropertyEditorRegistrar[] propertyEditorRegistrars;
@Nullable
private Map<Class<?>, Class<? extends PropertyEditor>> customEditors;
public void setOrder(int order) {
this.order = order;
}
@Override
public int getOrder() {
return this.order;
}
/**
* Specify the {@link PropertyEditorRegistrar PropertyEditorRegistrars}
* to apply to beans defined within the current application context.
* <p>This allows for sharing {@code PropertyEditorRegistrars} with
* {link org.springframework.validation.DataBinder DataBinders}, etc.
* Furthermore, it avoids the need for synchronization on custom editors:
* A {@code PropertyEditorRegistrar} will always create fresh editor
* instances for each bean creation attempt.
* @see ConfigurableListableBeanFactory#addPropertyEditorRegistrar
*/
public void setPropertyEditorRegistrars(PropertyEditorRegistrar[] propertyEditorRegistrars) {
this.propertyEditorRegistrars = propertyEditorRegistrars;
}
/**
* Specify the custom editors to register via a {@link Map}, using the
* class name of the required type as the key and the class name of the
* associated {@link PropertyEditor} as value.
* @see ConfigurableListableBeanFactory#registerCustomEditor
*/
public void setCustomEditors(Map<Class<?>, Class<? extends PropertyEditor>> customEditors) {
this.customEditors = customEditors;
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
// 如果属性编辑注册器不等于空
if (this.propertyEditorRegistrars != null) {
// 遍历属性编辑注册器的集合
for (PropertyEditorRegistrar propertyEditorRegistrar : this.propertyEditorRegistrars) {
// 将属性编辑注册器添加到beanFactory
beanFactory.addPropertyEditorRegistrar(propertyEditorRegistrar);
}
}
// 如果自定义编辑器不等于空
if (this.customEditors != null) {
// 遍历自定义编辑器集合将自定义编辑器添加到beanFactory中
this.customEditors.forEach(beanFactory::registerCustomEditor);
}
}
}
疑问:editor通过PropertyEditorRegistrySupport.customEditors属性获得自定义解析器。
如果我注入的是propertyEditorRegistrar,则实在那里转换为customEditors的。
package org.springframework.beans;
TypeConverterDelegate.convertIfNecessaryconvertIfNecessary(@Nullable String propertyName, @Nullable Object oldValue, @Nullable Object newValue,
@Nullable Class requiredType, @Nullable TypeDescriptor typeDescriptor) throws IllegalArgumentException {}
PropertyEditor editor = this.propertyEditorRegistry.findCustomEditor(requiredType, propertyName);