Java陷阱——慎用入參做返回值

語言: CN / TW / HK

正常情況下,在Java中入參是不建議用做返回值的。除了造成程式碼不易理解、語義不清等問題外,可能還埋下了陷阱等你入坑。

問題背景

比如有這麼一段程式碼:

@Named
public class AService {   
private SupplyAssignment localSupply = new SupplyAssignment();
    @Inject
    private BService bervice;

    public List<Supply> calcSupplyAssignment()
       List<Supply> supplyList = bService.getLocalSupplyList(this.localSupply);
        …
       return supplyList;
    }
}

上面程式碼,服務A希望呼叫服務B,以獲取supplyList,但同時,服務A又希望修改localSupply的狀態值,未能避免修改calcSupplyAssignment介面的(不想改返回的型別),將localSupply作為了入參但同時也用作了返回值。

服務B程式碼如下:

@Named
public class BService {   

public List<Supply> getLocalSupplyList (SupplyAssignment localSupply)
    SupplyAssignment supplyAssignment = this.getSupplyAssignment();
        // 希望localSupply被重新賦值後返回
        localSupply = supplyAssignment;
        …
        return supplyList;

    }
}

在服務B程式碼內部,服務A的入參localSupply被傳入,希望重新被supplyAssignment賦值而後返回新值。然而,這樣做是無效的。

問題原因

先來看下程式語言中關於引數傳遞的型別:

  • 值傳遞(pass by value)是指在呼叫函式時將實際引數複製一份傳遞到函式中,這樣在函式中如果對引數進行修改,將不會影響到實際引數。
  • 引用傳遞(pass by reference)是指在呼叫函式時將實際引數的地址直接傳遞到函式中,那麼在函式中對引數所進行的修改,將影響到實際引數。

因為Java程式設計語言是採用的值傳遞,因為Java沒有指標的概念。也就是說方法得到的是所有引數值的一個拷貝,方法並不能修改傳遞給它的任何引數變數的內容。

因此,上述程式碼中,服務A呼叫服務B時,服務B的引數localSupply實際上是服務A的localSupply的一個拷貝,當然,這兩個都是指向了同一個地址物件supplyAssignment1。

當在服務B內部對引數localSupply進行重新賦值是localSupply = supplyAssignment,實際上,只是對B的引數localSupply做了從新賦值,B的引數localSupply會指向一個新的地址物件supplyAssignment2。

從上圖可以清晰看到,因此,服務A的localSupply和B的引數localSupply已經指向了不同的物件了,對B的引數localSupply做任何的修改,都不會影響服務A的localSupply的原值。這就是問題的原因,你希望服務B來修改服務A入參的狀態,並將改後的值返回給服務A,但並不奏效。

解決方案

方案1:入參不要用作返回值

當然,這個是最清晰的且易於理解的,但這會導致有的介面的返回型別產生變化。

有時確實想要入參做返回值,那看方案2。

方案2:入參不要賦值新物件

這個方案就是直接在入參的物件上做狀態的修改,而不要去賦值新物件。還是這個圖:

在這個圖中,只要我們是一直在B的引數localSupply修改的是supplyAssignment1的狀態值,那結果就能反饋到服務A的localSupply上。如何實現?看下下面程式碼:

@Named
public class BService {   

    public List<Supply> getLocalSupplyList (SupplyAssignment localSupply)
        
        SupplyAssignment supplyAssignment = this.getSupplyAssignment();

        // 針對localSupply不能新建引用,只能重新賦值屬性
        BeanUtils.copyProperties(supplyAssignment, localSupply);
        …
        return supplyList;

    }

}

在上面的方法中,我們用到了Spring的工具類BeanUtils,該類的copyProperties方法的實質是將supplyAssignment的屬性值,賦值到了localSupply的屬性上。這意味著我們是修改的B的引數localSupply上的屬性,而並未新建物件。

參考引用