问题现象:
java常量定义在 interface 和 final class 的区别?
问题分析:
最近在项目开发规范中,发现有要求使用 interface类 来定义常量!
这让我想起来以前一直是用 final class 来定义常量的;那么这两者是有什么区别呢?
首先,来看看 final class 是怎么定义常量的:
/**
* 使用 final class 类来自定义常量
*/
public final class FinalClassConstants {
//禁止实例化此类
private FinalClassConstants() {}
public static final String REMOTE_IP = "127.0.0.1";
public static final int REMOTE_PORT = 8989;
public final class ExceptionModel {
//禁止实例化此类
private ExceptionModel() {}
public static final String MODEL_MEMBER = "member";
public static final String MODEL_SYSTEM = "system";
}
public final class MemberExceptionCode {
//禁止实例化此类
private MemberExceptionCode() {}
public static final String CODE_10001 = "10001";// 会员信息为找到
public static final String CODE_10002 = "10002";// 会员参数未找到
public static final String CODE_10003 = "10003";// 非法会员参数:原因(检测参数是否必填,但是值为空 或者 检测参数ID和参数类型是否匹配)
public static final String CODE_10004 = "10004";
public static final String CODE_10005 = "10005";
public static final String CODE_10006 = "10006";
public static final String CODE_10007 = "10007";
public static final String CODE_10008 = "10008";
public static final String CODE_10009 = "10009";
}
public final class SystemExceptionCode {
//禁止实例化此类
private SystemExceptionCode() {}
public static final String CODE_10001 = "10001";// 字典未查到
public static final String CODE_10002 = "10002";// 协议未找到,请联系管理员配置
public static final String CODE_10003 = "10003";
public static final String CODE_10004 = "10004";
public static final String CODE_10005 = "10005";
public static final String CODE_10006 = "10006";
public static final String CODE_10007 = "10007";
public static final String CODE_10008 = "10008";
public static final String CODE_10009 = "10009";
}
}
可以发现,使用 final class 定义常量的时候,是比较麻烦的:
1、需要使用 private 修饰构造函数,防止被实例化。
2、需要使用 public static final 修饰所有变量,来使其变成公用的常量。
3、使用类嵌套定义子常量时,子类名也需要使用 public final class 修饰。
测试:
/**
* 测试:获取自定义常量的相关数据
*/
public class ConstantTest {
public static void main(String[] args) {
//测试:获取 final class 自定义常量的相关数据
System.out.println("ip:" + FinalClassConstants.REMOTE_IP);
System.out.println("port:" + FinalClassConstants.REMOTE_PORT);
System.out.println("ExceptionModel_member:" + FinalClassConstants.ExceptionModel.MODEL_MEMBER);
System.out.println("ExceptionModel_system:" + FinalClassConstants.ExceptionModel.MODEL_SYSTEM);
System.out.println("ExceptionModel_member_code1:" + FinalClassConstants.MemberExceptionCode.CODE_10001);
System.out.println("ExceptionModel_system_code1:" + FinalClassConstants.SystemExceptionCode.CODE_10001);
}
}
结果:
而相比之下使用 interface类 来定义常量则显得非常简洁和优美,这是因为:
interface 中定义的变量,默认自带"public static final"修饰, 所以默认就是常量。
interface 被 public 修饰后,内部 interface 也会被 public 修饰。
解决方法:
代码:
/**
* 使用 interface 类来自定义常量
* 对比可以发现:
* 使用 interface 类来定义常量比使用 final class 类来定义常量要更简洁优美
* 【1、interface 中定义的变量,默认自带"public static final"修饰, 所以默认就是常量】
* 【2、interface 被 public 修饰后,内部 interface 也会被 public 修饰】
*/
public interface InterfaceConstants {
String REMOTE_IP = "127.0.0.1";
int REMOTE_PORT = 8989;
interface ExceptionModel {
String MODEL_MEMBER = "member";
String MODEL_SYSTEM = "system";
}
interface MemberExceptionCode {
String CODE_10001 = "10001";// 会员信息为找到
String CODE_10002 = "10002";// 会员参数未找到
String CODE_10003 = "10003";// 非法会员参数:原因(检测参数是否必填,但是值为空 或者 检测参数ID和参数类型是否匹配)
String CODE_10004 = "10004";
String CODE_10005 = "10005";
String CODE_10006 = "10006";
String CODE_10007 = "10007";
String CODE_10008 = "10008";
String CODE_10009 = "10009";
}
interface SystemExceptionCode {
String CODE_10001 = "10001";// 字典未查到
String CODE_10002 = "10002";// 协议未找到,请联系管理员配置
String CODE_10003 = "10003";
String CODE_10004 = "10004";
String CODE_10005 = "10005";
String CODE_10006 = "10006";
String CODE_10007 = "10007";
String CODE_10008 = "10008";
String CODE_10009 = "10009";
}
}
测试:
/**
* 测试:获取自定义常量的相关数据
*/
public class ConstantTest {
public static void main(String[] args) {
//测试:获取 interface 自定义常量的相关数据
System.out.println("ip:" + InterfaceConstants.REMOTE_IP);
System.out.println("port:" + InterfaceConstants.REMOTE_PORT);
System.out.println("ExceptionModel_member:" + InterfaceConstants.ExceptionModel.MODEL_MEMBER);
System.out.println("ExceptionModel_system:" + InterfaceConstants.ExceptionModel.MODEL_SYSTEM);
System.out.println("ExceptionModel_member_code1:" + InterfaceConstants.MemberExceptionCode.CODE_10001);
System.out.println("ExceptionModel_system_code1:" + InterfaceConstants.SystemExceptionCode.CODE_10001);
}
}
结果:
可以发现,对 final class 和 interface 的常量进行类型调用的结果是一样的。