7.0架构及规范

工程结构

包名

工程包名规范

javashop-core 包名规范

API路径规范

注：在每个api服务中，上述业务路径是相同的

异常规范

根据http状态判断业务是否正常

如果正常要求返回对象的Json

如果有异常返回异常的json

异常Json格式规范

{
    "code": "100",
    "message": "无权访问"，
    "data": []
}

code 规范

三位数字

每个模块code规范：

每个模块在开发过程中应记录 code 的说明在这里：《错误码对照表》

异常类

系统内置了一些异常类供开发者处理异常

统一定义在：com.enation.app.javashop.framework.exception中

其中ServiceException 供业务类处理异常使用

throw new ServiceException(GoodsErrorCode.E300.code(),"消息");

可以通过设置其data 属性来向前端输出 error json中的data

List list  = ...
throw new ServiceException(GoodsErrorCode.E300.code(),"消息",list);

可以通过设置其 status_code 来改变http 在status code:

ServiceException e  = new ServiceException(GoodsErrorCode.E300.code(),"消息");
e.setStatus_code(HttpStatus.BAD_REQUEST);
throw e;

参数规范

1.严格遵守《Javashop开发规范》

2.应使用阿里巴巴代码规约扫描插件进行扫描，做到新增的类，全部符合扫描通过

3.前端向服务器端传参使用蛇形规范如：

?user_id=1&user_name=wangfeng

注：Javashop7.0实现了自动将蛇形参数转化为驼峰参数的机制，接收上述参数的controller用驼峰即可：

public String  login(Integer userId,String userName)

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.带有分页的api 1）分页参数命名必须使用pageNo（页码）和pageSize（每页显示数量） 2）参数类型必须是引用类型Integer 3）不能使用封装对象接收分页参数

多数据源的使用

daoSupport和对数据源对应关系

数据源配置规则

以商品及订单数据源举例（使用了相同的用户名和密码）

spring:        
  datasource:                
    url:    jdbc:mysql://localhost:3306/v641? useUnicode=true&characterEncoding=utf8&autoReconnect=true                
    username:    root                
    password:    123456                
    driver-class-name:    com.mysql.jdbc.Driver                
    druid:                        
      goods:                                
      url:    jdbc:mysql://localhost:3306/goods

      trade:                                
      url:    jdbc:mysql://localhost:3306/trade
#在这里可以继续配置其它数据源

其中spring.datasource的配置是公用配置部分：

    spring:
    datasource:
        url:jdbc:mysql://localhost:3306/v641?useUnicode=true&characterEncoding=utf8&autoReconnect=true
        username:root
        password:123456
        driver-class-name:com.mysql.jdbc.Driver
    druid:
        goods:
          url:jdbc:mysql://localhost:3306/goods
          username:goodsdbname
          password:goodspwd

注：如果不进行数据库分离，则只需要配置spring.datasource即可。

配置中心使用规则

1. 开发时启动本地配置中心config-server。
2. 开发环境可以指向配置本地仓储，线上仓储名为config，可以下载到本地，作为配置文件的本地仓储。
3. 配置本地仓储，需要进行git add . 和git commit -m操作，但不可push到线上。

详情可参照教程：配置中心教程。

验权机制

7.0全部采用token验权，

其中seller-api要求的是seller权限

buyer-api要求提buyer的权限

manager-api要求的是 manager的权限

分为开发和生产环境两种

环境的声明在工程的bootstrap.yml中：

spring:
  ...
  cloud:
    config:
      uri: http://localhost:8888
      profile: dev

其中的profile标明了开发环境(dev)还是生产环境(prod)

开发环境

开发环境为了便于开发，直接在header中传递token:

Authorization:Bearer yourtoken

生产环境

生产环境为了防止重放攻击，需要传递如下四个参数：

token的获取

除使用统一登录api获取token外，

还可以使用 TokenCreator 生成token

当前的获取

使用UserContext获取：

//获取买家
Buyer buyer  = UserContext.getBuyer();

//获取卖家
Seller seller =  UserContext.getSeller();