jueduizone
V2EX  ›  Java

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

  •  1
     
  •   jueduizone · Mar 4, 2017 · 5804 views
    This topic created in 3364 days ago, the information mentioned may be changed or developed.

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

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

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

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

    Supplement 1  ·  Mar 22, 2017

    感谢大家的回复,最后采用@yeyuexia的说法,谢谢~

    13 replies    2017-03-07 09:33:17 +08:00
    zhihaofans
        1
    zhihaofans  
       Mar 4, 2017 via iPhone
    java 上我一般用第一种, php 才用第二种
    jueduizone
        2
    jueduizone  
    OP
       Mar 4, 2017
    @zhihaofans url 也是驼峰?阿里应该也是 java ,但参数是下划线,所以也很困惑
    qiayue
        3
    qiayue  
    PRO
       Mar 4, 2017
    淘宝最初是 PHP 做的,所以参数是下划线形式,后来改成了 JAVA ,但是参数不能改

    URL 中,驼峰或者下划线都可以,但是比较少用横线吧
    nooper
        4
    nooper  
       Mar 4, 2017
    Swagger
    340244120
        5
    340244120  
       Mar 4, 2017 via Android
    java 系就好好用驼峰吧
    0915240
        6
    0915240  
       Mar 4, 2017
    rest 的话 我喜欢中划线
    0915240
        7
    0915240  
       Mar 4, 2017
    @0915240 指的是 uri ,参数的话还是老老实实的驼峰吧
    Cbdy
        8
    Cbdy  
       Mar 4, 2017 via Android
    和 Java 没有关系的吧,一般是 my-topic
    yeyuexia
        9
    yeyuexia  
       Mar 5, 2017
    我自己在推广的规范是这样 url 不用驼峰命名 其中 url 的 path 用-号分割单词, queryparam 用_分隔 body 里面的用 field 用驼峰命名。
    -分隔的东西在前端没办法很好的写成变量 所以避免了一些直接映射
    _分隔的东西可以很好写在 dict 的 key 里 很直观
    驼峰的东西就是数据的映射了

    习惯之后很直观,一看就知道是在哪用的
    sagaxu
        10
    sagaxu  
       Mar 5, 2017
    Java Bean 规范里规定用驼峰命名法,严格遵守可以省事不少
    sagaxu
        11
    sagaxu  
       Mar 5, 2017
    用驼峰, springmvc 可以直接把参数注入到 form 对象
    beginor
        12
    beginor  
       Mar 6, 2017 via Android
    两个不同的领域为什么非得一致,堂堂大 springmvc 难道没有 parameter binding ? https://msdn.microsoft.com/en-us/library/system.web.http.fromuriattribute(v=vs.118).aspx
    Fireflyi
        13
    Fireflyi  
       Mar 7, 2017
    就看语言本身 , java 的函数都是驼峰命名, javabean 规范也是 大部分也是驼峰,所以这个问题不需要纠结 直接使用驼峰就行,即正确又规范
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   5443 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 60ms · UTC 06:37 · PVG 14:37 · LAX 23:37 · JFK 02:37
    ♥ Do have faith in what you're doing.