包命名和URL路径命名规则

包命名和URL路径命名规则

  • 包名:统一使用小写,点分隔符之间,有且仅有一个自然语义的英语单词,使用单数形式。
  • URL路径名:统一使用小写,斜杠之间,有且仅有一个自然语义的英语单词,使用单数形式。

大部分时候,这是符合逻辑的,能和业务逻辑建立对应关系。比如:开户功能对应的包名,应该为 account.open ,而不是 openAccount ;账户模块下的其他功能,也应放入account包下,比如销户功能为 account.close

包的命名、URL路径的命名,规则都是类似的。应该和业务逻辑有着对应关系。遵循高内聚低耦合原则,相关业务模块,放到统一的层级下。

阿里的《Java 开发手册》中的标准

【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式,但是类名如果有复数含义,类名可以使用复数形式。

正例:应用工具类包名为 com.alibaba.ei.kunlun.aap.util、类名为 MessageUtils(此规则参考 spring 的 框架结构)

包命名/URL命名

含义 逻辑层次 包名命名 URL地址
期货-推荐-开户 期货-推荐-开户 futures.recommend.account.open futures/recommend/account/open
期货-开户 期货-账户-开户 futures.account.open futures/account/open
期货-销户 期货-账户-销户 futures.account.close futures/account/close
期货-冻结账户 期货-账户-冻结 futures.account.freeze futures/account/freeze
期货-激活账户(首次开户后激活账户) 期货-账户-激活(首次开户后激活账户) futures.account.activate futures/account/activate
期货-重新激活账户(冻结后重新激活账户) 期货-账户-重新激活(冻结后重新激活账户) futures.account.reactivate futures/account/reactivate

包结构示例

  • futures
    • account
      • open
      • close
      • freeze
      • activate
      • reactivate

猜你喜欢

转载自blog.csdn.net/sgx1825192/article/details/129796255