為什么不推薦使用BeanUtils屬性轉(zhuǎn)換工具
往期熱門(mén)文章：
來(lái)源：blog.csdn.net/w605283073/article/details/1073714621、事務(wù)注解 @Transactional 失效的3種場(chǎng)景及解決辦法 2、看看人家SpringBoot的全局異常處理多么優(yōu)雅... 3、代碼總是被嫌棄寫(xiě)的太爛？裝上這個(gè)IDEA插件再試試！ 4、60個(gè)相見(jiàn)恨晚的神器工具！ 5、這10個(gè)讓你笑的合不攏嘴的GitHub項(xiàng)目，居然拿了7萬(wàn)星！
1 背景
之前在專欄中講過(guò)“不推薦使用屬性拷貝工具”，推薦直接定義轉(zhuǎn)換類(lèi)和方法使用 IDEA 插件自動(dòng)填充 get / set 函數(shù)。
不推薦的主要理由是：
有些屬性拷貝工具性能有點(diǎn)差 有些屬性拷貝工具有“BUG” 使用屬性拷貝工具容易存在一些隱患（后面例子會(huì)講到）
2 示例
首先公司內(nèi)部就遇到過(guò) commons 包的 BeanUtils 進(jìn)行屬性拷貝性能較差的真實(shí)案例，然后該同事?lián)Q成了 Spring 的 BeanUtils 性能好了很多，感興趣大家可以使用性能測(cè)試框架或者基準(zhǔn)測(cè)試框架去對(duì)比，這里就不對(duì)比了。
接下來(lái)我們看 Spring 的 BeanUtils 的屬性拷貝會(huì)存在啥問(wèn)題：
import lombok.Data;
import java.util.List;
@Data
public class A {
private String name;
private List<Integer> ids;
}
@Data
public class B {
private String name;
private List<String> ids;
}
import org.springframework.beans.BeanUtils;
import java.util.Arrays;
public class BeanUtilDemo {
public static void main(String[] args) {
A first = new A();
first.setName("demo");
first.setIds(Arrays.asList(1, 2, 3));
B second = new B();
BeanUtils.copyProperties(first, second);
for (String each : second.getIds()) {// 類(lèi)型轉(zhuǎn)換異常
System.out.println(each);
}
}
}
大家運(yùn)行上述示例時(shí)，會(huì)發(fā)生類(lèi)型轉(zhuǎn)換異常。
打斷點(diǎn)可以看到，屬性拷貝之后 B 類(lèi)型的 second 對(duì)象中 ids 仍然為 Integer 類(lèi)型：
如果不轉(zhuǎn)換為字符串，直接進(jìn)行打印，并不會(huì)報(bào)錯(cuò)。
使用CGlib 在不定義Converter 的情況下也會(huì)遇到類(lèi)似問(wèn)題：
import org.easymock.cglib.beans.BeanCopier;
import java.util.Arrays;
public class BeanUtilDemo {
public static void main(String[] args) {
A first = new A();
first.setName("demo");
first.setIds(Arrays.asList(1, 2, 3));
B second = new B();
final BeanCopier beanCopier = BeanCopier.create(A.class, B.class, false);
beanCopier.copy(first,second,null);
for (String each : second.getIds()) {// 類(lèi)型轉(zhuǎn)換異常
System.out.println(each);
}
}
}
同樣，問(wèn)題在運(yùn)行時(shí)才暴露出來(lái)。
接下來(lái)我們看下 mapstruct：
import org.mapstruct.Mapper;
import org.mapstruct.factory.Mappers;
@Mapper
public interface Converter {
Converter INSTANCE = Mappers.getMapper(Converter.class);
B aToB(A car);
}
import java.util.Arrays;
public class BeanUtilDemo {
public static void main(String[] args) {
A first = new A();
first.setName("demo");
first.setIds(Arrays.asList(1, 2, 3));
B second = Converter.INSTANCE.aToB(first);
for (String each : second.getIds()) {// 正常
System.out.println(each);
}
}
}
可以成功的將 A 中 List<Integer> 轉(zhuǎn)為 B 中的 List<String> 類(lèi)型。
我們看下編譯生成的 Converter 實(shí)現(xiàn)類(lèi)：
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Generated;
import org.springframework.stereotype.Component;
@Generated(
value = "org.mapstruct.ap.MappingProcessor",
comments = "version: 1.3.1.Final, compiler: javac, environment: Java 1.8.0_202 (Oracle Corporation)"
)
@Component
public class ConverterImpl implements Converter {
@Override
public B aToB(A car) {
if ( car == null ) {
return null;
}
B b = new B();
b.setName( car.getName() );
b.setIds( integerListToStringList( car.getIds() ) );
return b;
}
protected List<String> integerListToStringList(List<Integer> list) {
if ( list == null ) {
return null;
}
List<String> list1 = new ArrayList<String>( list.size() );
for ( Integer integer : list ) {
list1.add( String.valueOf( integer ) );
}
return list1;
}
}
自動(dòng)幫我們進(jìn)行了轉(zhuǎn)換，我們可能沒(méi)有意識(shí)到類(lèi)型并不一致。
如果我們?cè)?A 類(lèi)中添加一個(gè) String number 屬性，在 B 類(lèi)中添加一個(gè) Long number 屬性，使用 mapstruect 當(dāng) number 設(shè)置為非數(shù)字類(lèi)型時(shí)就會(huì)報(bào) .NumberFormatException。
@Override
public B aToB(A car) {
if ( car == null ) {
return null;
}
B b = new B();
b.setName( car.getName() );
if ( car.getNumber() != null ) { // 問(wèn)題出在這里
b.setNumber( Long.parseLong( car.getNumber() ) );
}
b.setIds( integerListToStringList( car.getIds() ) );
return b;
}
使用 cglib 默認(rèn)則不會(huì)映射 number 屬性，B 中的 number 為 null。
如果手動(dòng)定義轉(zhuǎn)換器，使用 IDEA 插件(如 generateO2O)自動(dòng)轉(zhuǎn)換：
public final class A2BConverter {
public static B from(A first) {
B b = new B();
b.setName(first.getName());
b.setIds(first.getIds());
return b;
}
}
在編碼階段就可以非常明確地發(fā)現(xiàn)這個(gè)問(wèn)題：
3 結(jié)論
由于 Java 的泛型其實(shí)是編譯期檢查，編譯后泛型擦除，導(dǎo)致運(yùn)行時(shí) List<Integer> 和 List<String> 都是 List 類(lèi)型，可以正常賦值。這就導(dǎo)致在使用很多屬性映射工具時(shí)，編譯時(shí)不容易明顯的錯(cuò)誤。
mapstruct 自定義了注解處理器，在編譯階段可以讀取映射雙方的泛型類(lèi)型，進(jìn)而進(jìn)行映射。但是這種映射也很可怕，有時(shí)候我們由于粗心等原因定義錯(cuò)了類(lèi)型，自動(dòng)幫助我們進(jìn)行了轉(zhuǎn)換，會(huì)帶了很多副作用。
之前對(duì)各種屬性映射工具的性能進(jìn)行了簡(jiǎn)單的對(duì)比，結(jié)果如下：
因此慎用屬性轉(zhuǎn)換工具，如果可能建議自定義轉(zhuǎn)換類(lèi)，使用IDEA插件自動(dòng)填充，效率也挺高， A 或 B 中任何屬性類(lèi)型不匹配，甚至刪除一個(gè)屬性，編譯階段即可報(bào)錯(cuò)，而且直接調(diào)用 get set 的效率也是非常高的。
最近熱文閱讀：
1、事務(wù)注解 @Transactional 失效的3種場(chǎng)景及解決辦法 2、看看人家SpringBoot的全局異常處理多么優(yōu)雅... 3、代碼總是被嫌棄寫(xiě)的太爛？裝上這個(gè)IDEA插件再試試！ 4、60個(gè)相見(jiàn)恨晚的神器工具！ 5、終于來(lái)了，IDEA 2021.1版本正式發(fā)布，完美支持WSL 2 6、面試被問(wèn)事務(wù)注解 @Transactional 失效怎么解決？ 7、CTO 說(shuō)了，用錯(cuò) @Autowired 和 @Resource 的人可以領(lǐng)盒飯了 8、在項(xiàng)目中用了Arrays.asList、ArrayList的subList，被公開(kāi)批評(píng) 9、別總寫(xiě)代碼，這130個(gè)網(wǎng)站比漲工資都重要 10、哇！IntelliJ IDEA 2021.1 中竟然有這么多牛逼的插件~ 關(guān)注公眾號(hào)，你想要的Java都在這里