javashop开发7.0架构及规范说明

后台-系统设置-扩展变量-手机广告位-内容正文顶部
  工程结构
  
  包名
  工程包名规范
  
  javashop-core包名规范
  
  API路径规范
  注:在每个api服务中,上述业务路径是相同的
  异常规范
  •   根据http状态判断业务是否正常
  •   如果正常要求返回对象的Json
  •   如果有异常返回异常的json

  异常Json格式规范
  {
  "code":"100",
  "message":"无权访问",
  "data":[]
  }

  code规范
  三位数字
  每个模块code规范
  
  每个模块在开发过程中应记录code的说明在这里:《错误码对照表》
  异常类
  系统内置了一些异常类供开发者处理异常
       统一定义在:com.enation.app.javashop.framework.exception中
  
  
  其中ServiceException供业务类处理异常使用


  thrownewServiceException(GoodsErrorCode.E300.code(),"消息");

  可以通过设置其data属性来向前端输出errorjson中的data
  Listlist=...
  thrownewServiceException(GoodsErrorCode.E300.code(),"消息",list);
 
  可以通过设置其status_code来改变http在statuscode:
  ServiceExceptione=newServiceException(GoodsErrorCode.E300.code(),"消息");
  e.setStatus_code(HttpStatus.BAD_REQUEST);
  throwe;
  参数规范
  1、严格遵守《Javashop开发规范》
  2、应使用阿里巴巴代码规约扫描插件进行扫描,做到新增的类,全部符合扫描通过
  3、前端向服务器端传参使用蛇形规范如:
  ?user_id=1&user_name=wangfeng
  注:Javashop7.0实现了自动将蛇形参数转化为驼峰参数的机制,接收上述参数的controller用驼峰即可:
  publicStringlogin(IntegeruserId,StringuserName)
  4、服务器端向前端输出json参数使用蛇形规范,如:
  {
  "brand_id":0,
  "goods_name":"string"
  "image_list":[]
  }
  5、客户端向服务器端传递分页参数规范为:
  page_no=<当前页号>&page_size=<分页大小>
  6、服务器端向客户端口传输分页结果规范为:
  {
  "data":[
  {..}
  ],
  "data_total":0,
  "page_no":0,
  "page_size":0
  }
  7、带有分页的api1)分页参数命名必须使用pageNo(页码)和pageSize(每页显示数量)2)参数类型必须是引用类型Integer3)不能使用封装对象接收分页参数

郑重声明:本文版权归原作者所有,转载文章仅为传播更多信息之目的,如作者信息标记有误,请第一时间联系我们修改或删除,多谢。

郑重声明:本文版权归原作者所有,转载文章仅为传播更多信息之目的,如作者信息标记有误,请第一时间联系我们修改或删除,多谢。

后台-系统设置-扩展变量-手机广告位-内容正文底部
留言与评论(共有 0 条评论)
   
验证码: