Static Substitution 静态替换（译）

Static Substitution 静态替换（译）

Martin Fowler

原文：http://martinfowler.com/bliki/StaticSubstitution.html

我们的开发组在讨论他们的工作时，一个常常听到的话题是他们不喜欢使用存放在静态（static）变量中的东西。我们通常会看到，一些Services或Components会在静态的初始化代码块中，保存在静态变量中。使用静态变量（大部分语言都有此特性）的最大问题之一，是不能通过多态性来把一种具体的实现（implementation）替换成为另外一种。这样会对我们造成很大的约束 -- 为我们是测试（驱动开发）的超级Fans -- 使用Service Stub来代替Service，对于很好地进行测试是十分重要的。

这里有一个这种静态变量的例子。

[code]

public class AddressBook {

    private static String connectionString, username, password;

 

    static {

        Properties props = getProperties();

        connectionString =(String) props.get("db.connectionString");

        password = (String) props.get("db.password");

        username = (String) props.get("db.username");

    }

 

    public static Person findByLastName(String s) {

        String query = "SELECT lastname, firstname FROM PEOPLE where lastname = ?";

        Connection conn = null;

        PreparedStatement st = null;

        ResultSet rs = null;

        try {

            conn = DriverManager.getConnection(connectionString, username, password);

            st = conn.prepareStatement(query);

            st.setString(1, s);

            rs = st.executeQuery();

            rs.next();

            Person result = new Person (rs.getString(2), rs.getString(1));

            return result;

        } catch (Exception e) {

            throw new RuntimeException(e);

        } finally {

            cleanUp(conn, st, rs);

        }

    }

 [/code]

例子中我们有一些在静态初始化代码块中初始化的配置值，和一个在数据库上执行查询的静态方法。

使用这种方式，对程序作某些改变是很容易实现的。例如通过更改properties文件，我们可以很容易地更换程序使用的数据库。但是对测试来说，我们也许根本不用数据库――使用一个简单的返回打包好的数据的stub就行了。

为了允许这种简单的替换，我们需要做一些简单的重构。第一步是把静态变量转为单例（singleton）。

[code]

public class AddressBook {

     private static AddressBook soleInstance = new AddressBook();

     private String connectionString, username, password;

     public AddressBook() {

        Properties props = getProperties();

        connectionString =(String) props.get("db.connectionString");

        password = (String) props.get("db.password");

        username = (String) props.get("db.username");

    }

     public static Person findByLastName(String s) {

        return  soleInstance.findByLastNameImpl(s);

    }

    public Person findByLastNameImpl(String s) {

        String query = "SELECT lastname, firstname FROM PEOPLE where lastname = ?";

        Connection conn = null;

        PreparedStatement st = null;

        ResultSet rs = null;

        try {

            conn = DriverManager.getConnection(connectionString, username, password);

            st = conn.prepareStatement(query);

            st.setString(1, s);

            rs = st.executeQuery();

            rs.next();

            Person result = new Person (rs.getString(2), rs.getString(1));

            return result;

        } catch (Exception e) {

            throw new RuntimeException(e);

        } finally {

            cleanUp(conn, st, rs);

        }

    }

[/code] 
    
    

这是一个相当简单明了的重构。

• 我们先把旧类中的静态数据转为实例数据。
• 然后把静态的初始化代码移到构造函数中。
• 最后我们把所有的公共方法的实现移到实例中，原来的静态方法中只是简单地调用实例方法。

在重构的分类中没有这个方法――也许我们应该把它称作“用单例替换静态变量”（Replace Statics With Singleton）。至此为止，这个重构并没有改变原来程序的任何功能，但已经使程序在支持替换的能力上迈进了一步。下一步是引入一个加载单独实例的方法。

[code]

    public static void loadInstance(AddressBook arg) {

        soleInstance = arg;

    }

 [/code]
    
    

现在，我们已经准备好为测试（或者其他的目的）进行替换了。在一个测试用例中，我们可以在测试的setUp方法中添加一个合适的方法调用：AddressBook.loadInstance(new StubAddressBook());

只要编写一个继承自AddressBook的子类，我们就可以用它来代替实际的东西（如数据库）进行测试了。

事情并没有到此结束。在上面的代码中，即使从来不使用，我们也会创建一个service的实例――因为单独的实例是在静态的初始化代码中进行初始化的。这样使service的使用和创建的代码有了依赖关系，代码的灵活性降低了。要解决这个问题，我们需要把这样的静态初始化代码移到一个可以替换的初始化类中。（可以参考Chris以获得更多这方面的信息）。但至少，我们所做的重构为处理这样的问题提供了很有用的一步。

这个重构还带来了使用单例模式可能带来的问题。特别要注意，如果使用单例（或者其他形式的Registry），要保证这些单例和他们的实例化方式都是可以很容易替换的。

我刚拿到Michael Feathers 的新书Working Effectively With Legacy Code，他在书中谈到更多（和更好的）关于处理类似问题的方法。