當get/set
太繁瑣時;當BeanUtils
沒法拷貝集合時;當。。。可能,你須要好好看看這篇文章,文末附完整示例代碼。html
在作業務的時候,爲了隔離變化,咱們會將DAO
查詢出來的DO
和對前端提供的DTO
隔離開來。大概90%
的時候,它們的結構都是相似的;可是咱們很不喜歡寫不少冗長的b.setF1(a.getF1())
這樣的代碼,因而咱們須要簡化對象拷貝方式。前端
Java
中,數據類型分爲值類型(基本數據類型)和引用類型,值類型包括int
、double
、byte
、boolean
、char
等簡單數據類型,引用類型包括類、接口、數組等複雜類型。java
對象拷貝分爲淺拷貝(淺克隆)與深拷貝(深克隆)。git
分類 | 淺拷貝 | 深拷貝 |
---|---|---|
區別 | 建立一個新對象,而後將當前對象的非靜態字段複製到該新對象,若是字段是值類型的,那麼對該字段執行復制;若是該字段是引用類型的話,則複製引用但不復制引用的對象。所以,原始對象及其副本引用同一個對象。 | 建立一個新對象,而後將當前對象的非靜態字段複製到該新對象,不管該字段是值類型的仍是引用類型,都複製獨立的一份。當你修改其中一個對象的任何內容時,都不會影響另外一個對象的內容。 |
參考文章:Java的深拷貝和淺拷貝github
Entity
對應的是持久層數據結構(通常是數據庫表的映射模型);Model
對應的是業務層的數據結構;VO
就是Controller
和客戶端交互的數據結構。例如:數據庫查詢出來的用戶信息(表的映射模型)是
UserDO
,可是咱們須要傳遞給客戶端的是UserVO
,這時候就須要把UserDO
實例的屬性一個一個賦值到UserVO
實例中。spring
在這些數據結構之間很大一部分屬性均可能會相同,也可能不一樣。數據庫
org.springframework.beans.BeanUtils
;org.springframework.cglib.beans.BeanCopier
;ma.glasnost.orika
;org.mapstruct
(強烈推薦)。BeanUtils
Spring
中的BeanUtils
,其中實現的方式很簡單,就是對兩個對象中相同名字的屬性進行簡單get/set
,僅檢查屬性的可訪問性。api
能夠看到, 成員變量賦值是基於目標對象的成員列表, 而且會跳過ignore
的以及在源對象中不存在的, 因此這個方法是安全的, 不會由於兩個對象之間的結構差別致使錯誤, 可是必須保證同名的兩個成員變量類型相同。緩存
咱們把數據庫查詢出來的UserDO.java
拷貝到 UserVO.java
。直接使用BeanUtils.copyProperties()
方法。
@Test
public void commonCopy() {
UserDO userDO = new UserDO(1L, "Van", 18, 1);
UserVO userVO = new UserVO();
BeanUtils.copyProperties(userDO, userVO);
log.info("userVO:{}",userVO);
}
複製代碼
.... userVO:UserVO(userId=1, userName=Van, age=18, sex=null)
複製代碼
剛剛拷貝的是一個對象,可是有時候咱們想拷貝一組UerDO.java
,是一個集合的時候就不能這樣直接賦值了。若是還按照這種邏輯,以下:
@Test
public void listCopyFalse() {
List<UserDO> userDOList = new ArrayList();
userDOList.add(new UserDO(1L, "Van", 18, 1));
userDOList.add(new UserDO(2L, "VanVan", 18, 2));
List<UserVO> userVOList = new ArrayList();
BeanUtils.copyProperties(userDOList, userVOList);
log.info("userVOList:{}",userVOList);
}
複製代碼
.... userVOList:[]
複製代碼
經過日誌能夠發現,直接拷貝集合是無效的,那麼怎麼解決呢?
將須要拷貝的集合遍歷,暴力拷貝。
@Test
public void listCopyCommon() {
List<UserDO> userDOList = new ArrayList();
userDOList.add(new UserDO(1L, "Van", 18, 1));
userDOList.add(new UserDO(2L, "VanVan", 20, 2));
List<UserVO> userVOList = new ArrayList();
userDOList.forEach(userDO ->{
UserVO userVO = new UserVO();
BeanUtils.copyProperties(userDO, userVO);
userVOList.add(userVO);
});
log.info("userVOList:{}",userVOList);
}
複製代碼
.... userVOList:[UserVO(userId=1, userName=Van, age=18, sex=null), UserVO(userId=2, userName=VanVan, age=20, sex=null)]
複製代碼
雖然該方式能夠解決,可是一點都不優雅,特別是寫起來麻煩。
經過JDK 8
的函數式接口封裝org.springframework.beans.BeanUtils
函數式接口裏是能夠包含默認方法,這裏咱們定義默認回調方法。
@FunctionalInterface
public interface BeanUtilCopyCallBack <S, T> {
/** * 定義默認回調方法 * @param t * @param s */
void callBack(S t, T s);
}
複製代碼
BeanUtilCopy.java
public class BeanUtilCopy extends BeanUtils {
/** * 集合數據的拷貝 * @param sources: 數據源類 * @param target: 目標類::new(eg: UserVO::new) * @return */
public static <S, T> List<T> copyListProperties(List<S> sources, Supplier<T> target) {
return copyListProperties(sources, target, null);
}
/** * 帶回調函數的集合數據的拷貝(可自定義字段拷貝規則) * @param sources: 數據源類 * @param target: 目標類::new(eg: UserVO::new) * @param callBack: 回調函數 * @return */
public static <S, T> List<T> copyListProperties(List<S> sources, Supplier<T> target, BeanUtilCopyCallBack<S, T> callBack) {
List<T> list = new ArrayList<>(sources.size());
for (S source : sources) {
T t = target.get();
copyProperties(source, t);
list.add(t);
if (callBack != null) {
// 回調
callBack.callBack(source, t);
}
}
return list;
}
}
複製代碼
@Test
public void listCopyUp() {
List<UserDO> userDOList = new ArrayList();
userDOList.add(new UserDO(1L, "Van", 18, 1));
userDOList.add(new UserDO(2L, "VanVan", 20, 2));
List<UserVO> userVOList = BeanUtilCopy.copyListProperties(userDOList, UserVO::new);
log.info("userVOList:{}",userVOList);
}
複製代碼
.... userVOList:[UserVO(userId=1, userName=Van, age=18, sex=null), UserVO(userId=2, userName=VanVan, age=20, sex=null)]
複製代碼
經過如上方法,咱們基本實現了集合的拷貝,可是從返回結果咱們能夠發現:屬性不一樣的字段沒法拷貝。
注意: UserDO.java
和UserVO.java
最後一個字段sex
類型不同,分別是:Integer
/String
優化一下
public enum SexEnum {
UNKNOW("未設置",0),
MEN("男生", 1),
WOMAN("女生",2),
;
private String desc;
private int code;
SexEnum(String desc, int code) {
this.desc = desc;
this.code = code;
}
public static SexEnum getDescByCode(int code) {
SexEnum[] typeEnums = values();
for (SexEnum value : typeEnums) {
if (code == value.getCode()) {
return value;
}
}
return null;
}
public String getDesc() {
return desc;
}
public void setDesc(String desc) {
this.desc = desc;
}
public int getCode() {
return code;
}
public void setCode(int code) {
this.code = code;
}
}
複製代碼
@Test
public void listCopyUpWithCallback() {
List<UserDO> userDOList = new ArrayList();
userDOList.add(new UserDO(1L, "Van", 18, 1));
userDOList.add(new UserDO(2L, "VanVan", 20, 2));
List<UserVO> userVOList = BeanUtilCopy.copyListProperties(userDOList, UserVO::new, (userDO, userVO) -> {
// 這裏能夠定義特定的轉換規則
userVO.setSex(SexEnum.getDescByCode(userDO.getSex()).getDesc());
});
log.info("userVOList:{}",userVOList);
}
複製代碼
... userVOList:[UserVO(userId=1, userName=Van, age=18, sex=男生), UserVO(userId=2, userName=VanVan, age=20, sex=女生)]
複製代碼
經過打印結果能夠發現,UserDO.java
中Integer
類型的sex
複製到UserVO.java
成了String
類型的男生/女生。
該方法是咱們用的最多的方案,這裏簡單封裝下,能夠方便集合類型對象的拷貝,日常使用基本夠用,僅供參考。
BeanCopier
BeanCopier
是用於在兩個bean
之間進行屬性拷貝的。BeanCopier
支持兩種方式:
Converter
的方式,僅對兩個bean
間屬性名和類型徹底相同的變量進行拷貝;Converter
,能夠對某些特定屬性值進行特殊操做。@Test
public void normalCopy() {
// 模擬查詢出數據
UserDO userDO = DataUtil.createData();
log.info("拷貝前:userDO:{}", userDO);
// 第一個參數:源對象, 第二個參數:目標對象,第三個參數:是否使用自定義轉換器(下面會介紹),下同
BeanCopier b = BeanCopier.create(UserDO.class, UserDTO.class, false);
UserDTO userDTO = new UserDTO();
b.copy(userDO, userDTO, null);
log.info("拷貝後:userDTO:{}", userDTO);
}
複製代碼
...... 拷貝前:userDO:UserDO(id=1, userName=Van, sex=0, gmtBroth=2019-11-02T18:24:24.077, balance=100)
...... 拷貝後:userDTO:UserDTO(id=1, userName=Van, sex=null)
複製代碼
經過結果發現:UserDO
的int
類型的sex
沒法拷貝到UserDTO
的Integer
的sex
。
即:BeanCopier
只拷貝名稱和類型都相同的屬性。
即便源類型是原始類型(
int
,short
和char
等),目標類型是其包裝類型(Integer
,Short
和Character
等),或反之:都不會被拷貝。
經過3.1
可知,當源和目標類的屬性類型不一樣時,不能拷貝該屬性,此時咱們能夠經過實現Converter
接口來自定義轉換器
@Data
public class UserDomain {
private Integer id;
private String userName;
/** * 如下兩個字段用戶模擬自定義轉換 */
private String gmtBroth;
private String balance;
}
複製代碼
Converter
接口來自定義屬性轉換public class UserDomainConverter implements Converter {
/** * 時間轉換的格式 */
DateTimeFormatter dtf = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
/** * 自定義屬性轉換 * @param value 源對象屬性類 * @param target 目標對象裏屬性對應set方法名,eg.setId * @param context 目標對象屬性類 * @return */
@Override
public Object convert(Object value, Class target, Object context) {
if (value instanceof Integer) {
return value;
} else if (value instanceof LocalDateTime) {
LocalDateTime date = (LocalDateTime) value;
return dtf.format(date);
} else if (value instanceof BigDecimal) {
BigDecimal bd = (BigDecimal) value;
return bd.toPlainString();
}
// 更多類型轉換請自定義
return value;
}
}
複製代碼
/** * 類型不一樣,使用Converter */
@Test
public void converterTest() {
// 模擬查詢出數據
UserDO userDO = DataUtil.createData();
log.info("拷貝前:userDO:{}", userDO);
BeanCopier copier = BeanCopier.create(UserDO.class, UserDomain.class, true);
UserDomainConverter converter = new UserDomainConverter();
UserDomain userDomain = new UserDomain();
copier.copy(userDO, userDomain, converter);
log.info("拷貝後:userDomain:{}", userDomain);
}
複製代碼
...... 拷貝前:userDO:UserDO(id=1, userName=Van, gmtBroth=2019-11-02T19:51:11.985, balance=100)
...... 拷貝後:userDomain:UserDomain(id=1, userName=Van, gmtBroth=2019-11-02 19:51:11, balance=100)
複製代碼
Converter
,BeanCopier
只使用Converter
定義的規則去拷貝屬性,因此在convert()
方法中要考慮全部的屬性;Converter
會使對象拷貝速度變慢。BeanCopier
實例提高性能BeanCopier
拷貝速度快,性能瓶頸出如今建立BeanCopier
實例的過程當中。 因此,把建立過的BeanCopier
實例放到緩存中,下次能夠直接獲取,提高性能。
@Test
public void beanCopierWithCache() {
List<UserDO> userDOList = DataUtil.createDataList(10000);
long start = System.currentTimeMillis();
List<UserDTO> userDTOS = new ArrayList<>();
userDOList.forEach(userDO -> {
UserDTO userDTO = new UserDTO();
copy(userDO, userDTO);
userDTOS.add(userDTO);
});
}
/** * 緩存 BeanCopier */
private static final ConcurrentHashMap<String, BeanCopier> BEAN_COPIERS = new ConcurrentHashMap<>();
public void copy(Object srcObj, Object destObj) {
String key = genKey(srcObj.getClass(), destObj.getClass());
BeanCopier copier = null;
if (!BEAN_COPIERS.containsKey(key)) {
copier = BeanCopier.create(srcObj.getClass(), destObj.getClass(), false);
BEAN_COPIERS.put(key, copier);
} else {
copier = BEAN_COPIERS.get(key);
}
copier.copy(srcObj, destObj, null);
}
private String genKey(Class<?> srcClazz, Class<?> destClazz) {
return srcClazz.getName() + destClazz.getName();
}
複製代碼
BeanCopier
總結int
,short
,char
)和 他們的包裝類型,在這裏都被當成了不一樣類型,所以不會被拷貝。setter
比getter
少,拷貝沒問題,此時setter
多餘,可是不會報錯。getter
都存在),可是目標類的setter
不存在,此時會拋出NullPointerException
。Orika
Orika
是 Java Bean
映射框架,能夠實現從一個對象遞歸拷貝數據至另外一個對象。它的優勢是:名字相同類型不一樣也能直接複製。
<dependency>
<groupId>ma.glasnost.orika</groupId>
<artifactId>orika-core</artifactId>
<version>1.5.4</version>
</dependency>
複製代碼
使用枚舉實現的單例模式建立一個映射工具類,便於測試。
public enum MapperUtils {
/** * 實例 */
INSTANCE;
/** * 默認字段工廠 */
private static final MapperFactory MAPPER_FACTORY = new DefaultMapperFactory.Builder().build();
/** * 默認字段實例 */
private static final MapperFacade MAPPER_FACADE = MAPPER_FACTORY.getMapperFacade();
/** * 默認字段實例集合 */
private static Map<String, MapperFacade> CACHE_MAPPER_FACADE_MAP = new ConcurrentHashMap<>();
/** * 映射實體(默認字段) * * @param toClass 映射類對象 * @param data 數據(對象) * @return 映射類對象 */
public <E, T> E map(Class<E> toClass, T data) {
return MAPPER_FACADE.map(data, toClass);
}
/** * 映射實體(自定義配置) * * @param toClass 映射類對象 * @param data 數據(對象) * @param configMap 自定義配置 * @return 映射類對象 */
public <E, T> E map(Class<E> toClass, T data, Map<String, String> configMap) {
MapperFacade mapperFacade = this.getMapperFacade(toClass, data.getClass(), configMap);
return mapperFacade.map(data, toClass);
}
/** * 映射集合(默認字段) * * @param toClass 映射類對象 * @param data 數據(集合) * @return 映射類對象 */
public <E, T> List<E> mapAsList(Class<E> toClass, Collection<T> data) {
return MAPPER_FACADE.mapAsList(data, toClass);
}
/** * 映射集合(自定義配置) * * @param toClass 映射類 * @param data 數據(集合) * @param configMap 自定義配置 * @return 映射類對象 */
public <E, T> List<E> mapAsList(Class<E> toClass, Collection<T> data, Map<String, String> configMap) {
T t = data.stream().findFirst().orElseThrow(() -> new ExceptionInInitializerError("映射集合,數據集合爲空"));
MapperFacade mapperFacade = this.getMapperFacade(toClass, t.getClass(), configMap);
return mapperFacade.mapAsList(data, toClass);
}
/** * 獲取自定義映射 * * @param toClass 映射類 * @param dataClass 數據映射類 * @param configMap 自定義配置 * @return 映射類對象 */
private <E, T> MapperFacade getMapperFacade(Class<E> toClass, Class<T> dataClass, Map<String, String> configMap) {
String mapKey = dataClass.getCanonicalName() + "_" + toClass.getCanonicalName();
MapperFacade mapperFacade = CACHE_MAPPER_FACADE_MAP.get(mapKey);
if (Objects.isNull(mapperFacade)) {
MapperFactory factory = new DefaultMapperFactory.Builder().build();
ClassMapBuilder classMapBuilder = factory.classMap(dataClass, toClass);
configMap.forEach(classMapBuilder::field);
classMapBuilder.byDefault().register();
mapperFacade = factory.getMapperFacade();
CACHE_MAPPER_FACADE_MAP.put(mapKey, mapperFacade);
}
return mapperFacade;
}
}
複製代碼
map(Class toClass, T data)
:普通的映射實體,主要映射名稱相同(類型能夠不一樣)的字段;
map(Class toClass, T data, Map<String, String> configMap)
:自定義配置的映射,映射名稱不一樣時,自定義映射對應名稱;
mapAsList(Class toClass, Collection data)
:普通的集合的映射;
mapAsList(Class toClass, Collection data, Map<String, String> configMap)
:自定義的集合映射,自定義映射對應名稱。
@Test
public void normalCopy() {
// 模擬查詢出數據
UserDO userDO = DataUtil.createData();
log.info("拷貝前:userDO:{}", userDO);
// 第一個參數:源對象, 第二個參數:目標對象,第三個參數:是否使用自定義轉換器(下面會介紹),下同
UserDTO userDTO = MapperUtils.INSTANCE.map(UserDTO.class, userDO);;
log.info("拷貝後:userDTO:{}", userDTO);
}
複製代碼
@Test
public void converterTest() {
// 模擬查詢出數據
UserDO userDO = DataUtil.createData();
Map<String, String> config = new HashMap<>();
// 自定義配置(balance 轉 balances)
config.put("balance", "balances");
log.info("拷貝前:userDO:{}", userDO);
UserDomain userDomain = MapperUtils.INSTANCE.map(UserDomain.class, userDO, config);
log.info("拷貝後:userDomain:{}", userDomain);
}
複製代碼
@Test
public void beanCopierWithCache() {
List<UserDO> userDOList = DataUtil.createDataList(3);
log.info("拷貝前:userDOList:{}", userDOList);
List<UserDTO> userDTOS = MapperUtils.INSTANCE.mapAsList(UserDTO.class,userDOList);
log.info("拷貝後:userDTOS:{}", userDTOS);
}
複製代碼
MapStruct
MapStruct
是一個自動生成 bean
映射類的代碼生成器。MapStruct
還可以在不一樣的數據類型之間進行轉換。
mapstruct-jdk8
包含所需的註釋,例如
@Mapping
。
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-jdk8</artifactId>
<version>1.3.0.Final</version>
</dependency>
複製代碼
mapstruct-processor
在編譯,生成映射器實現的註釋處理器。
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>1.3.0.Final</version>
<scope>provided</scope>
</dependency>
複製代碼
您所要作的就是定義一個mapper
接口,該接口聲明任何所需的映射方法。在編譯期間,MapStruct
將生成此接口的實現。此實現使用普通的Java
方法調用來在源對象和目標對象之間進行映射。
Mapper
利用@Mapper
註解標註該接口/抽象類是被MapStruct
自動映射的,只有存在該註解纔會將內部的接口方法自動實現。
Mapper
MapStruct
爲咱們提供了多種的獲取Mapper
的方式,習慣用默認配置:採用Mappers
經過動態工廠內部反射機制完成Mapper
實現類的獲取。
UserConvertUtils INSTANCE = Mappers.getMapper(UserConvertUtils.class);
複製代碼
完整的一個轉換器demo
:
@Mapper
public interface UserConvertUtils {
UserConvertUtils INSTANCE = Mappers.getMapper(UserConvertUtils.class);
/** * 普通的映射 * * @param userDO UserDO數據持久層類 * @return 數據傳輸類 */
UserDTO doToDTO(UserDO userDO);
/** * 類型轉換的映射 * * @param userDO UserDO數據持久層類 * @return 數據傳輸類 */
@Mappings({
@Mapping(target = "gmtBroth", source = "gmtBroth", dateFormat = "yyyy-MM-dd HH:mm:ss"),
@Mapping(target = "balances", source = "balance"),
})
UserDTO doToDtoWithConvert(UserDO userDO);
}
複製代碼
/** * 通常拷貝 */
@Test
public void normalCopy() {
// 模擬查詢出數據
UserDO userDO = DataUtil.createData();
log.info("拷貝前:userDO:{}", userDO);
UserDTO userDTO = UserConvertUtils.INSTANCE.doToDTO(userDO);
log.info("拷貝後:userDTO:{}", userDTO);
}
/** * 包含類型轉換的拷貝 */
@Test
public void doToDtoWithConvert() {
// 模擬查詢出數據
UserDO userDO = DataUtil.createData();
log.info("拷貝前:userDO:{}", userDO);
UserDTO userDTO = UserConvertUtils.INSTANCE.doToDtoWithConvert(userDO);
log.info("拷貝後:userDTO:{}", userDTO);
}
複製代碼
通常拷貝:
...拷貝前:userDO:UserDO(id=1, userName=Van, gmtBroth=2020-04-21T21:38:39.376, balance=100)
...拷貝後:userDTO:UserDTO(id=1, userName=Van, gmtBroth=2020-04-21T21:38:39.376, balances=null)
包含類型轉換的拷貝:
...拷貝前:userDO:UserDO(id=1, userName=Van, gmtBroth=2020-04-21T21:05:19.282, balance=100)
...拷貝後:userDTO:UserDTO(id=1, userName=Van, gmtBroth=2020-04-21 21:05:19, balances=100)
複製代碼
經過打印結果能夠發現:相較於前者,包含類型轉換的拷貝能夠自定義轉換屬性和時間格式等。
MapStruct
註解的關鍵詞@Mapper
:只有在接口加上這個註解, MapStruct
纔會去實現該接口;@Mappings
:配置多個@Mapping
;@Mapping
:屬性映射,若源對象屬性與目標對象名字一致,會自動映射對應屬性:source
:源屬性;target
:目標屬性;dateFormat
:字符串與日期之間相互轉換;ignore
: 忽略這個,某個屬性不想映射,能夠加個 ignore=true
;MapStruct
能夠將幾種類型的對象映射爲另一種類型,好比將多個 DO
對象轉換爲 DTO
。
詳見:
UserDTO doAndInfoToDto(UserDO userDO, UserInfoDO userInfoDO);
複製代碼
MapStruct
與手工編寫映射代碼相比,MapStruct
經過生成繁瑣且易於編寫的代碼來節省時間。遵循約定優於配置方法,MapStruct
使用合理的默認值,但在配置或實現特殊行爲時會採起措施。
與動態映射框架相比,MapStruct
具備如下優點:
DTO
等。經過四種屬性拷貝的方式,加上本身手動get/set
,僅給出如下建議:
get/set
;Spring
的狀況下,使用BeanUtils
;MapStruct
(性能幾乎等同於直接get/set
)。具體性能,參考文章:Java Bean Copy 性能大比拼
博主祖傳祕籍 Spring Boot 葵花寶典 開源中,歡迎前來吐槽,提 issues,告訴博主接下來更新哪方面文章,Van
堅信:1 + 1 > 2
!
最新文章,歡迎關注:公衆號-風塵博客;交流觀點,歡迎添加:我的微信