接口隔离原则:精简接口,专注职责,多环境配置管理案例_接口隔离原则

接口隔离原则(Interface Segregation Principle, ISP)是SOLID设计原则中的第四个原则。它主张不应该强迫客户依赖于它们不使用的方法,即一个类对另一个类的依赖应该建立在最小的接口上。

肖哥弹架构 跟大家“弹弹” 代码设计技巧,需要代码关注

欢迎 点赞,点赞,点赞.

关注公号Solomon肖哥弹架构获取更多精彩内容

历史热点文章

2. 接口隔离设计图:

将一个臃肿的接口拆分为多个客户端特定的接口:

接口隔离原则:精简接口,专注职责,多环境配置管理案例_接口隔离原则_02

3. 接口隔离解决什么:

接口隔离原则解决了因为接口设计过于庞大而导致的低内聚和高耦合问题,使得使用接口的类实现了许多它们不需要的方法。

4. 接口隔离特点:
  • 接口细分:接口应该尽可能小且职责单一。
  • 客户端定制:接口应该根据客户端的需要定制。
  • 高内聚:每个接口都聚焦于特定的功能。
  • 低耦合:客户端只依赖于它们需要的接口。
5. 接口隔离缺点:
  • 接口数量增加:可能会导致接口数量过多,管理起来较为复杂。
  • 设计难度:需要更多的设计思考来确定合适的接口粒度。
6. 接口隔离使用场景:

当一个类实现了许多它不需要的方法时,或者当多个类因为依赖同一个接口而互相影响时,应该考虑使用接口隔离原则。

7.接口隔离案例
7.1 多环境配置管理案例

考虑一个应用,它需要根据不同的环境(开发、测试、生产)加载不同的配置。

重构前:

    public interface IEnvironmentConfig {
        String getDatabaseUrl();
        String getAuthServiceUrl();
        String getEmailServiceUrl();
    }

    public class DevEnvironmentConfig implements IEnvironmentConfig {
        @Override
        public String getDatabaseUrl() {
            return "dev_database_url";
        }

        @Override
        public String getAuthServiceUrl() {
            // Dev环境可能不需要认证服务
            return "";
        }

        @Override
        public String getEmailServiceUrl() {
            return "dev_email_service_url";
        }
    }

    // Prod环境的配置类...
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.

重构后:

    public interface IDatabaseConfig {
        String getDatabaseUrl();
    }

    public interface IAuthServiceConfig {
        String getAuthServiceUrl();
    }

    public interface IEmailServiceConfig {
        String getEmailServiceUrl();
    }

    public class DevEnvironmentConfig implements IDatabaseConfig, IEmailServiceConfig {
        @Override
        public String getDatabaseUrl() {
            return "dev_database_url";
        }

        // DevEnvironmentConfig不实现IAuthServiceConfig,因为它不需要认证服务
    }

    public class ProdEnvironmentConfig implements IDatabaseConfig, IAuthServiceConfig, IEmailServiceConfig {
        @Override
        public String getDatabaseUrl() {
            return "prod_database_url";
        }

        @Override
        public String getAuthServiceUrl() {
            return "prod_auth_service_url";
        }

        @Override
        public String getEmailServiceUrl() {
            return "prod_email_service_url";
        }
    }

    public class Application {
        private IDatabaseConfig databaseConfig;
        private IAuthServiceConfig authServiceConfig;
        private IEmailServiceConfig emailServiceConfig;

        public Application(IEnvironmentConfig environmentConfig) {
            this.databaseConfig = environmentConfig;
            // 根据环境需求注入其他配置...
        }

        public void configureServices() {
            // 使用注入的配置初始化服务
        }
    }
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.
  • 28.
  • 29.
  • 30.
  • 31.
  • 32.
  • 33.
  • 34.
  • 35.
  • 36.
  • 37.
  • 38.
  • 39.
  • 40.
  • 41.
  • 42.
  • 43.
  • 44.
  • 45.
  • 46.
  • 47.
  • 48.
  • 49.
  • 50.
  • 51.
  • 52.
7.2 支付系统集成案例

商务平台,需要集成多种支付方式,如信用卡支付和银行转账

重构前:


public interface IPayable {
    void processPayment();
}

public class PaymentService {
    public void processPayment(IPayable payment) {
        payment.processPayment();
    }
}

// 特定支付方式实现IPayable接口
public class CreditCardPayment implements IPayable {
    @Override
    public void processPayment() {
        // 处理信用卡支付逻辑
    }
}

public class BankTransferPayment implements IPayable {
    @Override
    public void processPayment() {
        // 处理银行转账逻辑
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.

分析问题:

  1. 过度依赖: IPayable 接口强制所有实现类都实现 processPayment 方法,但不同支付方式可能需要不同的处理逻辑和附加步骤,例如信用卡授权或账户验证。
  2. 低内聚性: IPayable 接口可能包含了与支付处理无直接关联的方法,导致接口的内聚性降低。
  3. 扩展性差: 当需要添加新的支付方式或改变现有支付逻辑时,可能需要修改接口定义或对多个类进行更改,这增加了扩展的难度。
  4. 违反LSP: 如果子类重写了基类的方法以添加特定逻辑,这可能会影响使用基类引用的客户端代码,违反了里氏替换原则。
  5. 代码冗余: 为了满足接口定义,某些类可能不得不提供空实现或不相关的实现,导致代码冗余。

重构后:


public interface IPaymentProcessor {
    void processPayment();
}

public interface ICreditCardPaymentProcessor extends IPaymentProcessor {
    void authorizeCard();
}

public interface IBankTransferPaymentProcessor extends IPaymentProcessor {
    void validateAccount();
}

public class CreditCardPaymentProcessor implements ICreditCardPaymentProcessor {
    @Override
    public void processPayment() {
        // 处理信用卡支付逻辑
    }
    
    @Override
    public void authorizeCard() {
        // 授权信用卡
    }
}

public class BankTransferPaymentProcessor implements IBankTransferPaymentProcessor {
    @Override
    public void processPayment() {
        // 处理银行转账逻辑
    }
    
    @Override
    public void validateAccount() {
        // 验证账户信息
    }
}

public class PaymentService {
    public void processPayment(IPaymentProcessor paymentProcessor) {
        paymentProcessor.processPayment();
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.
  • 28.
  • 29.
  • 30.
  • 31.
  • 32.
  • 33.
  • 34.
  • 35.
  • 36.
  • 37.
  • 38.
  • 39.
  • 40.
  • 41.
  • 42.

解决的问题:

  1. 职责明确: 通过将 IPayable 拆分为 IPaymentProcessorICreditCardPaymentProcessorIBankTransferPaymentProcessor,每个接口都聚焦于特定的支付处理职责,提高了内聚性。
  2. 更好的扩展性: 新的支付方式可以通过实现相应的接口轻松添加,而不影响现有代码。例如,如果需要添加微支付,可以创建一个实现 IPaymentProcessorWeChatPaymentProcessor 类。
  3. 遵循LSP: 子类(特定支付处理器)现在可以安全地替换基类(IPaymentProcessor),而不改变客户端代码的行为,因为它们提供了与基类相同的方法。
  4. 减少代码冗余: 每个支付处理器类只需要实现与其职责相关的接口方法,消除了不必要的空实现或不相关的方法。
  5. 灵活性增强: 通过分离接口,可以更灵活地组合不同的支付处理步骤,例如,可以在信用卡支付处理器中添加额外的授权步骤,而不会影响到其他支付方式。
  6. 易于维护: 当需要修改特定支付方式的逻辑时,只需修改对应的接口实现,而不会影响到其他支付方式的实现,简化了维护工作。
8. 参考开源框架:
  • 在Java的Spring框架中,接口通常被设计得非常小且职责单一,以确保它们可以被客户端类轻松实现,而不会引入不必要的依赖。
  • 在Spring框架中,通过使用Profile来区分不同环境的配置,体现了接口隔离原则。
9. 总结:

接口隔离原则是提高软件系统可维护性和灵活性的关键原则。通过将大型接口拆分为更小的、特定于客户端的接口,我们减少了客户端类与它们不使用的接口方法之间的不必要耦合。虽然这可能会导致接口数量的增加,但它为构建一个更加模块化和可扩展的系统提供了坚实的基础。遵循接口隔离原则有助于确保每个接口都紧凑且职责明确,从而简化了代码的理解和维护。

历史热点文章