概述
眾所周知，java世界是由類構成的，各種各樣的類，提供各種各樣的作用，共同創造了一個個的java應用。物件是類的例項，在SpringBoot框架中，物件經常需要複製，例如資料庫實體複製成業務實體，匯入實體轉換為業務實體，各種資料傳輸物件之間的複製等等。日常開發工作中用到的地方和頻率是相當的高。本文就圍繞物件複製來聊聊常用的姿勢（方式）和工具。
定義實體類
為了演示物件複製將建立幾個實體類和幾個生成測試資料的方法。
Car
car描述了車輛這個業務物件， 其中包含一些常見的基本資料型別的屬性和一個 size型別 的屬性，即包含基本資料型別和引用型別，包含子實體。
import lombok.Data;
import lombok.experimental.Accessors;
import java.io.Serializable;
import java.math.BigDecimal;
import java.time.LocalDate;
@Data
@Accessors(chain = true)
public class Car implements Serializable {
private Integer id;
private String name;
private String brand;
private String address;
private Size size;
private Double cc;
/**
* 扭矩
*/
private Double torque;
/**
* 廠商
*/
private String manufacturer;
/**
* 上市時間
*/
private LocalDate marketDate;
/**
* 售價
*/
private BigDecimal price;
}
size
size描述了車輛大小，具體來說就是長寬高。
import lombok.Data;
import lombok.experimental.Accessors;
import java.io.Serializable;
@Data
@Accessors(chain = true)
public class Size implements Serializable {
private Double length;
private Double width;
private Double height;
}
carInfo
car物件需要複製為carInfo物件，他們兩個大部分屬性都一樣，carInfo比car多了 color ，type
package com.ramble.demo.dto;
import com.ramble.demo.model.Size;
import lombok.Data;
import lombok.experimental.Accessors;
import java.io.Serializable;
import java.math.BigDecimal;
import java.time.LocalDate;
@Data
@Accessors(chain = true)
public class CarInfo implements Serializable {
private Integer id;
private String name;
private String brand;
private String address;
private Size size;
private Double cc;
/**
* 扭矩
*/
private Double torque;
/**
* 廠商
*/
private String manufacturer;
/**
* 上市時間
*/
private LocalDate marketDate;
/**
* 售價
*/
private BigDecimal price;
private String color;
private Integer type;
}
造測試資料
造測試資料用到了一個工具 javaFaker，透過例項化一個Faker 物件可以輕易的生成測試資料：人名、地址、網址、手機號。。。。。。
gav座標為：
<dependency>
<groupId>com.github.javafaker</groupId>
<artifactId>javafaker</artifactId>
<version>1.0.2</version>
</dependency>
造資料方法很簡單，一個批次一個單個，可以透過count來控制造的資料量。
/**
* 批次造資料
*
* @return
*/
private List<Car> findCar() {
Faker faker = new Faker(new Locale("zh-CN"));
List<Car> list = new ArrayList<>();
int count = 100000;
for (int i = 0; i < count; i++) {
list.add(getCar(faker));
}
return list;
}
/**
* 造資料 - 單個
*
* @param faker
* @return
*/
private Car getCar(Faker faker) {
Car car = new Car();
car.setId(faker.number().numberBetween(1, 999999999));
car.setName(faker.name().name());
car.setBrand(faker.cat().breed());
car.setAddress(faker.address().fullAddress());
Size size = new Size();
size.setLength(faker.number().randomDouble(7, 4000, 7000));
size.setWidth(faker.number().randomDouble(7, 4000, 7000));
size.setHeight(faker.number().randomDouble(7, 4000, 7000));
car.setSize(size);
car.setCc(faker.number().randomDouble(7, 1000, 12000));
car.setTorque(faker.number().randomDouble(1, 100, 70000));
car.setManufacturer(faker.name().name());
Date date = faker.date().birthday();
Instant instant = date.toInstant();
ZoneId zone = ZoneId.systemDefault();
LocalDate localDate = instant.atZone(zone).toLocalDate();
car.setMarketDate(localDate);
car.setPrice(BigDecimal.valueOf(faker.number().randomDigit()));
return car;
}
Spring BeanUtils
這麼常用的功能官方肯定已經整合了，對對對，就是BeanUtils.copyProperties了。順便說一句，遇到找工具類的時候不要盲目baidu，不妨先看看springframework.util這個包下面的東西。
下面看看Spring的BeanUtils.copyProperties用法舉例
Faker faker = new Faker(new Locale("zh-CN"));
Car car = getCar(faker);
CarInfo carInfo = new CarInfo();
BeanUtils.copyProperties(car, carInfo);
- 使用反射實現兩個物件的複製
- 不會對型別進行轉換，如source物件有一個integer型別的id屬性，target物件有一個string型別的id屬性，複製之後，target物件為null；同理integer 無法複製到long
- 官方出品，無需引入其他依賴，推薦指數8顆星
Apache BeanUtils
apache-common系列的東西，java開發多多少少會用到一些，它本身也積累了很多經驗提供一些有用並常用的工具和元件。
針對BeanUtils 使用前需要引入pom
<!-- https://mvnrepository.com/artifact/commons-beanutils/commons-beanutils -->
<dependency>
<groupId>commons-beanutils</groupId>
<artifactId>commons-beanutils</artifactId>
<version>1.9.4</version>
</dependency>
下面看看Apache的BeanUtils.copyProperties 用法舉例
Faker faker = new Faker(new Locale("zh-CN"));
Car car = getCar(faker);
CarInfo carInfo = new CarInfo();
try {
org.apache.commons.beanutils.BeanUtils.copyProperties(carInfo, car);
} catch (IllegalAccessException e) {
throw new RuntimeException(e);
} catch (InvocationTargetException e) {
throw new RuntimeException(e);
}
- 強制要處理異常
- source物件和target物件相對Spring來說是顛倒的
- 透過反射實現
- 不會對型別進行轉換，如source物件有一個integer型別的id屬性，target物件有一個string型別的id屬性，複製之後，target物件為null；同理integer 無法複製到long
- 效能稍微遜色與Spring，推薦指數7顆星
Cglib BeanCopier
BeanCopier使用起來稍微有點複雜，需要先例項化一個BeanCopier物件，然後再呼叫其copy方法完成物件複製
使用前需要引入如下pom
<dependency>
<groupId>cglib</groupId>
<artifactId>cglib</artifactId>
<version>3.2.0</version>
</dependency>
下面看看 Cglib 的 BeanCopier 用法舉例
Faker faker = new Faker(new Locale("zh-CN"));
Car car = getCar(faker);
CarInfo item = new CarInfo();
inal BeanCopier copier = BeanCopier.create(Car.class, CarInfo.class, false);
copier.copy(car, item, null);
- BeanCopier雖然使用複雜，且要引入依賴，但是效能出眾
- 對於資料量小的情況不沒有必要使用這個，推薦指數5顆星
- 對於資料量大，比如5W個物件複製為另外一個物件，這種場景雖然少但是一旦發生了Spring BeanUtils處理起來就非常耗時，這種情況下推薦指數9顆星
MapStruct
MapStruct 是一個程式碼生成器，它基於約定生成的對映程式碼使用的是普通的方法呼叫，因此快速、型別安全且易於理解。MapStruct 本質沒有太多科技與狠活，就是幫助開發人員編寫getA，setB這樣的樣板程式碼，並提供擴充套件點，比如將carType對映為type。
使用前需要引入如下pom
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>1.5.0.Final</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>1.5.0.Final</version>
</dependency>
下面看看MapStruct用法舉例
使用前需要先定義一個介面，編寫轉換邏輯，而後透過呼叫介面方法獲取轉換後的結果。
CarInfoMapper
import com.ramble.demo.dto.CarInfo;
import com.ramble.demo.model.Car;
import org.mapstruct.Mapper;
import org.mapstruct.factory.Mappers;
@Mapper
public interface CarInfoMapper {
CarInfoMapper INSTANCT = Mappers.getMapper(CarInfoMapper.class);
CarInfo carToCarInfo(Car car);
}
- Mapper：將此介面標註為用來轉換bean的介面，並在編譯過程中生成相應的實現類
- carToCarInfo，宣告一個轉換方法，並將source作為方法入參，target作為方法出參
- INSTANCT，按照約定，介面宣告一個INSTANCT成員，提供給訪問者消費
- 一個介面可以有多個轉換方法
- 可透過在方法上新增@Mapping註解，將不同屬性名子的屬性進行轉換
- 可以將列舉型別轉換為字串
- 效能出眾，術業有專攻，在處理複雜轉換和大資料量的時候很有必要
- 因為要引入依賴並且需要單獨編寫介面，所以對於簡單的轉換還是推薦Spring，這種情況下推薦指數5顆星
- 如果在大資料量的情況，並且轉換相對複雜，推薦指數10顆星
呼叫 CarInfoMapper 進行物件複製
Faker faker = new Faker(new Locale("zh-CN"));
Car car = getCar(faker);
CarInfo carInfo = CarInfoMapper.INSTANCT.carToCarInfo(car);
效能測試
原則上， 效能測試是多維度的，速度、CPU消耗、記憶體消耗等等，本文僅考慮速度，只為說明問題，不為得到測試資料
測試程式碼邏輯，使用for結合faker生成一個大的List
測試程式碼如下：
/**
* 測試4種方式的處理速度
*/
@GetMapping("/test1")
public void test1() {
Faker faker = new Faker(new Locale("zh-CN"));
List<Car> carList = findCar();
StopWatch sw = new StopWatch("物件複製速度測試");
sw.start("方式1:Spring BeanUtils.copyProperties");
List<CarInfo> list1 = new ArrayList<>();
carList.forEach(x -> {
CarInfo item = new CarInfo();
BeanUtils.copyProperties(x, item);
item.setColor(faker.color().name());
item.setType(faker.number().randomDigit());
list1.add(item);
});
sw.stop();
sw.start("方式2:apache BeanUtils.copyProperties");
List<CarInfo> list2 = new ArrayList<>();
carList.forEach(x -> {
CarInfo item = new CarInfo();
try {
org.apache.commons.beanutils.BeanUtils.copyProperties(item, x);
} catch (IllegalAccessException e) {
throw new RuntimeException(e);
} catch (InvocationTargetException e) {
throw new RuntimeException(e);
}
item.setColor(faker.color().name());
item.setType(faker.number().randomDigit());
list2.add(item);
});
sw.stop();
sw.start("方式3:BeanCopier");
List<CarInfo> list3 = new ArrayList<>();
carList.forEach(x -> {
CarInfo item = new CarInfo();
final BeanCopier copier = BeanCopier.create(Car.class, CarInfo.class, false);
copier.copy(x, item, null);
item.setColor(faker.color().name());
item.setType(faker.number().randomDigit());
list3.add(item);
});
sw.stop();
sw.start("方式4:MapStruct");
List<CarInfo> list4 = new ArrayList<>();
carList.forEach(x -> {
CarInfo item = CarInfoMapper.INSTANCT.carToCarInfo(x);
item.setColor(faker.color().name());
item.setType(faker.number().randomDigit());
list4.add(item);
});
sw.stop();
String s = sw.prettyPrint();
System.out.println(s);
double totalTimeSeconds = sw.getTotalTimeSeconds();
System.out.println("總耗時：" + totalTimeSeconds);
}
測試結果如下
10W 資料量
StopWatch '物件複製速度測試': running time = 5382233200 ns
---------------------------------------------
ns % Task name
---------------------------------------------
2336099000 043% 方式1:Spring BeanUtils.copyProperties
2322316400 043% 方式2:apache BeanUtils.copyProperties
442981700 008% 方式3:BeanCopier
280836100 005% 方式4:MapStruct
總耗時：5.3822332
100W 資料量
StopWatch '物件複製速度測試': running time = 58689078300 ns
---------------------------------------------
ns % Task name
---------------------------------------------
25199532100 043% 方式1:Spring BeanUtils.copyProperties
27179965900 046% 方式2:apache BeanUtils.copyProperties
3629756500 006% 方式3:BeanCopier
2679823800 005% 方式4:MapStruct
總耗時：58.6890783
深複製or淺複製
上述四種方式均為淺複製。可透過如下測試程式碼驗證
/**
* 測試4種方式是淺複製還是深複製
*/
@GetMapping("/test2")
public void test2() {
Faker faker = new Faker(new Locale("zh-CN"));
Car car = getCar(faker);
log.info("car={}", JSON.toJSONString(car));
CarInfo carInfo = new CarInfo();
//方式1
// BeanUtils.copyProperties(car, carInfo);
// Size sizeNew = car.getSize();
// sizeNew.setLength(0d);
// sizeNew.setWidth(0d);
// sizeNew.setHeight(0d);
//// Size s = new Size();
//// s.setHeight(10d);
//// car.setSize(s);
// car.setName("新名字");
// log.info("carInfo={}", JSON.toJSONString(carInfo));
//方式2
// try {
// org.apache.commons.beanutils.BeanUtils.copyProperties(carInfo, car);
// } catch (IllegalAccessException e) {
// throw new RuntimeException(e);
// } catch (InvocationTargetException e) {
// throw new RuntimeException(e);
// }
// Size sizeNew = car.getSize();
// sizeNew.setLength(0d);
// sizeNew.setWidth(0d);
// sizeNew.setHeight(0d);
//
// car.setName("新名字");
// log.info("carInfo={}", JSON.toJSONString(carInfo));
//方式3
// final BeanCopier copier = BeanCopier.create(Car.class, CarInfo.class, false);
// copier.copy(car, carInfo, null);
// Size sizeNew = car.getSize();
// sizeNew.setLength(0d);
// sizeNew.setWidth(0d);
// sizeNew.setHeight(0d);
//
// car.setName("新名字");
// log.info("carInfo={}", JSON.toJSONString(carInfo));
//方式4
carInfo = CarInfoMapper.INSTANCT.carToCarInfo(car);
Size sizeNew = car.getSize();
sizeNew.setLength(0d);
sizeNew.setWidth(0d);
sizeNew.setHeight(0d);
car.setName("新名字");
log.info("carInfo={}", JSON.toJSONString(carInfo));
}
驗證邏輯為，在完成copy後修改car.size 的值，發現carInfo.size隨之改變，說明是淺複製。