Java中的传参陷阱，用时需谨慎-慎用入参做返回值

共 3647字，需浏览 8分钟

· 2021-09-21

祝大家中秋快乐！今天，文末搞活动，送 2 本实体书，欢迎参与！

下面开始正文部分！

正常情况下，在 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 上的属性，而并未新建对象。

赠书

《Spring Cloud Alibaba微服务实战》从初学者的角度出发，从微服务基础理论开始，基于Spring Boot框架搭建微服务系统。介绍了使用Spring Cloud Alibaba套件及其他热门微服务组件构建微服务系统的方法、微服务系统中常见的问题及解决方案，以及如何快速部署项目，使读者从开发到上线整体流程有一个清晰的认识。