天天看點

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

正常情況下,在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。

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

當在服務B内部對參數localSupply進行重新指派是localSupply = supplyAssignment,實際上,隻是對B的參數localSupply做了從新指派,B的參數localSupply會指向一個新的位址對象supplyAssignment2。

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

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

解決方案

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

當然,這個是最清晰的且易于了解的,但這會導緻有的接口的傳回類型産生變化。

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

方案2:入參不要指派新對象

這個方案就是直接在入參的對象上做狀态的修改,而不要去指派新對象。還是這個圖:

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

在這個圖中,隻要我們是一直在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上的屬性,而并未建立對象。

參考引用