Java 开发 App 接口中关于 url 和入参规范的问题

2017-03-04 16:34:25 +08:00
 jueduizone

现在公司用开发给前端用的接口,语言是Java,现在想定开发规范,然后有些纠结的地方:

一个是接口的名称,之前用的的驼峰的形式,比如myTopic,但是看网上推荐的有my_topic,更容易辨识,或者推荐比较多的my-topic,看到说法是比前一种输入起来更方便。

还有个入参的问题,比如一个接口接受的参数是分页的页数,之前也是习惯性的驼峰的pageNum,但看很多公司,比如支付宝的接受参数都是page_num这种。

想问下大家以上两个问题一般用的是那种或推荐哪种?

4987 次点击
所在节点    Java
13 条回复
zhihaofans
2017-03-04 16:40:18 +08:00
java 上我一般用第一种, php 才用第二种
jueduizone
2017-03-04 17:14:29 +08:00
@zhihaofans url 也是驼峰?阿里应该也是 java ,但参数是下划线,所以也很困惑
qiayue
2017-03-04 17:18:04 +08:00
淘宝最初是 PHP 做的,所以参数是下划线形式,后来改成了 JAVA ,但是参数不能改

URL 中,驼峰或者下划线都可以,但是比较少用横线吧
nooper
2017-03-04 20:38:23 +08:00
Swagger
340244120
2017-03-04 20:39:52 +08:00
java 系就好好用驼峰吧
0915240
2017-03-04 20:42:50 +08:00
rest 的话 我喜欢中划线
0915240
2017-03-04 20:43:43 +08:00
@0915240 指的是 uri ,参数的话还是老老实实的驼峰吧
Cbdy
2017-03-04 21:01:17 +08:00
和 Java 没有关系的吧,一般是 my-topic
yeyuexia
2017-03-05 00:45:52 +08:00
我自己在推广的规范是这样 url 不用驼峰命名 其中 url 的 path 用-号分割单词, queryparam 用_分隔 body 里面的用 field 用驼峰命名。
-分隔的东西在前端没办法很好的写成变量 所以避免了一些直接映射
_分隔的东西可以很好写在 dict 的 key 里 很直观
驼峰的东西就是数据的映射了

习惯之后很直观,一看就知道是在哪用的
sagaxu
2017-03-05 11:59:36 +08:00
Java Bean 规范里规定用驼峰命名法,严格遵守可以省事不少
sagaxu
2017-03-05 12:01:43 +08:00
用驼峰, springmvc 可以直接把参数注入到 form 对象
beginor
2017-03-06 08:50:59 +08:00
两个不同的领域为什么非得一致,堂堂大 springmvc 难道没有 parameter binding ? https://msdn.microsoft.com/en-us/library/system.web.http.fromuriattribute(v=vs.118).aspx
Fireflyi
2017-03-07 09:33:17 +08:00
就看语言本身 , java 的函数都是驼峰命名, javabean 规范也是 大部分也是驼峰,所以这个问题不需要纠结 直接使用驼峰就行,即正确又规范

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/344902

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX