Spring的BeanUtils.copyProperties屬性復(fù)制避坑指南

更新時間：2024年08月12日 17:01:19 作者：黃雞黃雞

這篇文章主要介紹了Spring的BeanUtils.copyProperties屬性復(fù)制避坑指南,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

Spring的BeanUtils.copyProperties屬性復(fù)制避坑

項目場景：

在分布式項目中，我進行我們的項目對外接口整合時，需要自己再定義對外的類來傳參，就避免不了用BeanUtils.copyProperties工具來進行屬性賦值。

問題描述

關(guān)于BeanUtils.copyProperties的屬性復(fù)制規(guī)則

話不多說直接上demo代碼

類A

class A {
    int a;
    List<Integer> list = new ArrayList<>();
    List<B> bList = new ArrayList<>();
    B b;

    public int getA() {
        return a;
    }

    public void setA(int a) {
        this.a = a;
    }

    public B getB() {
        return b;
    }

    public void setB(B b) {
        this.b = b;
    }

    public List<Integer> getList() {
        return list;
    }

    public void setList(List<Integer> list) {
        this.list = list;
    }

    public List<B> getbList() {
        return bList;
    }

    public void setbList(List<B> bList) {
        this.bList = bList;
    }

   @Override
   public String toString() {
       return "A{" +
           "a=" + a +
           ", list=" + list +
           ", bList=" + bList +
           ", b=" + b +
           '}';
   }
}

類A1

class A1 {
    int a;
    List<Integer> list = new ArrayList<>();
    List<B> bList = new ArrayList<>();
    B b;

    public int getA() {
        return a;
    }

    public void setA(int a) {
        this.a = a;
    }

    public B getB() {
        return b;
    }

    public void setB(B b) {
        this.b = b;
    }

    public List<Integer> getList() {
        return list;
    }

    public void setList(List<Integer> list) {
        this.list = list;
    }

    public List<B> getbList() {
        return bList;
    }

    public void setbList(List<B> bList) {
        this.bList = bList;
    }

    @Override
    public String toString() {
        return "A1{" +
            "a=" + a +
            ", list=" + list +
            ", bList=" + bList +
            ", b=" + b +
            '}';
    }
}

類B

class B {
	String b;

    public String getB() {
      return b;
    }

	public void setB(String b) {
	  this.b = b;
	}

	@Override
	public String toString() {
	    return "B{" +
	        "b='" + b + '\'' +
	        '}';
	}
	
	public B() {
    }

    public B(String b) {
        this.b = b;
    }
}

測試main方法1

public static void main(String[] args) {
    A a = new A();

    B b = new B();
    b.setB("bbb");

    List<Integer> list = new ArrayList<>();
    list.add(100);
    list.add(200);

    List<B> bList = new ArrayList<>();
    bList.add(new B("dd"));
    bList.add(new B("cc"));
    bList.add(new B("ee"));

    a.setA(1);
    a.setB(b);
    a.setList(list);
    a.setbList(bList);

    A1 a1 = new A1();

    BeanUtils.copyProperties(a, a1);

    System.out.println(a1);
}

結(jié)果：：A1{a=1, list=[100, 200], bList=[B{b=‘dd’}, B{b=‘cc’}, B{b=‘ee’}], b=B{b=‘bbb’}}

測試main方法2

public static void main(String[] args) {
   A a = new A();

    B b = new B();
    b.setB("bbb");

    List<Integer> list = new ArrayList<>();
    list.add(100);
    list.add(200);

    List<B> bList = new ArrayList<>();
    bList.add(new B("dd"));
    bList.add(new B("cc"));
    bList.add(new B("ee"));

    a.setA(1);
    a.setB(b);
    a.setList(list);
    a.setbList(bList);

    A1 a1 = new A1();

    BeanUtils.copyProperties(a, a1);

    b.setB("aaa");

    a.setA(2);

    list.clear();
    list.add(666);
    list.add(777);

    bList.clear();
    bList.add(new B("abc"));

    System.out.println(a1);
}

結(jié)果：A1{a=1, list=[666, 777], bList=[B{b=‘abc’}], b=B{b=‘aaa’}}

結(jié)果分析

從以上的例子和結(jié)果來看，BeanUtils.copyProperties是淺拷貝。

main方法1：當(dāng)A和A1中的屬性名稱相同時，使用BeanUtils.copyProperties會將所有屬性進行復(fù)制。從結(jié)果上來看，不管是基本數(shù)據(jù)類型int a，還是剩余的三個引用數(shù)據(jù)類型，List<Integer> list、List<B> bList、B b，都進行了復(fù)制。
main方法2 ：第二個main方法在第一個的基礎(chǔ)上對要復(fù)制的A的屬性進行了修改，從結(jié)果上發(fā)現(xiàn)，A1的屬性中基本數(shù)據(jù)類型int a的值并沒有因為修改而改變，但引用數(shù)據(jù)類型List<Integer> list、List<B> bList、B b的值會因為改變了A的屬性而改變。

附帶兩種對象屬性復(fù)制的方法

// 淺拷貝
a1 = JSONObject.parseObject(JSONObject.toJSONString(a), A1.class)

// 深拷貝，其中SerializerFeature.DisableCircularReferenceDetect是為了解決JSON的$ref 引用
a1 = JSONObject.parseObject(JSONObject.toJSONString(a, SerializerFeature.DisableCircularReferenceDetect), A1.class);

// 深拷貝
ObjectMapper objectMapper = new ObjectMapper();
a1 = objectMapper.readValue(JSONObject.toJSONString(a, SerializerFeature.DisableCircularReferenceDetect), A1.class);