【最佳实践】用优雅的方式安置静态常量：枚举＞常量类＞接口_move constants defined in this interfaces to anoth-优快云博客

本文链接：https://blog.youkuaiyun.com/weixin_60006489/article/details/146580807

问题

之前很喜欢把静态常量放在接口里面，比如：

public interface UserConstant {
    int DEFAULT_ROLE = 0;
    int ADMIN_ROLE = 1;
    int VIP_ROLE = 2;
    
}

写起来真的很爽，使用也很方便，但每次commit 的时候都会被sonarQube提醒：

An interface that consists solely of constant definitions is a bad practice. The purpose of interfaces is to provide an API, not implementation details. That is, they should provide functions in the first place and constants only to assist these functions, for example, as possible arguments.
If an interface contains constants only, move them either to somewhere else, or replace the interface with an Enum or a final class with a private constructor.

翻译过来就是说：

仅由常量定义组成的接口是一种不好的做法。接口的目的是提供API，而不是实现细节。也就是说，它们应该首先提供函数，并仅提供常量来辅助这些函数，例如，作为可能的参数。如果接口只包含常量，请将它们移动到其他地方，或将接口替换为Enum或将final类替换为私有构造函数。

这样的提醒确实是很有道理的，下面来详细聊聊

接口的本质

首先，我们要明确接口的核心职责：定义要做的行为。接口最重要的目的是描述一个类应该具备哪些方法，而不应当只是用来存储常量，否则就是给自己挖坑。

常量接口的三个坑

1. 命名空间污染

当一个类实现了包含常量的接口，这些常量会自动成为该类的一部分：

// 不推荐的写法
public interface Roles {
    int ADMIN = 1;
    int USER = 0;
}

public class UserService implements Roles {
    public void doSomething() {
        // 可以直接使用 ADMIN，看着很简洁，但这并不是一个好习惯
        int role = ADMIN;  
    }
}

这种设计会导致命名空间混乱，增加代码的耦合性，提高后续的维护成本

2. 多接口实现时常量冲突

如果多个接口定义了相同名称的常量，会导致编译错误：

public interface RoleConstants {
    int ADMIN = 1;
}

public interface UserConstants {
    int ADMIN = 2;  
}

如果有一个类同时实现了上面了两个接口，会出现变量之间的冲突。

3. 可见性和访问控制

接口中的常量默认是 public static final，这意味着：

任何地方都可以访问
无法限制访问范围
可能破坏封装性
当一个实现类实现常量接口的时候可能只是需要其中的少部分常量，但它实际得到的将是所有接口内的常量

推荐的常量定义方式

方案一：常量类

public final class UserConstants {
    private UserConstants() {} // 私有构造函数，防止实例化

    public static final class Roles {
        public static final int VIP = 2;
        public static final int ADMIN = 1;
        public static final int USER = 0;
    }
}

方案二：枚举（推荐）

public enum UserRole {
    ADMIN(2, "VIP"),
    ADMIN(1, "管理员"),
    USER(0, "普通用户");
    
    private final int code;
    private final String description;
    
    UserRole(int code, String description) {
        this.code = code;
        this.description = description;
    }
    
    public int getCode() {
        return code;
    }
    
    public String getDescription() {
        return description;
    }
}