更新/写入静态变量的最佳实践？答案

【问题标题】：Best practice for updating/writing to static variable?更新/写入静态变量的最佳实践？
【发布时间】：2010-12-16 02:49:19
【问题描述】：

我有一个显示部门文档的项目。我将所有文档（从数据库中获取）存储在一个静态 arrayList 中。每隔 X 小时，我就会根据数据库中的新文档（如果有）重建该 arrayList。还有一个静态变量可以控制是否重建该数组，在执行重建任务的方法中设置和取消设置。每个访问服务器的 Web 浏览器都会创建此类的实例，但 doc arrayList 和该控制变量在所有类实例之间共享。

Find-Bugs 工具抱怨“从实例方法 someClassMethod 写入静态字段 someArrayName 和 someVariableName”。似乎这不是一件好事（让类实例方法写入静态字段）。有没有人有很好的建议如何解决这个问题？谢谢。

【问题讨论】：

好的是的。由于每次点击（如果 JSF2.0 是新会话或新视图）都会生成一个类实例，我不想创建许多包含相同文档的重复数组列表。谢谢。
Charles：您需要一个实例可以引用的单例“管理器”对象。使用静态实例来实现单例有一些棘手的副作用。更好的方法是创建一个管理器对象，并以某种方式将每个实例指向该对象。如果您在创建实例的框架下工作（相对于您自己运行 java），请查看如何创建单例对象。例如，Tomcat 有某种可以读/写的上下文，作为处理持久状态的一种方式——但我对它不太熟悉。
感谢您的帮助。我在其中添加了一个单例类，每隔 X 小时重建文档静态树或静态数组列表。由于我使用的是 JSF，JSF PhaseListeners 由所有 JSF web 请求共享，所以我将实例化单例类放在 phaseListener 中，工作正常。虽然重建树时存在线程访问风险，但我可以将树重建时间设置为午夜，并且树是只读的。我们的流量很低，所以应该没问题。

标签： java static findbugs

【解决方案1】：

根据FindBugs bug descriptions：

ST：从实例方法写入静态字段 (ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD)

此实例方法写入静态字段。如果正在操纵多个实例，这很难纠正，而且通常是不好的做法。

除了并发问题之外，这意味着 JVM 中的所有实例都在访问相同的数据，并且不允许两组单独的实例。如果您有一个单例“管理器”对象并将其作为构造函数参数或至少作为setManager() 方法参数传递给每个实例，那就更好了。

关于并发问题：如果你必须使用静态字段，你的静态字段应该是最终的；显式同步很困难。（如果您要初始化非最终静态字段，还有一些棘手的方面，超出了我对 Java 的了解，但我想我已经在 Java Puzzlers 书中看到了它们。）至少有三种处理方法（警告，以下是未经测试的代码，使用前请先检查）：

使用线程安全的集合，例如Collections.synchronizedList 包裹着一个无法以任何其他方式访问的列表。
```
static final List<Item> items = createThreadSafeCollection();


static List<Item> createThreadSafeCollection()
{
   return Collections.synchronizedList(new ArrayList());
}
```
然后当您从一个实例替换此集合时：
```
List<Item> newItems = getNewListFromSomewhere();
items.clear();
items.add(newItems);
```
这样做的问题是，如果两个实例同时执行此序列，您可能会得到：

Instance1: items.clear(); Instance2: items.clear(); Instance1: items.addAll(newItems); Instance2: items.addAll(newItems);

并得到一个不满足所需类不变量的列表，即静态列表中有两组 newItems。因此，如果您将整个列表作为一个步骤清除，并将项目作为第二个步骤添加，则此方法不起作用。（不过，如果您的实例只需要添加一个项目，items.add(newItem) 在每个实例中都可以安全使用。）

同步访问集合。

您需要一个显式的同步机制。同步方法不起作用，因为它们在“this”上同步，这在实例之间并不常见。你可以使用：

static final private Object lock = new Object();
static volatile private List<Item> list;
// technically "list" doesn't need to be final if you
// make sure you synchronize properly around unit operations.


static void setList(List<Item> newList)
{
  synchronized(lock)
  {
      list = newList;
  }
}

使用原子引用

static final private AtomicReference<List<Item>> list;


static void setList(List<Item> newList)
{
  list.set(newList);
}

【讨论】：

【解决方案2】：

如果我正确理解您从 Find Bugs 发布的消息，这只是一个警告。

如果要隐藏警告，请从静态方法进行修改。 Find Bugs 会警告您，因为这通常是一个错误。程序员认为他们正在改变一些实例状态，但实际上他们正在改变一些影响每个实例的状态。

【讨论】：

它报告为一个错误（左侧附有错误图像）。

【解决方案3】：

使用Singleton 设计模式是一种方法。您只能拥有一个包含所需值的对象实例，并通过全局属性访问该实例。优点是，如果您以后想拥有更多实例，则对现有代码的修改较少（因为您没有将静态字段更改为实例字段）。

【讨论】：

单例模式在这里没有帮助——问题是列表不同步。单例模式无法保证同步访问。
+1 -- 这是合适的答案。一般来说，静态方法应该是无状态的并且不推荐使用静态字段，因为它们使得在对象中替换以进行测试变得更加困难。
问题真的是同步吗？

【解决方案4】：

您无需每次都删除该列表。如上所述，您将不得不处理多个线程，但您可以创建一次 ArrayList，然后使用 clear() 和 addAll() 方法进行擦除和重新填充。 FindBugs 应该对此非常满意，因为您没有设置静态。

伙计们 - 如果这项技术有任何问题，请随时参与 :-)

第二个想法是通过休眠从数据库中驱动东西。所以不要维护一个列表，hibernate 有内置的缓存，所以它几乎一样快。如果您在数据库级别更新数据（这意味着 hibernate 不知道），那么您可以告诉 hibernate 清除它的缓存并在下一次查询时从数据库中刷新。

【讨论】：

你说得对！一旦我执行了arrayList.clear()，然后为它分配新的arrayList（因为它是另一个数据库模型调用，它返回一个新的arrayList()），然后FindBugs 很高兴。但是该静态布尔控制变量仍然存在问题（控件是否根据计时器重建arrayList）。

【解决方案5】：

您不想这样做。每个请求都在自己的线程中运行。如果在浏览器操作上执行的代码修改了列表，那么两个请求可能同时修改列表，并破坏数据。这就是为什么从非静态上下文访问静态资源不是一个好主意的原因，可能也是您的工具警告您的原因。

看看这个

http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/package-summary.html

特别是关于 ArrayList 如何不同步的部分。另请注意，我提到的段落有一个解决方案，特别是

List list = Collections.synchronizedList(new ArrayList(...));

这是一种方法。但这仍然不是一个好主意，即因为它可能很慢。如果它不是商业级应用程序，并且您的交易量不高，那么您可能会通过不改进它来获得。如果这是每天只被点击几次的应用类型，您可以忽略警告，但要了解如果两个请求相互冲突，就会发生不好的事情可能。

更好的解决方案：由于您有数据库，我会在您需要时从数据库中获取信息，即在请求进来时。您可以使用一些缓存技术来提高性能。

我不喜欢单例模式想法的原因是，即使它使警告消失，它本身也不能解决基本的同步问题。但是，有线程安全的http://en.wikipedia.org/wiki/Singleton_pattern#Traditional_simple_way_using_synchronization，在这种情况下可能会起作用。

【讨论】：

@Jason 没错，但考虑到问题的性质，我认为 OP 没有正确处理并发。
特别是，静态变量应该只在新列表完全（重新）构建后设置，而不是在构建时设置。这并没有消除同步问题，但它大大缩小了争用窗口。