项目中List的返回值

最近公司一个已经稳定运行了1年的web系统出现了性能问题，响应速度非常慢，系统是不断注册新的模块的，每次增加新模块都会带来一定负载，虽然很快就断定是由于大量模块的配置文件加载与初始数据缓存本身占用了大量内容，导致留给用户操作内存空间小造成，最好的办法就是卸载无用模块和清理缓存数据，但领导还是坚持要求检查代码并消除浪费内存的低效代码，系统比较大，这件事做起来可不容易，呵呵…
在检查的时候，发现方法中对无数据集合类型的返回有2种方式，Null和new List，系统是由很多人开发的，根据代码上看很明显没有对这些细节形成统一的规范，不过也能理解…
随便找人问了问，然后告诉他们以后规范方面尽量统一，至于上面的问题返回null还是创建一个空内容数组，由于系统刚出现内存问题，几乎统一了意见，用null吧…
真是这样吗？创建新对象返回时为了避免客户端代码的空值验证，返回null值是为了减少开销，视乎都有道理。其实个人觉得不应该返回空，当然，这里暂时不考虑业务需要的情况。但内存开销怎么办?无数据集合基本上是不变的，开销应该是很低的，不过还是有两全其美的办法，不知道大家对Collections工具类的empty系列静态方法用的多不多，这些方法返回一个无内容集合，并且都是基于同一个对象实例，这样，就可以避免null值的验证和那一点开销了，建议大家大量使用


举例：

public List returnArray2(Object data){
	if(data == null){
		return Collections.emptyList();
	}
	return (List) data;
}

当然还有Collections.emptyMap()、Collections.emptySet()，原理是一样的
另外，也可以选择Collections的静态变量进行返回，其实上述方法中返回的就是下面的Collections中定义的静态变量：
public static final List EMPTY_LIST = new EmptyList();
public static final Set EMPTY_SET = new EmptySet();
public static final Map EMPTY_MAP = new EmptyMap();

在jdk1.5之前的版本使用只能使用静态变量的方式访问，具体可以见jdk源码

评论

30 楼 treblesoftware 2010-01-22  

anky_end 写道

fengsage 写道

谢谢LZ,学到了。原来返回null也会在占用一定空间啊·~~~看来影响程序性能的瓶颈还真多啊~~

我觉得楼主说的已经很明白
楼主并不认为new List会占用多少内存，出问题的是其他原因。

我还是坚持这个观点，即使直接返回个new List也不会有什么问题。这种短期对象很快就被回收了。

会出问题的是长期驻留在内存的东东，比如楼主说的配置模块缓存

哎，还有可能是过多的HTTPSESSION对象导致内存被过多占用，返回一个NULL，能占多少？而且这些对象几乎都是无状态的，很容易就被X掉。当然，虚拟机会在对象太多时进行垃圾回收，这时候也许性能会比较差，我认为LZ的问题是不是出在过多的有状态对象上，比如：HTTPSESSION。

29 楼 anky_end 2010-01-22  

fengsage 写道

谢谢LZ,学到了。原来返回null也会在占用一定空间啊·~~~看来影响程序性能的瓶颈还真多啊~~

我觉得楼主说的已经很明白
楼主并不认为new List会占用多少内存，出问题的是其他原因。

我还是坚持这个观点，即使直接返回个new List也不会有什么问题。这种短期对象很快就被回收了。

会出问题的是长期驻留在内存的东东，比如楼主说的配置模块缓存

28 楼 sunsong 2010-01-22  

anky_end 写道

sunsong 写道

凤舞凰扬 写道

nickevin 写道

Item 43: Return empty arrays or collections, not nulls

public List<Cheese> getCheeseList() {
  if (cheesesInStock.isEmpty())
    return Collections.emptyList(); // Always returns same list
  else
    return new ArrayList<Cheese>(cheesesInStock);
}

from Effective Java : Joshua Bloch

   包括楼主以及楼上在内的童鞋们请注意:
1. 对于服务层或者提供服务的类（比如工具类）等，使用默认的empty实现（不仅仅是List,还包括Set, Map等数据结构类）是正确的选择。这样可以避免客户程序调用时对返回值的理解不一致从而出现的NullPointerException。
2. 对于数据实体类，用于ORM映射时（比如domain层），就要小心了，不要随便返回empty实现。尤其是使用了LazyLoading技术来进行一对多mapping时。因为默认的empty实现都是不可写的。这个时候，如果ORM试图延迟装载对应的实体类时（访问主实体时，子实体集合是空的；而第一次访问子实体集合时，ORM会去装载子实体，并填充集合），就会出现异常。
   所以大家对于书的理解，对于程序的理解，切记要在一定范围内。

没试过，不知道说的填充异常，具体是如何产生的。

List list1 = Collections.emptyList();  
list1.add("a");

抛异常。。。。就这样。

ORM延迟加载会有这样的情况吗？如果主实体是一个emptyList，怎么会加载子实体呢？

27 楼 fengsage 2010-01-21  

谢谢LZ,学到了。原来返回null也会在占用一定空间啊·~~~看来影响程序性能的瓶颈还真多啊~~

26 楼 anky_end 2010-01-21  

sunsong 写道

凤舞凰扬 写道

nickevin 写道

Item 43: Return empty arrays or collections, not nulls

public List<Cheese> getCheeseList() {
  if (cheesesInStock.isEmpty())
    return Collections.emptyList(); // Always returns same list
  else
    return new ArrayList<Cheese>(cheesesInStock);
}

from Effective Java : Joshua Bloch

   包括楼主以及楼上在内的童鞋们请注意:
1. 对于服务层或者提供服务的类（比如工具类）等，使用默认的empty实现（不仅仅是List,还包括Set, Map等数据结构类）是正确的选择。这样可以避免客户程序调用时对返回值的理解不一致从而出现的NullPointerException。
2. 对于数据实体类，用于ORM映射时（比如domain层），就要小心了，不要随便返回empty实现。尤其是使用了LazyLoading技术来进行一对多mapping时。因为默认的empty实现都是不可写的。这个时候，如果ORM试图延迟装载对应的实体类时（访问主实体时，子实体集合是空的；而第一次访问子实体集合时，ORM会去装载子实体，并填充集合），就会出现异常。
   所以大家对于书的理解，对于程序的理解，切记要在一定范围内。

没试过，不知道说的填充异常，具体是如何产生的。

List list1 = Collections.emptyList();  
list1.add("a");

抛异常。。。。就这样。

25 楼 sunsong 2010-01-21  

凤舞凰扬 写道

nickevin 写道

Item 43: Return empty arrays or collections, not nulls

public List<Cheese> getCheeseList() {
  if (cheesesInStock.isEmpty())
    return Collections.emptyList(); // Always returns same list
  else
    return new ArrayList<Cheese>(cheesesInStock);
}

from Effective Java : Joshua Bloch

   包括楼主以及楼上在内的童鞋们请注意:
1. 对于服务层或者提供服务的类（比如工具类）等，使用默认的empty实现（不仅仅是List,还包括Set, Map等数据结构类）是正确的选择。这样可以避免客户程序调用时对返回值的理解不一致从而出现的NullPointerException。
2. 对于数据实体类，用于ORM映射时（比如domain层），就要小心了，不要随便返回empty实现。尤其是使用了LazyLoading技术来进行一对多mapping时。因为默认的empty实现都是不可写的。这个时候，如果ORM试图延迟装载对应的实体类时（访问主实体时，子实体集合是空的；而第一次访问子实体集合时，ORM会去装载子实体，并填充集合），就会出现异常。
   所以大家对于书的理解，对于程序的理解，切记要在一定范围内。

没试过，不知道说的填充异常，具体是如何产生的。

24 楼 anky_end 2010-01-20  

另外就是new对象，我个人看法，直接new个list返回回去，也耗费不了什么资源，当然没有empty实现好

23 楼 anky_end 2010-01-20  

hkliya 写道

凤舞凰扬 写道

引用

empty实现只占用一份内存，而且基本对象的内存占用我认为是很低的，而且如果没意外很快也就回收了。

   这句真没看懂....

可能他的意思是说：

        List list1 = Collections.emptyList();
        List list2 = Collections.emptyList();
        System.out.println(list1 == list2);//true

不好意思，很久没关注了，
谢谢哥哥替我解释。

22 楼 treblesoftware 2010-01-19  

内存紧缩的问题是不是出在过多人的登录上？过多的HTTPSESSION似乎很占用服务器内存。

21 楼 風一樣的男子 2010-01-18  

凤舞凰扬 写道

nickevin 写道

Item 43: Return empty arrays or collections, not nulls

public List<Cheese> getCheeseList() {
  if (cheesesInStock.isEmpty())
    return Collections.emptyList(); // Always returns same list
  else
    return new ArrayList<Cheese>(cheesesInStock);
}

from Effective Java : Joshua Bloch

   包括楼主以及楼上在内的童鞋们请注意:
1. 对于服务层或者提供服务的类（比如工具类）等，使用默认的empty实现（不仅仅是List,还包括Set, Map等数据结构类）是正确的选择。这样可以避免客户程序调用时对返回值的理解不一致从而出现的NullPointerException。
2. 对于数据实体类，用于ORM映射时（比如domain层），就要小心了，不要随便返回empty实现。尤其是使用了LazyLoading技术来进行一对多mapping时。因为默认的empty实现都是不可写的。这个时候，如果ORM试图延迟装载对应的实体类时（访问主实体时，子实体集合是空的；而第一次访问子实体集合时，ORM会去装载子实体，并填充集合），就会出现异常。
   所以大家对于书的理解，对于程序的理解，切记要在一定范围内。

学习了，在以后的开发中会注意，javaeye 里大牛不少

20 楼 hkliya 2010-01-18  

凤舞凰扬 写道

引用

empty实现只占用一份内存，而且基本对象的内存占用我认为是很低的，而且如果没意外很快也就回收了。

   这句真没看懂....

可能他的意思是说：

        List list1 = Collections.emptyList();
        List list2 = Collections.emptyList();
        System.out.println(list1 == list2);//true

19 楼 凤舞凰扬 2010-01-18  

   我们要把问题分成两个部分：
1. 对于一个类来说，它的方法返回的集合类型是否可写。
2. 对于返回空集合的情况，方法究竟改返回什么Null, EmptyXXX 或者new XXX(0).

   对于前者，其实不是讨论的重点，它一般是出现在服务类，并且应该是由服务行为（也就是方法行为）所描述或者确定的。
   对于后者，如果已经确认方法应该返回不可写的集合（比如服务类），那么应该返回EmptyXXX，这样一是保证不可写，而是避免客户程序空指针异常。（一个好的业务程序不应该让客户程序有不一致的理解） 而如果是实体类，比如用来进行关系映射的对象，就应该使用new XXX() ，比如new ArrayList()的方式（当然大小可自己限制确定）。 楼上有位童鞋说的

引用

难怪JPA返回的resultList是不可写的，也无法装载了。

其实是指EntityManager（服务类）执行query返回的结果集，而不是对象映射中的子对象集合（子对象集合如果是非可写的，并且子对象被映射成可写映射，就会出异常的）。

18 楼 BarryWei 2010-01-18  

凤舞凰扬 写道

引用

empty实现只占用一份内存，而且基本对象的内存占用我认为是很低的，而且如果没意外很快也就回收了。

   这句真没看懂....

这个意思大概应该是：返回的那个empty list是一个static的list，在内存中只有一个。

17 楼 凤舞凰扬 2010-01-18  

引用

empty实现只占用一份内存，而且基本对象的内存占用我认为是很低的，而且如果没意外很快也就回收了。

   这句真没看懂....

16 楼 sunjun 2010-01-18  

return new ArrayList(0); 这样就行吧

15 楼 anky_end 2010-01-18  

BarryWei 写道

引用

1. 对于服务层或者提供服务的类（比如工具类）等，使用默认的empty实现（不仅仅是List,还包括Set, Map等数据结构类）是正确的选择。这样可以避免客户程序调用时对返回值的理解不一致从而出现的NullPointerException。
2. 对于数据实体类，用于ORM映射时（比如domain层），就要小心了，不要随便返回empty实现。尤其是使用了LazyLoading技术来进行一对多mapping时。因为默认的empty实现都是不可写的。这个时候，如果ORM试图延迟装载对应的实体类时（访问主实体时，子实体集合是空的；而第一次访问子实体集合时，ORM会去装载子实体，并填充集合），就会出现异常。

ORM的时候返回不可写的集合，也是问题的根源之一吧。至少这个空的集合还是被分配了内存出来。

如果规范统一起来，都返回null，可能会好点吧？

empty实现只占用一份内存，而且基本对象的内存占用我认为是很低的，而且如果没意外很快也就回收了。

14 楼 BarryWei 2010-01-17  

引用

1. 对于服务层或者提供服务的类（比如工具类）等，使用默认的empty实现（不仅仅是List,还包括Set, Map等数据结构类）是正确的选择。这样可以避免客户程序调用时对返回值的理解不一致从而出现的NullPointerException。
2. 对于数据实体类，用于ORM映射时（比如domain层），就要小心了，不要随便返回empty实现。尤其是使用了LazyLoading技术来进行一对多mapping时。因为默认的empty实现都是不可写的。这个时候，如果ORM试图延迟装载对应的实体类时（访问主实体时，子实体集合是空的；而第一次访问子实体集合时，ORM会去装载子实体，并填充集合），就会出现异常。

ORM的时候返回不可写的集合，也是问题的根源之一吧。至少这个空的集合还是被分配了内存出来。

如果规范统一起来，都返回null，可能会好点吧？

13 楼 C_J 2010-01-17  

凤舞凰扬 写道

nickevin 写道

Item 43: Return empty arrays or collections, not nulls

public List<Cheese> getCheeseList() {
  if (cheesesInStock.isEmpty())
    return Collections.emptyList(); // Always returns same list
  else
    return new ArrayList<Cheese>(cheesesInStock);
}

from Effective Java : Joshua Bloch

   包括楼主以及楼上在内的童鞋们请注意:
1. 对于服务层或者提供服务的类（比如工具类）等，使用默认的empty实现（不仅仅是List,还包括Set, Map等数据结构类）是正确的选择。这样可以避免客户程序调用时对返回值的理解不一致从而出现的NullPointerException。
2. 对于数据实体类，用于ORM映射时（比如domain层），就要小心了，不要随便返回empty实现。尤其是使用了LazyLoading技术来进行一对多mapping时。因为默认的empty实现都是不可写的。这个时候，如果ORM试图延迟装载对应的实体类时（访问主实体时，子实体集合是空的；而第一次访问子实体集合时，ORM会去装载子实体，并填充集合），就会出现异常。
   所以大家对于书的理解，对于程序的理解，切记要在一定范围内。

难怪JPA返回的resultList是不可写的，也无法装载了。

看来楼主要注意了，我想你把所有返回都改写可能会带来风险！！

12 楼 hynuliuyi 2010-01-16  

凤舞凰扬 写道

nickevin 写道

Item 43: Return empty arrays or collections, not nulls

public List<Cheese> getCheeseList() {
  if (cheesesInStock.isEmpty())
    return Collections.emptyList(); // Always returns same list
  else
    return new ArrayList<Cheese>(cheesesInStock);
}

from Effective Java : Joshua Bloch

   包括楼主以及楼上在内的童鞋们请注意:
1. 对于服务层或者提供服务的类（比如工具类）等，使用默认的empty实现（不仅仅是List,还包括Set, Map等数据结构类）是正确的选择。这样可以避免客户程序调用时对返回值的理解不一致从而出现的NullPointerException。
2. 对于数据实体类，用于ORM映射时（比如domain层），就要小心了，不要随便返回empty实现。尤其是使用了LazyLoading技术来进行一对多mapping时。因为默认的empty实现都是不可写的。这个时候，如果ORM试图延迟装载对应的实体类时（访问主实体时，子实体集合是空的；而第一次访问子实体集合时，ORM会去装载子实体，并填充集合），就会出现异常。
   所以大家对于书的理解，对于程序的理解，切记要在一定范围内。

非常赞同，开发过程中应该在遵循规范的同时，考虑实际情况作出灵活的变改，规范是死的，程序是活的

11 楼 shadowlin 2010-01-16  

0dragon 写道

return null 有造成null pointer exception的可能吧...
所以取之前要判断是否为null

但是逻辑上也还是要判断集合是不是空的啊。