Spring Boot Restful Controller层方法命名规范及命名选择问题咨询
Spring Boot Restful Controller 方法命名规范说明
是否存在官方统一的强制命名规范?
Spring Boot 官方没有对 RestController 的方法名做出强制约束,只要符合 Java 基础标识符规则即可正常运行,但行业内有普遍达成共识的约定俗成规范可以参考。
getSomeData 和 fetchSomeData 如何选择?
优先选择 getSomeData,原因如下:
- Java 生态内默认查询类动作的前缀就是
get,符合绝大多数开发者的认知习惯,看到前缀即可快速判断该接口是查询类操作,可读性更高 fetch前缀更多用在DAO、Repository 等底层数据访问层,用来表示从数据库、第三方接口拉取数据的动作,放在 Controller 层容易混淆分层职责的语义边界
方法名中使用 get、post、put 等HTTP动词是否符合规范?
完全符合行业通用约定,甚至是比较推荐的做法:
- 方法名直接关联HTTP请求类型,不需要额外查看
@GetMapping、@PostMapping等注解配置即可快速理解接口的请求方式,降低维护成本 - 通用的命名范式为「HTTP动词 + 业务对象/操作描述」,比如
getUserById、postUserCreate、putUserInfo、deleteUser,和REST接口的语义完全对齐
如果你的团队有内部统一的命名规则,优先遵循团队约定即可,代码命名的一致性优先级高于单个命名的合理性。
内容的提问来源于stack exchange,提问作者user1354825
相关产品推荐
相关产品推荐

