映射值是应该以常量还是枚举声明?

时间:2012-07-31 13:18:05

标签: java spring spring-mvc enums dry

我看到这遍及整个代码库:

@RequestMapping(value = "myValue")

我更喜欢使用这样的东西:

@RequestMapping(value = Constants.myValue)

似乎使用@RequestMapping中的实际字符串值而不是常量来破坏DRY。 但这是一个很好的代码实践吗?我应该使用枚举吗? 我可能需要在代码库中的其他地方使用Constants.myValue

1 个答案:

答案 0 :(得分:17)

  

我应该使用枚举吗?

你做不到。注释变量必须是编译时常量。枚举和字符串文字都是,但你不能创建一个字符串枚举,@RequestMapping需要一个字符串(如果你的枚举有一个方法返回一个字符串或一个字符串字段,这不是一个编译 - 时间常数)。由于有多轮注释处理,当常量在另一个类中时它会起作用。

那说:是的,我会说使用一个专用的常量类(对于不同类型的常量,可能有几个)是一个很好的做法,我可以随时使用(并且只要常量a,它就可以使用注释)未在具有注释的同一编译单元内定义,b)在声明中初始化(与静态初始化程序块相对))。

以下是一个例子:

<强>控制器

@Controller @RequestMapping(value = Mappings.CUSTOMER_PAGE)
public class CustomerPageController{
    // methods here
}

常量类

public static final class Mappings{
    private Mappings(){}
    public static final String CUSTOMER_PAGE = "path/to/customer/page"
    // more constants
}

以下是一些不起作用的版本:

A)

@Controller @RequestMapping(value = CUSTOMER_PAGE)
public class CustomerPageController{
    private static final String CUSTOMER_PAGE = "path/to/customer/page";
}

这不会编译,因为注释引用了它注释的类中的常量。这不起作用,因为在编译期间,注释在代码的其余部分之前在单独的一轮中处理,而类需要已经处理注释以进行编译(即注释和常量之间存在特定的依赖关系)

b)中

public static final class Mappings{
    private Mappings(){}
    public static final String CUSTOMER_PAGE;
    static{
        CUSTOMER_PAGE = "path/to/customer/page"
    }

    // more constants
}

虽然这是一个静态的final字段,但它不是编译时常量,因此它不能用作注释参数