java - 维护 RestController 的路径常量

Question

我想知道维护 Rest Controller 路径常量的常见样式是什么。例如你有类似的东西:

@RequestMapping(method = RequestMethod.GET, value = ANY_PATH_VALUE)

我目前确实在名为 PathConstants 的类中维护这些常量(在示例中为 ANY_PATH_VALUE)，如下所示:

public abstract class PathConstants {
    public static final String ANY_PATH_VALUE = "/path/{SOME_ID}";
    ...
}

这是将这些值直接保留在 RestController 类的方法中的常见方法还是像我现在所做的那样？或者是否有更常见的方法来维护此类内容？

Answer 1

这有两个方面，

它实际上存在接近于零的性能问题。这必须具有可读性。

• 第一个 View 是将值保留为 Controller 中的 native 字符串。
  这更具可读性，因为您可以在进入 Controller 时直接检查确切的 API 路由。
• 第二个 View 是将其保存在带有 static 常量的其他文件中。
  像这样保留所有路由实际上为您提供了一个公共(public)场所，您可以在其中了解应用程序当前支持的所有 API 路由。

我个人更喜欢第二种，即将所有路径保存在名为 APIRoutes 的文件中，并进一步按域划分。

public class APIRoutes {

    public class SYSTEM {
         public static final String HEALTH_CHECK = "api/v1/healthcheck";
         public static final String LB_HEALTH_CHECK = "lb/v1/healthcheck";
    }

    public class API {
         public static final String SAVE_X = "api/v1/save";
         public static final String GET_X = "api/v1/get";
    }

    public class CACHE {
         public static final String RELOAD_X = "cache/v1/load/x";
         public static final String RELOAD_Y = "cache/v1/load/y";
    }

}

这样在你的 Controller 中，你就有了类似的东西

@RequestMapping(method = RequestMethod.GET, value = APIRoutes.API.SAVE_X)